Developers

PUBLIC API v1

Create a manual transaction

POST /api/v1/accounting/transactions/

Create a manual transaction for the company

Permission: write_transactions · Direct link

Company-scoped. Account permissions, plan limits and document state still apply.

Request body

application/json

FieldType / accepted valuesDescription
amountstring (decimal)Not specified
currencystringNot specified
descriptionRequiredstringNot specified
descriptionLongstring | nullNot specified
companystring (uuid) | nullNot specified
valueDateRequiredstring (date-time) | nullNot specified
paymentDatestring (date) | nullNot specified
paymentType"BANK" | "CASH" | "CREDIT_CARD" | "PAYPAL" | "NOT_PAID" | "" | nullNot specified
ledgerPaymentAccountCodestring | nullNot specified
supplierCountry"DE" | "PL" | "DOMESTIC" | "INSIDE_EU" | "OUTSIDE_EU" | ""Not specified
saleType"GOODS" | "SERVICES" | ""Not specified
inputVatType"NO_VAT" | "GERMAN_VAT" | "FOREIGN_VAT" | "" | nullNot specified
accountstring (uuid) | nullNot specified
source"IMPORT" | "MANUAL" | "API"* `IMPORT` - Import * `MANUAL` - Manual * `API` - API
verifiedAtstring (date-time) | nullNot specified
clientstring (uuid) | nullNot specified
vendorstring (uuid) | nullNot specified
reverseChargebooleanNot specified
vatRate23 | 19 | 8 | 7 | 5 | 0 | -1 | -2* `23` - 23% * `19` - 19% * `8` - 8% * `7` - 7% * `5` - 5% * `0` - 0% * `-1` - CUSTOM % * `-2` - Reverse charge
cashflowType"INCOME" | "EXPENSE"* `INCOME` - Income * `EXPENSE` - Expense
categorystring (uuid) | nullNot specified
companyCategorystring (uuid) | nullNot specified
isRefundbooleanNot specified
categoryMetadataobjectNot specified
Nested fields
FieldType / accepted valuesDescription
tripMealAllowanceobjectNot specified
Nested fields
FieldType / accepted valuesDescription
tripStartDateRequiredstring (date)Not specified
tripFinishDateRequiredstring (date)Not specified
tripDestinationRequired"AT" | "DE" | "BE" | "HR" | "CY" | "CZ" | "DK" | "EE" | "FI" | "FR" | "HU" | "IE" | "IT" | "LV" | "LT" | "LU" | "MT" | "NL" | "PL" | "PT" | "SK" | "SI" | "ES" | "SE" | "IL" | "LI" | "MC" | "MON" | "NO" | "SM" | "RS" | "CH" | "GB" | "CA" | "US" | "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "CU" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "ET" | "FK" | "FO" | "FJ" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "HN" | "HK" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IM" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LB" | "LS" | "LR" | "LY" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MN" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "SH" | "KN" | "LC" | "PM" | "VC" | "WS" | "ST" | "SA" | "SN" | "SC" | "SL" | "SG" | "SB" | "SO" | "ZA" | "GS" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "UM" | "UY" | "UZ" | "VU" | "VA" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"* `AT` - Austria * `DE` - Germany * `BE` - Belgium * `HR` - Croatia * `CY` - Cyprus * `CZ` - Czech Republic * `DK` - Denmark * `EE` - Estonia * `FI` - Finland * `FR` - France * `HU` - Hungary * `IE` - Ireland * `IT` - Italy * `LV` - Latvia * `LT` - Lithuania * `LU` - Luxembourg * `MT` - Malta * `NL` - Netherlands * `PL` - Poland * `PT` - Portugal * `SK` - Slovakia * `SI` - Slovenia * `ES` - Spain * `SE` - Sweden * `IL` - Israel * `LI` - Liechtenstein * `MC` - Monaco * `MON` - Montenegro * `NO` - Norway * `SM` - San Marino * `RS` - Serbia * `CH` - Switzerland * `GB` - United Kingdom * `CA` - Canada * `US` - United States * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - AndorrA * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei Darussalam * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `KH` - Cambodia * `CM` - Cameroon * `CV` - Cape Verde * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo, The Democratic Republic of the * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Cote D'Ivoire * `CU` - Cuba * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `ET` - Ethiopia * `FK` - Falkland Islands * `FO` - Faroe Islands * `FJ` - Fiji * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and Mcdonald Islands * `HN` - Honduras * `HK` - Hong Kong * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IM` - Isle of Man * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KP` - North Korea * `KR` - South Korea * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Lao People'S * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `MO` - Macao * `MK` - Macedonia * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MN` - Mongolia * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `AN` - Netherlands Antilles * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `MP` - Northern Mariana Islands * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestina * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Reunion * `RO` - Romania * `RU` - Russian Federation * `RW` - RWANDA * `SH` - Saint Helena * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SZ` - Swaziland * `SY` - Syrian Arab Republic * `TW` - Taiwan, Province of China * `TJ` - Tajikistan * `TZ` - Tanzania, United Republic of * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `UM` - United States Minor Outlying Islands * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VA` - Vatican * `VE` - Venezuela * `VN` - Viet Nam * `VG` - Virgin Islands, British * `VI` - Virgin Islands, U.S. * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe
amortizationobjectNot specified
Nested fields
FieldType / accepted valuesDescription
professionalUsePartnumber (double)Not specified
usefulLifetimeRequiredintegerNot specified
businessMealobjectNot specified
Nested fields
FieldType / accepted valuesDescription
businessMealstringNot specified
carUsageobjectNot specified
Nested fields
FieldType / accepted valuesDescription
carUseType"DRIVE_TO_WORK" | "BUSINESS_TRIP"* `DRIVE_TO_WORK` - Drive to Work * `BUSINESS_TRIP` - Business Trip
carUsageStartDateRequiredstring (date)Not specified
carUsageFinishDateRequiredstring (date)Not specified
carUsageDistanceRequiredintegerNot specified
vatPaidobjectNot specified
Nested fields
FieldType / accepted valuesDescription
vatDeclarationYearintegerNot specified
vatDeclarationPeriod"yearly" | "Q1" | "Q2" | "Q3" | "Q4" | "Jan" | "Feb" | "Mar" | "Apr" | "May" | "Jun" | "Jul" | "Aug" | "Sep" | "Oct" | "Nov" | "Dec" | "other"* `yearly` - Yearly * `Q1` - Q1 (Jan, Feb, Mar) * `Q2` - Q2 (Apr, May, Jun) * `Q3` - Q3 (Jul, Aug, Sep) * `Q4` - Q4 (Oct, Nov, Dec) * `Jan` - January * `Feb` - February * `Mar` - March * `Apr` - April * `May` - May * `Jun` - June * `Jul` - July * `Aug` - August * `Sep` - September * `Oct` - October * `Nov` - November * `Dec` - December * `other` - Other
professionalUsePartobjectNot specified
Nested fields
FieldType / accepted valuesDescription
professionalUsePartRequirednumber (double)Not specified
itemsobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
descriptionstringNot specified
amountRequiredstring (decimal)Not specified
vatRateRequiredintegerNot specified
vatType"VAT_INCLUDED" | "VAT_EXCLUDED"* `VAT_INCLUDED` - VAT Included * `VAT_EXCLUDED` - VAT Excluded
categorystring (uuid) | nullNot specified
companyCategorystring (uuid) | nullNot specified
professionalUsePartnumber (double)Not specified
orderintegerNot specified
metadataobjectNot specified

