Accounting6

Aggregators5

Aggregators > Usage4

Analytics1

Approval workflows5

Audit logs1

Bank Accounts3

Billable events6

Catalog8

Companies2

Coupons5

Coupons > Promotion codes5

Custom properties4

Customers15

Customers > Credits10

Customers > Features3

Customers > Payment methods4

Customers > Segments5

Customers > Usage4

Exports4

Features7

Files4

Integrations1

Invoices16

Invoices > Events1

Invoices > Transactions2

Invoicing entities5

OAuth26

Organisations2

Payments1

Price books7

Price configurations4

Products7

Products > Features3

Quotes13

Quotes > Templates2

Subscriptions17

Subscriptions > Phases3

Subscriptions > Templates8

Subscriptions > Transitions4

Taxes2

Third-party apps4

Transactions1

Users2

Users > Roles2

Wallets9

Webhooks6

Invoicing entities

Update invoicing entity

Update an existing invoicing entity.

put/v1/invoicing-entities/{id}

Path parameters

idstring required

Request body

namestring

The name of the invoicing entity.

registration_numberstring nullable

The registration number of the invoicing entity.

tax_idstring nullable

The tax identification number of the invoicing entity.

billing_emailstring email nullable

The billing email address for the invoicing entity.

timezonestring

The timezone the invoicing entity operates in.

language'fr' | 'en' | 'de' | 'it' | 'nl' | 'es' | 'pt' | 'pl'

The default language of the invoicing entity.

is_defaultboolean

Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.

address_line1string nullable

The first line of the address for the invoicing entity.

address_line2string nullable

The second line of the address for the invoicing entity.

zip_codestring nullable

The postal code for the invoicing entity's address.

statestring nullable

The state or province of the invoicing entity.

citystring nullable

The city of the invoicing entity.

country'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BF' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PT-20' | 'PT-30' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'

The country in which the invoicing entity is registered.

currency'EUR' | 'AED' | 'AFN' | 'XCD' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'USD' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'XOF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'NOK' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'XAF' | 'CHF' | 'NZD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'ANG' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'MAD' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'XPF' | 'NGN' | 'NIO' | 'NPR' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

The currency code that the invoicing entity operates in.

accounting_currency'EUR' | 'AED' | 'AFN' | 'XCD' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'USD' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'XOF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'NOK' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'XAF' | 'CHF' | 'NZD' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'ANG' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'MAD' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'XPF' | 'NGN' | 'NIO' | 'NPR' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

The currency used for accounting purposes.

invoice_number_patternstring

The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

credit_note_number_patternstring

The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

document_number_patternstring

The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

default_payment_delayinteger

The default payment term in days.

invoice_grace_period_durationinteger

The grace period duration in days.

invoice_payment_initiation_delayinteger nullable

The payment initiation delay in days for the invoices.

document_payment_initiation_delayinteger nullable

The payment initiation delay in days for the custom documents.

invoice_late_feesstring nullable

The late fees applicable to the invoices.

invoice_footerstring nullable

The footer text to be used in invoices.

document_footerstring nullable

The footer text to be used in documents. If not specified, the invoice footer will be used.

logo_urlstring uri nullable

URL of the logo to be used in invoices.

favicon_urlstring uri nullable

URL of the logo to be used as favicon.

brand_colorstring nullable

Brand color to be used in invoices (hexadecimal color code).

forced_customer_type'corporate' | 'person' nullable

Forces all customers created under this invoicing entity to have this type. Set to null to allow users to choose.

credit_note_wallet_refund_enabledboolean

When enabled, credit note refunds default to the customer's wallet for invoices under this invoicing entity. The default applies only when refund_method is omitted on POST /v1/invoices/{id}/credit-notes; an explicit refund_method always wins. Requires wallets to be enabled at the workspace level.

Example request

{
  "name": "Acme Corp",
  "registration_number": "00011122334",
  "tax_id": "123456789",
  "billing_email": "billing@acmecorp.com",
  "timezone": "America/New_York",
  "language": "en",
  "is_default": true,
  "address_line1": "123 Elm St",
  "address_line2": "Suite 5",
  "zip_code": "10001",
  "state": "NY",
  "city": "New York",
  "country": "USA",
  "currency": "USD",
  "accounting_currency": "USD",
  "invoice_number_pattern": "INV-#####",
  "credit_note_number_pattern": "CN-#####",
  "document_number_pattern": "DOC-#####",
  "default_payment_delay": 30,
  "invoice_grace_period_duration": 7,
  "invoice_payment_initiation_delay": 2,
  "document_payment_initiation_delay": 2,
  "invoice_late_fees": "2% per month",
  "invoice_footer": "Thank you for your business.",
  "document_footer": "Thank you for your business.",
  "logo_url": "http://example.com/logo.png",
  "favicon_url": "http://example.com/logo.png",
  "brand_color": "#FF5733"
}

