{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/invoicexml-com/json-schema/invoicexml-com-create-order-request-schema.json", "title": "CreateOrderRequest", "description": "Envelope for the `/v1/create/cio` (Order-X Cross-Industry Order)\nendpoint. Orders reuse the BT-first InvoiceDocument model:\nparties, line items, references, and totals map one-to-one; the\norder-only semantics (type code, profile) live in the options.", "x-generated": "2026-10-30", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/invoicexml-com-openapi.json#/components/schemas/CreateOrderRequest", "required": [ "order" ], "type": "object", "properties": { "order": { "oneOf": [ { "type": "null" }, { "description": "The order document (BT-first model shared with the invoice endpoints).\nThe document number field carries the order number.", "$ref": "#/$defs/InvoiceDocument" } ] }, "options": { "description": "Optional processing settings. Defaults apply when omitted.", "$ref": "#/$defs/OrderOptions" } }, "$defs": { "AdditionalSupportingDocument": { "type": "object", "properties": { "reference": { "type": [ "null", "string" ] }, "schemeId": { "type": [ "null", "string" ] }, "documentTypeCode": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "externalUri": { "type": [ "null", "string" ] }, "attachment": { "type": [ "null", "string" ], "format": "byte" }, "attachmentMimeCode": { "type": [ "null", "string" ] }, "attachmentFilename": { "type": [ "null", "string" ] } } }, "BuyerContact": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "BuyerElectronicAddress": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "BuyerIdentifier": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "BuyerLegalRegistration": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "BuyerParty": { "required": [ "name", "postalAddress" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "tradingName": { "type": [ "null", "string" ] }, "postalAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/BuyerPostalAddress" } ] }, "contact": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/BuyerContact" } ] }, "identifiers": { "type": "array", "items": { "$ref": "#/$defs/BuyerIdentifier" } }, "legalRegistration": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/BuyerLegalRegistration" } ] }, "vatIdentifier": { "type": [ "null", "string" ] }, "electronicAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/BuyerElectronicAddress" } ] } } }, "BuyerPostalAddress": { "required": [ "country" ], "type": "object", "properties": { "line1": { "type": [ "null", "string" ] }, "line2": { "type": [ "null", "string" ] }, "line3": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postCode": { "type": [ "null", "string" ] }, "countrySubdivision": { "type": [ "null", "string" ] }, "country": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/CountryCode" } ] } } }, "CountryCode": { "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" ], "type": "string", "x-enum-varnames": [ "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" ], "x-enum-descriptions": [ "Andorra", "United Arab Emirates", "Afghanistan", "Antigua and Barbuda", "Anguilla", "Albania", "Armenia", "Angola", "Antarctica", "Argentina", "American Samoa", "Austria", "Australia", "Aruba", "Aland Islands", "Azerbaijan", "Bosnia and Herzegovina", "Barbados", "Bangladesh", "Belgium", "Burkina Faso", "Bulgaria", "Bahrain", "Burundi", "Benin", "Saint Barthelemy", "Bermuda", "Brunei Darussalam", "Bolivia", "Bonaire, Sint Eustatius and Saba", "Brazil", "Bahamas", "Bhutan", "Bouvet Island", "Botswana", "Belarus", "Belize", "Canada", "Cocos (Keeling) Islands", "Congo, Democratic Republic of the", "Central African Republic", "Congo", "Switzerland", "Cote d'Ivoire", "Cook Islands", "Chile", "Cameroon", "China", "Colombia", "Costa Rica", "Cuba", "Cabo Verde", "Curacao", "Christmas Island", "Cyprus", "Czechia", "Germany", "Djibouti", "Denmark", "Dominica", "Dominican Republic", "Algeria", "Ecuador", "Estonia", "Egypt", "Western Sahara", "Eritrea", "Spain", "Ethiopia", "Finland", "Fiji", "Falkland Islands (Malvinas)", "Micronesia, Federated States of", "Faroe Islands", "France", "Gabon", "United Kingdom", "Grenada", "Georgia", "French Guiana", "Guernsey", "Ghana", "Gibraltar", "Greenland", "Gambia", "Guinea", "Guadeloupe", "Equatorial Guinea", "Greece", "South Georgia and the South Sandwich Islands", "Guatemala", "Guam", "Guinea-Bissau", "Guyana", "Hong Kong", "Heard Island and McDonald Islands", "Honduras", "Croatia", "Haiti", "Hungary", "Indonesia", "Ireland", "Israel", "Isle of Man", "India", "British Indian Ocean Territory", "Iraq", "Iran", "Iceland", "Italy", "Jersey", "Jamaica", "Jordan", "Japan", "Kenya", "Kyrgyzstan", "Cambodia", "Kiribati", "Comoros", "Saint Kitts and Nevis", "Korea, Democratic People's Republic of", "Korea, Republic of", "Kuwait", "Cayman Islands", "Kazakhstan", "Lao People's Democratic Republic", "Lebanon", "Saint Lucia", "Liechtenstein", "Sri Lanka", "Liberia", "Lesotho", "Lithuania", "Luxembourg", "Latvia", "Libya", "Morocco", "Monaco", "Moldova", "Montenegro", "Saint Martin (French part)", "Madagascar", "Marshall Islands", "North Macedonia", "Mali", "Myanmar", "Mongolia", "Macao", "Northern Mariana Islands", "Martinique", "Mauritania", "Montserrat", "Malta", "Mauritius", "Maldives", "Malawi", "Mexico", "Malaysia", "Mozambique", "Namibia", "New Caledonia", "Niger", "Norfolk Island", "Nigeria", "Nicaragua", "Netherlands", "Norway", "Nepal", "Nauru", "Niue", "New Zealand", "Oman", "Panama", "Peru", "French Polynesia", "Papua New Guinea", "Philippines", "Pakistan", "Poland", "Saint Pierre and Miquelon", "Pitcairn", "Puerto Rico", "Palestine, State of", "Portugal", "Palau", "Paraguay", "Qatar", "Reunion", "Romania", "Serbia", "Russian Federation", "Rwanda", "Saudi Arabia", "Solomon Islands", "Seychelles", "Sudan", "Sweden", "Singapore", "Saint Helena, Ascension and Tristan da Cunha", "Slovenia", "Svalbard and Jan Mayen", "Slovakia", "Sierra Leone", "San Marino", "Senegal", "Somalia", "Suriname", "South Sudan", "Sao Tome and Principe", "El Salvador", "Sint Maarten (Dutch part)", "Syrian Arab Republic", "Eswatini", "Turks and Caicos Islands", "Chad", "French Southern Territories", "Togo", "Thailand", "Tajikistan", "Tokelau", "Timor-Leste", "Turkmenistan", "Tunisia", "Tonga", "Turkiye", "Trinidad and Tobago", "Tuvalu", "Taiwan, Province of China", "Tanzania, United Republic of", "Ukraine", "Uganda", "United States Minor Outlying Islands", "United States", "Uruguay", "Uzbekistan", "Holy See", "Saint Vincent and the Grenadines", "Venezuela", "Virgin Islands, British", "Virgin Islands, U.S.", "Viet Nam", "Vanuatu", "Wallis and Futuna", "Samoa", "Yemen", "Mayotte", "South Africa", "Zambia", "Zimbabwe" ] }, "CurrencyCode": { "enum": [ "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ], "type": "string", "x-enum-varnames": [ "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWG" ], "x-enum-descriptions": [ "Euro", "UAE dirham", "Afghan afghani", "Albanian lek", "Armenian dram", "Netherlands Antillean guilder", "Angolan kwanza", "Argentine peso", "Australian dollar", "Aruban florin", "Azerbaijani manat", "Bosnia and Herzegovina convertible mark", "Barbados dollar", "Bangladeshi taka", "Bulgarian lev", "Bahraini dinar", "Burundian franc", "Bermudian dollar", "Brunei dollar", "Boliviano", "Brazilian real", "Bahamian dollar", "Bhutanese ngultrum", "Botswana pula", "Belarusian ruble", "Belize dollar", "Canadian dollar", "Congolese franc", "Swiss franc", "Chilean peso", "Renminbi (Chinese yuan)", "Colombian peso", "Costa Rican colon", "Cuban peso", "Cape Verdean escudo", "Czech koruna", "Djiboutian franc", "Danish krone", "Dominican peso", "Algerian dinar", "Egyptian pound", "Eritrean nakfa", "Ethiopian birr", "Fiji dollar", "Falkland Islands pound", "Pound sterling", "Georgian lari", "Ghanaian cedi", "Gibraltar pound", "Gambian dalasi", "Guinean franc", "Guatemalan quetzal", "Guyanese dollar", "Hong Kong dollar", "Honduran lempira", "Haitian gourde", "Hungarian forint", "Indonesian rupiah", "Israeli new shekel", "Indian rupee", "Iraqi dinar", "Iranian rial", "Icelandic krona", "Jamaican dollar", "Jordanian dinar", "Japanese yen", "Kenyan shilling", "Kyrgyzstani som", "Cambodian riel", "Comoro franc", "North Korean won", "South Korean won", "Kuwaiti dinar", "Cayman Islands dollar", "Kazakhstani tenge", "Lao kip", "Lebanese pound", "Sri Lankan rupee", "Liberian dollar", "Lesotho loti", "Libyan dinar", "Moroccan dirham", "Moldovan leu", "Malagasy ariary", "Macedonian denar", "Myanmar kyat", "Mongolian togrog", "Macanese pataca", "Mauritanian ouguiya", "Mauritian rupee", "Maldivian rufiyaa", "Malawian kwacha", "Mexican peso", "Malaysian ringgit", "Mozambican metical", "Namibian dollar", "Nigerian naira", "Nicaraguan cordoba", "Norwegian krone", "Nepalese rupee", "New Zealand dollar", "Omani rial", "Panamanian balboa", "Peruvian sol", "Papua New Guinean kina", "Philippine peso", "Pakistani rupee", "Polish zloty", "Paraguayan guarani", "Qatari riyal", "Romanian leu", "Serbian dinar", "Russian ruble", "Rwandan franc", "Saudi riyal", "Solomon Islands dollar", "Seychelles rupee", "Sudanese pound", "Swedish krona", "Singapore dollar", "Saint Helena pound", "Sierra Leonean leone", "Somali shilling", "Surinamese dollar", "South Sudanese pound", "Sao Tome and Principe dobra", "Salvadoran colon", "Syrian pound", "Swazi lilangeni", "Thai baht", "Tajikistani somoni", "Turkmenistan manat", "Tunisian dinar", "Tongan pa'anga", "Turkish lira", "Trinidad and Tobago dollar", "New Taiwan dollar", "Tanzanian shilling", "Ukrainian hryvnia", "Ugandan shilling", "United States dollar", "Uruguayan peso", "Uzbekistani sum", "Venezuelan digital bolivar", "Venezuelan sovereign bolivar", "Vietnamese dong", "Vanuatu vatu", "Samoan tala", "CFA franc BEAC", "East Caribbean dollar", "CFA franc BCEAO", "CFP franc", "Yemeni rial", "South African rand", "Zambian kwacha", "Zimbabwe Gold" ] }, "DeliveryInformation": { "type": "object", "properties": { "receiverName": { "type": [ "null", "string" ] }, "locationIdentifier": { "type": [ "null", "string" ] }, "locationIdentifierSchemeId": { "type": [ "null", "string" ] }, "actualDeliveryDate": { "type": [ "null", "string" ], "format": "date" }, "deliveryAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/DeliveryPostalAddress" } ] } } }, "DeliveryPostalAddress": { "type": "object", "properties": { "line1": { "type": [ "null", "string" ] }, "line2": { "type": [ "null", "string" ] }, "line3": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postCode": { "type": [ "null", "string" ] }, "countrySubdivision": { "type": [ "null", "string" ] }, "country": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/CountryCode" } ] } } }, "DocumentLevelAllowance": { "type": "object", "properties": { "amount": { "type": [ "null", "number" ], "format": "double" }, "baseAmount": { "type": [ "null", "number" ], "format": "double" }, "percentage": { "type": [ "null", "number" ], "format": "double" }, "vatCategoryCode": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/VatCategoryCode" } ] }, "vatRate": { "type": [ "null", "number" ], "format": "double" }, "reason": { "type": [ "null", "string" ] }, "reasonCode": { "type": [ "null", "string" ] } } }, "DocumentLevelCharge": { "type": "object", "properties": { "amount": { "type": [ "null", "number" ], "format": "double" }, "baseAmount": { "type": [ "null", "number" ], "format": "double" }, "percentage": { "type": [ "null", "number" ], "format": "double" }, "vatCategoryCode": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/VatCategoryCode" } ] }, "vatRate": { "type": [ "null", "number" ], "format": "double" }, "reason": { "type": [ "null", "string" ] }, "reasonCode": { "type": [ "null", "string" ] } } }, "DocumentTotals": { "type": "object", "properties": { "sumOfLineNetAmounts": { "type": [ "null", "number" ], "format": "double" }, "sumOfAllowances": { "type": [ "null", "number" ], "format": "double" }, "sumOfCharges": { "type": [ "null", "number" ], "format": "double" }, "taxBasisTotalAmount": { "type": [ "null", "number" ], "format": "double" }, "taxTotalAmount": { "type": [ "null", "number" ], "format": "double" }, "taxTotalAmountInAccountingCurrency": { "type": [ "null", "number" ], "format": "double" }, "grandTotalAmount": { "type": [ "null", "number" ], "format": "double" }, "paidAmount": { "type": [ "null", "number" ], "format": "double" }, "roundingAmount": { "type": [ "null", "number" ], "format": "double" }, "duePayableAmount": { "type": [ "null", "number" ], "format": "double" } } }, "InvoiceDocument": { "required": [ "invoiceNumber", "currency", "seller", "buyer", "lines" ], "type": "object", "properties": { "invoiceNumber": { "type": [ "null", "string" ] }, "issueDate": { "type": [ "null", "string" ], "format": "date" }, "dueDate": { "type": [ "null", "string" ], "format": "date" }, "typeCode": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/InvoiceTypeCode" } ] }, "currency": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/CurrencyCode" } ] }, "taxCurrency": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/CurrencyCode" } ] }, "specificationId": { "type": [ "null", "string" ] }, "businessProcessType": { "type": [ "null", "string" ] }, "buyerReference": { "type": [ "null", "string" ] }, "contractReference": { "type": [ "null", "string" ] }, "purchaseOrderReference": { "type": [ "null", "string" ] }, "despatchAdviceReference": { "type": [ "null", "string" ] }, "notes": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "The note text, without a subject code." }, { "$ref": "#/$defs/InvoiceNote" } ], "description": "A note, either as plain text or as an object that adds a subject code." } }, "vatPointDateCode": { "type": [ "null", "string" ] }, "supportingDocuments": { "type": "array", "items": { "$ref": "#/$defs/AdditionalSupportingDocument" } }, "precedingInvoiceReferences": { "type": "array", "items": { "$ref": "#/$defs/PrecedingInvoiceReference" } }, "seller": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/SellerParty" } ] }, "buyer": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/BuyerParty" } ] }, "delivery": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/DeliveryInformation" } ] }, "invoicingPeriod": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/InvoicingPeriod" } ] }, "paymentDetails": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/PaymentDetails" } ] }, "totals": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/DocumentTotals" } ] }, "vatBreakdowns": { "type": "array", "items": { "$ref": "#/$defs/VatBreakdown" } }, "lines": { "minItems": 1, "type": "array", "items": { "$ref": "#/$defs/InvoiceLine" } }, "allowances": { "type": "array", "items": { "$ref": "#/$defs/DocumentLevelAllowance" } }, "charges": { "type": "array", "items": { "$ref": "#/$defs/DocumentLevelCharge" } }, "hasReasonOnlyVatBreakdowns": { "type": "boolean" } } }, "InvoiceLine": { "required": [ "quantity", "priceDetails", "vatInformation", "item" ], "type": "object", "properties": { "lineId": { "type": [ "null", "string" ] }, "lineNote": { "type": [ "null", "string" ] }, "objectIdentifier": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/LineObjectIdentifier" } ] }, "quantity": { "type": [ "null", "number" ], "format": "double" }, "unitCode": { "type": [ "null", "string" ] }, "lineNetAmount": { "type": [ "null", "number" ], "format": "double" }, "buyerOrderLineReference": { "type": [ "null", "string" ] }, "lineBuyerAccountingReference": { "type": [ "null", "string" ] }, "linePeriod": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/InvoiceLinePeriod" } ] }, "priceDetails": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/PriceDetails" } ] }, "vatInformation": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/LineVatInformation" } ] }, "item": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/ItemInformation" } ] }, "allowances": { "type": "array", "items": { "$ref": "#/$defs/LineAllowance" } }, "charges": { "type": "array", "items": { "$ref": "#/$defs/LineCharge" } } } }, "InvoiceLinePeriod": { "type": "object", "properties": { "startDate": { "type": [ "null", "string" ], "format": "date" }, "endDate": { "type": [ "null", "string" ], "format": "date" } } }, "InvoiceNote": { "required": [ "note" ], "type": "object", "properties": { "note": { "type": "string", "description": "The note text." }, "subjectCode": { "type": [ "null", "string" ], "description": "UNTDID 4451 text subject code qualifying the note, for example PMT (recovery costs), PMD (late-payment penalties), AAB (discount terms) or TXD (tax statement)." } }, "description": "A note with a subject code that qualifies what it is about." }, "InvoiceTypeCode": { "enum": [ "261", "326", "380", "381", "383", "384", "386", "389", "875", "876", "877" ], "type": "string", "x-enum-varnames": [ "SelfBilledCreditNote", "PartialInvoice", "Invoice", "CreditNote", "DebitNote", "CorrectedInvoice", "PrepaymentInvoice", "SelfBilledInvoice", "PartialConstructionInvoice", "PartialFinalConstructionInvoice", "FinalConstructionInvoice" ], "x-enum-descriptions": [ "Self-billed credit note", "Partial invoice", "Commercial invoice", "Credit note", "Debit note", "Corrected invoice", "Prepayment invoice", "Self-billed invoice", "Partial construction invoice", "Partial final construction invoice", "Final construction invoice" ] }, "InvoicingPeriod": { "type": "object", "properties": { "startDate": { "type": [ "null", "string" ], "format": "date" }, "endDate": { "type": [ "null", "string" ], "format": "date" } } }, "ItemAttribute": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "ItemClassification": { "required": [ "identifier", "schemeId", "schemeVersion" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] }, "schemeVersion": { "type": [ "null", "string" ] } } }, "ItemInformation": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "sellerIdentifier": { "type": [ "null", "string" ] }, "buyerIdentifier": { "type": [ "null", "string" ] }, "standardIdentifier": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/ItemStandardIdentifier" } ] }, "classifications": { "type": "array", "items": { "$ref": "#/$defs/ItemClassification" } }, "attributes": { "type": "array", "items": { "$ref": "#/$defs/ItemAttribute" } }, "countryOfOrigin": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/CountryCode" } ] } } }, "ItemStandardIdentifier": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "LineAllowance": { "type": "object", "properties": { "amount": { "type": [ "null", "number" ], "format": "double" }, "baseAmount": { "type": [ "null", "number" ], "format": "double" }, "percentage": { "type": [ "null", "number" ], "format": "double" }, "reason": { "type": [ "null", "string" ] }, "reasonCode": { "type": [ "null", "string" ] } } }, "LineCharge": { "type": "object", "properties": { "amount": { "type": [ "null", "number" ], "format": "double" }, "baseAmount": { "type": [ "null", "number" ], "format": "double" }, "percentage": { "type": [ "null", "number" ], "format": "double" }, "reason": { "type": [ "null", "string" ] }, "reasonCode": { "type": [ "null", "string" ] } } }, "LineObjectIdentifier": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "LineVatInformation": { "type": "object", "properties": { "categoryCode": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/VatCategoryCode" } ] }, "rate": { "type": [ "null", "number" ], "format": "double" } } }, "OrderOptions": { "type": "object", "properties": { "profile": { "pattern": "^(?i:basic|comfort|extended)$", "type": [ "null", "string" ], "description": "Order-X conformance profile stamped into the guideline identifier and\nused to pick the validation schema. Accepted values: `basic`,\n`comfort`, `extended`. Defaults to `comfort` when omitted." }, "typeCode": { "pattern": "^(220|230|231)$", "type": [ "null", "string" ], "description": "UNTDID 1001 document type code: `220` (order, the default),\n`230` (order change), or `231` (order response)." }, "language": { "oneOf": [ { "type": "null" }, { "description": "Localisation for the rendered PDF of `/v1/create/order-x`.\nDefaults to English when omitted. The XML endpoint ignores this field.", "$ref": "#/$defs/PdfLanguage" } ] }, "validationLanguage": { "enum": [ "en", "de", "fr" ], "type": [ "null", "string" ], "description": "Language of the validation findings: `en`, `de` or `fr`; defaults to\n`en` when omitted. Words the `message` of every finding in the\n`errors` and `warnings` arrays; rule ids, codes, fields and `raw` stay\nthe same, and so do the problem's `title` and `detail`. Independent of\n`language`, which words the order itself. Any other value is refused with a\n4002 finding on this field.", "default": "en" }, "brandColor": { "pattern": "^#[0-9A-Fa-f]{6}$", "type": [ "null", "string" ], "description": "Primary brand colour for the rendered PDF of `/v1/create/order-x`,\nhex format `#RRGGBB`. The XML endpoint ignores this field." }, "pdfUrl": { "maxLength": 2048, "minLength": 0, "type": [ "null", "string" ], "description": "Optional public URL of a PDF to use as the visual layer of the hybrid\n`/v1/create/order-x` output. When supplied, the generated CIO XML\nis embedded into this PDF instead of the rendered template, and\n`language`, `brandColor`, `logo` and `logoUrl` are ignored. Must be\nan absolute http/https URL to a publicly reachable PDF of at most 20 MB.\nThe XML endpoint ignores this field." }, "logoUrl": { "maxLength": 2048, "minLength": 0, "type": [ "null", "string" ], "description": "Optional public URL of the buyer's logo, printed top-left on the rendered\norder template of `/v1/create/order-x`. PNG or JPEG, at most 2 MB and 4 megapixels,\nat an absolute http/https URL that is publicly reachable. To send the\nimage itself instead, use `logo`; a request may carry one of the two,\nnot both. Ignored when `pdfUrl` supplies the visual layer. The XML\nendpoint ignores this field." }, "logo": { "type": [ "null", "string" ], "description": "Optional buyer's logo as the image file itself, for a logo that is not at a\npublic URL: printed top-left on the rendered order template of\n`/v1/create/order-x`, exactly as a `logoUrl` would be. The PNG or\nJPEG file as plain base64, without a `data:` prefix; at most 2 MB once\ndecoded and 4 megapixels. A request may carry `logo` or `logoUrl`,\nnot both. Ignored when `pdfUrl` supplies the visual layer. The XML\nendpoint ignores this field.", "format": "byte" } }, "description": "Non-BT processing options for the Order-X endpoints." }, "PaymentDetails": { "type": "object", "properties": { "paymentMeansCode": { "type": [ "null", "string" ], "description": "UNTDID 4461 payment means code, for example \"30\" (credit transfer) or \"58\" (SEPA credit transfer). Any code from the UNTDID 4461 list is accepted. The code is also accepted as a JSON number (30) or by its readable name (\"CreditTransfer\") and is always returned as the code string." }, "paymentMeansText": { "type": [ "null", "string" ] }, "remittanceInformation": { "type": [ "null", "string" ] }, "paymentAccountIdentifier": { "type": [ "null", "string" ] }, "paymentAccountName": { "type": [ "null", "string" ] }, "bic": { "type": [ "null", "string" ] }, "mandateReference": { "type": [ "null", "string" ] }, "paymentTerms": { "type": [ "null", "string" ] } } }, "PdfLanguage": { "enum": [ "EN", "DE", "FR" ], "type": "string", "x-enum-varnames": [ "EN", "DE", "FR" ], "x-enum-descriptions": [ "EN", "DE", "FR" ] }, "PrecedingInvoiceReference": { "type": "object", "properties": { "reference": { "type": [ "null", "string" ] }, "issueDate": { "type": [ "null", "string" ], "format": "date" } } }, "PriceDetails": { "type": "object", "properties": { "netPrice": { "type": [ "null", "number" ], "format": "double" }, "discountAmount": { "type": [ "null", "number" ], "format": "double" }, "grossPrice": { "type": [ "null", "number" ], "format": "double" }, "priceBaseQuantity": { "type": [ "null", "number" ], "format": "double" }, "priceBaseUnit": { "type": [ "null", "string" ] } } }, "SellerContact": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] } } }, "SellerElectronicAddress": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "SellerIdentifier": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "SellerLegalRegistration": { "required": [ "identifier", "schemeId" ], "type": "object", "properties": { "identifier": { "type": "string" }, "schemeId": { "type": [ "null", "string" ] } } }, "SellerParty": { "required": [ "name", "postalAddress" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "tradingName": { "type": [ "null", "string" ] }, "postalAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/SellerPostalAddress" } ] }, "contact": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/SellerContact" } ] }, "identifiers": { "type": "array", "items": { "$ref": "#/$defs/SellerIdentifier" } }, "legalRegistration": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/SellerLegalRegistration" } ] }, "vatIdentifier": { "type": [ "null", "string" ] }, "taxRegistrationIdentifier": { "type": [ "null", "string" ] }, "additionalLegalInformation": { "type": [ "null", "string" ] }, "electronicAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/SellerElectronicAddress" } ] } } }, "SellerPostalAddress": { "required": [ "country" ], "type": "object", "properties": { "line1": { "type": [ "null", "string" ] }, "line2": { "type": [ "null", "string" ] }, "line3": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postCode": { "type": [ "null", "string" ] }, "countrySubdivision": { "type": [ "null", "string" ] }, "country": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/CountryCode" } ] } } }, "VatBreakdown": { "type": "object", "properties": { "taxableAmount": { "type": [ "null", "number" ], "format": "double" }, "taxAmount": { "type": [ "null", "number" ], "format": "double" }, "categoryCode": { "oneOf": [ { "type": "null" }, { "$ref": "#/$defs/VatCategoryCode" } ] }, "rate": { "type": [ "null", "number" ], "format": "double" }, "exemptionReasonText": { "type": [ "null", "string" ] }, "exemptionReasonCode": { "type": [ "null", "string" ] } } }, "VatCategoryCode": { "enum": [ "S", "Z", "E", "AE", "K", "G", "O", "L", "M" ], "type": "string", "x-enum-varnames": [ "S", "Z", "E", "AE", "K", "G", "O", "L", "M" ], "x-enum-descriptions": [ "Standard rate", "Zero rated goods", "Exempt from tax", "VAT reverse charge", "VAT exempt for EEA intra-community supply of goods and services", "Free export item, VAT not charged", "Services outside scope of tax", "Canary Islands general indirect tax", "Tax for production, services and importation in Ceuta and Melilla" ] } } }