multipart/form-data

FieldType / accepted valuesDescription
amountstring (decimal)Not specified
currencystringNot specified
descriptionRequiredstringNot specified
descriptionLongstring | nullNot specified
companystring (uuid) | nullNot specified
valueDateRequiredstring (date-time) | nullNot specified
paymentDatestring (date) | nullNot specified
paymentType"BANK" | "CASH" | "CREDIT_CARD" | "PAYPAL" | "NOT_PAID" | "" | nullNot specified
ledgerPaymentAccountCodestring | nullNot specified
supplierCountry"DE" | "PL" | "DOMESTIC" | "INSIDE_EU" | "OUTSIDE_EU" | ""Not specified
saleType"GOODS" | "SERVICES" | ""Not specified
inputVatType"NO_VAT" | "GERMAN_VAT" | "FOREIGN_VAT" | "" | nullNot specified
accountstring (uuid) | nullNot specified
source"IMPORT" | "MANUAL" | "API"* `IMPORT` - Import * `MANUAL` - Manual * `API` - API
verifiedAtstring (date-time) | nullNot specified
clientstring (uuid) | nullNot specified
vendorstring (uuid) | nullNot specified
reverseChargebooleanNot specified
vatRate23 | 19 | 8 | 7 | 5 | 0 | -1 | -2* `23` - 23% * `19` - 19% * `8` - 8% * `7` - 7% * `5` - 5% * `0` - 0% * `-1` - CUSTOM % * `-2` - Reverse charge
cashflowType"INCOME" | "EXPENSE"* `INCOME` - Income * `EXPENSE` - Expense
categorystring (uuid) | nullNot specified
companyCategorystring (uuid) | nullNot specified
isRefundbooleanNot specified
categoryMetadataobjectNot specified
Nested fields
FieldType / accepted valuesDescription
tripMealAllowanceobjectNot specified
Nested fields
FieldType / accepted valuesDescription
tripStartDateRequiredstring (date)Not specified
tripFinishDateRequiredstring (date)Not specified
tripDestinationRequired"AT" | "DE" | "BE" | "HR" | "CY" | "CZ" | "DK" | "EE" | "FI" | "FR" | "HU" | "IE" | "IT" | "LV" | "LT" | "LU" | "MT" | "NL" | "PL" | "PT" | "SK" | "SI" | "ES" | "SE" | "IL" | "LI" | "MC" | "MON" | "NO" | "SM" | "RS" | "CH" | "GB" | "CA" | "US" | "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "CU" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "ET" | "FK" | "FO" | "FJ" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "HN" | "HK" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IM" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LB" | "LS" | "LR" | "LY" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MN" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "SH" | "KN" | "LC" | "PM" | "VC" | "WS" | "ST" | "SA" | "SN" | "SC" | "SL" | "SG" | "SB" | "SO" | "ZA" | "GS" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "UM" | "UY" | "UZ" | "VU" | "VA" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"* `AT` - Austria * `DE` - Germany * `BE` - Belgium * `HR` - Croatia * `CY` - Cyprus * `CZ` - Czech Republic * `DK` - Denmark * `EE` - Estonia * `FI` - Finland * `FR` - France * `HU` - Hungary * `IE` - Ireland * `IT` - Italy * `LV` - Latvia * `LT` - Lithuania * `LU` - Luxembourg * `MT` - Malta * `NL` - Netherlands * `PL` - Poland * `PT` - Portugal * `SK` - Slovakia * `SI` - Slovenia * `ES` - Spain * `SE` - Sweden * `IL` - Israel * `LI` - Liechtenstein * `MC` - Monaco * `MON` - Montenegro * `NO` - Norway * `SM` - San Marino * `RS` - Serbia * `CH` - Switzerland * `GB` - United Kingdom * `CA` - Canada * `US` - United States * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - AndorrA * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei Darussalam * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `KH` - Cambodia * `CM` - Cameroon * `CV` - Cape Verde * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo, The Democratic Republic of the * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Cote D'Ivoire * `CU` - Cuba * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `ET` - Ethiopia * `FK` - Falkland Islands * `FO` - Faroe Islands * `FJ` - Fiji * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and Mcdonald Islands * `HN` - Honduras * `HK` - Hong Kong * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IM` - Isle of Man * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KP` - North Korea * `KR` - South Korea * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Lao People'S * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `MO` - Macao * `MK` - Macedonia * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MN` - Mongolia * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `AN` - Netherlands Antilles * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `MP` - Northern Mariana Islands * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestina * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Reunion * `RO` - Romania * `RU` - Russian Federation * `RW` - RWANDA * `SH` - Saint Helena * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SZ` - Swaziland * `SY` - Syrian Arab Republic * `TW` - Taiwan, Province of China * `TJ` - Tajikistan * `TZ` - Tanzania, United Republic of * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `UM` - United States Minor Outlying Islands * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VA` - Vatican * `VE` - Venezuela * `VN` - Viet Nam * `VG` - Virgin Islands, British * `VI` - Virgin Islands, U.S. * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe
amortizationobjectNot specified
Nested fields
FieldType / accepted valuesDescription
professionalUsePartnumber (double)Not specified
usefulLifetimeRequiredintegerNot specified
businessMealobjectNot specified
Nested fields
FieldType / accepted valuesDescription
businessMealstringNot specified
carUsageobjectNot specified
Nested fields
FieldType / accepted valuesDescription
carUseType"DRIVE_TO_WORK" | "BUSINESS_TRIP"* `DRIVE_TO_WORK` - Drive to Work * `BUSINESS_TRIP` - Business Trip
carUsageStartDateRequiredstring (date)Not specified
carUsageFinishDateRequiredstring (date)Not specified
carUsageDistanceRequiredintegerNot specified
vatPaidobjectNot specified
Nested fields
FieldType / accepted valuesDescription
vatDeclarationYearintegerNot specified
vatDeclarationPeriod"yearly" | "Q1" | "Q2" | "Q3" | "Q4" | "Jan" | "Feb" | "Mar" | "Apr" | "May" | "Jun" | "Jul" | "Aug" | "Sep" | "Oct" | "Nov" | "Dec" | "other"* `yearly` - Yearly * `Q1` - Q1 (Jan, Feb, Mar) * `Q2` - Q2 (Apr, May, Jun) * `Q3` - Q3 (Jul, Aug, Sep) * `Q4` - Q4 (Oct, Nov, Dec) * `Jan` - January * `Feb` - February * `Mar` - March * `Apr` - April * `May` - May * `Jun` - June * `Jul` - July * `Aug` - August * `Sep` - September * `Oct` - October * `Nov` - November * `Dec` - December * `other` - Other
professionalUsePartobjectNot specified
Nested fields
FieldType / accepted valuesDescription
professionalUsePartRequirednumber (double)Not specified
itemsobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
descriptionstringNot specified
amountRequiredstring (decimal)Not specified
vatRateRequiredintegerNot specified
vatType"VAT_INCLUDED" | "VAT_EXCLUDED"* `VAT_INCLUDED` - VAT Included * `VAT_EXCLUDED` - VAT Excluded
categorystring (uuid) | nullNot specified
companyCategorystring (uuid) | nullNot specified
professionalUsePartnumber (double)Not specified
orderintegerNot specified
metadataobjectNot specified