Response

idstring required

The unique identifier for the invoicing entity.

namestring required

The name of the invoicing entity.

trade_namestring

The trade name of the invoicing entity.

timezonestring required

The timezone the invoicing entity operates in.

language'fr' | 'en' | 'de' | 'it' | 'nl' | 'es' | 'pt' | 'pl' required

The default language of the invoicing entity.

is_defaultboolean required

Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.

The currency code that the invoicing entity operates in.

accounting_currencystring required

The currency used for accounting purposes.

address_line1string nullable required

The first line of the address for the invoicing entity.

address_line2string nullable required

The second line of the address for the invoicing entity.

zip_codestring nullable required

The postal code for the invoicing entity's address.

statestring nullable required

The state or province of the invoicing entity.

citystring nullable required

The city of the invoicing entity.

The country in which the invoicing entity is registered.

registration_numberstring nullable required

The registration number of the invoicing entity.

tax_idstring nullable required

The tax identification number of the invoicing entity.

tax_id_validboolean nullable required

Boolean indicating whether the tax ID is valid.

billing_emailstring email nullable required

The billing email address for the invoicing entity.

invoice_number_patternstring required

The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

credit_note_number_patternstring required

The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

document_number_patternstring required

The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.

next_invoice_numbernumber required

The next invoice number to be used.

next_credit_note_numbernumber required

The next credit note number to be used.

next_document_numbernumber required

The next document number to be used.

default_payment_delayinteger required

The default payment term in days.

invoice_grace_period_durationinteger required

The grace period duration in days.

invoice_payment_initiation_delayinteger nullable required

The payment initiation delay in days for the invoices.

document_payment_initiation_delayinteger nullable required

The payment initiation delay in days for the custom documents.

invoice_late_feesstring nullable required

The late fees applicable to the invoices.

invoice_footerstring nullable required

The footer text to be used in invoices.

document_footerstring nullable required

The footer text to be used in documents. If not specified, the invoice footer will be used.

logo_urlstring uri nullable required

URL of the logo to be used in invoices.

favicon_urlstring uri nullable required

URL of the logo to be used as favicon.

brand_colorstring nullable required

Brand color to be used in invoices (hexadecimal color code).

forced_customer_type'corporate' | 'person' nullable required

Forces all customers created under this invoicing entity to have this type. Set to null to allow users to choose.

credit_note_wallet_refund_enabledboolean required

created_atstring date required

Creation date of the invoicing entity.

updated_atstring date required

Last edition date of the invoicing entity.

deleted_atstring date nullable required

Date of the invoicing entity deletion.

Example response

{
  "id": "inv123",
  "name": "Acme Corp",
  "trade_name": "Acme",
  "timezone": "America/New_York",
  "language": "en",
  "is_default": true,
  "currency": "USD",
  "accounting_currency": "USD",
  "address_line1": "123 Elm St",
  "address_line2": "Suite 5",
  "zip_code": "10001",
  "state": "NY",
  "city": "New York",
  "country": "USA",
  "registration_number": "00011122334",
  "tax_id": "123456789",
  "tax_id_valid": true,
  "billing_email": "billing@acmecorp.com",
  "invoice_number_pattern": "INV-#####",
  "credit_note_number_pattern": "CN-#####",
  "document_number_pattern": "DOC-#####",
  "next_invoice_number": 1001,
  "next_credit_note_number": 201,
  "next_document_number": 1501,
  "default_payment_delay": 30,
  "invoice_grace_period_duration": 7,
  "invoice_payment_initiation_delay": 2,
  "document_payment_initiation_delay": 2,
  "invoice_late_fees": "2% per month",
  "invoice_footer": "Thank you for your business.",
  "document_footer": "Thank you for your business.",
  "logo_url": "http://example.com/logo.png",
  "favicon_url": "http://example.com/logo.png",
  "brand_color": "#FF5733",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-04-01T00:00:00Z"
}