{
"openapi": "3.1.0",
"info": {
"title": "eCourier",
"version": "1.0.0",
"description": "With Ecourier, you can send and receive electronics invoices through various networks.\nCheck our website for more information.\n\nThe API supports transmitting documents as native XML or JSON."
},
"servers": [
{
"url": "https://api.ecourier.io/v1"
}
],
"tags": [
{
"name": "Companies"
},
{
"name": "Documents"
},
{
"name": "Participants"
}
],
"security": [
{
"http": []
}
],
"paths": {
"/companies": {
"get": {
"operationId": "companies.index",
"description": "Get a paginated list of companies for the authenticated team and mode.\nResults are ordered by company name (A\u2013Z).",
"summary": "List companies",
"tags": [
"Companies"
],
"parameters": [
{
"name": "filter[channel][]",
"in": "query",
"description": "Match companies with a participant on any of the given channels.",
"schema": {
"type": "string",
"enum": [
"Peppol",
"NemHandel"
],
"example": "Peppol",
"x-enumDescriptions": {
"Peppol": "PEPPOL is the global standard for electronic invoicing.",
"NemHandel": "NemHandel is only used in Denmark."
}
}
},
{
"name": "filter[company_no][]",
"in": "query",
"description": "Exact match on company number.",
"schema": {
"type": "string"
}
},
{
"name": "filter[country][]",
"in": "query",
"description": "Match any of the given countries.",
"schema": {
"type": "string",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"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",
"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",
"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",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"example": "AD",
"x-enumDescriptions": {
"AD": "Andorra",
"AE": "United Arab Emirates",
"AF": "Afghanistan",
"AG": "Antigua & Barbuda",
"AI": "Anguilla",
"AL": "Albania",
"AM": "Armenia",
"AO": "Angola",
"AQ": "Antarctica",
"AR": "Argentina",
"AS": "American Samoa",
"AT": "Austria",
"AU": "Australia",
"AW": "Aruba",
"AX": "\u00c5land Islands",
"AZ": "Azerbaijan",
"BA": "Bosnia & Herzegovina",
"BB": "Barbados",
"BD": "Bangladesh",
"BE": "Belgium",
"BF": "Burkina Faso",
"BG": "Bulgaria",
"BH": "Bahrain",
"BI": "Burundi",
"BJ": "Benin",
"BL": "St. Barth\u00e9lemy",
"BM": "Bermuda",
"BN": "Brunei",
"BO": "Bolivia",
"BQ": "Caribbean Netherlands",
"BR": "Brazil",
"BS": "Bahamas",
"BT": "Bhutan",
"BV": "Bouvet Island",
"BW": "Botswana",
"BY": "Belarus",
"BZ": "Belize",
"CA": "Canada",
"CC": "Cocos (Keeling) Islands",
"CD": "Congo - Kinshasa",
"CF": "Central African Republic",
"CG": "Congo - Brazzaville",
"CH": "Switzerland",
"CI": "C\u00f4te d\u2019Ivoire",
"CK": "Cook Islands",
"CL": "Chile",
"CM": "Cameroon",
"CN": "China",
"CO": "Colombia",
"CR": "Costa Rica",
"CU": "Cuba",
"CV": "Cape Verde",
"CW": "Cura\u00e7ao",
"CX": "Christmas Island",
"CY": "Cyprus",
"CZ": "Czechia",
"DE": "Germany",
"DJ": "Djibouti",
"DK": "Denmark",
"DM": "Dominica",
"DO": "Dominican Republic",
"DZ": "Algeria",
"EC": "Ecuador",
"EE": "Estonia",
"EG": "Egypt",
"EH": "Western Sahara",
"ER": "Eritrea",
"ES": "Spain",
"ET": "Ethiopia",
"FI": "Finland",
"FJ": "Fiji",
"FK": "Falkland Islands",
"FM": "Micronesia",
"FO": "Faroe Islands",
"FR": "France",
"GA": "Gabon",
"GB": "United Kingdom",
"GD": "Grenada",
"GE": "Georgia",
"GF": "French Guiana",
"GG": "Guernsey",
"GH": "Ghana",
"GI": "Gibraltar",
"GL": "Greenland",
"GM": "Gambia",
"GN": "Guinea",
"GP": "Guadeloupe",
"GQ": "Equatorial Guinea",
"GR": "Greece",
"GS": "South Georgia & South Sandwich Islands",
"GT": "Guatemala",
"GU": "Guam",
"GW": "Guinea-Bissau",
"GY": "Guyana",
"HK": "Hong Kong SAR China",
"HM": "Heard & McDonald Islands",
"HN": "Honduras",
"HR": "Croatia",
"HT": "Haiti",
"HU": "Hungary",
"ID": "Indonesia",
"IE": "Ireland",
"IL": "Israel",
"IM": "Isle of Man",
"IN": "India",
"IO": "British Indian Ocean Territory",
"IQ": "Iraq",
"IR": "Iran",
"IS": "Iceland",
"IT": "Italy",
"JE": "Jersey",
"JM": "Jamaica",
"JO": "Jordan",
"JP": "Japan",
"KE": "Kenya",
"KG": "Kyrgyzstan",
"KH": "Cambodia",
"KI": "Kiribati",
"KM": "Comoros",
"KN": "St. Kitts & Nevis",
"KP": "North Korea",
"KR": "South Korea",
"KW": "Kuwait",
"KY": "Cayman Islands",
"KZ": "Kazakhstan",
"LA": "Laos",
"LB": "Lebanon",
"LC": "St. Lucia",
"LI": "Liechtenstein",
"LK": "Sri Lanka",
"LR": "Liberia",
"LS": "Lesotho",
"LT": "Lithuania",
"LU": "Luxembourg",
"LV": "Latvia",
"LY": "Libya",
"MA": "Morocco",
"MC": "Monaco",
"MD": "Moldova",
"ME": "Montenegro",
"MF": "St. Martin",
"MG": "Madagascar",
"MH": "Marshall Islands",
"MK": "North Macedonia",
"ML": "Mali",
"MM": "Myanmar (Burma)",
"MN": "Mongolia",
"MO": "Macao SAR China",
"MP": "Northern Mariana Islands",
"MQ": "Martinique",
"MR": "Mauritania",
"MS": "Montserrat",
"MT": "Malta",
"MU": "Mauritius",
"MV": "Maldives",
"MW": "Malawi",
"MX": "Mexico",
"MY": "Malaysia",
"MZ": "Mozambique",
"NA": "Namibia",
"NC": "New Caledonia",
"NE": "Niger",
"NF": "Norfolk Island",
"NG": "Nigeria",
"NI": "Nicaragua",
"NL": "Netherlands",
"NO": "Norway",
"NP": "Nepal",
"NR": "Nauru",
"NU": "Niue",
"NZ": "New Zealand",
"OM": "Oman",
"PA": "Panama",
"PE": "Peru",
"PF": "French Polynesia",
"PG": "Papua New Guinea",
"PH": "Philippines",
"PK": "Pakistan",
"PL": "Poland",
"PM": "St. Pierre & Miquelon",
"PN": "Pitcairn Islands",
"PR": "Puerto Rico",
"PS": "Palestinian Territories",
"PT": "Portugal",
"PW": "Palau",
"PY": "Paraguay",
"QA": "Qatar",
"RE": "R\u00e9union",
"RO": "Romania",
"RS": "Serbia",
"RU": "Russia",
"RW": "Rwanda",
"SA": "Saudi Arabia",
"SB": "Solomon Islands",
"SC": "Seychelles",
"SD": "Sudan",
"SE": "Sweden",
"SG": "Singapore",
"SH": "St. Helena",
"SI": "Slovenia",
"SJ": "Svalbard & Jan Mayen",
"SK": "Slovakia",
"SL": "Sierra Leone",
"SM": "San Marino",
"SN": "Senegal",
"SO": "Somalia",
"SR": "Suriname",
"SS": "South Sudan",
"ST": "S\u00e3o Tom\u00e9 & Pr\u00edncipe",
"SV": "El Salvador",
"SX": "Sint Maarten",
"SY": "Syria",
"SZ": "Eswatini",
"TC": "Turks & Caicos Islands",
"TD": "Chad",
"TF": "French Southern Territories",
"TG": "Togo",
"TH": "Thailand",
"TJ": "Tajikistan",
"TK": "Tokelau",
"TL": "Timor-Leste",
"TM": "Turkmenistan",
"TN": "Tunisia",
"TO": "Tonga",
"TR": "Turkey",
"TT": "Trinidad & Tobago",
"TV": "Tuvalu",
"TW": "Taiwan",
"TZ": "Tanzania",
"UA": "Ukraine",
"UG": "Uganda",
"UM": "U.S. Outlying Islands",
"US": "United States",
"UY": "Uruguay",
"UZ": "Uzbekistan",
"VA": "Vatican City",
"VC": "St. Vincent & Grenadines",
"VE": "Venezuela",
"VG": "British Virgin Islands",
"VI": "U.S. Virgin Islands",
"VN": "Vietnam",
"VU": "Vanuatu",
"WF": "Wallis & Futuna",
"WS": "Samoa",
"YE": "Yemen",
"YT": "Mayotte",
"ZA": "South Africa",
"ZM": "Zambia",
"ZW": "Zimbabwe"
}
}
},
{
"name": "filter[name][]",
"in": "query",
"description": "Partial match on company name.",
"schema": {
"type": "string"
}
},
{
"name": "filter[signed]",
"in": "query",
"description": "Whether the authorisation is signed (`true` or `false`).",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "The paginated collection of `CompanyListItemResponse`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "The list of items",
"items": {
"$ref": "#/components/schemas/CompanyListItemResponse"
}
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"first_page_url": {
"type": "string"
},
"from": {
"type": [
"integer",
"null"
]
},
"last_page": {
"type": "integer"
},
"last_page_url": {
"type": "string"
},
"next_page_url": {
"type": [
"string",
"null"
]
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page."
},
"prev_page_url": {
"type": [
"string",
"null"
]
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice."
},
"total": {
"type": "integer",
"description": "Total number of items being paginated."
}
},
"required": [
"current_page",
"first_page_url",
"from",
"last_page",
"last_page_url",
"next_page_url",
"path",
"per_page",
"prev_page_url",
"to",
"total"
]
}
},
"required": [
"data",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"post": {
"operationId": "companies.create",
"description": "Create a new company and its authorisation agreement.",
"summary": "Create company",
"tags": [
"Companies"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCompanyPayload"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyDetailsResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/companies/{company}": {
"get": {
"operationId": "companies.details",
"description": "Get all details about a given company.",
"summary": "Company details",
"tags": [
"Companies"
],
"parameters": [
{
"name": "company",
"in": "path",
"required": true,
"description": "The company ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyDetailsResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"patch": {
"operationId": "companies.update",
"description": "Update the name of an existing company.",
"summary": "Update company",
"tags": [
"Companies"
],
"parameters": [
{
"name": "company",
"in": "path",
"required": true,
"description": "The company ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCompanyPayload"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyDetailsResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"delete": {
"operationId": "companies.delete",
"description": "Soft-delete a company and its child companies. Fails when any company in the tree has participants.",
"summary": "Delete company",
"tags": [
"Companies"
],
"parameters": [
{
"name": "company",
"in": "path",
"required": true,
"description": "The company ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"422": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/documents": {
"get": {
"operationId": "documents.index",
"description": "Get a paginated list of documents for the authenticated team and mode.\nThis includes both sent and received documents.\nResults are ordered by creation time (newest first).",
"summary": "List documents",
"tags": [
"Documents"
],
"parameters": [
{
"name": "filter[channel][]",
"in": "query",
"description": "Match any of the given channels.",
"schema": {
"type": "string",
"enum": [
"Peppol",
"NemHandel"
],
"example": "Peppol",
"x-enumDescriptions": {
"Peppol": "PEPPOL is the global standard for electronic invoicing.",
"NemHandel": "NemHandel is only used in Denmark."
}
}
},
{
"name": "filter[company_id][]",
"in": "query",
"description": "Exact match on company ID.",
"schema": {
"type": "string"
},
"example": "0101knwp96k3ggvkra831yrd74zh"
},
{
"name": "filter[direction][]",
"in": "query",
"description": "Match any of the given directions.",
"schema": {
"type": "string",
"enum": [
"Send",
"Receive"
],
"example": "Send",
"x-enumDescriptions": {
"Send": "You are sending this document",
"Receive": "You are receiving this document"
}
}
},
{
"name": "filter[status][]",
"in": "query",
"description": "Match any of the given document statuses.",
"schema": {
"type": "string",
"enum": [
"Pending",
"Ready",
"Delivered",
"Failed"
],
"example": "Pending",
"x-enumDescriptions": {
"Pending": "Document is pending to be delivered.",
"Ready": "Document has been received into eCourier, but not yet marked as delivered by the recipient.",
"Delivered": "Document has been delivered to the recipient.",
"Failed": "Delivery has failed."
}
}
}
],
"responses": {
"200": {
"description": "The paginated collection of `DocumentListItemResponse`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "The list of items",
"items": {
"$ref": "#/components/schemas/DocumentListItemResponse"
}
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"first_page_url": {
"type": "string"
},
"from": {
"type": [
"integer",
"null"
]
},
"last_page": {
"type": "integer"
},
"last_page_url": {
"type": "string"
},
"next_page_url": {
"type": [
"string",
"null"
]
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page."
},
"prev_page_url": {
"type": [
"string",
"null"
]
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice."
},
"total": {
"type": "integer",
"description": "Total number of items being paginated."
}
},
"required": [
"current_page",
"first_page_url",
"from",
"last_page",
"last_page_url",
"next_page_url",
"path",
"per_page",
"prev_page_url",
"to",
"total"
]
}
},
"required": [
"data",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/documents/{document}": {
"get": {
"operationId": "documents.details",
"description": "Get all details about a given document.",
"summary": "Document details",
"tags": [
"Documents"
],
"parameters": [
{
"name": "document",
"in": "path",
"required": true,
"description": "The document ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentDetailsResponse"
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/documents/xml": {
"post": {
"operationId": "documents.send-xml",
"description": "Send your document as raw XML and maintain full control over the XML.\n\nThe document is accepted immediately; schema and rule validation run asynchronously in a queue.\nUse document details or webhooks to see validation or delivery outcomes.\nYou must use the appropriate XML schema for the given channel.\n[More information](https://docs.ecourier.io/documentation/sending#sending-as-xml).",
"summary": "Send as XML",
"tags": [
"Documents"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "mime-type"
},
"example": "application/xml"
},
{
"name": "Ecourier-Channel",
"in": "header",
"required": true,
"description": "The channel to send the document to.",
"schema": {
"type": "string",
"enum": [
"Peppol",
"NemHandel"
],
"example": "Peppol",
"x-enumDescriptions": {
"Peppol": "PEPPOL is the global standard for electronic invoicing.",
"NemHandel": "NemHandel is only used in Denmark."
}
},
"example": "Peppol"
},
{
"name": "Ecourier-Sender-Scheme",
"in": "header",
"required": true,
"description": "The identifier scheme for the sender.",
"schema": {
"type": "string",
"enum": [
"DUNS",
"EU:NAL",
"EU:REID",
"EU:VAT",
"GLN",
"GS1",
"IBAN",
"LEI",
"SPIS",
"UBLBE",
"AD:VAT",
"AE:TIN",
"AL:VAT",
"AT:CID",
"AT:GOV",
"AT:KUR",
"AT:VAT",
"AU:ABN",
"BA:VAT",
"BE:EN",
"BE:VAT",
"BG:VAT",
"CH:UIDB",
"CH:VAT",
"CY:VAT",
"CZ:VAT",
"DE:GEBA",
"DE:LWID",
"DE:VAT",
"DK:CVR",
"DK:P",
"DK:SE",
"EE:CC",
"EE:VAT",
"ES:VAT",
"FI:OVT2",
"FR:CTC",
"FR:SIRENE",
"FR:SIRET",
"FR:VAT",
"GB:VAT",
"GR:VAT",
"HR:VAT",
"HU:VAT",
"IE:VAT",
"IS:KT",
"IS:KTNR",
"IT:CFI",
"IT:COD",
"IT:CUUO",
"IT:FTI",
"IT:SECETI",
"IT:SIA",
"IT:IVA",
"JP:IIN",
"JP:SST",
"LI:VAT",
"LT:LEC",
"LT:VAT",
"LU:MAT",
"LU:VAT",
"LV:URN",
"LV:VAT",
"MC:VAT",
"ME:VAT",
"MK:VAT",
"MT:VAT",
"MY:EIF",
"NG:TID",
"NL:KVK",
"NL:OINO",
"NL:VAT",
"NO:ORG",
"NO:VAT",
"OM:VAT",
"PL:VAT",
"PT:VAT",
"RO:VAT",
"RS:VAT",
"SE:ORGNR",
"SG:UEN",
"SI:VAT",
"SK:DIC",
"SK:VAT",
"SM:VAT",
"TR:VAT",
"US:EIN",
"VA:VAT"
],
"example": "DUNS",
"x-enumDescriptions": {
"DUNS": "Data Universal Numbering System (D-U-N-S Number) (ICD 0060)",
"EU:NAL": "Directorates of the European Commission (ICD 0130)",
"EU:REID": "Business Registers Network (ICD 9913)",
"EU:VAT": "National ministries of Economy VAT number (ICD 9912)",
"GLN": "Global Location Number (ICD 0088)",
"GS1": "GS1 identification keys (ICD 0209)",
"IBAN": "International Bank Account Number (ICD 9918)",
"LEI": "Legal Entity Identifier (ICD 0199)",
"SPIS": "OpenPeppol Service Provider Identification Scheme (ICD 0242)",
"UBLBE": "UBL.BE Party Identifier (ICD 0193)",
"AD:VAT": "Andorra VAT number (ICD 9922)",
"AE:TIN": "UAE Tax Identification Number (ICD 0235)",
"AL:VAT": "Albania VAT number (ICD 9923)",
"AT:CID": "Firmenidentifikationsnummer der Statistik Austria (ICD 9916)",
"AT:GOV": "Austrian government number (ICD 9915)",
"AT:KUR": "Kennziffer des Unternehmensregisters (ICD 9919)",
"AT:VAT": "Austrian VAT number (ICD 9914)",
"AU:ABN": "Australian Business Number (ICD 0151)",
"BA:VAT": "Bosnia and Herzegovina VAT number (ICD 9924)",
"BE:EN": "Numero d'entreprise / ondernemingsnummer / Unternehmensnummer (ICD 0208)",
"BE:VAT": "Belgian VAT number (ICD 9925)",
"BG:VAT": "Bulgaria VAT number (ICD 9926)",
"CH:UIDB": "Swiss Unique Business Identification Number (ICD 0183)",
"CH:VAT": "Switzerland VAT number (ICD 9927)",
"CY:VAT": "Cyprus VAT number (ICD 9928)",
"CZ:VAT": "Czech Republic VAT number (ICD 9929)",
"DE:GEBA": "German Electronic Business Address (ICD 0246)",
"DE:LWID": "Peppol-Leitweg-ID (ICD 0204)",
"DE:VAT": "German VAT number (ICD 9930)",
"DK:CVR": "The Danish Business Authority - CVR-number (ICD 0184)",
"DK:P": "The Danish Business Authority - P-number (ICD 0096)",
"DK:SE": "The Danish Business Authority - SE-number (ICD 0198)",
"EE:CC": "Company code (ICD 0191)",
"EE:VAT": "Estonia VAT number (ICD 9931)",
"ES:VAT": "Spain VAT number (ICD 9920)",
"FI:OVT2": "OVTcode (ICD 0216)",
"FR:CTC": "FRCTC Electronic Address (ICD 0225)",
"FR:SIRENE": "System Information et Repertoire des Entreprise et des Etablissements: SIRENE (ICD 0002)",
"FR:SIRET": "SIRET-CODE (ICD 0009)",
"FR:VAT": "French VAT number (ICD 9957)",
"GB:VAT": "United Kingdom VAT number (ICD 9932)",
"GR:VAT": "Greece VAT number (ICD 9933)",
"HR:VAT": "Croatia VAT number (ICD 9934)",
"HU:VAT": "Hungary VAT number (ICD 9910)",
"IE:VAT": "Ireland VAT number (ICD 9935)",
"IS:KT": "Icelandic National Registry (ICD 9917)",
"IS:KTNR": "Icelandic identifier (ICD 0196)",
"IT:CFI": "CODICE FISCALE (ICD 0210)",
"IT:COD": "CODDEST (ICD 0205)",
"IT:CUUO": "Codice Univoco Unita Organizzativa iPA (ICD 0201)",
"IT:FTI": "FTI - Ediforum Italia (ICD 0097)",
"IT:SECETI": "SECETI Object Identifiers (ICD 0142)",
"IT:SIA": "SIA Object Identifiers (ICD 0135)",
"IT:IVA": "PARTITA IVA (ICD 0211)",
"JP:IIN": "The registered number of the qualified invoice issuer (ICD 0221)",
"JP:SST": "Corporate Number of The Social Security and Tax Number System (ICD 0188)",
"LI:VAT": "Liechtenstein VAT number (ICD 9936)",
"LT:LEC": "Legal entity code (ICD 0200)",
"LT:VAT": "Lithuania VAT number (ICD 9937)",
"LU:MAT": "Register of legal persons (ICD 0240)",
"LU:VAT": "Luxemburg VAT number (ICD 9938)",
"LV:URN": "Unified registration number (ICD 0218)",
"LV:VAT": "Latvia VAT number (ICD 9939)",
"MC:VAT": "Monaco VAT number (ICD 9940)",
"ME:VAT": "Montenegro VAT number (ICD 9941)",
"MK:VAT": "North Macedonia VAT number (ICD 9942)",
"MT:VAT": "Malta VAT number (ICD 9943)",
"MY:EIF": "National e-Invoicing Framework (ICD 0230)",
"NG:TID": "Tax Identification (ICD 0244)",
"NL:KVK": "Vereniging van Kamers van Koophandel en Fabrieken in Nederland Scheme (ICD 0106)",
"NL:OINO": "Organisatie-identificatienummer (ICD 0190)",
"NL:VAT": "Netherlands VAT number (ICD 9944)",
"NO:ORG": "Organisasjonsnummer (ICD 0192)",
"NO:VAT": "Norwegian VAT number (ICD 9909)",
"OM:VAT": "Oman Value Added Tax Identification Number (VATIN) (ICD 0248)",
"PL:VAT": "Poland VAT number (ICD 9945)",
"PT:VAT": "Portugal VAT number (ICD 9946)",
"RO:VAT": "Romania VAT number (ICD 9947)",
"RS:VAT": "Serbia VAT number (ICD 9948)",
"SE:ORGNR": "Organisationsnummer (ICD 0007)",
"SG:UEN": "Singapore Nationwide E-Invoice Framework (ICD 0195)",
"SI:VAT": "Slovenia VAT number (ICD 9949)",
"SK:DIC": "Tax identification number (ICD 0245)",
"SK:VAT": "Slovakia VAT number (ICD 9950)",
"SM:VAT": "San Marino VAT number (ICD 9951)",
"TR:VAT": "Turkey VAT number (ICD 9952)",
"US:EIN": "US Employer ID Number (ICD 9959)",
"VA:VAT": "Holy See (Vatican City State) VAT number (ICD 9953)"
}
},
"example": "GLN"
},
{
"name": "Ecourier-Sender-Id",
"in": "header",
"required": true,
"description": "The sender identifier within the given scheme.",
"schema": {
"type": "string"
},
"example": "1234567890123"
},
{
"name": "Ecourier-Recipient-Scheme",
"in": "header",
"required": true,
"description": "The identifier scheme for the recipient.",
"schema": {
"type": "string",
"enum": [
"DUNS",
"EU:NAL",
"EU:REID",
"EU:VAT",
"GLN",
"GS1",
"IBAN",
"LEI",
"SPIS",
"UBLBE",
"AD:VAT",
"AE:TIN",
"AL:VAT",
"AT:CID",
"AT:GOV",
"AT:KUR",
"AT:VAT",
"AU:ABN",
"BA:VAT",
"BE:EN",
"BE:VAT",
"BG:VAT",
"CH:UIDB",
"CH:VAT",
"CY:VAT",
"CZ:VAT",
"DE:GEBA",
"DE:LWID",
"DE:VAT",
"DK:CVR",
"DK:P",
"DK:SE",
"EE:CC",
"EE:VAT",
"ES:VAT",
"FI:OVT2",
"FR:CTC",
"FR:SIRENE",
"FR:SIRET",
"FR:VAT",
"GB:VAT",
"GR:VAT",
"HR:VAT",
"HU:VAT",
"IE:VAT",
"IS:KT",
"IS:KTNR",
"IT:CFI",
"IT:COD",
"IT:CUUO",
"IT:FTI",
"IT:SECETI",
"IT:SIA",
"IT:IVA",
"JP:IIN",
"JP:SST",
"LI:VAT",
"LT:LEC",
"LT:VAT",
"LU:MAT",
"LU:VAT",
"LV:URN",
"LV:VAT",
"MC:VAT",
"ME:VAT",
"MK:VAT",
"MT:VAT",
"MY:EIF",
"NG:TID",
"NL:KVK",
"NL:OINO",
"NL:VAT",
"NO:ORG",
"NO:VAT",
"OM:VAT",
"PL:VAT",
"PT:VAT",
"RO:VAT",
"RS:VAT",
"SE:ORGNR",
"SG:UEN",
"SI:VAT",
"SK:DIC",
"SK:VAT",
"SM:VAT",
"TR:VAT",
"US:EIN",
"VA:VAT"
],
"example": "DUNS",
"x-enumDescriptions": {
"DUNS": "Data Universal Numbering System (D-U-N-S Number) (ICD 0060)",
"EU:NAL": "Directorates of the European Commission (ICD 0130)",
"EU:REID": "Business Registers Network (ICD 9913)",
"EU:VAT": "National ministries of Economy VAT number (ICD 9912)",
"GLN": "Global Location Number (ICD 0088)",
"GS1": "GS1 identification keys (ICD 0209)",
"IBAN": "International Bank Account Number (ICD 9918)",
"LEI": "Legal Entity Identifier (ICD 0199)",
"SPIS": "OpenPeppol Service Provider Identification Scheme (ICD 0242)",
"UBLBE": "UBL.BE Party Identifier (ICD 0193)",
"AD:VAT": "Andorra VAT number (ICD 9922)",
"AE:TIN": "UAE Tax Identification Number (ICD 0235)",
"AL:VAT": "Albania VAT number (ICD 9923)",
"AT:CID": "Firmenidentifikationsnummer der Statistik Austria (ICD 9916)",
"AT:GOV": "Austrian government number (ICD 9915)",
"AT:KUR": "Kennziffer des Unternehmensregisters (ICD 9919)",
"AT:VAT": "Austrian VAT number (ICD 9914)",
"AU:ABN": "Australian Business Number (ICD 0151)",
"BA:VAT": "Bosnia and Herzegovina VAT number (ICD 9924)",
"BE:EN": "Numero d'entreprise / ondernemingsnummer / Unternehmensnummer (ICD 0208)",
"BE:VAT": "Belgian VAT number (ICD 9925)",
"BG:VAT": "Bulgaria VAT number (ICD 9926)",
"CH:UIDB": "Swiss Unique Business Identification Number (ICD 0183)",
"CH:VAT": "Switzerland VAT number (ICD 9927)",
"CY:VAT": "Cyprus VAT number (ICD 9928)",
"CZ:VAT": "Czech Republic VAT number (ICD 9929)",
"DE:GEBA": "German Electronic Business Address (ICD 0246)",
"DE:LWID": "Peppol-Leitweg-ID (ICD 0204)",
"DE:VAT": "German VAT number (ICD 9930)",
"DK:CVR": "The Danish Business Authority - CVR-number (ICD 0184)",
"DK:P": "The Danish Business Authority - P-number (ICD 0096)",
"DK:SE": "The Danish Business Authority - SE-number (ICD 0198)",
"EE:CC": "Company code (ICD 0191)",
"EE:VAT": "Estonia VAT number (ICD 9931)",
"ES:VAT": "Spain VAT number (ICD 9920)",
"FI:OVT2": "OVTcode (ICD 0216)",
"FR:CTC": "FRCTC Electronic Address (ICD 0225)",
"FR:SIRENE": "System Information et Repertoire des Entreprise et des Etablissements: SIRENE (ICD 0002)",
"FR:SIRET": "SIRET-CODE (ICD 0009)",
"FR:VAT": "French VAT number (ICD 9957)",
"GB:VAT": "United Kingdom VAT number (ICD 9932)",
"GR:VAT": "Greece VAT number (ICD 9933)",
"HR:VAT": "Croatia VAT number (ICD 9934)",
"HU:VAT": "Hungary VAT number (ICD 9910)",
"IE:VAT": "Ireland VAT number (ICD 9935)",
"IS:KT": "Icelandic National Registry (ICD 9917)",
"IS:KTNR": "Icelandic identifier (ICD 0196)",
"IT:CFI": "CODICE FISCALE (ICD 0210)",
"IT:COD": "CODDEST (ICD 0205)",
"IT:CUUO": "Codice Univoco Unita Organizzativa iPA (ICD 0201)",
"IT:FTI": "FTI - Ediforum Italia (ICD 0097)",
"IT:SECETI": "SECETI Object Identifiers (ICD 0142)",
"IT:SIA": "SIA Object Identifiers (ICD 0135)",
"IT:IVA": "PARTITA IVA (ICD 0211)",
"JP:IIN": "The registered number of the qualified invoice issuer (ICD 0221)",
"JP:SST": "Corporate Number of The Social Security and Tax Number System (ICD 0188)",
"LI:VAT": "Liechtenstein VAT number (ICD 9936)",
"LT:LEC": "Legal entity code (ICD 0200)",
"LT:VAT": "Lithuania VAT number (ICD 9937)",
"LU:MAT": "Register of legal persons (ICD 0240)",
"LU:VAT": "Luxemburg VAT number (ICD 9938)",
"LV:URN": "Unified registration number (ICD 0218)",
"LV:VAT": "Latvia VAT number (ICD 9939)",
"MC:VAT": "Monaco VAT number (ICD 9940)",
"ME:VAT": "Montenegro VAT number (ICD 9941)",
"MK:VAT": "North Macedonia VAT number (ICD 9942)",
"MT:VAT": "Malta VAT number (ICD 9943)",
"MY:EIF": "National e-Invoicing Framework (ICD 0230)",
"NG:TID": "Tax Identification (ICD 0244)",
"NL:KVK": "Vereniging van Kamers van Koophandel en Fabrieken in Nederland Scheme (ICD 0106)",
"NL:OINO": "Organisatie-identificatienummer (ICD 0190)",
"NL:VAT": "Netherlands VAT number (ICD 9944)",
"NO:ORG": "Organisasjonsnummer (ICD 0192)",
"NO:VAT": "Norwegian VAT number (ICD 9909)",
"OM:VAT": "Oman Value Added Tax Identification Number (VATIN) (ICD 0248)",
"PL:VAT": "Poland VAT number (ICD 9945)",
"PT:VAT": "Portugal VAT number (ICD 9946)",
"RO:VAT": "Romania VAT number (ICD 9947)",
"RS:VAT": "Serbia VAT number (ICD 9948)",
"SE:ORGNR": "Organisationsnummer (ICD 0007)",
"SG:UEN": "Singapore Nationwide E-Invoice Framework (ICD 0195)",
"SI:VAT": "Slovenia VAT number (ICD 9949)",
"SK:DIC": "Tax identification number (ICD 0245)",
"SK:VAT": "Slovakia VAT number (ICD 9950)",
"SM:VAT": "San Marino VAT number (ICD 9951)",
"TR:VAT": "Turkey VAT number (ICD 9952)",
"US:EIN": "US Employer ID Number (ICD 9959)",
"VA:VAT": "Holy See (Vatican City State) VAT number (ICD 9953)"
}
},
"example": "AT:GOV"
},
{
"name": "Ecourier-Recipient-Id",
"in": "header",
"required": true,
"description": "The recipient identifier within the given scheme.",
"schema": {
"type": "string"
},
"example": "test"
}
],
"requestBody": {
"content": {
"application/xml": {
"schema": {
"type": "string",
"example": "\n"
}
}
}
},
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Unable to parse XML payload. Please check the XML syntax."
}
},
"required": [
"message"
]
},
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
]
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendDocumentResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/documents/json": {
"post": {
"operationId": "documents.send-json",
"description": "Send your invoices and credit notes as simplified JSON.\n\neCourier converts it to the appropriate XML schema for the selected channel, so you only need to maintain one schema on your end.",
"summary": "Send as JSON",
"tags": [
"Documents"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendJsonPayload"
}
}
}
},
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendDocumentResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
}
},
"/documents/{document}/xml": {
"get": {
"operationId": "documents.get-xml",
"summary": "Get content as XML",
"tags": [
"Documents"
],
"parameters": [
{
"name": "document",
"in": "path",
"required": true,
"description": "The document ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"410": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Document has expired"
}
},
"required": [
"message"
]
}
}
}
},
"200": {
"description": "",
"content": {
"application/xml": {
"schema": {
"type": "string",
"example": ""
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/documents/{document}/html": {
"get": {
"operationId": "documents.get-html",
"description": ":::caution Experimental\nThis endpoint is experimental. HTML rendering is still work in progress and may change.\n:::\n\nErrors:\n- `410 Gone` if the XML has been deleted (logging retention expired)\n- `422 Unprocessable Entity` if the document cannot be rendered",
"summary": "Get rendered document as HTML (Experimental)",
"tags": [
"Documents"
],
"parameters": [
{
"name": "document",
"in": "path",
"required": true,
"description": "The document ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"422": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Document could not be rendered"
}
},
"required": [
"message"
]
}
}
}
},
"410": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Document has expired"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"200": {
"description": "",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": ""
}
}
}
}
}
}
},
"/documents/{document}/pdf": {
"get": {
"operationId": "documents.get-pdf",
"description": ":::caution Experimental\nThis endpoint is experimental. PDF rendering is still work in progress and may change.\n:::\n\nErrors:\n- `410 Gone` if the XML has been deleted (logging retention expired)\n- `422 Unprocessable Entity` if the document cannot be rendered",
"summary": "Get rendered document as PDF (Experimental)",
"tags": [
"Documents"
],
"parameters": [
{
"name": "document",
"in": "path",
"required": true,
"description": "The document ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"422": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Document could not be rendered"
}
},
"required": [
"message"
]
}
}
}
},
"410": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Document has expired"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"200": {
"description": "",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary",
"example": "%PDF-1.4"
}
}
}
}
}
}
},
"/lookup/{channel}/{participantScheme}/{participantId}": {
"get": {
"operationId": "lookup",
"description": "Lookup a participant by channel, scheme, and ID.",
"summary": "Lookup participant",
"tags": [
"Participants"
],
"parameters": [
{
"name": "channel",
"in": "path",
"required": true,
"description": "The channel ID",
"schema": {
"type": "string",
"enum": [
"Peppol",
"NemHandel"
],
"example": "Peppol",
"x-enumDescriptions": {
"Peppol": "PEPPOL is the global standard for electronic invoicing.",
"NemHandel": "NemHandel is only used in Denmark."
}
}
},
{
"name": "participantScheme",
"in": "path",
"required": true,
"description": "The participant scheme ID",
"schema": {
"type": "string",
"enum": [
"DUNS",
"EU:NAL",
"EU:REID",
"EU:VAT",
"GLN",
"GS1",
"IBAN",
"LEI",
"SPIS",
"UBLBE",
"AD:VAT",
"AE:TIN",
"AL:VAT",
"AT:CID",
"AT:GOV",
"AT:KUR",
"AT:VAT",
"AU:ABN",
"BA:VAT",
"BE:EN",
"BE:VAT",
"BG:VAT",
"CH:UIDB",
"CH:VAT",
"CY:VAT",
"CZ:VAT",
"DE:GEBA",
"DE:LWID",
"DE:VAT",
"DK:CVR",
"DK:P",
"DK:SE",
"EE:CC",
"EE:VAT",
"ES:VAT",
"FI:OVT2",
"FR:CTC",
"FR:SIRENE",
"FR:SIRET",
"FR:VAT",
"GB:VAT",
"GR:VAT",
"HR:VAT",
"HU:VAT",
"IE:VAT",
"IS:KT",
"IS:KTNR",
"IT:CFI",
"IT:COD",
"IT:CUUO",
"IT:FTI",
"IT:SECETI",
"IT:SIA",
"IT:IVA",
"JP:IIN",
"JP:SST",
"LI:VAT",
"LT:LEC",
"LT:VAT",
"LU:MAT",
"LU:VAT",
"LV:URN",
"LV:VAT",
"MC:VAT",
"ME:VAT",
"MK:VAT",
"MT:VAT",
"MY:EIF",
"NG:TID",
"NL:KVK",
"NL:OINO",
"NL:VAT",
"NO:ORG",
"NO:VAT",
"OM:VAT",
"PL:VAT",
"PT:VAT",
"RO:VAT",
"RS:VAT",
"SE:ORGNR",
"SG:UEN",
"SI:VAT",
"SK:DIC",
"SK:VAT",
"SM:VAT",
"TR:VAT",
"US:EIN",
"VA:VAT"
],
"example": "DUNS",
"x-enumDescriptions": {
"DUNS": "Data Universal Numbering System (D-U-N-S Number) (ICD 0060)",
"EU:NAL": "Directorates of the European Commission (ICD 0130)",
"EU:REID": "Business Registers Network (ICD 9913)",
"EU:VAT": "National ministries of Economy VAT number (ICD 9912)",
"GLN": "Global Location Number (ICD 0088)",
"GS1": "GS1 identification keys (ICD 0209)",
"IBAN": "International Bank Account Number (ICD 9918)",
"LEI": "Legal Entity Identifier (ICD 0199)",
"SPIS": "OpenPeppol Service Provider Identification Scheme (ICD 0242)",
"UBLBE": "UBL.BE Party Identifier (ICD 0193)",
"AD:VAT": "Andorra VAT number (ICD 9922)",
"AE:TIN": "UAE Tax Identification Number (ICD 0235)",
"AL:VAT": "Albania VAT number (ICD 9923)",
"AT:CID": "Firmenidentifikationsnummer der Statistik Austria (ICD 9916)",
"AT:GOV": "Austrian government number (ICD 9915)",
"AT:KUR": "Kennziffer des Unternehmensregisters (ICD 9919)",
"AT:VAT": "Austrian VAT number (ICD 9914)",
"AU:ABN": "Australian Business Number (ICD 0151)",
"BA:VAT": "Bosnia and Herzegovina VAT number (ICD 9924)",
"BE:EN": "Numero d'entreprise / ondernemingsnummer / Unternehmensnummer (ICD 0208)",
"BE:VAT": "Belgian VAT number (ICD 9925)",
"BG:VAT": "Bulgaria VAT number (ICD 9926)",
"CH:UIDB": "Swiss Unique Business Identification Number (ICD 0183)",
"CH:VAT": "Switzerland VAT number (ICD 9927)",
"CY:VAT": "Cyprus VAT number (ICD 9928)",
"CZ:VAT": "Czech Republic VAT number (ICD 9929)",
"DE:GEBA": "German Electronic Business Address (ICD 0246)",
"DE:LWID": "Peppol-Leitweg-ID (ICD 0204)",
"DE:VAT": "German VAT number (ICD 9930)",
"DK:CVR": "The Danish Business Authority - CVR-number (ICD 0184)",
"DK:P": "The Danish Business Authority - P-number (ICD 0096)",
"DK:SE": "The Danish Business Authority - SE-number (ICD 0198)",
"EE:CC": "Company code (ICD 0191)",
"EE:VAT": "Estonia VAT number (ICD 9931)",
"ES:VAT": "Spain VAT number (ICD 9920)",
"FI:OVT2": "OVTcode (ICD 0216)",
"FR:CTC": "FRCTC Electronic Address (ICD 0225)",
"FR:SIRENE": "System Information et Repertoire des Entreprise et des Etablissements: SIRENE (ICD 0002)",
"FR:SIRET": "SIRET-CODE (ICD 0009)",
"FR:VAT": "French VAT number (ICD 9957)",
"GB:VAT": "United Kingdom VAT number (ICD 9932)",
"GR:VAT": "Greece VAT number (ICD 9933)",
"HR:VAT": "Croatia VAT number (ICD 9934)",
"HU:VAT": "Hungary VAT number (ICD 9910)",
"IE:VAT": "Ireland VAT number (ICD 9935)",
"IS:KT": "Icelandic National Registry (ICD 9917)",
"IS:KTNR": "Icelandic identifier (ICD 0196)",
"IT:CFI": "CODICE FISCALE (ICD 0210)",
"IT:COD": "CODDEST (ICD 0205)",
"IT:CUUO": "Codice Univoco Unita Organizzativa iPA (ICD 0201)",
"IT:FTI": "FTI - Ediforum Italia (ICD 0097)",
"IT:SECETI": "SECETI Object Identifiers (ICD 0142)",
"IT:SIA": "SIA Object Identifiers (ICD 0135)",
"IT:IVA": "PARTITA IVA (ICD 0211)",
"JP:IIN": "The registered number of the qualified invoice issuer (ICD 0221)",
"JP:SST": "Corporate Number of The Social Security and Tax Number System (ICD 0188)",
"LI:VAT": "Liechtenstein VAT number (ICD 9936)",
"LT:LEC": "Legal entity code (ICD 0200)",
"LT:VAT": "Lithuania VAT number (ICD 9937)",
"LU:MAT": "Register of legal persons (ICD 0240)",
"LU:VAT": "Luxemburg VAT number (ICD 9938)",
"LV:URN": "Unified registration number (ICD 0218)",
"LV:VAT": "Latvia VAT number (ICD 9939)",
"MC:VAT": "Monaco VAT number (ICD 9940)",
"ME:VAT": "Montenegro VAT number (ICD 9941)",
"MK:VAT": "North Macedonia VAT number (ICD 9942)",
"MT:VAT": "Malta VAT number (ICD 9943)",
"MY:EIF": "National e-Invoicing Framework (ICD 0230)",
"NG:TID": "Tax Identification (ICD 0244)",
"NL:KVK": "Vereniging van Kamers van Koophandel en Fabrieken in Nederland Scheme (ICD 0106)",
"NL:OINO": "Organisatie-identificatienummer (ICD 0190)",
"NL:VAT": "Netherlands VAT number (ICD 9944)",
"NO:ORG": "Organisasjonsnummer (ICD 0192)",
"NO:VAT": "Norwegian VAT number (ICD 9909)",
"OM:VAT": "Oman Value Added Tax Identification Number (VATIN) (ICD 0248)",
"PL:VAT": "Poland VAT number (ICD 9945)",
"PT:VAT": "Portugal VAT number (ICD 9946)",
"RO:VAT": "Romania VAT number (ICD 9947)",
"RS:VAT": "Serbia VAT number (ICD 9948)",
"SE:ORGNR": "Organisationsnummer (ICD 0007)",
"SG:UEN": "Singapore Nationwide E-Invoice Framework (ICD 0195)",
"SI:VAT": "Slovenia VAT number (ICD 9949)",
"SK:DIC": "Tax identification number (ICD 0245)",
"SK:VAT": "Slovakia VAT number (ICD 9950)",
"SM:VAT": "San Marino VAT number (ICD 9951)",
"TR:VAT": "Turkey VAT number (ICD 9952)",
"US:EIN": "US Employer ID Number (ICD 9959)",
"VA:VAT": "Holy See (Vatican City State) VAT number (ICD 9953)"
}
}
},
{
"name": "participantId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"424": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"$ref": "#/components/responses/ModelNotFoundException"
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParticipantLookupResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
}
},
"/openapi.json": {
"get": {
"operationId": "routing.redirect",
"summary": "Invoke the controller method",
"tags": [
"Redirect"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"http": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"AccountSchemeId": {
"type": "string",
"description": "Financial account scheme identifiers. Country-specific schemes are prefixed with ISO 3166-1 alpha-2 codes.\n",
"enum": [
"IBAN",
"DK:BBAN"
],
"example": "IBAN",
"title": "AccountSchemeId"
},
"Channel": {
"type": "string",
"enum": [
"Peppol",
"NemHandel"
],
"example": "Peppol",
"x-enumDescriptions": {
"Peppol": "PEPPOL is the global standard for electronic invoicing.",
"NemHandel": "NemHandel is only used in Denmark."
},
"title": "Channel"
},
"CompanyAuthorisationResponse": {
"type": "object",
"properties": {
"signed": {
"type": "boolean",
"example": false
},
"sign_url": {
"type": [
"string",
"null"
],
"description": "Present when the agreement is not yet signed; null once signed",
"example": "https://app.ecourier.io/end-user/authorise/01kmkdaf55vrrecfy70181tpr6?expires=1716000000&signature=abc123"
},
"signer": {
"$ref": "#/components/schemas/CompanyAuthorisationSignerResponse"
}
},
"required": [
"signed",
"sign_url",
"signer"
],
"title": "CompanyAuthorisationResponse"
},
"CompanyAuthorisationSignerResponse": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "Pernille"
},
"last_name": {
"type": "string",
"example": "Jensen"
},
"title": {
"type": "string",
"example": "CEO"
}
},
"required": [
"first_name",
"last_name",
"title"
],
"title": "CompanyAuthorisationSignerResponse"
},
"CompanyDetailsResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0101knwp96k3ggvkra831yrd74zh"
},
"name": {
"type": "string",
"example": "Acme Danmark A/S"
},
"mode": {
"type": "string",
"enum": [
"Live",
"Test"
],
"example": "Live",
"x-enumDescriptions": {
"Live": "Documents are sent to real recipients.",
"Test": "Documents are still sent, but only in the test version of the selected channel."
}
},
"company_no": {
"type": "string",
"example": "12345678"
},
"created_at": {
"type": "string",
"example": "2026-04-11T12:34:56+00:00"
},
"updated_at": {
"type": "string",
"example": "2026-05-21T09:15:30+00:00"
},
"parent_id": {
"type": [
"string",
"null"
],
"example": "0101knwp96k3ggvkra831yrd75abc"
},
"children": {
"type": "array",
"example": [
"0101knwp96k3ggvkra831yrd76def"
],
"items": {
"type": "string"
}
},
"country": {
"type": "string",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"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",
"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",
"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",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"example": "DK",
"x-enumDescriptions": {
"AD": "Andorra",
"AE": "United Arab Emirates",
"AF": "Afghanistan",
"AG": "Antigua & Barbuda",
"AI": "Anguilla",
"AL": "Albania",
"AM": "Armenia",
"AO": "Angola",
"AQ": "Antarctica",
"AR": "Argentina",
"AS": "American Samoa",
"AT": "Austria",
"AU": "Australia",
"AW": "Aruba",
"AX": "\u00c5land Islands",
"AZ": "Azerbaijan",
"BA": "Bosnia & Herzegovina",
"BB": "Barbados",
"BD": "Bangladesh",
"BE": "Belgium",
"BF": "Burkina Faso",
"BG": "Bulgaria",
"BH": "Bahrain",
"BI": "Burundi",
"BJ": "Benin",
"BL": "St. Barth\u00e9lemy",
"BM": "Bermuda",
"BN": "Brunei",
"BO": "Bolivia",
"BQ": "Caribbean Netherlands",
"BR": "Brazil",
"BS": "Bahamas",
"BT": "Bhutan",
"BV": "Bouvet Island",
"BW": "Botswana",
"BY": "Belarus",
"BZ": "Belize",
"CA": "Canada",
"CC": "Cocos (Keeling) Islands",
"CD": "Congo - Kinshasa",
"CF": "Central African Republic",
"CG": "Congo - Brazzaville",
"CH": "Switzerland",
"CI": "C\u00f4te d\u2019Ivoire",
"CK": "Cook Islands",
"CL": "Chile",
"CM": "Cameroon",
"CN": "China",
"CO": "Colombia",
"CR": "Costa Rica",
"CU": "Cuba",
"CV": "Cape Verde",
"CW": "Cura\u00e7ao",
"CX": "Christmas Island",
"CY": "Cyprus",
"CZ": "Czechia",
"DE": "Germany",
"DJ": "Djibouti",
"DK": "Denmark",
"DM": "Dominica",
"DO": "Dominican Republic",
"DZ": "Algeria",
"EC": "Ecuador",
"EE": "Estonia",
"EG": "Egypt",
"EH": "Western Sahara",
"ER": "Eritrea",
"ES": "Spain",
"ET": "Ethiopia",
"FI": "Finland",
"FJ": "Fiji",
"FK": "Falkland Islands",
"FM": "Micronesia",
"FO": "Faroe Islands",
"FR": "France",
"GA": "Gabon",
"GB": "United Kingdom",
"GD": "Grenada",
"GE": "Georgia",
"GF": "French Guiana",
"GG": "Guernsey",
"GH": "Ghana",
"GI": "Gibraltar",
"GL": "Greenland",
"GM": "Gambia",
"GN": "Guinea",
"GP": "Guadeloupe",
"GQ": "Equatorial Guinea",
"GR": "Greece",
"GS": "South Georgia & South Sandwich Islands",
"GT": "Guatemala",
"GU": "Guam",
"GW": "Guinea-Bissau",
"GY": "Guyana",
"HK": "Hong Kong SAR China",
"HM": "Heard & McDonald Islands",
"HN": "Honduras",
"HR": "Croatia",
"HT": "Haiti",
"HU": "Hungary",
"ID": "Indonesia",
"IE": "Ireland",
"IL": "Israel",
"IM": "Isle of Man",
"IN": "India",
"IO": "British Indian Ocean Territory",
"IQ": "Iraq",
"IR": "Iran",
"IS": "Iceland",
"IT": "Italy",
"JE": "Jersey",
"JM": "Jamaica",
"JO": "Jordan",
"JP": "Japan",
"KE": "Kenya",
"KG": "Kyrgyzstan",
"KH": "Cambodia",
"KI": "Kiribati",
"KM": "Comoros",
"KN": "St. Kitts & Nevis",
"KP": "North Korea",
"KR": "South Korea",
"KW": "Kuwait",
"KY": "Cayman Islands",
"KZ": "Kazakhstan",
"LA": "Laos",
"LB": "Lebanon",
"LC": "St. Lucia",
"LI": "Liechtenstein",
"LK": "Sri Lanka",
"LR": "Liberia",
"LS": "Lesotho",
"LT": "Lithuania",
"LU": "Luxembourg",
"LV": "Latvia",
"LY": "Libya",
"MA": "Morocco",
"MC": "Monaco",
"MD": "Moldova",
"ME": "Montenegro",
"MF": "St. Martin",
"MG": "Madagascar",
"MH": "Marshall Islands",
"MK": "North Macedonia",
"ML": "Mali",
"MM": "Myanmar (Burma)",
"MN": "Mongolia",
"MO": "Macao SAR China",
"MP": "Northern Mariana Islands",
"MQ": "Martinique",
"MR": "Mauritania",
"MS": "Montserrat",
"MT": "Malta",
"MU": "Mauritius",
"MV": "Maldives",
"MW": "Malawi",
"MX": "Mexico",
"MY": "Malaysia",
"MZ": "Mozambique",
"NA": "Namibia",
"NC": "New Caledonia",
"NE": "Niger",
"NF": "Norfolk Island",
"NG": "Nigeria",
"NI": "Nicaragua",
"NL": "Netherlands",
"NO": "Norway",
"NP": "Nepal",
"NR": "Nauru",
"NU": "Niue",
"NZ": "New Zealand",
"OM": "Oman",
"PA": "Panama",
"PE": "Peru",
"PF": "French Polynesia",
"PG": "Papua New Guinea",
"PH": "Philippines",
"PK": "Pakistan",
"PL": "Poland",
"PM": "St. Pierre & Miquelon",
"PN": "Pitcairn Islands",
"PR": "Puerto Rico",
"PS": "Palestinian Territories",
"PT": "Portugal",
"PW": "Palau",
"PY": "Paraguay",
"QA": "Qatar",
"RE": "R\u00e9union",
"RO": "Romania",
"RS": "Serbia",
"RU": "Russia",
"RW": "Rwanda",
"SA": "Saudi Arabia",
"SB": "Solomon Islands",
"SC": "Seychelles",
"SD": "Sudan",
"SE": "Sweden",
"SG": "Singapore",
"SH": "St. Helena",
"SI": "Slovenia",
"SJ": "Svalbard & Jan Mayen",
"SK": "Slovakia",
"SL": "Sierra Leone",
"SM": "San Marino",
"SN": "Senegal",
"SO": "Somalia",
"SR": "Suriname",
"SS": "South Sudan",
"ST": "S\u00e3o Tom\u00e9 & Pr\u00edncipe",
"SV": "El Salvador",
"SX": "Sint Maarten",
"SY": "Syria",
"SZ": "Eswatini",
"TC": "Turks & Caicos Islands",
"TD": "Chad",
"TF": "French Southern Territories",
"TG": "Togo",
"TH": "Thailand",
"TJ": "Tajikistan",
"TK": "Tokelau",
"TL": "Timor-Leste",
"TM": "Turkmenistan",
"TN": "Tunisia",
"TO": "Tonga",
"TR": "Turkey",
"TT": "Trinidad & Tobago",
"TV": "Tuvalu",
"TW": "Taiwan",
"TZ": "Tanzania",
"UA": "Ukraine",
"UG": "Uganda",
"UM": "U.S. Outlying Islands",
"US": "United States",
"UY": "Uruguay",
"UZ": "Uzbekistan",
"VA": "Vatican City",
"VC": "St. Vincent & Grenadines",
"VE": "Venezuela",
"VG": "British Virgin Islands",
"VI": "U.S. Virgin Islands",
"VN": "Vietnam",
"VU": "Vanuatu",
"WF": "Wallis & Futuna",
"WS": "Samoa",
"YE": "Yemen",
"YT": "Mayotte",
"ZA": "South Africa",
"ZM": "Zambia",
"ZW": "Zimbabwe"
}
},
"authorisation": {
"anyOf": [
{
"$ref": "#/components/schemas/CompanyAuthorisationResponse"
},
{
"type": "null"
}
]
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyParticipantResponse"
}
}
},
"required": [
"id",
"name",
"mode",
"company_no",
"created_at",
"updated_at",
"parent_id",
"children",
"country",
"authorisation",
"participants"
],
"title": "CompanyDetailsResponse"
},
"CompanyListItemResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0101knwp96k3ggvkra831yrd74zh"
},
"name": {
"type": "string",
"example": "Acme Danmark A/S"
},
"country": {
"type": "string",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"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",
"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",
"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",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"example": "DK",
"x-enumDescriptions": {
"AD": "Andorra",
"AE": "United Arab Emirates",
"AF": "Afghanistan",
"AG": "Antigua & Barbuda",
"AI": "Anguilla",
"AL": "Albania",
"AM": "Armenia",
"AO": "Angola",
"AQ": "Antarctica",
"AR": "Argentina",
"AS": "American Samoa",
"AT": "Austria",
"AU": "Australia",
"AW": "Aruba",
"AX": "\u00c5land Islands",
"AZ": "Azerbaijan",
"BA": "Bosnia & Herzegovina",
"BB": "Barbados",
"BD": "Bangladesh",
"BE": "Belgium",
"BF": "Burkina Faso",
"BG": "Bulgaria",
"BH": "Bahrain",
"BI": "Burundi",
"BJ": "Benin",
"BL": "St. Barth\u00e9lemy",
"BM": "Bermuda",
"BN": "Brunei",
"BO": "Bolivia",
"BQ": "Caribbean Netherlands",
"BR": "Brazil",
"BS": "Bahamas",
"BT": "Bhutan",
"BV": "Bouvet Island",
"BW": "Botswana",
"BY": "Belarus",
"BZ": "Belize",
"CA": "Canada",
"CC": "Cocos (Keeling) Islands",
"CD": "Congo - Kinshasa",
"CF": "Central African Republic",
"CG": "Congo - Brazzaville",
"CH": "Switzerland",
"CI": "C\u00f4te d\u2019Ivoire",
"CK": "Cook Islands",
"CL": "Chile",
"CM": "Cameroon",
"CN": "China",
"CO": "Colombia",
"CR": "Costa Rica",
"CU": "Cuba",
"CV": "Cape Verde",
"CW": "Cura\u00e7ao",
"CX": "Christmas Island",
"CY": "Cyprus",
"CZ": "Czechia",
"DE": "Germany",
"DJ": "Djibouti",
"DK": "Denmark",
"DM": "Dominica",
"DO": "Dominican Republic",
"DZ": "Algeria",
"EC": "Ecuador",
"EE": "Estonia",
"EG": "Egypt",
"EH": "Western Sahara",
"ER": "Eritrea",
"ES": "Spain",
"ET": "Ethiopia",
"FI": "Finland",
"FJ": "Fiji",
"FK": "Falkland Islands",
"FM": "Micronesia",
"FO": "Faroe Islands",
"FR": "France",
"GA": "Gabon",
"GB": "United Kingdom",
"GD": "Grenada",
"GE": "Georgia",
"GF": "French Guiana",
"GG": "Guernsey",
"GH": "Ghana",
"GI": "Gibraltar",
"GL": "Greenland",
"GM": "Gambia",
"GN": "Guinea",
"GP": "Guadeloupe",
"GQ": "Equatorial Guinea",
"GR": "Greece",
"GS": "South Georgia & South Sandwich Islands",
"GT": "Guatemala",
"GU": "Guam",
"GW": "Guinea-Bissau",
"GY": "Guyana",
"HK": "Hong Kong SAR China",
"HM": "Heard & McDonald Islands",
"HN": "Honduras",
"HR": "Croatia",
"HT": "Haiti",
"HU": "Hungary",
"ID": "Indonesia",
"IE": "Ireland",
"IL": "Israel",
"IM": "Isle of Man",
"IN": "India",
"IO": "British Indian Ocean Territory",
"IQ": "Iraq",
"IR": "Iran",
"IS": "Iceland",
"IT": "Italy",
"JE": "Jersey",
"JM": "Jamaica",
"JO": "Jordan",
"JP": "Japan",
"KE": "Kenya",
"KG": "Kyrgyzstan",
"KH": "Cambodia",
"KI": "Kiribati",
"KM": "Comoros",
"KN": "St. Kitts & Nevis",
"KP": "North Korea",
"KR": "South Korea",
"KW": "Kuwait",
"KY": "Cayman Islands",
"KZ": "Kazakhstan",
"LA": "Laos",
"LB": "Lebanon",
"LC": "St. Lucia",
"LI": "Liechtenstein",
"LK": "Sri Lanka",
"LR": "Liberia",
"LS": "Lesotho",
"LT": "Lithuania",
"LU": "Luxembourg",
"LV": "Latvia",
"LY": "Libya",
"MA": "Morocco",
"MC": "Monaco",
"MD": "Moldova",
"ME": "Montenegro",
"MF": "St. Martin",
"MG": "Madagascar",
"MH": "Marshall Islands",
"MK": "North Macedonia",
"ML": "Mali",
"MM": "Myanmar (Burma)",
"MN": "Mongolia",
"MO": "Macao SAR China",
"MP": "Northern Mariana Islands",
"MQ": "Martinique",
"MR": "Mauritania",
"MS": "Montserrat",
"MT": "Malta",
"MU": "Mauritius",
"MV": "Maldives",
"MW": "Malawi",
"MX": "Mexico",
"MY": "Malaysia",
"MZ": "Mozambique",
"NA": "Namibia",
"NC": "New Caledonia",
"NE": "Niger",
"NF": "Norfolk Island",
"NG": "Nigeria",
"NI": "Nicaragua",
"NL": "Netherlands",
"NO": "Norway",
"NP": "Nepal",
"NR": "Nauru",
"NU": "Niue",
"NZ": "New Zealand",
"OM": "Oman",
"PA": "Panama",
"PE": "Peru",
"PF": "French Polynesia",
"PG": "Papua New Guinea",
"PH": "Philippines",
"PK": "Pakistan",
"PL": "Poland",
"PM": "St. Pierre & Miquelon",
"PN": "Pitcairn Islands",
"PR": "Puerto Rico",
"PS": "Palestinian Territories",
"PT": "Portugal",
"PW": "Palau",
"PY": "Paraguay",
"QA": "Qatar",
"RE": "R\u00e9union",
"RO": "Romania",
"RS": "Serbia",
"RU": "Russia",
"RW": "Rwanda",
"SA": "Saudi Arabia",
"SB": "Solomon Islands",
"SC": "Seychelles",
"SD": "Sudan",
"SE": "Sweden",
"SG": "Singapore",
"SH": "St. Helena",
"SI": "Slovenia",
"SJ": "Svalbard & Jan Mayen",
"SK": "Slovakia",
"SL": "Sierra Leone",
"SM": "San Marino",
"SN": "Senegal",
"SO": "Somalia",
"SR": "Suriname",
"SS": "South Sudan",
"ST": "S\u00e3o Tom\u00e9 & Pr\u00edncipe",
"SV": "El Salvador",
"SX": "Sint Maarten",
"SY": "Syria",
"SZ": "Eswatini",
"TC": "Turks & Caicos Islands",
"TD": "Chad",
"TF": "French Southern Territories",
"TG": "Togo",
"TH": "Thailand",
"TJ": "Tajikistan",
"TK": "Tokelau",
"TL": "Timor-Leste",
"TM": "Turkmenistan",
"TN": "Tunisia",
"TO": "Tonga",
"TR": "Turkey",
"TT": "Trinidad & Tobago",
"TV": "Tuvalu",
"TW": "Taiwan",
"TZ": "Tanzania",
"UA": "Ukraine",
"UG": "Uganda",
"UM": "U.S. Outlying Islands",
"US": "United States",
"UY": "Uruguay",
"UZ": "Uzbekistan",
"VA": "Vatican City",
"VC": "St. Vincent & Grenadines",
"VE": "Venezuela",
"VG": "British Virgin Islands",
"VI": "U.S. Virgin Islands",
"VN": "Vietnam",
"VU": "Vanuatu",
"WF": "Wallis & Futuna",
"WS": "Samoa",
"YE": "Yemen",
"YT": "Mayotte",
"ZA": "South Africa",
"ZM": "Zambia",
"ZW": "Zimbabwe"
}
},
"company_no": {
"type": "string",
"example": "12345678"
}
},
"required": [
"id",
"name",
"country",
"company_no"
],
"title": "CompanyListItemResponse"
},
"CompanyParticipantResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0101knwp96k3ggvkra831yrd77ghi"
},
"icd:identifier": {
"type": "string",
"example": "0088:5790000435944"
},
"scheme": {
"type": "string",
"enum": [
"DUNS",
"EU:NAL",
"EU:REID",
"EU:VAT",
"GLN",
"GS1",
"IBAN",
"LEI",
"SPIS",
"UBLBE",
"AD:VAT",
"AE:TIN",
"AL:VAT",
"AT:CID",
"AT:GOV",
"AT:KUR",
"AT:VAT",
"AU:ABN",
"BA:VAT",
"BE:EN",
"BE:VAT",
"BG:VAT",
"CH:UIDB",
"CH:VAT",
"CY:VAT",
"CZ:VAT",
"DE:GEBA",
"DE:LWID",
"DE:VAT",
"DK:CVR",
"DK:P",
"DK:SE",
"EE:CC",
"EE:VAT",
"ES:VAT",
"FI:OVT2",
"FR:CTC",
"FR:SIRENE",
"FR:SIRET",
"FR:VAT",
"GB:VAT",
"GR:VAT",
"HR:VAT",
"HU:VAT",
"IE:VAT",
"IS:KT",
"IS:KTNR",
"IT:CFI",
"IT:COD",
"IT:CUUO",
"IT:FTI",
"IT:SECETI",
"IT:SIA",
"IT:IVA",
"JP:IIN",
"JP:SST",
"LI:VAT",
"LT:LEC",
"LT:VAT",
"LU:MAT",
"LU:VAT",
"LV:URN",
"LV:VAT",
"MC:VAT",
"ME:VAT",
"MK:VAT",
"MT:VAT",
"MY:EIF",
"NG:TID",
"NL:KVK",
"NL:OINO",
"NL:VAT",
"NO:ORG",
"NO:VAT",
"OM:VAT",
"PL:VAT",
"PT:VAT",
"RO:VAT",
"RS:VAT",
"SE:ORGNR",
"SG:UEN",
"SI:VAT",
"SK:DIC",
"SK:VAT",
"SM:VAT",
"TR:VAT",
"US:EIN",
"VA:VAT"
],
"example": "GLN",
"x-enumDescriptions": {
"DUNS": "Data Universal Numbering System (D-U-N-S Number) (ICD 0060)",
"EU:NAL": "Directorates of the European Commission (ICD 0130)",
"EU:REID": "Business Registers Network (ICD 9913)",
"EU:VAT": "National ministries of Economy VAT number (ICD 9912)",
"GLN": "Global Location Number (ICD 0088)",
"GS1": "GS1 identification keys (ICD 0209)",
"IBAN": "International Bank Account Number (ICD 9918)",
"LEI": "Legal Entity Identifier (ICD 0199)",
"SPIS": "OpenPeppol Service Provider Identification Scheme (ICD 0242)",
"UBLBE": "UBL.BE Party Identifier (ICD 0193)",
"AD:VAT": "Andorra VAT number (ICD 9922)",
"AE:TIN": "UAE Tax Identification Number (ICD 0235)",
"AL:VAT": "Albania VAT number (ICD 9923)",
"AT:CID": "Firmenidentifikationsnummer der Statistik Austria (ICD 9916)",
"AT:GOV": "Austrian government number (ICD 9915)",
"AT:KUR": "Kennziffer des Unternehmensregisters (ICD 9919)",
"AT:VAT": "Austrian VAT number (ICD 9914)",
"AU:ABN": "Australian Business Number (ICD 0151)",
"BA:VAT": "Bosnia and Herzegovina VAT number (ICD 9924)",
"BE:EN": "Numero d'entreprise / ondernemingsnummer / Unternehmensnummer (ICD 0208)",
"BE:VAT": "Belgian VAT number (ICD 9925)",
"BG:VAT": "Bulgaria VAT number (ICD 9926)",
"CH:UIDB": "Swiss Unique Business Identification Number (ICD 0183)",
"CH:VAT": "Switzerland VAT number (ICD 9927)",
"CY:VAT": "Cyprus VAT number (ICD 9928)",
"CZ:VAT": "Czech Republic VAT number (ICD 9929)",
"DE:GEBA": "German Electronic Business Address (ICD 0246)",
"DE:LWID": "Peppol-Leitweg-ID (ICD 0204)",
"DE:VAT": "German VAT number (ICD 9930)",
"DK:CVR": "The Danish Business Authority - CVR-number (ICD 0184)",
"DK:P": "The Danish Business Authority - P-number (ICD 0096)",
"DK:SE": "The Danish Business Authority - SE-number (ICD 0198)",
"EE:CC": "Company code (ICD 0191)",
"EE:VAT": "Estonia VAT number (ICD 9931)",
"ES:VAT": "Spain VAT number (ICD 9920)",
"FI:OVT2": "OVTcode (ICD 0216)",
"FR:CTC": "FRCTC Electronic Address (ICD 0225)",
"FR:SIRENE": "System Information et Repertoire des Entreprise et des Etablissements: SIRENE (ICD 0002)",
"FR:SIRET": "SIRET-CODE (ICD 0009)",
"FR:VAT": "French VAT number (ICD 9957)",
"GB:VAT": "United Kingdom VAT number (ICD 9932)",
"GR:VAT": "Greece VAT number (ICD 9933)",
"HR:VAT": "Croatia VAT number (ICD 9934)",
"HU:VAT": "Hungary VAT number (ICD 9910)",
"IE:VAT": "Ireland VAT number (ICD 9935)",
"IS:KT": "Icelandic National Registry (ICD 9917)",
"IS:KTNR": "Icelandic identifier (ICD 0196)",
"IT:CFI": "CODICE FISCALE (ICD 0210)",
"IT:COD": "CODDEST (ICD 0205)",
"IT:CUUO": "Codice Univoco Unita Organizzativa iPA (ICD 0201)",
"IT:FTI": "FTI - Ediforum Italia (ICD 0097)",
"IT:SECETI": "SECETI Object Identifiers (ICD 0142)",
"IT:SIA": "SIA Object Identifiers (ICD 0135)",
"IT:IVA": "PARTITA IVA (ICD 0211)",
"JP:IIN": "The registered number of the qualified invoice issuer (ICD 0221)",
"JP:SST": "Corporate Number of The Social Security and Tax Number System (ICD 0188)",
"LI:VAT": "Liechtenstein VAT number (ICD 9936)",
"LT:LEC": "Legal entity code (ICD 0200)",
"LT:VAT": "Lithuania VAT number (ICD 9937)",
"LU:MAT": "Register of legal persons (ICD 0240)",
"LU:VAT": "Luxemburg VAT number (ICD 9938)",
"LV:URN": "Unified registration number (ICD 0218)",
"LV:VAT": "Latvia VAT number (ICD 9939)",
"MC:VAT": "Monaco VAT number (ICD 9940)",
"ME:VAT": "Montenegro VAT number (ICD 9941)",
"MK:VAT": "North Macedonia VAT number (ICD 9942)",
"MT:VAT": "Malta VAT number (ICD 9943)",
"MY:EIF": "National e-Invoicing Framework (ICD 0230)",
"NG:TID": "Tax Identification (ICD 0244)",
"NL:KVK": "Vereniging van Kamers van Koophandel en Fabrieken in Nederland Scheme (ICD 0106)",
"NL:OINO": "Organisatie-identificatienummer (ICD 0190)",
"NL:VAT": "Netherlands VAT number (ICD 9944)",
"NO:ORG": "Organisasjonsnummer (ICD 0192)",
"NO:VAT": "Norwegian VAT number (ICD 9909)",
"OM:VAT": "Oman Value Added Tax Identification Number (VATIN) (ICD 0248)",
"PL:VAT": "Poland VAT number (ICD 9945)",
"PT:VAT": "Portugal VAT number (ICD 9946)",
"RO:VAT": "Romania VAT number (ICD 9947)",
"RS:VAT": "Serbia VAT number (ICD 9948)",
"SE:ORGNR": "Organisationsnummer (ICD 0007)",
"SG:UEN": "Singapore Nationwide E-Invoice Framework (ICD 0195)",
"SI:VAT": "Slovenia VAT number (ICD 9949)",
"SK:DIC": "Tax identification number (ICD 0245)",
"SK:VAT": "Slovakia VAT number (ICD 9950)",
"SM:VAT": "San Marino VAT number (ICD 9951)",
"TR:VAT": "Turkey VAT number (ICD 9952)",
"US:EIN": "US Employer ID Number (ICD 9959)",
"VA:VAT": "Holy See (Vatican City State) VAT number (ICD 9953)"
}
},
"identifier": {
"type": "string",
"example": "5790000435944"
},
"channels": {
"type": "array",
"example": [
"NemHandel"
],
"items": {
"$ref": "#/components/schemas/Channel"
}
}
},
"required": [
"id",
"icd:identifier",
"scheme",
"identifier",
"channels"
],
"title": "CompanyParticipantResponse"
},
"Country": {
"type": "string",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"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",
"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",
"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",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"example": "AD",
"x-enumDescriptions": {
"AD": "Andorra",
"AE": "United Arab Emirates",
"AF": "Afghanistan",
"AG": "Antigua & Barbuda",
"AI": "Anguilla",
"AL": "Albania",
"AM": "Armenia",
"AO": "Angola",
"AQ": "Antarctica",
"AR": "Argentina",
"AS": "American Samoa",
"AT": "Austria",
"AU": "Australia",
"AW": "Aruba",
"AX": "\u00c5land Islands",
"AZ": "Azerbaijan",
"BA": "Bosnia & Herzegovina",
"BB": "Barbados",
"BD": "Bangladesh",
"BE": "Belgium",
"BF": "Burkina Faso",
"BG": "Bulgaria",
"BH": "Bahrain",
"BI": "Burundi",
"BJ": "Benin",
"BL": "St. Barth\u00e9lemy",
"BM": "Bermuda",
"BN": "Brunei",
"BO": "Bolivia",
"BQ": "Caribbean Netherlands",
"BR": "Brazil",
"BS": "Bahamas",
"BT": "Bhutan",
"BV": "Bouvet Island",
"BW": "Botswana",
"BY": "Belarus",
"BZ": "Belize",
"CA": "Canada",
"CC": "Cocos (Keeling) Islands",
"CD": "Congo - Kinshasa",
"CF": "Central African Republic",
"CG": "Congo - Brazzaville",
"CH": "Switzerland",
"CI": "C\u00f4te d\u2019Ivoire",
"CK": "Cook Islands",
"CL": "Chile",
"CM": "Cameroon",
"CN": "China",
"CO": "Colombia",
"CR": "Costa Rica",
"CU": "Cuba",
"CV": "Cape Verde",
"CW": "Cura\u00e7ao",
"CX": "Christmas Island",
"CY": "Cyprus",
"CZ": "Czechia",
"DE": "Germany",
"DJ": "Djibouti",
"DK": "Denmark",
"DM": "Dominica",
"DO": "Dominican Republic",
"DZ": "Algeria",
"EC": "Ecuador",
"EE": "Estonia",
"EG": "Egypt",
"EH": "Western Sahara",
"ER": "Eritrea",
"ES": "Spain",
"ET": "Ethiopia",
"FI": "Finland",
"FJ": "Fiji",
"FK": "Falkland Islands",
"FM": "Micronesia",
"FO": "Faroe Islands",
"FR": "France",
"GA": "Gabon",
"GB": "United Kingdom",
"GD": "Grenada",
"GE": "Georgia",
"GF": "French Guiana",
"GG": "Guernsey",
"GH": "Ghana",
"GI": "Gibraltar",
"GL": "Greenland",
"GM": "Gambia",
"GN": "Guinea",
"GP": "Guadeloupe",
"GQ": "Equatorial Guinea",
"GR": "Greece",
"GS": "South Georgia & South Sandwich Islands",
"GT": "Guatemala",
"GU": "Guam",
"GW": "Guinea-Bissau",
"GY": "Guyana",
"HK": "Hong Kong SAR China",
"HM": "Heard & McDonald Islands",
"HN": "Honduras",
"HR": "Croatia",
"HT": "Haiti",
"HU": "Hungary",
"ID": "Indonesia",
"IE": "Ireland",
"IL": "Israel",
"IM": "Isle of Man",
"IN": "India",
"IO": "British Indian Ocean Territory",
"IQ": "Iraq",
"IR": "Iran",
"IS": "Iceland",
"IT": "Italy",
"JE": "Jersey",
"JM": "Jamaica",
"JO": "Jordan",
"JP": "Japan",
"KE": "Kenya",
"KG": "Kyrgyzstan",
"KH": "Cambodia",
"KI": "Kiribati",
"KM": "Comoros",
"KN": "St. Kitts & Nevis",
"KP": "North Korea",
"KR": "South Korea",
"KW": "Kuwait",
"KY": "Cayman Islands",
"KZ": "Kazakhstan",
"LA": "Laos",
"LB": "Lebanon",
"LC": "St. Lucia",
"LI": "Liechtenstein",
"LK": "Sri Lanka",
"LR": "Liberia",
"LS": "Lesotho",
"LT": "Lithuania",
"LU": "Luxembourg",
"LV": "Latvia",
"LY": "Libya",
"MA": "Morocco",
"MC": "Monaco",
"MD": "Moldova",
"ME": "Montenegro",
"MF": "St. Martin",
"MG": "Madagascar",
"MH": "Marshall Islands",
"MK": "North Macedonia",
"ML": "Mali",
"MM": "Myanmar (Burma)",
"MN": "Mongolia",
"MO": "Macao SAR China",
"MP": "Northern Mariana Islands",
"MQ": "Martinique",
"MR": "Mauritania",
"MS": "Montserrat",
"MT": "Malta",
"MU": "Mauritius",
"MV": "Maldives",
"MW": "Malawi",
"MX": "Mexico",
"MY": "Malaysia",
"MZ": "Mozambique",
"NA": "Namibia",
"NC": "New Caledonia",
"NE": "Niger",
"NF": "Norfolk Island",
"NG": "Nigeria",
"NI": "Nicaragua",
"NL": "Netherlands",
"NO": "Norway",
"NP": "Nepal",
"NR": "Nauru",
"NU": "Niue",
"NZ": "New Zealand",
"OM": "Oman",
"PA": "Panama",
"PE": "Peru",
"PF": "French Polynesia",
"PG": "Papua New Guinea",
"PH": "Philippines",
"PK": "Pakistan",
"PL": "Poland",
"PM": "St. Pierre & Miquelon",
"PN": "Pitcairn Islands",
"PR": "Puerto Rico",
"PS": "Palestinian Territories",
"PT": "Portugal",
"PW": "Palau",
"PY": "Paraguay",
"QA": "Qatar",
"RE": "R\u00e9union",
"RO": "Romania",
"RS": "Serbia",
"RU": "Russia",
"RW": "Rwanda",
"SA": "Saudi Arabia",
"SB": "Solomon Islands",
"SC": "Seychelles",
"SD": "Sudan",
"SE": "Sweden",
"SG": "Singapore",
"SH": "St. Helena",
"SI": "Slovenia",
"SJ": "Svalbard & Jan Mayen",
"SK": "Slovakia",
"SL": "Sierra Leone",
"SM": "San Marino",
"SN": "Senegal",
"SO": "Somalia",
"SR": "Suriname",
"SS": "South Sudan",
"ST": "S\u00e3o Tom\u00e9 & Pr\u00edncipe",
"SV": "El Salvador",
"SX": "Sint Maarten",
"SY": "Syria",
"SZ": "Eswatini",
"TC": "Turks & Caicos Islands",
"TD": "Chad",
"TF": "French Southern Territories",
"TG": "Togo",
"TH": "Thailand",
"TJ": "Tajikistan",
"TK": "Tokelau",
"TL": "Timor-Leste",
"TM": "Turkmenistan",
"TN": "Tunisia",
"TO": "Tonga",
"TR": "Turkey",
"TT": "Trinidad & Tobago",
"TV": "Tuvalu",
"TW": "Taiwan",
"TZ": "Tanzania",
"UA": "Ukraine",
"UG": "Uganda",
"UM": "U.S. Outlying Islands",
"US": "United States",
"UY": "Uruguay",
"UZ": "Uzbekistan",
"VA": "Vatican City",
"VC": "St. Vincent & Grenadines",
"VE": "Venezuela",
"VG": "British Virgin Islands",
"VI": "U.S. Virgin Islands",
"VN": "Vietnam",
"VU": "Vanuatu",
"WF": "Wallis & Futuna",
"WS": "Samoa",
"YE": "Yemen",
"YT": "Mayotte",
"ZA": "South Africa",
"ZM": "Zambia",
"ZW": "Zimbabwe"
},
"title": "Country"
},
"CreateCompanyPayload": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Acme Danmark A/S"
},
"country": {
"type": "string",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"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",
"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",
"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",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"example": "DK",
"x-enumDescriptions": {
"AD": "Andorra",
"AE": "United Arab Emirates",
"AF": "Afghanistan",
"AG": "Antigua & Barbuda",
"AI": "Anguilla",
"AL": "Albania",
"AM": "Armenia",
"AO": "Angola",
"AQ": "Antarctica",
"AR": "Argentina",
"AS": "American Samoa",
"AT": "Austria",
"AU": "Australia",
"AW": "Aruba",
"AX": "\u00c5land Islands",
"AZ": "Azerbaijan",
"BA": "Bosnia & Herzegovina",
"BB": "Barbados",
"BD": "Bangladesh",
"BE": "Belgium",
"BF": "Burkina Faso",
"BG": "Bulgaria",
"BH": "Bahrain",
"BI": "Burundi",
"BJ": "Benin",
"BL": "St. Barth\u00e9lemy",
"BM": "Bermuda",
"BN": "Brunei",
"BO": "Bolivia",
"BQ": "Caribbean Netherlands",
"BR": "Brazil",
"BS": "Bahamas",
"BT": "Bhutan",
"BV": "Bouvet Island",
"BW": "Botswana",
"BY": "Belarus",
"BZ": "Belize",
"CA": "Canada",
"CC": "Cocos (Keeling) Islands",
"CD": "Congo - Kinshasa",
"CF": "Central African Republic",
"CG": "Congo - Brazzaville",
"CH": "Switzerland",
"CI": "C\u00f4te d\u2019Ivoire",
"CK": "Cook Islands",
"CL": "Chile",
"CM": "Cameroon",
"CN": "China",
"CO": "Colombia",
"CR": "Costa Rica",
"CU": "Cuba",
"CV": "Cape Verde",
"CW": "Cura\u00e7ao",
"CX": "Christmas Island",
"CY": "Cyprus",
"CZ": "Czechia",
"DE": "Germany",
"DJ": "Djibouti",
"DK": "Denmark",
"DM": "Dominica",
"DO": "Dominican Republic",
"DZ": "Algeria",
"EC": "Ecuador",
"EE": "Estonia",
"EG": "Egypt",
"EH": "Western Sahara",
"ER": "Eritrea",
"ES": "Spain",
"ET": "Ethiopia",
"FI": "Finland",
"FJ": "Fiji",
"FK": "Falkland Islands",
"FM": "Micronesia",
"FO": "Faroe Islands",
"FR": "France",
"GA": "Gabon",
"GB": "United Kingdom",
"GD": "Grenada",
"GE": "Georgia",
"GF": "French Guiana",
"GG": "Guernsey",
"GH": "Ghana",
"GI": "Gibraltar",
"GL": "Greenland",
"GM": "Gambia",
"GN": "Guinea",
"GP": "Guadeloupe",
"GQ": "Equatorial Guinea",
"GR": "Greece",
"GS": "South Georgia & South Sandwich Islands",
"GT": "Guatemala",
"GU": "Guam",
"GW": "Guinea-Bissau",
"GY": "Guyana",
"HK": "Hong Kong SAR China",
"HM": "Heard & McDonald Islands",
"HN": "Honduras",
"HR": "Croatia",
"HT": "Haiti",
"HU": "Hungary",
"ID": "Indonesia",
"IE": "Ireland",
"IL": "Israel",
"IM": "Isle of Man",
"IN": "India",
"IO": "British Indian Ocean Territory",
"IQ": "Iraq",
"IR": "Iran",
"IS": "Iceland",
"IT": "Italy",
"JE": "Jersey",
"JM": "Jamaica",
"JO": "Jordan",
"JP": "Japan",
"KE": "Kenya",
"KG": "Kyrgyzstan",
"KH": "Cambodia",
"KI": "Kiribati",
"KM": "Comoros",
"KN": "St. Kitts & Nevis",
"KP": "North Korea",
"KR": "South Korea",
"KW": "Kuwait",
"KY": "Cayman Islands",
"KZ": "Kazakhstan",
"LA": "Laos",
"LB": "Lebanon",
"LC": "St. Lucia",
"LI": "Liechtenstein",
"LK": "Sri Lanka",
"LR": "Liberia",
"LS": "Lesotho",
"LT": "Lithuania",
"LU": "Luxembourg",
"LV": "Latvia",
"LY": "Libya",
"MA": "Morocco",
"MC": "Monaco",
"MD": "Moldova",
"ME": "Montenegro",
"MF": "St. Martin",
"MG": "Madagascar",
"MH": "Marshall Islands",
"MK": "North Macedonia",
"ML": "Mali",
"MM": "Myanmar (Burma)",
"MN": "Mongolia",
"MO": "Macao SAR China",
"MP": "Northern Mariana Islands",
"MQ": "Martinique",
"MR": "Mauritania",
"MS": "Montserrat",
"MT": "Malta",
"MU": "Mauritius",
"MV": "Maldives",
"MW": "Malawi",
"MX": "Mexico",
"MY": "Malaysia",
"MZ": "Mozambique",
"NA": "Namibia",
"NC": "New Caledonia",
"NE": "Niger",
"NF": "Norfolk Island",
"NG": "Nigeria",
"NI": "Nicaragua",
"NL": "Netherlands",
"NO": "Norway",
"NP": "Nepal",
"NR": "Nauru",
"NU": "Niue",
"NZ": "New Zealand",
"OM": "Oman",
"PA": "Panama",
"PE": "Peru",
"PF": "French Polynesia",
"PG": "Papua New Guinea",
"PH": "Philippines",
"PK": "Pakistan",
"PL": "Poland",
"PM": "St. Pierre & Miquelon",
"PN": "Pitcairn Islands",
"PR": "Puerto Rico",
"PS": "Palestinian Territories",
"PT": "Portugal",
"PW": "Palau",
"PY": "Paraguay",
"QA": "Qatar",
"RE": "R\u00e9union",
"RO": "Romania",
"RS": "Serbia",
"RU": "Russia",
"RW": "Rwanda",
"SA": "Saudi Arabia",
"SB": "Solomon Islands",
"SC": "Seychelles",
"SD": "Sudan",
"SE": "Sweden",
"SG": "Singapore",
"SH": "St. Helena",
"SI": "Slovenia",
"SJ": "Svalbard & Jan Mayen",
"SK": "Slovakia",
"SL": "Sierra Leone",
"SM": "San Marino",
"SN": "Senegal",
"SO": "Somalia",
"SR": "Suriname",
"SS": "South Sudan",
"ST": "S\u00e3o Tom\u00e9 & Pr\u00edncipe",
"SV": "El Salvador",
"SX": "Sint Maarten",
"SY": "Syria",
"SZ": "Eswatini",
"TC": "Turks & Caicos Islands",
"TD": "Chad",
"TF": "French Southern Territories",
"TG": "Togo",
"TH": "Thailand",
"TJ": "Tajikistan",
"TK": "Tokelau",
"TL": "Timor-Leste",
"TM": "Turkmenistan",
"TN": "Tunisia",
"TO": "Tonga",
"TR": "Turkey",
"TT": "Trinidad & Tobago",
"TV": "Tuvalu",
"TW": "Taiwan",
"TZ": "Tanzania",
"UA": "Ukraine",
"UG": "Uganda",
"UM": "U.S. Outlying Islands",
"US": "United States",
"UY": "Uruguay",
"UZ": "Uzbekistan",
"VA": "Vatican City",
"VC": "St. Vincent & Grenadines",
"VE": "Venezuela",
"VG": "British Virgin Islands",
"VI": "U.S. Virgin Islands",
"VN": "Vietnam",
"VU": "Vanuatu",
"WF": "Wallis & Futuna",
"WS": "Samoa",
"YE": "Yemen",
"YT": "Mayotte",
"ZA": "South Africa",
"ZM": "Zambia",
"ZW": "Zimbabwe"
}
},
"company_no": {
"type": "string",
"example": "12345678"
},
"parent_id": {
"type": [
"string",
"null"
]
},
"signer": {
"$ref": "#/components/schemas/CreateCompanySignerData"
}
},
"required": [
"name",
"country",
"company_no",
"signer"
],
"title": "CreateCompanyPayload"
},
"CreateCompanyRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"country": {
"$ref": "#/components/schemas/Country"
},
"company_no": {
"type": "string",
"maxLength": 255
},
"parent_id": {
"type": [
"string",
"null"
]
},
"signer": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 255
},
"last_name": {
"type": "string",
"maxLength": 255
},
"title": {
"type": "string",
"maxLength": 255
}
},
"required": [
"first_name",
"last_name",
"title"
]
}
},
"required": [
"name",
"country",
"company_no",
"signer"
],
"title": "CreateCompanyRequest"
},
"CreateCompanySignerData": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "Ada"
},
"last_name": {
"type": "string",
"example": "Lovelace"
},
"title": {
"type": "string",
"example": "CEO"
}
},
"required": [
"first_name",
"last_name",
"title"
],
"title": "CreateCompanySignerData"
},
"Currency": {
"type": "string",
"enum": [
"AUD",
"BGN",
"BRL",
"CAD",
"CHF",
"CNY",
"CZK",
"DKK",
"EUR",
"GBP",
"HKD",
"HUF",
"IDR",
"ILS",
"INR",
"ISK",
"JPY",
"KRW",
"MMK",
"MXN",
"MYR",
"NOK",
"NZD",
"PHP",
"PLN",
"RON",
"RUB",
"SEK",
"SGD",
"THB",
"TRY",
"USD",
"ZAR"
],
"example": "AUD",
"x-enumDescriptions": {
"AUD": "AUD",
"BGN": "BGN",
"BRL": "BRL",
"CAD": "CAD",
"CHF": "CHF",
"CNY": "CNY",
"CZK": "CZK",
"DKK": "DKK",
"EUR": "EUR",
"GBP": "GBP",
"HKD": "HKD",
"HUF": "HUF",
"IDR": "IDR",
"ILS": "ILS",
"INR": "INR",
"ISK": "ISK",
"JPY": "JPY",
"KRW": "KRW",
"MMK": "MMK",
"MXN": "MXN",
"MYR": "MYR",
"NOK": "NOK",
"NZD": "NZD",
"PHP": "PHP",
"PLN": "PLN",
"RON": "RON",
"RUB": "RUB",
"SEK": "SEK",
"SGD": "SGD",
"THB": "THB",
"TRY": "TRY",
"USD": "USD",
"ZAR": "ZAR"
},
"title": "Currency"
},
"Direction": {
"type": "string",
"enum": [
"Send",
"Receive"
],
"example": "Send",
"x-enumDescriptions": {
"Send": "You are sending this document",
"Receive": "You are receiving this document"
},
"title": "Direction"
},
"DocumentDetailsCompany": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "DocumentDetailsCompany"
},
"DocumentDetailsResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"description": "The latest delivery status for the document",
"allOf": [
{
"$ref": "#/components/schemas/DocumentStatus"
}
]
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"mode": {
"$ref": "#/components/schemas/Mode"
},
"direction": {
"$ref": "#/components/schemas/Direction"
},
"type": {
"$ref": "#/components/schemas/DocumentType"
},
"submission_format": {
"$ref": "#/components/schemas/SubmissionFormat"
},
"sender": {
"$ref": "#/components/schemas/ParticipantIdentifier"
},
"recipient": {
"$ref": "#/components/schemas/ParticipantIdentifier"
},
"e2e_message_uuid": {
"type": [
"string",
"null"
],
"description": "End-to-end identifier of the message that contains the document"
},
"company": {
"description": "The company associated with the document - either as a sender or recipient",
"$ref": "#/components/schemas/DocumentDetailsCompany"
}
},
"required": [
"id",
"status",
"channel",
"mode",
"direction",
"type",
"submission_format",
"sender",
"recipient",
"e2e_message_uuid",
"company"
],
"title": "DocumentDetailsResponse"
},
"DocumentListItemResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/DocumentStatus"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"direction": {
"$ref": "#/components/schemas/Direction"
},
"type": {
"$ref": "#/components/schemas/DocumentType"
},
"created_at": {
"type": "string"
},
"company": {
"anyOf": [
{
"$ref": "#/components/schemas/DocumentDetailsCompany"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"channel",
"direction",
"type",
"created_at",
"company"
],
"title": "DocumentListItemResponse"
},
"DocumentStatus": {
"type": "string",
"enum": [
"Pending",
"Ready",
"Delivered",
"Failed"
],
"example": "Pending",
"x-enumDescriptions": {
"Pending": "Document is pending to be delivered.",
"Ready": "Document has been received into eCourier, but not yet marked as delivered by the recipient.",
"Delivered": "Document has been delivered to the recipient.",
"Failed": "Delivery has failed."
},
"title": "DocumentStatus"
},
"DocumentType": {
"type": "string",
"enum": [
"ApplicationResponse",
"CreditNote",
"Invoice",
"Other"
],
"example": "ApplicationResponse",
"title": "DocumentType"
},
"IdentifierScheme": {
"type": "string",
"enum": [
"DUNS",
"EU:NAL",
"EU:REID",
"EU:VAT",
"GLN",
"GS1",
"IBAN",
"LEI",
"SPIS",
"UBLBE",
"AD:VAT",
"AE:TIN",
"AL:VAT",
"AT:CID",
"AT:GOV",
"AT:KUR",
"AT:VAT",
"AU:ABN",
"BA:VAT",
"BE:EN",
"BE:VAT",
"BG:VAT",
"CH:UIDB",
"CH:VAT",
"CY:VAT",
"CZ:VAT",
"DE:GEBA",
"DE:LWID",
"DE:VAT",
"DK:CVR",
"DK:P",
"DK:SE",
"EE:CC",
"EE:VAT",
"ES:VAT",
"FI:OVT2",
"FR:CTC",
"FR:SIRENE",
"FR:SIRET",
"FR:VAT",
"GB:VAT",
"GR:VAT",
"HR:VAT",
"HU:VAT",
"IE:VAT",
"IS:KT",
"IS:KTNR",
"IT:CFI",
"IT:COD",
"IT:CUUO",
"IT:FTI",
"IT:SECETI",
"IT:SIA",
"IT:IVA",
"JP:IIN",
"JP:SST",
"LI:VAT",
"LT:LEC",
"LT:VAT",
"LU:MAT",
"LU:VAT",
"LV:URN",
"LV:VAT",
"MC:VAT",
"ME:VAT",
"MK:VAT",
"MT:VAT",
"MY:EIF",
"NG:TID",
"NL:KVK",
"NL:OINO",
"NL:VAT",
"NO:ORG",
"NO:VAT",
"OM:VAT",
"PL:VAT",
"PT:VAT",
"RO:VAT",
"RS:VAT",
"SE:ORGNR",
"SG:UEN",
"SI:VAT",
"SK:DIC",
"SK:VAT",
"SM:VAT",
"TR:VAT",
"US:EIN",
"VA:VAT"
],
"example": "DUNS",
"x-enumDescriptions": {
"DUNS": "Data Universal Numbering System (D-U-N-S Number) (ICD 0060)",
"EU:NAL": "Directorates of the European Commission (ICD 0130)",
"EU:REID": "Business Registers Network (ICD 9913)",
"EU:VAT": "National ministries of Economy VAT number (ICD 9912)",
"GLN": "Global Location Number (ICD 0088)",
"GS1": "GS1 identification keys (ICD 0209)",
"IBAN": "International Bank Account Number (ICD 9918)",
"LEI": "Legal Entity Identifier (ICD 0199)",
"SPIS": "OpenPeppol Service Provider Identification Scheme (ICD 0242)",
"UBLBE": "UBL.BE Party Identifier (ICD 0193)",
"AD:VAT": "Andorra VAT number (ICD 9922)",
"AE:TIN": "UAE Tax Identification Number (ICD 0235)",
"AL:VAT": "Albania VAT number (ICD 9923)",
"AT:CID": "Firmenidentifikationsnummer der Statistik Austria (ICD 9916)",
"AT:GOV": "Austrian government number (ICD 9915)",
"AT:KUR": "Kennziffer des Unternehmensregisters (ICD 9919)",
"AT:VAT": "Austrian VAT number (ICD 9914)",
"AU:ABN": "Australian Business Number (ICD 0151)",
"BA:VAT": "Bosnia and Herzegovina VAT number (ICD 9924)",
"BE:EN": "Numero d'entreprise / ondernemingsnummer / Unternehmensnummer (ICD 0208)",
"BE:VAT": "Belgian VAT number (ICD 9925)",
"BG:VAT": "Bulgaria VAT number (ICD 9926)",
"CH:UIDB": "Swiss Unique Business Identification Number (ICD 0183)",
"CH:VAT": "Switzerland VAT number (ICD 9927)",
"CY:VAT": "Cyprus VAT number (ICD 9928)",
"CZ:VAT": "Czech Republic VAT number (ICD 9929)",
"DE:GEBA": "German Electronic Business Address (ICD 0246)",
"DE:LWID": "Peppol-Leitweg-ID (ICD 0204)",
"DE:VAT": "German VAT number (ICD 9930)",
"DK:CVR": "The Danish Business Authority - CVR-number (ICD 0184)",
"DK:P": "The Danish Business Authority - P-number (ICD 0096)",
"DK:SE": "The Danish Business Authority - SE-number (ICD 0198)",
"EE:CC": "Company code (ICD 0191)",
"EE:VAT": "Estonia VAT number (ICD 9931)",
"ES:VAT": "Spain VAT number (ICD 9920)",
"FI:OVT2": "OVTcode (ICD 0216)",
"FR:CTC": "FRCTC Electronic Address (ICD 0225)",
"FR:SIRENE": "System Information et Repertoire des Entreprise et des Etablissements: SIRENE (ICD 0002)",
"FR:SIRET": "SIRET-CODE (ICD 0009)",
"FR:VAT": "French VAT number (ICD 9957)",
"GB:VAT": "United Kingdom VAT number (ICD 9932)",
"GR:VAT": "Greece VAT number (ICD 9933)",
"HR:VAT": "Croatia VAT number (ICD 9934)",
"HU:VAT": "Hungary VAT number (ICD 9910)",
"IE:VAT": "Ireland VAT number (ICD 9935)",
"IS:KT": "Icelandic National Registry (ICD 9917)",
"IS:KTNR": "Icelandic identifier (ICD 0196)",
"IT:CFI": "CODICE FISCALE (ICD 0210)",
"IT:COD": "CODDEST (ICD 0205)",
"IT:CUUO": "Codice Univoco Unita Organizzativa iPA (ICD 0201)",
"IT:FTI": "FTI - Ediforum Italia (ICD 0097)",
"IT:SECETI": "SECETI Object Identifiers (ICD 0142)",
"IT:SIA": "SIA Object Identifiers (ICD 0135)",
"IT:IVA": "PARTITA IVA (ICD 0211)",
"JP:IIN": "The registered number of the qualified invoice issuer (ICD 0221)",
"JP:SST": "Corporate Number of The Social Security and Tax Number System (ICD 0188)",
"LI:VAT": "Liechtenstein VAT number (ICD 9936)",
"LT:LEC": "Legal entity code (ICD 0200)",
"LT:VAT": "Lithuania VAT number (ICD 9937)",
"LU:MAT": "Register of legal persons (ICD 0240)",
"LU:VAT": "Luxemburg VAT number (ICD 9938)",
"LV:URN": "Unified registration number (ICD 0218)",
"LV:VAT": "Latvia VAT number (ICD 9939)",
"MC:VAT": "Monaco VAT number (ICD 9940)",
"ME:VAT": "Montenegro VAT number (ICD 9941)",
"MK:VAT": "North Macedonia VAT number (ICD 9942)",
"MT:VAT": "Malta VAT number (ICD 9943)",
"MY:EIF": "National e-Invoicing Framework (ICD 0230)",
"NG:TID": "Tax Identification (ICD 0244)",
"NL:KVK": "Vereniging van Kamers van Koophandel en Fabrieken in Nederland Scheme (ICD 0106)",
"NL:OINO": "Organisatie-identificatienummer (ICD 0190)",
"NL:VAT": "Netherlands VAT number (ICD 9944)",
"NO:ORG": "Organisasjonsnummer (ICD 0192)",
"NO:VAT": "Norwegian VAT number (ICD 9909)",
"OM:VAT": "Oman Value Added Tax Identification Number (VATIN) (ICD 0248)",
"PL:VAT": "Poland VAT number (ICD 9945)",
"PT:VAT": "Portugal VAT number (ICD 9946)",
"RO:VAT": "Romania VAT number (ICD 9947)",
"RS:VAT": "Serbia VAT number (ICD 9948)",
"SE:ORGNR": "Organisationsnummer (ICD 0007)",
"SG:UEN": "Singapore Nationwide E-Invoice Framework (ICD 0195)",
"SI:VAT": "Slovenia VAT number (ICD 9949)",
"SK:DIC": "Tax identification number (ICD 0245)",
"SK:VAT": "Slovakia VAT number (ICD 9950)",
"SM:VAT": "San Marino VAT number (ICD 9951)",
"TR:VAT": "Turkey VAT number (ICD 9952)",
"US:EIN": "US Employer ID Number (ICD 9959)",
"VA:VAT": "Holy See (Vatican City State) VAT number (ICD 9953)"
},
"title": "IdentifierScheme"
},
"InvoiceContactData": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "Contact name",
"example": "Jane Doe"
},
"email": {
"type": [
"string",
"null"
],
"description": "Contact email",
"example": "ap@company.example"
},
"phone": {
"type": [
"string",
"null"
],
"description": "Contact phone",
"example": "+45 12 34 56 78"
}
},
"title": "InvoiceContactData"
},
"InvoiceDocumentData": {
"type": "object",
"description": "Canonical invoice/credit note document.",
"properties": {
"type": {
"type": "string",
"description": "Document type",
"enum": [
"ApplicationResponse",
"CreditNote",
"Invoice",
"Other"
],
"example": "Invoice"
},
"id": {
"type": "string",
"description": "Invoice or credit note number",
"example": "INV-300"
},
"uuid": {
"type": [
"string",
"null"
],
"description": "UUID to ensure idempotency on the client side",
"example": "550e8400-e29b-41d4-a716-446655440003"
},
"issue_date": {
"type": "string",
"description": "Issue date (YYYY-MM-DD)",
"example": "2026-04-16"
},
"due_date": {
"type": [
"string",
"null"
],
"description": "Due date (YYYY-MM-DD)",
"example": "2026-05-16"
},
"order_reference": {
"type": [
"string",
"null"
],
"description": "Order reference (typically the buyer's purchase order number)",
"example": "PO-12345"
},
"currency": {
"type": "string",
"description": "Document currency",
"enum": [
"AUD",
"BGN",
"BRL",
"CAD",
"CHF",
"CNY",
"CZK",
"DKK",
"EUR",
"GBP",
"HKD",
"HUF",
"IDR",
"ILS",
"INR",
"ISK",
"JPY",
"KRW",
"MMK",
"MXN",
"MYR",
"NOK",
"NZD",
"PHP",
"PLN",
"RON",
"RUB",
"SEK",
"SGD",
"THB",
"TRY",
"USD",
"ZAR"
],
"example": "DKK",
"x-enumDescriptions": {
"AUD": "AUD",
"BGN": "BGN",
"BRL": "BRL",
"CAD": "CAD",
"CHF": "CHF",
"CNY": "CNY",
"CZK": "CZK",
"DKK": "DKK",
"EUR": "EUR",
"GBP": "GBP",
"HKD": "HKD",
"HUF": "HUF",
"IDR": "IDR",
"ILS": "ILS",
"INR": "INR",
"ISK": "ISK",
"JPY": "JPY",
"KRW": "KRW",
"MMK": "MMK",
"MXN": "MXN",
"MYR": "MYR",
"NOK": "NOK",
"NZD": "NZD",
"PHP": "PHP",
"PLN": "PLN",
"RON": "RON",
"RUB": "RUB",
"SEK": "SEK",
"SGD": "SGD",
"THB": "THB",
"TRY": "TRY",
"USD": "USD",
"ZAR": "ZAR"
}
},
"supplier": {
"description": "Seller/supplier party",
"$ref": "#/components/schemas/InvoicePartyData"
},
"customer": {
"description": "Buyer/customer party",
"$ref": "#/components/schemas/InvoicePartyData"
},
"lines": {
"type": "array",
"description": "Invoice lines",
"items": {
"$ref": "#/components/schemas/InvoiceLineData"
}
},
"payment": {
"description": "Payment information",
"$ref": "#/components/schemas/InvoicePaymentData"
},
"totals": {
"description": "Totals for control/validation",
"$ref": "#/components/schemas/InvoiceTotalsData"
}
},
"required": [
"type",
"id",
"issue_date",
"currency",
"supplier",
"customer",
"lines",
"totals"
],
"title": "InvoiceDocumentData"
},
"InvoiceLineData": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Line identifier",
"example": 1
},
"name": {
"type": [
"string",
"null"
],
"description": "Line item name",
"example": "Consulting"
},
"description": {
"type": [
"string",
"null"
],
"description": "Line item description",
"example": "Consulting services"
},
"quantity": {
"type": [
"string",
"null"
],
"description": "Quantity (decimal as string)",
"example": "1"
},
"unit_code": {
"type": "string",
"description": "UN/ECE unit code",
"example": "C62",
"default": "C62"
},
"unit_price": {
"type": [
"string",
"null"
],
"description": "Unit price (excl. tax) in document currency (decimal as string)",
"example": "100.00"
},
"line_total": {
"type": [
"string",
"null"
],
"description": "Line total (excl. tax) in document currency (decimal as string)",
"example": "100.00"
},
"tax_category": {
"anyOf": [
{
"description": "Tax category",
"$ref": "#/components/schemas/InvoiceTaxCategoryData"
},
{
"type": "null"
}
]
},
"item_id": {
"type": [
"string",
"null"
],
"description": "Standard item identifier",
"example": "SKU-1"
},
"sellers_item_id": {
"type": [
"string",
"null"
],
"description": "Seller's item identifier",
"example": "SUP-1"
},
"buyers_item_id": {
"type": [
"string",
"null"
],
"description": "Buyer's item identifier",
"example": "BUY-1"
}
},
"required": [
"id"
],
"title": "InvoiceLineData"
},
"InvoicePartyData": {
"type": "object",
"properties": {
"participant": {
"description": "Participant identifier used for network addressing (sender/recipient)",
"$ref": "#/components/schemas/ParticipantIdentifierRequest"
},
"name": {
"type": [
"string",
"null"
],
"description": "Legal name",
"example": "Company A/S"
},
"registration_number": {
"type": [
"string",
"null"
],
"description": "Company registration number",
"example": "12345678"
},
"vat_id": {
"type": [
"string",
"null"
],
"description": "VAT identifier",
"example": "DK12345678"
},
"simplified_address": {
"anyOf": [
{
"description": "Simplified address",
"$ref": "#/components/schemas/SimplifiedAddressData"
},
{
"type": "null"
}
]
},
"contact": {
"anyOf": [
{
"description": "Contact person",
"$ref": "#/components/schemas/InvoiceContactData"
},
{
"type": "null"
}
]
}
},
"required": [
"participant"
],
"title": "InvoicePartyData"
},
"InvoicePaymentAccountData": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Account identifier (e.g. IBAN, BBAN)",
"example": "DK12341234567890"
},
"scheme": {
"type": "string",
"description": "Account scheme identifier",
"enum": [
"IBAN",
"DK:BBAN"
],
"example": "IBAN"
},
"bank_id": {
"type": [
"string",
"null"
],
"description": "Bank identifier",
"example": "DABADKKK"
},
"bank_name": {
"type": [
"string",
"null"
],
"description": "Bank name",
"example": "Example Bank"
}
},
"required": [
"id",
"scheme"
],
"title": "InvoicePaymentAccountData"
},
"InvoicePaymentData": {
"type": "object",
"properties": {
"payment_means": {
"type": [
"array",
"null"
],
"description": "Payment means entries (bank transfer, FIK/Giro, etc.)",
"items": {
"$ref": "#/components/schemas/InvoicePaymentMeansData"
}
},
"payment_terms_note": {
"type": [
"string",
"null"
],
"description": "Payment terms note"
}
},
"title": "InvoicePaymentData"
},
"InvoicePaymentMeansData": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
],
"description": "Payment means identifier (sequence number)",
"example": 1
},
"code": {
"type": "string",
"description": "Payment means code (UNCL 4461 / Peppol)",
"enum": [
"30",
"31",
"42"
],
"example": 30,
"x-enumDescriptions": {
"30": "UNCL4461: Credit transfer. Use this for IBAN transfers.",
"31": "UNCL4461: Debit transfer. Rare for invoicing; only use if your payment flow requires it.",
"42": "UNCL4461: Payment to bank account. In our API this is the recommended code for DK BBAN payments."
}
},
"remittance_text": {
"type": [
"string",
"null"
],
"description": "Remittance information / payment reference text",
"example": "REF-1"
},
"instruction": {
"type": [
"string",
"null"
],
"description": "Additional payment instruction",
"example": "Use the invoice number as a reference"
},
"account": {
"anyOf": [
{
"description": "Payee account details",
"$ref": "#/components/schemas/InvoicePaymentAccountData"
},
{
"type": "null"
}
]
}
},
"required": [
"code"
],
"title": "InvoicePaymentMeansData"
},
"InvoiceTaxCategoryData": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Tax category code (UNCL 5305)",
"enum": [
"S",
"AA",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"example": "S"
},
"percent": {
"type": [
"string",
"null"
],
"description": "VAT rate percentage (decimal as string)",
"example": "25.00"
},
"exemption_reason": {
"type": [
"string",
"null"
],
"description": "Exemption reason",
"example": null
}
},
"required": [
"code"
],
"title": "InvoiceTaxCategoryData"
},
"InvoiceTotalsData": {
"type": "object",
"properties": {
"subtotal_amount": {
"type": "string",
"description": "Subtotal amount (line extension total) in document currency",
"example": "100.00"
},
"tax_amount": {
"type": "string",
"description": "Total tax amount in document currency",
"example": "25.00"
},
"total_amount": {
"type": "string",
"description": "Grand total amount (tax inclusive) in document currency",
"example": "125.00"
}
},
"required": [
"subtotal_amount",
"tax_amount",
"total_amount"
],
"title": "InvoiceTotalsData"
},
"Mode": {
"type": "string",
"enum": [
"Live",
"Test"
],
"example": "Live",
"x-enumDescriptions": {
"Live": "Documents are sent to real recipients.",
"Test": "Documents are still sent, but only in the test version of the selected channel."
},
"title": "Mode"
},
"ParticipantIdentifier": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"description": "The scheme of the identifier",
"enum": [
"DUNS",
"EU:NAL",
"EU:REID",
"EU:VAT",
"GLN",
"GS1",
"IBAN",
"LEI",
"SPIS",
"UBLBE",
"AD:VAT",
"AE:TIN",
"AL:VAT",
"AT:CID",
"AT:GOV",
"AT:KUR",
"AT:VAT",
"AU:ABN",
"BA:VAT",
"BE:EN",
"BE:VAT",
"BG:VAT",
"CH:UIDB",
"CH:VAT",
"CY:VAT",
"CZ:VAT",
"DE:GEBA",
"DE:LWID",
"DE:VAT",
"DK:CVR",
"DK:P",
"DK:SE",
"EE:CC",
"EE:VAT",
"ES:VAT",
"FI:OVT2",
"FR:CTC",
"FR:SIRENE",
"FR:SIRET",
"FR:VAT",
"GB:VAT",
"GR:VAT",
"HR:VAT",
"HU:VAT",
"IE:VAT",
"IS:KT",
"IS:KTNR",
"IT:CFI",
"IT:COD",
"IT:CUUO",
"IT:FTI",
"IT:SECETI",
"IT:SIA",
"IT:IVA",
"JP:IIN",
"JP:SST",
"LI:VAT",
"LT:LEC",
"LT:VAT",
"LU:MAT",
"LU:VAT",
"LV:URN",
"LV:VAT",
"MC:VAT",
"ME:VAT",
"MK:VAT",
"MT:VAT",
"MY:EIF",
"NG:TID",
"NL:KVK",
"NL:OINO",
"NL:VAT",
"NO:ORG",
"NO:VAT",
"OM:VAT",
"PL:VAT",
"PT:VAT",
"RO:VAT",
"RS:VAT",
"SE:ORGNR",
"SG:UEN",
"SI:VAT",
"SK:DIC",
"SK:VAT",
"SM:VAT",
"TR:VAT",
"US:EIN",
"VA:VAT"
],
"example": "DK:CVR",
"x-enumDescriptions": {
"DUNS": "Data Universal Numbering System (D-U-N-S Number) (ICD 0060)",
"EU:NAL": "Directorates of the European Commission (ICD 0130)",
"EU:REID": "Business Registers Network (ICD 9913)",
"EU:VAT": "National ministries of Economy VAT number (ICD 9912)",
"GLN": "Global Location Number (ICD 0088)",
"GS1": "GS1 identification keys (ICD 0209)",
"IBAN": "International Bank Account Number (ICD 9918)",
"LEI": "Legal Entity Identifier (ICD 0199)",
"SPIS": "OpenPeppol Service Provider Identification Scheme (ICD 0242)",
"UBLBE": "UBL.BE Party Identifier (ICD 0193)",
"AD:VAT": "Andorra VAT number (ICD 9922)",
"AE:TIN": "UAE Tax Identification Number (ICD 0235)",
"AL:VAT": "Albania VAT number (ICD 9923)",
"AT:CID": "Firmenidentifikationsnummer der Statistik Austria (ICD 9916)",
"AT:GOV": "Austrian government number (ICD 9915)",
"AT:KUR": "Kennziffer des Unternehmensregisters (ICD 9919)",
"AT:VAT": "Austrian VAT number (ICD 9914)",
"AU:ABN": "Australian Business Number (ICD 0151)",
"BA:VAT": "Bosnia and Herzegovina VAT number (ICD 9924)",
"BE:EN": "Numero d'entreprise / ondernemingsnummer / Unternehmensnummer (ICD 0208)",
"BE:VAT": "Belgian VAT number (ICD 9925)",
"BG:VAT": "Bulgaria VAT number (ICD 9926)",
"CH:UIDB": "Swiss Unique Business Identification Number (ICD 0183)",
"CH:VAT": "Switzerland VAT number (ICD 9927)",
"CY:VAT": "Cyprus VAT number (ICD 9928)",
"CZ:VAT": "Czech Republic VAT number (ICD 9929)",
"DE:GEBA": "German Electronic Business Address (ICD 0246)",
"DE:LWID": "Peppol-Leitweg-ID (ICD 0204)",
"DE:VAT": "German VAT number (ICD 9930)",
"DK:CVR": "The Danish Business Authority - CVR-number (ICD 0184)",
"DK:P": "The Danish Business Authority - P-number (ICD 0096)",
"DK:SE": "The Danish Business Authority - SE-number (ICD 0198)",
"EE:CC": "Company code (ICD 0191)",
"EE:VAT": "Estonia VAT number (ICD 9931)",
"ES:VAT": "Spain VAT number (ICD 9920)",
"FI:OVT2": "OVTcode (ICD 0216)",
"FR:CTC": "FRCTC Electronic Address (ICD 0225)",
"FR:SIRENE": "System Information et Repertoire des Entreprise et des Etablissements: SIRENE (ICD 0002)",
"FR:SIRET": "SIRET-CODE (ICD 0009)",
"FR:VAT": "French VAT number (ICD 9957)",
"GB:VAT": "United Kingdom VAT number (ICD 9932)",
"GR:VAT": "Greece VAT number (ICD 9933)",
"HR:VAT": "Croatia VAT number (ICD 9934)",
"HU:VAT": "Hungary VAT number (ICD 9910)",
"IE:VAT": "Ireland VAT number (ICD 9935)",
"IS:KT": "Icelandic National Registry (ICD 9917)",
"IS:KTNR": "Icelandic identifier (ICD 0196)",
"IT:CFI": "CODICE FISCALE (ICD 0210)",
"IT:COD": "CODDEST (ICD 0205)",
"IT:CUUO": "Codice Univoco Unita Organizzativa iPA (ICD 0201)",
"IT:FTI": "FTI - Ediforum Italia (ICD 0097)",
"IT:SECETI": "SECETI Object Identifiers (ICD 0142)",
"IT:SIA": "SIA Object Identifiers (ICD 0135)",
"IT:IVA": "PARTITA IVA (ICD 0211)",
"JP:IIN": "The registered number of the qualified invoice issuer (ICD 0221)",
"JP:SST": "Corporate Number of The Social Security and Tax Number System (ICD 0188)",
"LI:VAT": "Liechtenstein VAT number (ICD 9936)",
"LT:LEC": "Legal entity code (ICD 0200)",
"LT:VAT": "Lithuania VAT number (ICD 9937)",
"LU:MAT": "Register of legal persons (ICD 0240)",
"LU:VAT": "Luxemburg VAT number (ICD 9938)",
"LV:URN": "Unified registration number (ICD 0218)",
"LV:VAT": "Latvia VAT number (ICD 9939)",
"MC:VAT": "Monaco VAT number (ICD 9940)",
"ME:VAT": "Montenegro VAT number (ICD 9941)",
"MK:VAT": "North Macedonia VAT number (ICD 9942)",
"MT:VAT": "Malta VAT number (ICD 9943)",
"MY:EIF": "National e-Invoicing Framework (ICD 0230)",
"NG:TID": "Tax Identification (ICD 0244)",
"NL:KVK": "Vereniging van Kamers van Koophandel en Fabrieken in Nederland Scheme (ICD 0106)",
"NL:OINO": "Organisatie-identificatienummer (ICD 0190)",
"NL:VAT": "Netherlands VAT number (ICD 9944)",
"NO:ORG": "Organisasjonsnummer (ICD 0192)",
"NO:VAT": "Norwegian VAT number (ICD 9909)",
"OM:VAT": "Oman Value Added Tax Identification Number (VATIN) (ICD 0248)",
"PL:VAT": "Poland VAT number (ICD 9945)",
"PT:VAT": "Portugal VAT number (ICD 9946)",
"RO:VAT": "Romania VAT number (ICD 9947)",
"RS:VAT": "Serbia VAT number (ICD 9948)",
"SE:ORGNR": "Organisationsnummer (ICD 0007)",
"SG:UEN": "Singapore Nationwide E-Invoice Framework (ICD 0195)",
"SI:VAT": "Slovenia VAT number (ICD 9949)",
"SK:DIC": "Tax identification number (ICD 0245)",
"SK:VAT": "Slovakia VAT number (ICD 9950)",
"SM:VAT": "San Marino VAT number (ICD 9951)",
"TR:VAT": "Turkey VAT number (ICD 9952)",
"US:EIN": "US Employer ID Number (ICD 9959)",
"VA:VAT": "Holy See (Vatican City State) VAT number (ICD 9953)"
}
},
"id": {
"type": "string",
"description": "The identifier itself",
"example": "41412003"
}
},
"required": [
"scheme",
"id"
],
"title": "ParticipantIdentifier"
},
"ParticipantIdentifierRequest": {
"type": "object",
"properties": {
"scheme": {
"type": "string",
"description": "The scheme of the identifier",
"enum": [
"DUNS",
"EU:NAL",
"EU:REID",
"EU:VAT",
"GLN",
"GS1",
"IBAN",
"LEI",
"SPIS",
"UBLBE",
"AD:VAT",
"AE:TIN",
"AL:VAT",
"AT:CID",
"AT:GOV",
"AT:KUR",
"AT:VAT",
"AU:ABN",
"BA:VAT",
"BE:EN",
"BE:VAT",
"BG:VAT",
"CH:UIDB",
"CH:VAT",
"CY:VAT",
"CZ:VAT",
"DE:GEBA",
"DE:LWID",
"DE:VAT",
"DK:CVR",
"DK:P",
"DK:SE",
"EE:CC",
"EE:VAT",
"ES:VAT",
"FI:OVT2",
"FR:CTC",
"FR:SIRENE",
"FR:SIRET",
"FR:VAT",
"GB:VAT",
"GR:VAT",
"HR:VAT",
"HU:VAT",
"IE:VAT",
"IS:KT",
"IS:KTNR",
"IT:CFI",
"IT:COD",
"IT:CUUO",
"IT:FTI",
"IT:SECETI",
"IT:SIA",
"IT:IVA",
"JP:IIN",
"JP:SST",
"LI:VAT",
"LT:LEC",
"LT:VAT",
"LU:MAT",
"LU:VAT",
"LV:URN",
"LV:VAT",
"MC:VAT",
"ME:VAT",
"MK:VAT",
"MT:VAT",
"MY:EIF",
"NG:TID",
"NL:KVK",
"NL:OINO",
"NL:VAT",
"NO:ORG",
"NO:VAT",
"OM:VAT",
"PL:VAT",
"PT:VAT",
"RO:VAT",
"RS:VAT",
"SE:ORGNR",
"SG:UEN",
"SI:VAT",
"SK:DIC",
"SK:VAT",
"SM:VAT",
"TR:VAT",
"US:EIN",
"VA:VAT"
],
"example": "DK:CVR",
"x-enumDescriptions": {
"DUNS": "Data Universal Numbering System (D-U-N-S Number) (ICD 0060)",
"EU:NAL": "Directorates of the European Commission (ICD 0130)",
"EU:REID": "Business Registers Network (ICD 9913)",
"EU:VAT": "National ministries of Economy VAT number (ICD 9912)",
"GLN": "Global Location Number (ICD 0088)",
"GS1": "GS1 identification keys (ICD 0209)",
"IBAN": "International Bank Account Number (ICD 9918)",
"LEI": "Legal Entity Identifier (ICD 0199)",
"SPIS": "OpenPeppol Service Provider Identification Scheme (ICD 0242)",
"UBLBE": "UBL.BE Party Identifier (ICD 0193)",
"AD:VAT": "Andorra VAT number (ICD 9922)",
"AE:TIN": "UAE Tax Identification Number (ICD 0235)",
"AL:VAT": "Albania VAT number (ICD 9923)",
"AT:CID": "Firmenidentifikationsnummer der Statistik Austria (ICD 9916)",
"AT:GOV": "Austrian government number (ICD 9915)",
"AT:KUR": "Kennziffer des Unternehmensregisters (ICD 9919)",
"AT:VAT": "Austrian VAT number (ICD 9914)",
"AU:ABN": "Australian Business Number (ICD 0151)",
"BA:VAT": "Bosnia and Herzegovina VAT number (ICD 9924)",
"BE:EN": "Numero d'entreprise / ondernemingsnummer / Unternehmensnummer (ICD 0208)",
"BE:VAT": "Belgian VAT number (ICD 9925)",
"BG:VAT": "Bulgaria VAT number (ICD 9926)",
"CH:UIDB": "Swiss Unique Business Identification Number (ICD 0183)",
"CH:VAT": "Switzerland VAT number (ICD 9927)",
"CY:VAT": "Cyprus VAT number (ICD 9928)",
"CZ:VAT": "Czech Republic VAT number (ICD 9929)",
"DE:GEBA": "German Electronic Business Address (ICD 0246)",
"DE:LWID": "Peppol-Leitweg-ID (ICD 0204)",
"DE:VAT": "German VAT number (ICD 9930)",
"DK:CVR": "The Danish Business Authority - CVR-number (ICD 0184)",
"DK:P": "The Danish Business Authority - P-number (ICD 0096)",
"DK:SE": "The Danish Business Authority - SE-number (ICD 0198)",
"EE:CC": "Company code (ICD 0191)",
"EE:VAT": "Estonia VAT number (ICD 9931)",
"ES:VAT": "Spain VAT number (ICD 9920)",
"FI:OVT2": "OVTcode (ICD 0216)",
"FR:CTC": "FRCTC Electronic Address (ICD 0225)",
"FR:SIRENE": "System Information et Repertoire des Entreprise et des Etablissements: SIRENE (ICD 0002)",
"FR:SIRET": "SIRET-CODE (ICD 0009)",
"FR:VAT": "French VAT number (ICD 9957)",
"GB:VAT": "United Kingdom VAT number (ICD 9932)",
"GR:VAT": "Greece VAT number (ICD 9933)",
"HR:VAT": "Croatia VAT number (ICD 9934)",
"HU:VAT": "Hungary VAT number (ICD 9910)",
"IE:VAT": "Ireland VAT number (ICD 9935)",
"IS:KT": "Icelandic National Registry (ICD 9917)",
"IS:KTNR": "Icelandic identifier (ICD 0196)",
"IT:CFI": "CODICE FISCALE (ICD 0210)",
"IT:COD": "CODDEST (ICD 0205)",
"IT:CUUO": "Codice Univoco Unita Organizzativa iPA (ICD 0201)",
"IT:FTI": "FTI - Ediforum Italia (ICD 0097)",
"IT:SECETI": "SECETI Object Identifiers (ICD 0142)",
"IT:SIA": "SIA Object Identifiers (ICD 0135)",
"IT:IVA": "PARTITA IVA (ICD 0211)",
"JP:IIN": "The registered number of the qualified invoice issuer (ICD 0221)",
"JP:SST": "Corporate Number of The Social Security and Tax Number System (ICD 0188)",
"LI:VAT": "Liechtenstein VAT number (ICD 9936)",
"LT:LEC": "Legal entity code (ICD 0200)",
"LT:VAT": "Lithuania VAT number (ICD 9937)",
"LU:MAT": "Register of legal persons (ICD 0240)",
"LU:VAT": "Luxemburg VAT number (ICD 9938)",
"LV:URN": "Unified registration number (ICD 0218)",
"LV:VAT": "Latvia VAT number (ICD 9939)",
"MC:VAT": "Monaco VAT number (ICD 9940)",
"ME:VAT": "Montenegro VAT number (ICD 9941)",
"MK:VAT": "North Macedonia VAT number (ICD 9942)",
"MT:VAT": "Malta VAT number (ICD 9943)",
"MY:EIF": "National e-Invoicing Framework (ICD 0230)",
"NG:TID": "Tax Identification (ICD 0244)",
"NL:KVK": "Vereniging van Kamers van Koophandel en Fabrieken in Nederland Scheme (ICD 0106)",
"NL:OINO": "Organisatie-identificatienummer (ICD 0190)",
"NL:VAT": "Netherlands VAT number (ICD 9944)",
"NO:ORG": "Organisasjonsnummer (ICD 0192)",
"NO:VAT": "Norwegian VAT number (ICD 9909)",
"OM:VAT": "Oman Value Added Tax Identification Number (VATIN) (ICD 0248)",
"PL:VAT": "Poland VAT number (ICD 9945)",
"PT:VAT": "Portugal VAT number (ICD 9946)",
"RO:VAT": "Romania VAT number (ICD 9947)",
"RS:VAT": "Serbia VAT number (ICD 9948)",
"SE:ORGNR": "Organisationsnummer (ICD 0007)",
"SG:UEN": "Singapore Nationwide E-Invoice Framework (ICD 0195)",
"SI:VAT": "Slovenia VAT number (ICD 9949)",
"SK:DIC": "Tax identification number (ICD 0245)",
"SK:VAT": "Slovakia VAT number (ICD 9950)",
"SM:VAT": "San Marino VAT number (ICD 9951)",
"TR:VAT": "Turkey VAT number (ICD 9952)",
"US:EIN": "US Employer ID Number (ICD 9959)",
"VA:VAT": "Holy See (Vatican City State) VAT number (ICD 9953)"
}
},
"id": {
"type": "string",
"description": "The identifier itself",
"example": "41412003"
}
},
"required": [
"scheme",
"id"
],
"title": "ParticipantIdentifierRequest"
},
"ParticipantLookupResponse": {
"type": "object",
"properties": {
"channel": {
"$ref": "#/components/schemas/Channel"
},
"mode": {
"$ref": "#/components/schemas/Mode"
},
"entityName": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/Country"
},
"registrationDate": {
"type": "string"
},
"orgNo": {
"type": "string"
},
"registryUrl": {
"type": "string",
"description": "Link to the network's registry with details of the participant"
}
},
"required": [
"channel",
"mode",
"entityName",
"country",
"registrationDate",
"orgNo",
"registryUrl"
],
"title": "ParticipantLookupResponse"
},
"PaymentMeansCode": {
"type": "string",
"description": "Payment means codes based on UN/EDIFACT UNCL4461.\n",
"enum": [
"30",
"31",
"42"
],
"example": "30",
"x-enumDescriptions": {
"30": "UNCL4461: Credit transfer. Use this for IBAN transfers.",
"31": "UNCL4461: Debit transfer. Rare for invoicing; only use if your payment flow requires it.",
"42": "UNCL4461: Payment to bank account. In our API this is the recommended code for DK BBAN payments."
},
"title": "PaymentMeansCode"
},
"SendDocumentResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the document",
"example": "01kmkdaf55vrrecfy70180tpr6"
},
"e2e_message_uuid": {
"type": "string",
"description": "End-to-end identifier used for correlation across systems.\nThe message UUID is unique within the network and is automatically assigned by eCourier",
"example": "ddc3b3ef-cbd4-4630-9d65-896b3e1abc61"
}
},
"required": [
"id",
"e2e_message_uuid"
],
"title": "SendDocumentResponse"
},
"SendJsonPayload": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "The channel to send the document via",
"enum": [
"Peppol",
"NemHandel"
],
"example": "NemHandel",
"x-enumDescriptions": {
"Peppol": "PEPPOL is the global standard for electronic invoicing.",
"NemHandel": "NemHandel is only used in Denmark."
}
},
"document": {
"description": "The invoice or credit note document to send",
"$ref": "#/components/schemas/InvoiceDocumentData"
}
},
"required": [
"channel",
"document"
],
"title": "SendJsonPayload"
},
"SendJsonRequest": {
"type": "object",
"properties": {
"channel": {
"$ref": "#/components/schemas/Channel"
},
"document": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Invoice",
"CreditNote"
],
"example": "Invoice"
},
"id": {
"type": "string",
"maxLength": 30
},
"uuid": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"issue_date": {
"type": "string",
"format": "date"
},
"due_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"order_reference": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"supplier": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200
},
"registration_number": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"vat_id": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"simplified_address": {
"type": "object",
"properties": {
"street_name": {
"type": "string",
"maxLength": 200
},
"city": {
"type": "string",
"maxLength": 100
},
"postal_code": {
"type": "string",
"maxLength": 20
},
"country": {
"$ref": "#/components/schemas/Country"
}
},
"required": [
"street_name",
"city",
"postal_code",
"country"
]
},
"contact": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"maxLength": 200
},
"email": {
"type": [
"string",
"null"
],
"maxLength": 200
},
"phone": {
"type": [
"string",
"null"
],
"maxLength": 50
}
}
},
"participant": {
"type": "object",
"properties": {
"scheme": {
"$ref": "#/components/schemas/IdentifierScheme"
},
"id": {
"type": "string",
"maxLength": 50
}
},
"required": [
"scheme",
"id"
]
}
},
"required": [
"name",
"simplified_address",
"participant"
]
},
"customer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200
},
"registration_number": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"vat_id": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"simplified_address": {
"type": "object",
"properties": {
"street_name": {
"type": "string",
"maxLength": 200
},
"city": {
"type": "string",
"maxLength": 100
},
"postal_code": {
"type": "string",
"maxLength": 20
},
"country": {
"$ref": "#/components/schemas/Country"
}
},
"required": [
"street_name",
"city",
"postal_code",
"country"
]
},
"contact": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"maxLength": 200
},
"email": {
"type": [
"string",
"null"
],
"maxLength": 200
},
"phone": {
"type": [
"string",
"null"
],
"maxLength": 50
}
}
},
"participant": {
"type": "object",
"properties": {
"scheme": {
"$ref": "#/components/schemas/IdentifierScheme"
},
"id": {
"type": "string",
"maxLength": 50
}
},
"required": [
"scheme",
"id"
]
}
},
"required": [
"name",
"simplified_address",
"participant"
]
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 100
},
"quantity": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"unit_code": {
"type": [
"string",
"null"
],
"maxLength": 10
},
"unit_price": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"line_total": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"tax_category": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/TaxCategoryCode"
},
"percent": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"exemption_reason": {
"type": [
"string",
"null"
],
"maxLength": 500
}
}
}
},
"required": [
"id"
]
},
"minItems": 1
},
"totals": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"payment": {
"type": "object",
"properties": {
"payment_means": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"maximum": 100
},
"code": {
"$ref": "#/components/schemas/PaymentMeansCode"
},
"remittance_text": {
"type": [
"string",
"null"
],
"maxLength": 200
},
"instruction": {
"type": [
"string",
"null"
],
"maxLength": 500
},
"account": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"scheme": {
"$ref": "#/components/schemas/AccountSchemeId"
},
"bank_id": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"bank_name": {
"type": [
"string",
"null"
],
"maxLength": 200
}
}
}
}
}
}
}
}
},
"required": [
"type",
"id",
"issue_date",
"currency",
"supplier",
"customer",
"lines",
"totals"
]
}
},
"required": [
"channel",
"document"
],
"title": "SendJsonRequest"
},
"SimplifiedAddressData": {
"type": "object",
"properties": {
"street_name": {
"type": "string",
"description": "Street + number, or a single address line",
"example": "Jagtvej 123"
},
"city": {
"type": "string",
"description": "City",
"example": "Copenhagen N"
},
"postal_code": {
"type": "string",
"description": "Postal code",
"example": "2200"
},
"country": {
"type": "string",
"description": "Country (ISO 3166-1 alpha-2)",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"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",
"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",
"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",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"example": "DK",
"x-enumDescriptions": {
"AD": "Andorra",
"AE": "United Arab Emirates",
"AF": "Afghanistan",
"AG": "Antigua & Barbuda",
"AI": "Anguilla",
"AL": "Albania",
"AM": "Armenia",
"AO": "Angola",
"AQ": "Antarctica",
"AR": "Argentina",
"AS": "American Samoa",
"AT": "Austria",
"AU": "Australia",
"AW": "Aruba",
"AX": "\u00c5land Islands",
"AZ": "Azerbaijan",
"BA": "Bosnia & Herzegovina",
"BB": "Barbados",
"BD": "Bangladesh",
"BE": "Belgium",
"BF": "Burkina Faso",
"BG": "Bulgaria",
"BH": "Bahrain",
"BI": "Burundi",
"BJ": "Benin",
"BL": "St. Barth\u00e9lemy",
"BM": "Bermuda",
"BN": "Brunei",
"BO": "Bolivia",
"BQ": "Caribbean Netherlands",
"BR": "Brazil",
"BS": "Bahamas",
"BT": "Bhutan",
"BV": "Bouvet Island",
"BW": "Botswana",
"BY": "Belarus",
"BZ": "Belize",
"CA": "Canada",
"CC": "Cocos (Keeling) Islands",
"CD": "Congo - Kinshasa",
"CF": "Central African Republic",
"CG": "Congo - Brazzaville",
"CH": "Switzerland",
"CI": "C\u00f4te d\u2019Ivoire",
"CK": "Cook Islands",
"CL": "Chile",
"CM": "Cameroon",
"CN": "China",
"CO": "Colombia",
"CR": "Costa Rica",
"CU": "Cuba",
"CV": "Cape Verde",
"CW": "Cura\u00e7ao",
"CX": "Christmas Island",
"CY": "Cyprus",
"CZ": "Czechia",
"DE": "Germany",
"DJ": "Djibouti",
"DK": "Denmark",
"DM": "Dominica",
"DO": "Dominican Republic",
"DZ": "Algeria",
"EC": "Ecuador",
"EE": "Estonia",
"EG": "Egypt",
"EH": "Western Sahara",
"ER": "Eritrea",
"ES": "Spain",
"ET": "Ethiopia",
"FI": "Finland",
"FJ": "Fiji",
"FK": "Falkland Islands",
"FM": "Micronesia",
"FO": "Faroe Islands",
"FR": "France",
"GA": "Gabon",
"GB": "United Kingdom",
"GD": "Grenada",
"GE": "Georgia",
"GF": "French Guiana",
"GG": "Guernsey",
"GH": "Ghana",
"GI": "Gibraltar",
"GL": "Greenland",
"GM": "Gambia",
"GN": "Guinea",
"GP": "Guadeloupe",
"GQ": "Equatorial Guinea",
"GR": "Greece",
"GS": "South Georgia & South Sandwich Islands",
"GT": "Guatemala",
"GU": "Guam",
"GW": "Guinea-Bissau",
"GY": "Guyana",
"HK": "Hong Kong SAR China",
"HM": "Heard & McDonald Islands",
"HN": "Honduras",
"HR": "Croatia",
"HT": "Haiti",
"HU": "Hungary",
"ID": "Indonesia",
"IE": "Ireland",
"IL": "Israel",
"IM": "Isle of Man",
"IN": "India",
"IO": "British Indian Ocean Territory",
"IQ": "Iraq",
"IR": "Iran",
"IS": "Iceland",
"IT": "Italy",
"JE": "Jersey",
"JM": "Jamaica",
"JO": "Jordan",
"JP": "Japan",
"KE": "Kenya",
"KG": "Kyrgyzstan",
"KH": "Cambodia",
"KI": "Kiribati",
"KM": "Comoros",
"KN": "St. Kitts & Nevis",
"KP": "North Korea",
"KR": "South Korea",
"KW": "Kuwait",
"KY": "Cayman Islands",
"KZ": "Kazakhstan",
"LA": "Laos",
"LB": "Lebanon",
"LC": "St. Lucia",
"LI": "Liechtenstein",
"LK": "Sri Lanka",
"LR": "Liberia",
"LS": "Lesotho",
"LT": "Lithuania",
"LU": "Luxembourg",
"LV": "Latvia",
"LY": "Libya",
"MA": "Morocco",
"MC": "Monaco",
"MD": "Moldova",
"ME": "Montenegro",
"MF": "St. Martin",
"MG": "Madagascar",
"MH": "Marshall Islands",
"MK": "North Macedonia",
"ML": "Mali",
"MM": "Myanmar (Burma)",
"MN": "Mongolia",
"MO": "Macao SAR China",
"MP": "Northern Mariana Islands",
"MQ": "Martinique",
"MR": "Mauritania",
"MS": "Montserrat",
"MT": "Malta",
"MU": "Mauritius",
"MV": "Maldives",
"MW": "Malawi",
"MX": "Mexico",
"MY": "Malaysia",
"MZ": "Mozambique",
"NA": "Namibia",
"NC": "New Caledonia",
"NE": "Niger",
"NF": "Norfolk Island",
"NG": "Nigeria",
"NI": "Nicaragua",
"NL": "Netherlands",
"NO": "Norway",
"NP": "Nepal",
"NR": "Nauru",
"NU": "Niue",
"NZ": "New Zealand",
"OM": "Oman",
"PA": "Panama",
"PE": "Peru",
"PF": "French Polynesia",
"PG": "Papua New Guinea",
"PH": "Philippines",
"PK": "Pakistan",
"PL": "Poland",
"PM": "St. Pierre & Miquelon",
"PN": "Pitcairn Islands",
"PR": "Puerto Rico",
"PS": "Palestinian Territories",
"PT": "Portugal",
"PW": "Palau",
"PY": "Paraguay",
"QA": "Qatar",
"RE": "R\u00e9union",
"RO": "Romania",
"RS": "Serbia",
"RU": "Russia",
"RW": "Rwanda",
"SA": "Saudi Arabia",
"SB": "Solomon Islands",
"SC": "Seychelles",
"SD": "Sudan",
"SE": "Sweden",
"SG": "Singapore",
"SH": "St. Helena",
"SI": "Slovenia",
"SJ": "Svalbard & Jan Mayen",
"SK": "Slovakia",
"SL": "Sierra Leone",
"SM": "San Marino",
"SN": "Senegal",
"SO": "Somalia",
"SR": "Suriname",
"SS": "South Sudan",
"ST": "S\u00e3o Tom\u00e9 & Pr\u00edncipe",
"SV": "El Salvador",
"SX": "Sint Maarten",
"SY": "Syria",
"SZ": "Eswatini",
"TC": "Turks & Caicos Islands",
"TD": "Chad",
"TF": "French Southern Territories",
"TG": "Togo",
"TH": "Thailand",
"TJ": "Tajikistan",
"TK": "Tokelau",
"TL": "Timor-Leste",
"TM": "Turkmenistan",
"TN": "Tunisia",
"TO": "Tonga",
"TR": "Turkey",
"TT": "Trinidad & Tobago",
"TV": "Tuvalu",
"TW": "Taiwan",
"TZ": "Tanzania",
"UA": "Ukraine",
"UG": "Uganda",
"UM": "U.S. Outlying Islands",
"US": "United States",
"UY": "Uruguay",
"UZ": "Uzbekistan",
"VA": "Vatican City",
"VC": "St. Vincent & Grenadines",
"VE": "Venezuela",
"VG": "British Virgin Islands",
"VI": "U.S. Virgin Islands",
"VN": "Vietnam",
"VU": "Vanuatu",
"WF": "Wallis & Futuna",
"WS": "Samoa",
"YE": "Yemen",
"YT": "Mayotte",
"ZA": "South Africa",
"ZM": "Zambia",
"ZW": "Zimbabwe"
}
}
},
"required": [
"street_name",
"city",
"postal_code",
"country"
],
"title": "SimplifiedAddressData"
},
"SubmissionFormat": {
"type": "string",
"enum": [
"XML",
"GOBL",
"JSON"
],
"example": "XML",
"x-enumDescriptions": {
"XML": "This document was submitted as XML.",
"GOBL": "This document was submitted as GOBL.",
"JSON": "This document was submitted as JSON (canonical DTO) and converted to XML."
},
"title": "SubmissionFormat"
},
"TaxCategoryCode": {
"type": "string",
"description": "Tax category codes based on UN/EDIFACT UNCL5305 (Peppol BIS 3.0).\n",
"enum": [
"S",
"AA",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"example": "S",
"title": "TaxCategoryCode"
},
"UpdateCompanyPayload": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Acme Danmark A/S"
}
},
"required": [
"name"
],
"title": "UpdateCompanyPayload"
},
"UpdateCompanyRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
}
},
"required": [
"name"
],
"title": "UpdateCompanyRequest"
}
},
"responses": {
"AuthenticationException": {
"description": "Unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"ValidationException": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"ModelNotFoundException": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
}
}
}
}