application/x-www-form-urlencoded

FieldType / accepted valuesDescription
amountstring (decimal)Not specified
currencystringNot specified
descriptionRequiredstringNot specified
descriptionLongstring | nullNot specified
companystring (uuid) | nullNot specified
valueDateRequiredstring (date-time) | nullNot specified
paymentDatestring (date) | nullNot specified
paymentType"BANK" | "CASH" | "CREDIT_CARD" | "PAYPAL" | "NOT_PAID" | "" | nullNot specified
ledgerPaymentAccountCodestring | nullNot specified
supplierCountry"DE" | "PL" | "DOMESTIC" | "INSIDE_EU" | "OUTSIDE_EU" | ""Not specified
saleType"GOODS" | "SERVICES" | ""Not specified
inputVatType"NO_VAT" | "GERMAN_VAT" | "FOREIGN_VAT" | "" | nullNot specified
accountstring (uuid) | nullNot specified
source"IMPORT" | "MANUAL" | "API"* `IMPORT` - Import * `MANUAL` - Manual * `API` - API
verifiedAtstring (date-time) | nullNot specified
clientstring (uuid) | nullNot specified
vendorstring (uuid) | nullNot specified
reverseChargebooleanNot specified
vatRate23 | 19 | 8 | 7 | 5 | 0 | -1 | -2* `23` - 23% * `19` - 19% * `8` - 8% * `7` - 7% * `5` - 5% * `0` - 0% * `-1` - CUSTOM % * `-2` - Reverse charge
cashflowType"INCOME" | "EXPENSE"* `INCOME` - Income * `EXPENSE` - Expense
categorystring (uuid) | nullNot specified
companyCategorystring (uuid) | nullNot specified
isRefundbooleanNot specified
categoryMetadataobjectNot specified
Nested fields
FieldType / accepted valuesDescription
tripMealAllowanceobjectNot specified
Nested fields
FieldType / accepted valuesDescription
tripStartDateRequiredstring (date)Not specified
tripFinishDateRequiredstring (date)Not specified
tripDestinationRequired"AT" | "DE" | "BE" | "HR" | "CY" | "CZ" | "DK" | "EE" | "FI" | "FR" | "HU" | "IE" | "IT" | "LV" | "LT" | "LU" | "MT" | "NL" | "PL" | "PT" | "SK" | "SI" | "ES" | "SE" | "IL" | "LI" | "MC" | "MON" | "NO" | "SM" | "RS" | "CH" | "GB" | "CA" | "US" | "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "CU" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "ET" | "FK" | "FO" | "FJ" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "HN" | "HK" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IM" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LB" | "LS" | "LR" | "LY" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MN" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "SH" | "KN" | "LC" | "PM" | "VC" | "WS" | "ST" | "SA" | "SN" | "SC" | "SL" | "SG" | "SB" | "SO" | "ZA" | "GS" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "UM" | "UY" | "UZ" | "VU" | "VA" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"* `AT` - Austria * `DE` - Germany * `BE` - Belgium * `HR` - Croatia * `CY` - Cyprus * `CZ` - Czech Republic * `DK` - Denmark * `EE` - Estonia * `FI` - Finland * `FR` - France * `HU` - Hungary * `IE` - Ireland * `IT` - Italy * `LV` - Latvia * `LT` - Lithuania * `LU` - Luxembourg * `MT` - Malta * `NL` - Netherlands * `PL` - Poland * `PT` - Portugal * `SK` - Slovakia * `SI` - Slovenia * `ES` - Spain * `SE` - Sweden * `IL` - Israel * `LI` - Liechtenstein * `MC` - Monaco * `MON` - Montenegro * `NO` - Norway * `SM` - San Marino * `RS` - Serbia * `CH` - Switzerland * `GB` - United Kingdom * `CA` - Canada * `US` - United States * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - AndorrA * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei Darussalam * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `KH` - Cambodia * `CM` - Cameroon * `CV` - Cape Verde * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo, The Democratic Republic of the * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Cote D'Ivoire * `CU` - Cuba * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `ET` - Ethiopia * `FK` - Falkland Islands * `FO` - Faroe Islands * `FJ` - Fiji * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and Mcdonald Islands * `HN` - Honduras * `HK` - Hong Kong * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IM` - Isle of Man * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KP` - North Korea * `KR` - South Korea * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Lao People'S * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `MO` - Macao * `MK` - Macedonia * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MN` - Mongolia * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `AN` - Netherlands Antilles * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `MP` - Northern Mariana Islands * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestina * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Reunion * `RO` - Romania * `RU` - Russian Federation * `RW` - RWANDA * `SH` - Saint Helena * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SZ` - Swaziland * `SY` - Syrian Arab Republic * `TW` - Taiwan, Province of China * `TJ` - Tajikistan * `TZ` - Tanzania, United Republic of * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `UM` - United States Minor Outlying Islands * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VA` - Vatican * `VE` - Venezuela * `VN` - Viet Nam * `VG` - Virgin Islands, British * `VI` - Virgin Islands, U.S. * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe
amortizationobjectNot specified
Nested fields
FieldType / accepted valuesDescription
professionalUsePartnumber (double)Not specified
usefulLifetimeRequiredintegerNot specified
businessMealobjectNot specified
Nested fields
FieldType / accepted valuesDescription
businessMealstringNot specified
carUsageobjectNot specified
Nested fields
FieldType / accepted valuesDescription
carUseType"DRIVE_TO_WORK" | "BUSINESS_TRIP"* `DRIVE_TO_WORK` - Drive to Work * `BUSINESS_TRIP` - Business Trip
carUsageStartDateRequiredstring (date)Not specified
carUsageFinishDateRequiredstring (date)Not specified
carUsageDistanceRequiredintegerNot specified
vatPaidobjectNot specified
Nested fields
FieldType / accepted valuesDescription
vatDeclarationYearintegerNot specified
vatDeclarationPeriod"yearly" | "Q1" | "Q2" | "Q3" | "Q4" | "Jan" | "Feb" | "Mar" | "Apr" | "May" | "Jun" | "Jul" | "Aug" | "Sep" | "Oct" | "Nov" | "Dec" | "other"* `yearly` - Yearly * `Q1` - Q1 (Jan, Feb, Mar) * `Q2` - Q2 (Apr, May, Jun) * `Q3` - Q3 (Jul, Aug, Sep) * `Q4` - Q4 (Oct, Nov, Dec) * `Jan` - January * `Feb` - February * `Mar` - March * `Apr` - April * `May` - May * `Jun` - June * `Jul` - July * `Aug` - August * `Sep` - September * `Oct` - October * `Nov` - November * `Dec` - December * `other` - Other
professionalUsePartobjectNot specified
Nested fields
FieldType / accepted valuesDescription
professionalUsePartRequirednumber (double)Not specified
itemsobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
descriptionstringNot specified
amountRequiredstring (decimal)Not specified
vatRateRequiredintegerNot specified
vatType"VAT_INCLUDED" | "VAT_EXCLUDED"* `VAT_INCLUDED` - VAT Included * `VAT_EXCLUDED` - VAT Excluded
categorystring (uuid) | nullNot specified
companyCategorystring (uuid) | nullNot specified
professionalUsePartnumber (double)Not specified
orderintegerNot specified
metadataobjectNot specified

