PUBLIC API v1

Set up a recurring invoice

POST /api/v1/companies/{company_pk}/recurring-invoices/

The template is the invoice as typed, without number and dates. On each run date Norman makes one ordinary invoice from it: a draft (mode=draft), an issued invoice (issue) or an issued and emailed one (send). Placeholders {month}, {year}, {quarter}, {week} and {period} in line texts, notes and the email are filled from the period each invoice covers. A start today or earlier makes the first invoice at once.

Permission: write_invoices · Direct link

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

Path and query parameters

Parameter	Location / type	Description
`company_pk`Required	path · `string (uuid)`	Not specified

Request body

application/json

Field Type / accepted values Description

client string (uuid) | null Not specified

invoiceType "GOODS" | "SERVICES" * `GOODS` - Goods * `SERVICES` - Services

invoicedItems

object[]

Not specified

Nested fields

Field	Type / accepted values	Description
`id`	`string \| null`	The line's id (UUID), assigned by the server when the line is first written. Echo it on an update so the line keeps its identity; leave it out for a new line.
`name`Required	`string`	Not specified
`quantity`Required	`number (double)`	Not specified
`rate`Required	`integer`	Not specified
`vatRate`Required	`integer`	Not specified
`itemPriceNet`	`integer`	Not specified
`itemPriceGross`	`integer`	Not specified
`itemVatAmount`	`integer`	Not specified
`discountPercent`	`number (double)`	Not specified
`itemDiscountAmount`	`integer`	Not specified
`description`	`string`	Not specified
`discountNote`	`string`	Deprecated, use description.
`unit`	`"items" \| "hours" \| "days" \| "kilograms" \| "liters" \| "meters" \| "square_meters" \| "" \| null`	Not specified
`productId`	`string \| null`	Not specified
`companyCategory`	`string \| null`	Not specified
`gtuCode`	`"GTU_01" \| "GTU_02" \| "GTU_03" \| "GTU_04" \| "GTU_05" \| "GTU_06" \| "GTU_07" \| "GTU_08" \| "GTU_09" \| "GTU_10" \| "GTU_11" \| "GTU_12" \| "GTU_13" \| ""`	Not specified
`isSplitPayment`	`boolean`	Not specified

currency string Not specified

currencyExchanged string Not specified

language "de" | "en" | "pl" | "it" | "es" * `de` - German * `en` - English * `pl` - Polish * `it` - Italian * `es` - Spanish

isVatIncluded boolean Not specified

discountPercents integer Not specified

paymentTerms string Not specified

notes string Not specified

instructions string Not specified

message string Not specified

taxExemptReason string | null Not specified

companyEmail string (email) | null Not specified

createQr boolean Not specified

settingsOnOverdue

object | null

Not specified

Nested fields

Field	Type / accepted values	Description
`isToAutosendNotification`	`boolean`	Not specified
`notifyAfterDays`	`integer[]`	Not specified
`notifyInParticularDays`	`string (date)[]`	Not specified
`customEmailBody`	`string \| null`	Not specified
`customEmailSubject`	`string \| null`	Not specified

mailingData object | null Not specified

onlinePaymentEnabled boolean Not specified

documentDesign

object

Not specified

Nested fields

Field	Type / accepted values	Description
`template`Required	`"heritage" \| "regent" \| "meridian" \| "horizon" \| "atelier" \| "epoque" \| "sovereign"`	* `heritage` - heritage * `regent` - regent * `meridian` - meridian * `horizon` - horizon * `atelier` - atelier * `epoque` - epoque * `sovereign` - sovereign
`version`	`1`	* `1` - 1
`logoSize`	`integer`	Not specified
`textSize`	`"small" \| "medium" \| "large"`	* `small` - small * `medium` - medium * `large` - large
`spacing`	`"compact" \| "standard" \| "spacious"`	* `compact` - compact * `standard` - standard * `spacious` - spacious
`tableBorders`	`"none" \| "dividers" \| "grid"`	* `none` - none * `dividers` - dividers * `grid` - grid

font string Not specified

colorSchema string Not specified

sourceContract string (uuid) | null Not specified

interval "week" | "month" | "year" * `week` - Week * `month` - Month * `year` - Year

intervalCount integer Not specified

startsOn string (date) Not specified

endsOn string (date) | null Not specified

endsAfter integer | null Not specified

paymentDueDays integer Not specified

billingInAdvance boolean Not specified

mode "draft" | "issue" | "send" * `draft` - Create a draft * `issue` - Issue * `send` - Issue and send

clientData

object

Not specified

Nested fields

