Skip to main content
PUT
/
invoice
/
settings
cURL
curl --request PUT \
  --url https://api.slash.com/invoice/settings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "companyName": "<string>",
  "email": "jsmith@example.com",
  "address": {
    "addressLine": "<string>",
    "addressCity": "<string>",
    "addressState": "<string>",
    "addressZip": "<string>",
    "addressLine2": "<string>",
    "addressCountry": "<string>"
  },
  "defaultMemo": "<string>",
  "logoDocumentId": "<string>",
  "unitPriceDecimalPlaces": 4,
  "branding": {
    "backgroundColor": "<string>",
    "titleColor": "<string>"
  }
}
'
{
  "invoiceSettings": {
    "$entity": "invoice_settings",
    "id": "<string>",
    "legalEntityId": "<string>",
    "settings": {
      "companyName": "<string>",
      "email": "jsmith@example.com",
      "address": {
        "addressLine": "<string>",
        "addressCity": "<string>",
        "addressState": "<string>",
        "addressZip": "<string>",
        "addressLine2": "<string>",
        "addressCountry": "<string>"
      },
      "defaultMemo": "<string>",
      "logoDocumentId": "<string>",
      "unitPriceDecimalPlaces": 4,
      "branding": {
        "backgroundColor": "<string>",
        "titleColor": "<string>"
      }
    },
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Authentication from public API requests

Query Parameters

​
filter:legalEntityId
string

The legal entity ID. Required if authenticating with access to multiple legal entities.

Body

application/json

Invoice display settings for a legal entity.

​
companyName
string
required

The company name to display on invoices.

Minimum string length: 1
​
email
string<email>
required

The email address to display on invoices.

Minimum string length: 1
​
address
IAddressModel · object
required

The company address to display on invoices.

​
defaultMemo
string

Default memo text to pre-fill when creating new invoices.

Maximum string length: 500
​
logoDocumentId
string

Document ID of the company logo to display on invoices.

​
unitPriceDecimalPlaces
integer

Number of decimal places allowed for unit prices (in dollars). Defaults to 2 if not set.

Required range: 2 <= x <= 6
​
branding
object

Custom branding settings for invoice styling. Extensible for future branding options.

Response

OK

​
invoiceSettings
InvoiceSettings · object
required

Full invoice settings entity for a legal entity, including metadata.