Responses

201 Response fields

application/json

FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
externalIdstringNot specified
status"PENDING" | "BOOKED" | "UNDEFINED"* `PENDING` - Pending * `BOOKED` - Booked * `UNDEFINED` - Undefined
amountRequiredstring (decimal)Not specified
amountExchangedstring (decimal) | nullNot specified
currencyRequiredobjectNot specified
Nested fields
FieldType / accepted valuesDescription
fullNameRequiredRead onlystringNot specified
isoCodeRequiredstringNot specified
currencyExchangedRequiredobjectNot specified
Nested fields
FieldType / accepted valuesDescription
fullNameRequiredRead onlystringNot specified
isoCodeRequiredstringNot specified
descriptionstringNot specified
descriptionLongstring | nullNot specified
userStatus"UNVERIFIED" | "VERIFIED"* `UNVERIFIED` - Unverified * `VERIFIED` - Verified
vatRate23 | 19 | 8 | 7 | 5 | 0 | -1 | -2* `23` - 23% * `19` - 19% * `8` - 8% * `7` - 7% * `5` - 5% * `0` - 0% * `-1` - CUSTOM % * `-2` - Reverse charge
vatAmountstring (decimal)Not specified
valueDatestring (date-time) | nullNot specified
paymentDatestring (date) | nullNot specified
paymentType"BANK" | "CASH" | "CREDIT_CARD" | "PAYPAL" | "NOT_PAID" | "" | nullNot specified
ledgerPaymentAccountCodestring | nullNot specified
categoryRequiredobjectNot specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
nameRequiredRead onlystringNot specified
parentstring (uuid) | nullNot specified
cashflowTypeRequiredstringNot specified
vatApplied"YES" | "NO"* `YES` - Yes * `NO` - No
metadataobjectNot specified
descriptionRequiredRead onlystringNot specified
examplesRequiredRead onlystringNot specified
companyCategoryRequiredRead onlyobjectNot specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
codeRequiredstringNot specified
nameRequiredstringNot specified
nameDestringNot specified
namePlstringNot specified
descriptionstringNot specified
cashflowType"ASSET" | "LIABILITY" | "EQUITY" | "INCOME" | "EXPENSE"* `ASSET` - Asset * `LIABILITY` - Liability * `EQUITY` - Equity * `INCOME` - Income * `EXPENSE` - Expense
vatApplicabilitybooleanNot specified
suggestedVatRateintegerNot specified
isCustombooleanNot specified
isActivebooleanNot specified
isBookablebooleanNot specified
categoryGroupstringNot specified
metadataobjectNot specified
isRefundbooleanNot specified
ibanstringNot specified
bankLogoRequiredRead onlystring | nullNot specified
verifiedAtstring (date-time) | nullNot specified
vatAmountExchangedstring (decimal) | nullNot specified
cashflowTypeRequiredstringNot specified
sourceRequiredstringNot specified
attachmentstring (uuid) | nullNot specified
additionalAttachmentsRequiredRead onlyobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
filestring (uri) | nullNot specified
invoicestring (uuid) | nullNot specified
supplierCountry"DE" | "PL" | "DOMESTIC" | "INSIDE_EU" | "OUTSIDE_EU" | ""Not specified
supplierCountryNameRequiredstringNot specified
clientstring (uuid) | nullNot specified
vendorstring (uuid) | nullNot specified
vendorDetailsRequiredRead onlyobjectNot specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
nameRequiredstringNot specified
displayLogoUrlRequiredRead onlystringNot specified
catalogKeystringNot specified
reverseChargebooleanNot specified
saleType"GOODS" | "SERVICES" | ""Not specified
inputVatType"NO_VAT" | "GERMAN_VAT" | "FOREIGN_VAT" | "" | nullNot specified
categoryMetadataobjectNot specified
logostring (uri) | nullNot specified
appliedRuleRequiredRead onlyobjectMinimal serializer for embedding in transaction responses.
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
nameRequiredstringNot specified
conditionsSummaryRequiredRead onlystringNot specified
advisorNotesstringPrivate memo, not visible to your tax advisor. Use the transaction discussion to contact your advisor.
categorizationStatus"PENDING" | "CATEGORIZED" | "UNCATEGORIZED"* `PENDING` - Pending * `CATEGORIZED` - Categorized * `UNCATEGORIZED` - Uncategorized
itemsRequiredRead onlyobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
descriptionstringNot specified
amountRequiredstring (decimal)Not specified
amountExchangedstring (decimal) | nullNot specified
vatRate23 | 19 | 8 | 7 | 5 | 0 | -1 | -2* `23` - 23% * `19` - 19% * `8` - 8% * `7` - 7% * `5` - 5% * `0` - 0% * `-1` - CUSTOM % * `-2` - Reverse charge
vatAmountstring (decimal)Not specified
vatAmountExchangedstring (decimal) | nullNot specified
vatType"VAT_INCLUDED" | "VAT_EXCLUDED"* `VAT_INCLUDED` - VAT Included * `VAT_EXCLUDED` - VAT Excluded
categoryRequiredRead onlyobjectNot specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
nameRequiredRead onlystringNot specified
parentstring (uuid) | nullNot specified
cashflowTypeRequiredstringNot specified
vatApplied"YES" | "NO"* `YES` - Yes * `NO` - No
metadataobjectNot specified
descriptionRequiredRead onlystringNot specified
examplesRequiredRead onlystringNot specified
companyCategoryRequiredRead onlyobjectNot specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
codeRequiredstringNot specified
nameRequiredstringNot specified
nameDestringNot specified
namePlstringNot specified
descriptionstringNot specified
cashflowType"ASSET" | "LIABILITY" | "EQUITY" | "INCOME" | "EXPENSE"* `ASSET` - Asset * `LIABILITY` - Liability * `EQUITY` - Equity * `INCOME` - Income * `EXPENSE` - Expense
vatApplicabilitybooleanNot specified
suggestedVatRateintegerNot specified
isCustombooleanNot specified
isActivebooleanNot specified
isBookablebooleanNot specified
categoryGroupstringNot specified
metadataobjectNot specified
professionalUsePartstring (decimal)Fraction of business use (0.000 to 1.000)
orderintegerNot specified
metadataobjectNot specified
isLockedbooleanNot specified
usesPreviousSkrAccountRequiredRead onlybooleanNot specified
documentNotRequiredboolean | nullNot specified
400 Response fields

application/json

FieldType / accepted valuesDescription
detailRequiredstringNot specified
codeintegerNot specified
type_stringNot specified
fieldRequiredstringNot specified
401 Response fields

application/json

FieldType / accepted valuesDescription
detailRequiredRead onlystringNot specified
403 Missing scope, company mismatch, unsupported operation, or a plan/account restriction.
429 Rate limit exceeded. Wait for the Retry-After header before retrying.

Use the base URL https://api.norman.finance/api/v1. Sign up or log in to Norman to create an API key, then send it as a Bearer token. For an OpenAPI JSON file, contact support.