This section describes the standard formats used.
Money
Amounts are integer numbers in cents. For examples, the value for 10,28€ is 1028
.
Currencies
Currencies use ISO 4217 codes
Rates
Rates such as the interest rate and daily fees rates are in percentage.
Business identifiers
Business Identifiers are information elements that are used to establish the unique identity of parties (organisations, agencies, etc.)
As they may come in different shapes and sizes depending on the country where the business is registered, you can provide a identifier_type
next to it to strictly define which format we should expect.
Let's take a look at some examples (formats details are detailed below)
Name | Countries | Type | Examples |
---|---|---|---|
SIREN | 🇫🇷 FR | siren | '899270979' '899 270 979' |
SIRET | 🇫🇷 FR | siret | '89927097900029' '899 270 979 00029' |
VAT | 🇪🇺 EU | vat_number | 'FR61899270979' 'ESB64717838' |
NIF | 🇪🇸 ES | nif | 'B64717838' 'ES B64717838' '54362315K' 'J99216582' |
CIF | 🇪🇸 ES | cif | 'J99216582' |
KvK | 🇳🇱 NLD | kvk | '83747737' |
BSN | 🇳🇱 NLD | bsn | '111222333' '1112.22.333' |
Handelregister nummer | 🇩🇪 DE | hr_nummer | 'Hamburg HRA 12345' 'Berlin (Charlottenburg) HRB 12345' 'Charlottenburg HRB 12345' |
Accepted formats
Type | Accepted formats | Notes |
---|---|---|
siren | [9 digits] | |
siret | [siren][(5) digits: nic] ddd ddd ddd ddddd | NIC: Internal classification number |
vat_number | [country][prefix][(n) digits] | Country should be 2 letter (ISO 3166-1). Number of digits varies per country |
nif | ['B'][(9) digits] ['ES B'][(9) digits] [(8) digits][checksum] [letter][(8) digits] | |
cif | [letter][(8) digits] | |
kvk | [(8) digits] | |
bsn | [(9) digits] [(4) digits].[(2) digits].[(3) digits] | Also known as "Citizen service number" |
hr_nummer | [court] [registry] [(6) digits] | Also known as "Handelregisternummer" |
Add your own data!
All objects that you can create have a metadata
field that is yours. The field is an object
. You can place your custom data inside this.
An example within an Invoice
is:
{
"invoice_id": "INVOICE_1234",
"metadata": {
"your_custom_field_1": "your custom value",
"your_custom_field_2": 12345,
"quickbooks_reference": "quick_1234"
}
...
}