Field	Type / accepted values	Description
`name`Required	`string`	Not specified
`address`	`string`	Not specified
`city`	`string`	Not specified
`zipCode`	`string`	Not specified
`country`	"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
`vatNumber`	`string`	Not specified
`email`	`string (email)`	Not specified
`phone`	`string`	Not specified

saveClientDetails boolean Not specified

iban string | null Not specified

bic string | null Not specified

bankName string | null Not specified

skipBankDetails boolean Not specified

multipart/form-data

Field Type / accepted values Description

client string (uuid) | null Not specified

invoiceType "GOODS" | "SERVICES" * `GOODS` - Goods * `SERVICES` - Services

invoicedItems

object[]

Not specified

Nested fields

Field	Type / accepted values	Description
`id`	`string \| null`	The line's id (UUID), assigned by the server when the line is first written. Echo it on an update so the line keeps its identity; leave it out for a new line.
`name`Required	`string`	Not specified
`quantity`Required	`number (double)`	Not specified
`rate`Required	`integer`	Not specified
`vatRate`Required	`integer`	Not specified
`itemPriceNet`	`integer`	Not specified
`itemPriceGross`	`integer`	Not specified
`itemVatAmount`	`integer`	Not specified
`discountPercent`	`number (double)`	Not specified
`itemDiscountAmount`	`integer`	Not specified
`description`	`string`	Not specified
`discountNote`	`string`	Deprecated, use description.
`unit`	`"items" \| "hours" \| "days" \| "kilograms" \| "liters" \| "meters" \| "square_meters" \| "" \| null`	Not specified
`productId`	`string \| null`	Not specified
`companyCategory`	`string \| null`	Not specified
`gtuCode`	`"GTU_01" \| "GTU_02" \| "GTU_03" \| "GTU_04" \| "GTU_05" \| "GTU_06" \| "GTU_07" \| "GTU_08" \| "GTU_09" \| "GTU_10" \| "GTU_11" \| "GTU_12" \| "GTU_13" \| ""`	Not specified
`isSplitPayment`	`boolean`	Not specified

currency string Not specified

currencyExchanged string Not specified

language "de" | "en" | "pl" | "it" | "es" * `de` - German * `en` - English * `pl` - Polish * `it` - Italian * `es` - Spanish

isVatIncluded boolean Not specified

discountPercents integer Not specified

paymentTerms string Not specified

notes string Not specified

instructions string Not specified

message string Not specified

taxExemptReason string | null Not specified

companyEmail string (email) | null Not specified

createQr boolean Not specified

settingsOnOverdue

object | null

Not specified

Nested fields

Field	Type / accepted values	Description
`isToAutosendNotification`	`boolean`	Not specified
`notifyAfterDays`	`integer[]`	Not specified
`notifyInParticularDays`	`string (date)[]`	Not specified
`customEmailBody`	`string \| null`	Not specified
`customEmailSubject`	`string \| null`	Not specified

mailingData object | null Not specified

onlinePaymentEnabled boolean Not specified

documentDesign

object

Not specified

Nested fields

Field	Type / accepted values	Description
`template`Required	`"heritage" \| "regent" \| "meridian" \| "horizon" \| "atelier" \| "epoque" \| "sovereign"`	* `heritage` - heritage * `regent` - regent * `meridian` - meridian * `horizon` - horizon * `atelier` - atelier * `epoque` - epoque * `sovereign` - sovereign
`version`	`1`	* `1` - 1
`logoSize`	`integer`	Not specified
`textSize`	`"small" \| "medium" \| "large"`	* `small` - small * `medium` - medium * `large` - large
`spacing`	`"compact" \| "standard" \| "spacious"`	* `compact` - compact * `standard` - standard * `spacious` - spacious
`tableBorders`	`"none" \| "dividers" \| "grid"`	* `none` - none * `dividers` - dividers * `grid` - grid

font string Not specified

colorSchema string Not specified

sourceContract string (uuid) | null Not specified

interval "week" | "month" | "year" * `week` - Week * `month` - Month * `year` - Year

intervalCount integer Not specified

startsOn string (date) Not specified

endsOn string (date) | null Not specified

endsAfter integer | null Not specified

paymentDueDays integer Not specified

billingInAdvance boolean Not specified

mode "draft" | "issue" | "send" * `draft` - Create a draft * `issue` - Issue * `send` - Issue and send

clientData

object

Not specified

Nested fields

Field	Type / accepted values	Description
`name`Required	`string`	Not specified
`address`	`string`	Not specified
`city`	`string`	Not specified
`zipCode`	`string`	Not specified
`country`	"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
`vatNumber`	`string`	Not specified
`email`	`string (email)`	Not specified
`phone`	`string`	Not specified

