Skip to main content
PATCH
Update invoice settings
Only the fields you send change, and null clears a field. See Invoice settings.

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Body

application/json

Partial update. An omitted field is left unchanged; null clears a clearable field. address and branding are replaced as a whole.

companyName
string
Required string length: 1 - 255
email
string<email>
address
Address · object
defaultMemo
string | null
Required string length: 1 - 500
defaultPaymentTermsDays
integer | null
Required range: 0 <= x <= 365
logoDocumentId
string | null

A document uploaded with purpose invoice_logo, with the st_ prefix. null removes the logo.

branding
object | null

Response

The updated invoice settings.

What every invoice from the legal entity shows: who it's from, the defaults new invoices start with, and the logo and colors on the PDF and payment page.

companyName
string
required

Who invoices are from.

email
string
required

The reply-to address on invoice emails.

address
Address · object
required
nextInvoiceNumber
string
required

The number the next invoice gets when it doesn't name one.

Example:

"INV-1043"

defaultMemo
string

The memo the dashboard fills in on new invoices.

defaultPaymentTermsDays
integer

How many days after issue the dashboard makes new invoices due.

logoDocumentId
string

The logo, a document uploaded with purpose invoice_logo.

branding
object