saveClientDetails boolean Not specified

iban string | null Not specified

bic string | null Not specified

bankName string | null Not specified

skipBankDetails boolean Not specified

application/x-www-form-urlencoded

Field Type / accepted values Description

client string (uuid) | null Not specified

invoiceType "GOODS" | "SERVICES" * `GOODS` - Goods * `SERVICES` - Services

invoicedItems

object[]

Not specified

Nested fields

Field	Type / accepted values	Description
`id`	`string \| null`	The line's id (UUID), assigned by the server when the line is first written. Echo it on an update so the line keeps its identity; leave it out for a new line.
`name`Required	`string`	Not specified
`quantity`Required	`number (double)`	Not specified
`rate`Required	`integer`	Not specified
`vatRate`Required	`integer`	Not specified
`itemPriceNet`	`integer`	Not specified
`itemPriceGross`	`integer`	Not specified
`itemVatAmount`	`integer`	Not specified
`discountPercent`	`number (double)`	Not specified
`itemDiscountAmount`	`integer`	Not specified
`description`	`string`	Not specified
`discountNote`	`string`	Deprecated, use description.
`unit`	`"items" \| "hours" \| "days" \| "kilograms" \| "liters" \| "meters" \| "square_meters" \| "" \| null`	Not specified
`productId`	`string \| null`	Not specified
`companyCategory`	`string \| null`	Not specified
`gtuCode`	`"GTU_01" \| "GTU_02" \| "GTU_03" \| "GTU_04" \| "GTU_05" \| "GTU_06" \| "GTU_07" \| "GTU_08" \| "GTU_09" \| "GTU_10" \| "GTU_11" \| "GTU_12" \| "GTU_13" \| ""`	Not specified
`isSplitPayment`	`boolean`	Not specified

currency string Not specified

currencyExchanged string Not specified

language "de" | "en" | "pl" | "it" | "es" * `de` - German * `en` - English * `pl` - Polish * `it` - Italian * `es` - Spanish

isVatIncluded boolean Not specified

discountPercents integer Not specified

paymentTerms string Not specified

notes string Not specified

instructions string Not specified

message string Not specified

taxExemptReason string | null Not specified

companyEmail string (email) | null Not specified

createQr boolean Not specified

settingsOnOverdue

object | null

Not specified

Nested fields

Field	Type / accepted values	Description
`isToAutosendNotification`	`boolean`	Not specified
`notifyAfterDays`	`integer[]`	Not specified
`notifyInParticularDays`	`string (date)[]`	Not specified
`customEmailBody`	`string \| null`	Not specified
`customEmailSubject`	`string \| null`	Not specified

mailingData object | null Not specified

onlinePaymentEnabled boolean Not specified

documentDesign

object

Not specified

Nested fields

Field	Type / accepted values	Description
`template`Required	`"heritage" \| "regent" \| "meridian" \| "horizon" \| "atelier" \| "epoque" \| "sovereign"`	* `heritage` - heritage * `regent` - regent * `meridian` - meridian * `horizon` - horizon * `atelier` - atelier * `epoque` - epoque * `sovereign` - sovereign
`version`	`1`	* `1` - 1
`logoSize`	`integer`	Not specified
`textSize`	`"small" \| "medium" \| "large"`	* `small` - small * `medium` - medium * `large` - large
`spacing`	`"compact" \| "standard" \| "spacious"`	* `compact` - compact * `standard` - standard * `spacious` - spacious
`tableBorders`	`"none" \| "dividers" \| "grid"`	* `none` - none * `dividers` - dividers * `grid` - grid

font string Not specified

colorSchema string Not specified

sourceContract string (uuid) | null Not specified

interval "week" | "month" | "year" * `week` - Week * `month` - Month * `year` - Year

intervalCount integer Not specified

startsOn string (date) Not specified

endsOn string (date) | null Not specified

endsAfter integer | null Not specified

paymentDueDays integer Not specified

billingInAdvance boolean Not specified

mode "draft" | "issue" | "send" * `draft` - Create a draft * `issue` - Issue * `send` - Issue and send

clientData

object

Not specified

Nested fields

Field	Type / accepted values	Description
`name`Required	`string`	Not specified
`address`	`string`	Not specified
`city`	`string`	Not specified
`zipCode`	`string`	Not specified
`country`	"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
`vatNumber`	`string`	Not specified
`email`	`string (email)`	Not specified
`phone`	`string`	Not specified

saveClientDetails boolean Not specified

iban string | null Not specified

bic string | null Not specified

bankName string | null Not specified

skipBankDetails boolean Not specified

Responses

201 Response fields

application/json

Field Type / accepted values Description

publicIdRequiredRead only string (uuid) Not specified

status "active" | "paused" | "ended" * `active` - Active * `paused` - Paused * `ended` - Ended

lastError string Not specified

nextRunOn string (date) | null Not specified

periodStartRequiredRead only string (date) | null Not specified

runsMade integer Not specified

fullCost integer (int64) | null Not specified

fullCostOrigin string (decimal) | null Not specified

isReverseCharged boolean Not specified

createdRequiredRead only string (date-time) Not specified

interval "week" | "month" | "year" * `week` - Week * `month` - Month * `year` - Year

intervalCount integer Not specified

startsOnRequired string (date) Not specified

endsOn string (date) | null Not specified

endsAfter integer | null Not specified

paymentDueDays integer Not specified

billingInAdvance boolean Not specified

mode "draft" | "issue" | "send" * `draft` - Create a draft * `issue` - Issue * `send` - Issue and send

client string (uuid) | null Not specified

invoiceType "GOODS" | "SERVICES" * `GOODS` - Goods * `SERVICES` - Services

invoicedItemsRequired

object[]

Not specified

Nested fields

Field	Type / accepted values	Description
`name`Required	`string`	Not specified
`quantity`Required	`number (double)`	Not specified
`rate`Required	`number (double)`	Not specified
`vatRate`Required	`integer`	Not specified
`itemPriceNet`Required	`integer`	Not specified
`itemPriceGross`Required	`integer`	Not specified
`itemVatAmount`Required	`integer`	Not specified
`discountPercent`	`number (double)`	Not specified
`itemDiscountAmount`	`integer`	Not specified
`description`	`string`	Not specified
`unit`	`"items" \| "hours" \| "days" \| "kilograms" \| "liters" \| "meters" \| "square_meters" \| "" \| null`	Not specified
`productId`	`string \| null`	Not specified
`companyCategory`	`string \| null`	Not specified
`gtuCode`	`string`	Not specified
`isSplitPayment`	`boolean`	Not specified

currencyRequired string Not specified

currencyExchangedRequired string Not specified

language "de" | "en" | "pl" | "it" | "es" * `de` - German * `en` - English * `pl` - Polish * `it` - Italian * `es` - Spanish

isVatIncluded boolean Not specified

discountPercents integer Not specified

paymentTerms string Not specified

notes string Not specified

instructions string Not specified

message string Not specified

taxExemptReason string | null Not specified

companyEmail string (email) | null Not specified

createQr boolean Not specified

settingsOnOverdue object | null Not specified

mailingData object | null Not specified

onlinePaymentEnabled boolean Not specified

documentDesign

object

Not specified

Nested fields

Field	Type / accepted values	Description
`template`Required	`"heritage" \| "regent" \| "meridian" \| "horizon" \| "atelier" \| "epoque" \| "sovereign"`	* `heritage` - heritage * `regent` - regent * `meridian` - meridian * `horizon` - horizon * `atelier` - atelier * `epoque` - epoque * `sovereign` - sovereign
`version`	`1`	* `1` - 1
`logoSize`	`integer`	Not specified
`textSize`	`"small" \| "medium" \| "large"`	* `small` - small * `medium` - medium * `large` - large
`spacing`	`"compact" \| "standard" \| "spacious"`	* `compact` - compact * `standard` - standard * `spacious` - spacious
`tableBorders`	`"none" \| "dividers" \| "grid"`	* `none` - none * `dividers` - dividers * `grid` - grid

font string Not specified

colorSchema string Not specified

sourceContract string (uuid) | null Not specified

clientName string Not specified

upcomingRequiredRead only object[] Not specified

invoicesRequiredRead only object[] Not specified

400 Response fields

application/json

Field	Type / accepted values	Description
`field`Required	`string`	Not specified
`code`	`integer`	Not specified
`message`Required	`string`	Not specified
`type_`	`string`	Not specified

401 Response fields

application/json

Field	Type / accepted values	Description
`detail`RequiredRead only	`string`	Not specified

403 Response fields

application/json

Field	Type / accepted values	Description
`detail`RequiredRead only	`string`	Not specified

404 Response fields

application/json

Field	Type / accepted values	Description
`detail`Required	`string`	Not specified
`code`Required	`integer`	Not specified
`type_`Required	`string`	Not specified
`field`Required	`string`	Not specified

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.