{"components":{"responses":{"4XX_Client_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 4XX"},"5XX_Server_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 5XX"}},"schemas":{"AddressCreateRequest":{"description":"An address create request that is assigned to a specific debtorId. Can be of addressType INVOICE or SHIPPING.\n","properties":{"academicTitle":{"description":"Size must be between 0 and 255.","example":"Dr.","maxLength":255,"type":"string"},"addressAddition":{"description":"Optional additional address information.\nSize must be between 0 and 255.","example":"3. OG","maxLength":255,"type":"string"},"addressIdent":{"description":"Unique external reference. If not provided NBX will auto generate a UUID.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"addressType":{"description":"Cannot be amended after the initial POST.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| INVOICE  |\n| SHIPPING |","example":"INVOICE","type":"string"},"agencyProfessionTitle":{"description":"Agency Profession Title.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"city":{"description":"City.\nSize must be between 0 and 255.","example":"Hamburg","maxLength":255,"type":"string"},"company":{"description":"Company name.\nSize must be between 0 and 255.","example":"Nitrobox","maxLength":255,"type":"string"},"country":{"description":"Country code for country of address. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","example":"DE","type":"string"},"department":{"description":"Department within a company.\nSize must be between 0 and 255.","example":"Finance","maxLength":255,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParameters"},"email":{"description":"Recipient's email. It becomes mandatory for addresses of addressType INVOICE and preferredDocumentDelivery EMAIL.\nSize must be between 0 and 255.","example":"info@customercompany.com","maxLength":255,"type":"string"},"firstname":{"description":"First name of recipient.\nSize must be between 0 and 255.","example":"Max","maxLength":255,"type":"string"},"gender":{"description":"Recipient's gender.\nMust be one of:\n|        |\n| ------ |\n| MALE   |\n| FEMALE |\n| OTHER  |\n| NOTSET |","example":"FEMALE","type":"string"},"lastname":{"description":"Last name of recipient.\nSize must be between 0 and 255.","example":"Mustermann","maxLength":255,"type":"string"},"postOfficeBox":{"description":"Number of post office box.\nSize must be between 0 and 255.","example":"42000","maxLength":255,"type":"string"},"preferredDocumentDelivery":{"default":"NONE","description":"Defines the preferred way of delivering documents to this customer. Only used for Addresses of Type INVOICE. When set to EMAIL and addressType is INVOICE, the field email must be filled.\nMust be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","example":"EMAIL","type":"string"},"properties":{"description":"Array of properties assigned to the specific address.","items":{"$ref":"#/components/schemas/AddressProperty"},"type":"array","uniqueItems":true},"state":{"description":"State.\nSize must be between 0 and 255.","example":"Brandenburg","maxLength":255,"type":"string"},"stateCode":{"description":"State code. ISO 3166-2 subdivision code.\nSize must be between 0 and 255.","example":"DE-BB","maxLength":255,"type":"string"},"street":{"description":"Name of street.\nSize must be between 0 and 255.","example":"Hofweg","maxLength":255,"type":"string"},"streetNo":{"description":"Street Number.\nSize must be between 0 and 255.","example":"6","maxLength":255,"type":"string"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity by their tax authority such as the German Steuernummer or Italian Codice Fiscale.\nSize must be between 0 and 32.","example":"3012034567890","maxLength":32,"type":"string"},"validationStatus":{"description":"Status of address validation if required by configured tax provider.\nMust be one of:\n|                         |\n| ----------------------- |\n| TAXABLE                 |\n| NON_TAXABLE             |\n| VALIDATION_PENDING      |\n| VALIDATION_NOT_REQUIRED |\n| NOT_VALIDATED           |\n| VALIDATION_FAILED       |","example":"VALIDATION_PENDING","type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN). An identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.\nSize must be between 0 and 20.","example":"DE123456789","maxLength":20,"type":"string"},"zip":{"description":"Postcode.\nSize must be between 0 and 10.","example":"22085","maxLength":10,"type":"string"}},"required":["addressType","country"],"type":"object"},"AddressProperty":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"propertyIdent":{"description":"Key of the property.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"propertyValue":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["propertyIdent","propertyValue"],"type":"object"},"AddressResponse":{"description":"An address that is assigned to a specific debtorId. Can be of addressType INVOICE or SHIPPING.","properties":{"academicTitle":{"description":"Size must be between 0 and 255.","example":"Dr.","maxLength":255,"type":"string"},"addressAddition":{"description":"Optional additional address information.\nSize must be between 0 and 255.","example":"3. OG","maxLength":255,"type":"string"},"addressId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"addressIdent":{"description":"Unique external reference. If not provided NBX will auto generate a UUID.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"addressType":{"description":"Cannot be amended after the initial POST.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| INVOICE  |\n| SHIPPING |","example":"INVOICE","type":"string"},"agencyProfessionTitle":{"description":"Agency Profession Title.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"city":{"description":"City.\nSize must be between 0 and 255.","example":"Hamburg","maxLength":255,"type":"string"},"company":{"description":"Company name.\nSize must be between 0 and 255.","example":"Nitrobox","maxLength":255,"type":"string"},"country":{"description":"Country code for country of address. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","example":"DE","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"debtorId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"department":{"description":"Department within a company.\nSize must be between 0 and 255.","example":"Finance","maxLength":255,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParameters"},"email":{"description":"Recipient's email. It becomes mandatory for addresses of addressType INVOICE and preferredDocumentDelivery EMAIL.\nSize must be between 0 and 255.","example":"info@customercompany.com","maxLength":255,"type":"string"},"firstname":{"description":"First name of recipient.\nSize must be between 0 and 255.","example":"Max","maxLength":255,"type":"string"},"gender":{"description":"Recipient's gender.\nMust be one of:\n|        |\n| ------ |\n| MALE   |\n| FEMALE |\n| OTHER  |\n| NOTSET |","example":"FEMALE","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"lastname":{"description":"Last name of recipient.\nSize must be between 0 and 255.","example":"Mustermann","maxLength":255,"type":"string"},"postOfficeBox":{"description":"Number of post office box.\nSize must be between 0 and 255.","example":"42000","maxLength":255,"type":"string"},"preferredDocumentDelivery":{"default":"NONE","description":"Defines the preferred way of delivering documents to this customer. Only used for Addresses of Type INVOICE. When set to EMAIL and addressType is INVOICE, the field email must be filled.\nMust be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","example":"EMAIL","type":"string"},"properties":{"description":"Array of properties assigned to the specific address.","items":{"$ref":"#/components/schemas/AddressProperty"},"type":"array","uniqueItems":true},"state":{"description":"State.\nSize must be between 0 and 255.","example":"Brandenburg","maxLength":255,"type":"string"},"stateCode":{"description":"State code. ISO 3166-2 subdivision code.\nSize must be between 0 and 255.","example":"DE-BB","maxLength":255,"type":"string"},"street":{"description":"Name of street.\nSize must be between 0 and 255.","example":"Hofweg","maxLength":255,"type":"string"},"streetNo":{"description":"Street Number.\nSize must be between 0 and 255.","example":"6","maxLength":255,"type":"string"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity by their tax authority such as the German Steuernummer or Italian Codice Fiscale.\nSize must be between 0 and 32.","example":"3012034567890","maxLength":32,"type":"string"},"tenantId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"validationStatus":{"description":"Status of address validation if required by configured tax provider.\nMust be one of:\n|                         |\n| ----------------------- |\n| TAXABLE                 |\n| NON_TAXABLE             |\n| VALIDATION_PENDING      |\n| VALIDATION_NOT_REQUIRED |\n| NOT_VALIDATED           |\n| VALIDATION_FAILED       |","example":"VALIDATION_PENDING","type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN). An identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.\nSize must be between 0 and 20.","example":"DE123456789","maxLength":20,"type":"string"},"zip":{"description":"Postcode.\nSize must be between 0 and 10.","example":"22085","maxLength":10,"type":"string"}},"required":["addressType","country"],"type":"object"},"AddressUpdateRequest":{"description":"An address request that is assigned to a specific debtorId. Can be of addressType INVOICE or SHIPPING.\n","properties":{"academicTitle":{"description":"Size must be between 0 and 255.","example":"Dr.","maxLength":255,"type":"string"},"addressAddition":{"description":"Optional additional address information.\nSize must be between 0 and 255.","example":"3. OG","maxLength":255,"type":"string"},"addressType":{"description":"Cannot be amended after the initial POST.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| INVOICE  |\n| SHIPPING |","example":"INVOICE","type":"string"},"agencyProfessionTitle":{"description":"Agency Profession Title.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"city":{"description":"City.\nSize must be between 0 and 255.","example":"Hamburg","maxLength":255,"type":"string"},"company":{"description":"Company name.\nSize must be between 0 and 255.","example":"Nitrobox","maxLength":255,"type":"string"},"country":{"description":"Country code for country of address. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","example":"DE","type":"string"},"department":{"description":"Department within a company.\nSize must be between 0 and 255.","example":"Finance","maxLength":255,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParameters"},"email":{"description":"Recipient's email. It becomes mandatory for addresses of addressType INVOICE and preferredDocumentDelivery EMAIL.\nSize must be between 0 and 255.","example":"info@customercompany.com","maxLength":255,"type":"string"},"firstname":{"description":"First name of recipient.\nSize must be between 0 and 255.","example":"Max","maxLength":255,"type":"string"},"gender":{"description":"Recipient's gender.\nMust be one of:\n|        |\n| ------ |\n| MALE   |\n| FEMALE |\n| OTHER  |\n| NOTSET |","example":"FEMALE","type":"string"},"lastname":{"description":"Last name of recipient.\nSize must be between 0 and 255.","example":"Mustermann","maxLength":255,"type":"string"},"postOfficeBox":{"description":"Number of post office box.\nSize must be between 0 and 255.","example":"42000","maxLength":255,"type":"string"},"preferredDocumentDelivery":{"default":"NONE","description":"Defines the preferred way of delivering documents to this customer. Only used for Addresses of Type INVOICE. When set to EMAIL and addressType is INVOICE, the field email must be filled.\nMust be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","example":"EMAIL","type":"string"},"properties":{"description":"Array of properties assigned to the specific address.","items":{"$ref":"#/components/schemas/AddressProperty"},"type":"array","uniqueItems":true},"state":{"description":"State.\nSize must be between 0 and 255.","example":"Brandenburg","maxLength":255,"type":"string"},"stateCode":{"description":"State code. ISO 3166-2 subdivision code.\nSize must be between 0 and 255.","example":"DE-BB","maxLength":255,"type":"string"},"street":{"description":"Name of street.\nSize must be between 0 and 255.","example":"Hofweg","maxLength":255,"type":"string"},"streetNo":{"description":"Street Number.\nSize must be between 0 and 255.","example":"6","maxLength":255,"type":"string"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity by their tax authority such as the German Steuernummer or Italian Codice Fiscale.\nSize must be between 0 and 32.","example":"3012034567890","maxLength":32,"type":"string"},"validationStatus":{"description":"Status of address validation if required by configured tax provider.\nMust be one of:\n|                         |\n| ----------------------- |\n| TAXABLE                 |\n| NON_TAXABLE             |\n| VALIDATION_PENDING      |\n| VALIDATION_NOT_REQUIRED |\n| NOT_VALIDATED           |\n| VALIDATION_FAILED       |","example":"VALIDATION_PENDING","type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN). An identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.\nSize must be between 0 and 20.","example":"DE123456789","maxLength":20,"type":"string"},"zip":{"description":"Postcode.\nSize must be between 0 and 10.","example":"22085","maxLength":10,"type":"string"}},"required":["addressType","country"],"type":"object"},"AddressValidationConfiguration":{"description":"The representation of an address validation configuration. A configuration consists of an address provider and a set of countries that it's validation is enabled on.\n","properties":{"addressProvider":{"description":"The provider that should be used for address validation.\nMust be one of:\n|         |\n| ------- |\n| AVALARA |\n| NONE    |","type":"string"},"countries":{"description":"The set of countries that the address validation by the given provider is enabled on. Each country can only persist in one configuration.\nMust not be null.","items":{"description":"The set of countries that the address validation by the given provider is enabled on. Each country can only persist in one configuration.\n","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","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","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","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","IC","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","NT","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","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"},"type":"array","uniqueItems":true}},"required":["countries"],"type":"object"},"CustomerCreateRequest":{"description":"The representation of a customer. Customers are assigned addresses and properties.\nOther objects are linked to the customer via the unique ident, which can be an external reference such as a customer number.\n","properties":{"addresses":{"description":"The addresses of the customer.\nMust not be empty.","items":{"$ref":"#/components/schemas/AddressCreateRequest"},"minItems":1,"type":"array"},"contractorReferenceIdent":{"description":"Contractor (reference) id which can be used for example as customer support ident by third parties' system.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"contractorReferenceType":{"description":"Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"customerType":{"description":"Type of the customer.\nMust be one of:\n|            |\n| ---------- |\n| B2B        |\n| B2C        |\n| AFFILIATED |","example":"B2C","type":"string"},"debtorAccountNumber":{"description":"Can be either set at customer creation, in which case the associated debtor booking account will receive the provided number, or set by the nitrobox system automatically.","format":"int64","type":"integer"},"dunning":{"$ref":"#/components/schemas/DunningRequest"},"ident":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"language":{"description":"The language of the customer. Should be in ISO 639-1 ('de') format and if given must match to the used Business Segment.","example":"de","type":"string"},"properties":{"description":"Set of properties assigned to the specific customer.","items":{"$ref":"#/components/schemas/CustomerPropertyRequest"},"type":"array","uniqueItems":true},"taxClassifications":{"description":"Updates a tax classification of a customer with a validity period.","items":{"$ref":"#/components/schemas/CustomerTaxClassificationRequest"},"nullable":true,"type":"array"},"tenantId":{"description":"Is set by the Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","example":11,"format":"int64","type":"integer"}},"required":["addresses","ident"],"type":"object"},"CustomerIdentificationResponse":{"description":"Legacy Support required to stay backward compatible with the contract service which still uses debtorIds for references","properties":{"id":{"description":"Legacy Support required to stay backward compatible","format":"int64","type":"integer"},"ident":{"description":"Legacy Support required to stay backward compatible","type":"string"}},"type":"object"},"CustomerPropertyRequest":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"ident":{"description":"Key of the property.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"value":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["ident","value"],"type":"object"},"CustomerPropertyResponse":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"ident":{"description":"Key of the property.\nMust not be blank.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"value":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["ident","value"],"type":"object"},"CustomerResponse":{"allOf":[{"$ref":"#/components/schemas/CustomerSlimResponse"},{"properties":{"addresses":{"description":"The addresses of the customer.","items":{"$ref":"#/components/schemas/AddressResponse"},"type":"array"}},"type":"object"}],"description":"The representation of a customer. Customers are assigned addresses and properties.\nOther objects are linked to the customer via the unique ident, which can be an external reference such as a customer number.\n","required":["detailLevel","ident"],"type":"object"},"CustomerSlimResponse":{"description":"The representation of a customer. Customers are assigned addresses and properties.\nOther objects are linked to the customer via the unique ident, which can be an external reference such as a customer number.\n","discriminator":{"mapping":{"DEFAULT":"#/components/schemas/CustomerResponse","SLIM":"#/components/schemas/CustomerSlimResponse"},"propertyName":"detailLevel"},"properties":{"contractorReferenceIdent":{"description":"Contractor (reference) id which can be used for example as customer support ident by third parties' system","type":"string"},"contractorReferenceType":{"description":"Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"customerType":{"description":"Type of the customer.\nMust be one of:\n|            |\n| ---------- |\n| B2B        |\n| B2C        |\n| AFFILIATED |","example":"B2C","type":"string"},"debtorAccountNumber":{"description":"Can be either set at customer creation, in which case the associated debtor booking account will receive the provided number, or set by the nitrobox system automatically.","format":"int64","type":"integer"},"detailLevel":{"default":"DEFAULT","description":"Whether or not additional details are included. Slim representations do not contain nested collections.\nMust be one of:\n|         |\n| ------- |\n| SLIM    |\n| DEFAULT |","example":"SLIM","type":"string"},"dunning":{"$ref":"#/components/schemas/DunningResponse"},"ident":{"description":"Unique external reference.","type":"string"},"language":{"description":"The language of the customer. Should be in ISO 639-1 ('de') format and if given must match to the used Business Segment.","example":"de","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"properties":{"description":"Set of properties assigned to the specific customer.","items":{"$ref":"#/components/schemas/CustomerPropertyResponse"},"type":"array","uniqueItems":true},"taxClassifications":{"description":"Customer-specific tax classification including validity period and audit timestamps.","items":{"$ref":"#/components/schemas/CustomerTaxClassificationResponse"},"nullable":true,"type":"array"},"tenantId":{"description":"Is set by the Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","example":11,"format":"int64","type":"integer"}},"required":["createdAt","detailLevel","ident","lastModifiedAt"],"type":"object"},"CustomerTaxClassificationRequest":{"description":"Updates a tax classification of a customer with a validity period.","nullable":true,"properties":{"code":{"description":"Unique tax classification code.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"end":{"description":"Optional end date (inclusive) until which the tax classification applies. Omit or set to null for open-ended validity. ISO 8601 calendar date.","format":"date","nullable":true,"type":"string"},"start":{"description":"Start date (inclusive) from which the tax classification applies. ISO 8601 calendar date.\nMust not be null.","format":"date","type":"string"}},"required":["code","start"],"type":"object"},"CustomerTaxClassificationResponse":{"description":"Customer-specific tax classification including validity period and audit timestamps.","nullable":true,"properties":{"code":{"description":"Unique tax classification code. Used as the identifier when assigning tax classifications to customers.","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"end":{"description":"Optional end date (inclusive) until which the tax classification applies. Null for open-ended validity.","format":"date","nullable":true,"type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the tax classification.","nullable":true,"type":"string"},"start":{"description":"Start date (inclusive) from which the tax classification applies. ISO 8601 calendar date.","format":"date","type":"string"}},"required":["code","start"],"type":"object"},"CustomerUpdateRequest":{"description":"The representation of a customer's updatable properties.","properties":{"contractorReferenceIdent":{"description":"Contractor (reference) id which can be used for example as customer support ident by third parties' system.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"contractorReferenceType":{"description":"Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"customerType":{"description":"Type of the customer.\nMust be one of:\n|            |\n| ---------- |\n| B2B        |\n| B2C        |\n| AFFILIATED |","example":"B2C","type":"string"},"dunning":{"$ref":"#/components/schemas/DunningRequest"},"language":{"description":"The language of the customer. Should be in ISO 639-1 ('de') format and if given must match to the used Business Segment.","example":"de","type":"string"},"properties":{"description":"Set of properties assigned to the specific customer.","items":{"$ref":"#/components/schemas/CustomerPropertyRequest"},"type":"array","uniqueItems":true},"taxClassifications":{"description":"Updates a tax classification of a customer with a validity period.","items":{"$ref":"#/components/schemas/CustomerTaxClassificationRequest"},"nullable":true,"type":"array"}},"type":"object"},"Debtor":{"description":"The representation of a customer. Debtors are assigned addresses and properties.\nOther objects are linked to the customer via the debtorId (assigned by Nitrobox). The customer must also be identified\nwith a unique debtorIdent which can be an external reference such as a customer number.\n","properties":{"addresses":{"description":"The addresses of the customer.\nMust not be empty.","items":{"$ref":"#/components/schemas/AddressResponse"},"minItems":1,"type":"array"},"contractorReferenceIdent":{"description":"Contractor (reference) id which can be used for example as customer support ident by third parties' system.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"contractorReferenceType":{"description":"Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"customerType":{"description":"Type of the customer.\nMust be one of:\n|            |\n| ---------- |\n| B2B        |\n| B2C        |\n| AFFILIATED |","example":"B2C","type":"string"},"debtorAccountNumber":{"description":"Can be either set at customer creation, in which case the associated debtor booking account will receive the provided number, or set by the nitrobox system automatically.","format":"int64","type":"integer"},"debtorId":{"description":"Is set by the Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","example":560,"format":"int64","type":"integer"},"debtorIdent":{"description":"Must be a unique external reference. Cannot be amended after the initial POST.\nNote: While '@' is currently allowed it is not recommended to be used as its incompatible with newer features such as Customer Payment Accounts.\nIt is planned to be removed in an upcoming version.\nSize must be between 1 and 100.\nMust match with the regular expression '[a-zA-Z0-9_.~@-]*'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~@-]*","type":"string"},"dunning":{"$ref":"#/components/schemas/DunningResponse"},"language":{"description":"The language of the order. Should be in ISO 639-1 ('de') format and if given must match to the used Business Segment.","example":"de","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"properties":{"description":"Array of properties assigned to the specific customer.","items":{"$ref":"#/components/schemas/Property"},"type":"array","uniqueItems":true},"tenantId":{"description":"Is set by the Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","example":11,"format":"int64","type":"integer"}},"required":["addresses","createdAt","debtorIdent","lastModifiedAt"],"type":"object"},"DebtorStatisticsResponse":{"description":"Statistics for the Debtor Resource","properties":{"groupedBy":{"description":"The grouping criteria for the statistics response","example":"LANGUAGE","type":"object"},"value":{"description":"The value of the statistics response","example":42,"type":"object"}},"type":"object"},"DunningBlockRequest":{"description":"Dunning block configuration. It includes details on whether the block is active and the reason.","properties":{"active":{"default":false,"description":"A boolean value indicating whether a dunning block for the customer is active.","type":"boolean"},"note":{"description":"Note providing additional information about the dunning block, e.g. reason for a dunning stop.\nSize must be between 0 and 100.","maxLength":100,"nullable":true,"type":"string"}},"required":["active"],"type":"object"},"DunningBlockResponse":{"description":"Dunning block configuration. It includes details on whether the block is active and the reason.","properties":{"active":{"description":"A boolean value indicating whether a dunning block for the customer is active.","type":"boolean"},"note":{"description":"Note providing additional information about the dunning block, e.g. reason for a dunning stop.\nSize must be between 0 and 100.","maxLength":100,"nullable":true,"type":"string"}},"required":["active","note"],"type":"object"},"DunningRequest":{"description":"The customer dunning configuration.","nullable":true,"properties":{"dunningBlock":{"$ref":"#/components/schemas/DunningBlockRequest"}},"type":"object"},"DunningResponse":{"description":"The customer dunning configuration.","properties":{"dunningBlock":{"$ref":"#/components/schemas/DunningBlockResponse"}},"required":["dunningBlock"],"type":"object"},"EInvoicingParameters":{"description":"Provides information needed to handle e-invoicing.","properties":{"recipientCode":{"description":"The recipient code used in the underlying network of the recipientCodeType.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"recipientCodeType":{"description":"For which e-invoicing scheme the following recipient code is relevant. Further information can be found at https://docs.nitrobox.io/docs/e-invoicing-recipient-codes.","type":"string"}},"type":"object"},"GlobalErrorResponse":{"description":"error response providing details about the error occurred","properties":{"errors":{"description":"optional list of multiple errors occurred","items":{"type":"object"},"type":"array"},"message":{"description":"message describing the error","type":"string"},"path":{"description":"URL path where the error occurred","type":"string"},"status":{"description":"textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400","type":"string"},"timestamp":{"description":"timestamp in UTC when the error occurred","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries","format":"uuid","type":"string"}},"type":"object"},"JsonNode":{"description":"The payload","nullable":true,"type":"object"},"MigrationResponse":{"description":"A generic DTO (i.e. not tied to one specific entity) used for all sorts of migration purposes","properties":{"endTime":{"description":"Time when a scheduled migration ended - if already.","example":"2007-12-03T10:15:30+01:00","format":"date-time","type":"string"},"entityName":{"description":"Name of the database entity that is supposed to be migrated.","example":"Customer","type":"string"},"message":{"description":"A message desribing the migration task.","example":"processed page: 1; pages left: 2 (batchSize: 10, elements left: 5); lastId: 42","type":"string"},"startTime":{"description":"Time when a scheduled migration was or is to be started.","example":"2007-12-03T10:15:30+01:00","format":"date-time","type":"string"},"status":{"description":"Status of a scheduled migration.\nMust be one of:\n|           |\n| --------- |\n| SCHEDULED |\n| RUNNING   |\n| COMPLETED |\n| FAILED    |","example":"COMPLETED","type":"string"}},"type":"object"},"NestedSellerOperatingSiteCreateRequest":{"description":"Request object for creating a seller operating site during the initial setup of a seller.","properties":{"address":{"$ref":"#/components/schemas/SellerAddressRequest"},"bankInformation":{"$ref":"#/components/schemas/SellerOperatingSiteBankInformationDto"},"directorsAndOfficers":{"description":"Directors and officers responsible for the operating site.","items":{"$ref":"#/components/schemas/SellerOperatingSiteDirectorsAndOfficersDto"},"type":"array"},"ident":{"description":"Unique identifier of the operating site. Cannot be changed afterwards.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"a954deb7-f57d-4e18-b377-23343a7c18b1","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"description":"Additional properties related to the operating site, such as opening hours or special notes.","items":{"$ref":"#/components/schemas/SellerOperatingSitePropertyDto"},"type":"array"},"supportInformation":{"description":"Support contact methods such as email or phone.","items":{"$ref":"#/components/schemas/SellerOperatingSiteSupportInformationDto"},"type":"array"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity\nby their tax authority such as the German Steuernummer or Italian Codice Fiscale.","example":"3012034567890","type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN).\nAn identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.","example":"DE1234567890","type":"string"}},"required":["address","ident"],"type":"object"},"OutboxEntryResponse":{"description":"Result list.","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"deleteAt":{"description":"The delete timestamp","format":"date-time","nullable":true,"type":"string"},"failures":{"description":"Number of failures","format":"int32","type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be blank.","minLength":1,"type":"string"},"ident":{"description":"The ident of the outbox entry. An entry does not necessarily require an ident. It serves as a convenience feature only.","nullable":true,"type":"string"},"lastFailureMessage":{"description":"Last failure message","nullable":true,"type":"string"},"nextRetryAt":{"description":"The next retry timestamp","format":"date-time","nullable":true,"type":"string"},"payload":{"$ref":"#/components/schemas/JsonNode"},"status":{"description":"The status of the outbox entry.\nMust not be null.","enum":["ENQUEUED","PROCESSING","WAITING","PROCESSED","FAILED"],"type":"string"},"statusHistory":{"description":"The status history.\nMust not be null.","items":{"$ref":"#/components/schemas/StatusHistory"},"type":"array"},"statusTimestamp":{"description":"The timestamp of the last status change.\nMust not be null.","format":"date-time","type":"string"},"tracingAttributes":{"additionalProperties":{"description":"Tracing attributes","type":"string"},"description":"Tracing attributes.\nMust not be null.","type":"object"}},"required":["createdAt","failures","id","status","statusHistory","statusTimestamp","tracingAttributes"],"type":"object"},"OutboxQueryParams":{"properties":{"createdFrom":{"description":"Start timestamp (inclusive) for filtering by the creation time of the outbox entry.","format":"date-time","nullable":true,"type":"string"},"createdTo":{"description":"End timestamp (inclusive) for filtering by the creation time of the outbox entry.","format":"date-time","nullable":true,"type":"string"},"from":{"description":"Start timestamp (inclusive) for filtering outbox entries based on the status timestamp.","format":"date-time","nullable":true,"type":"string"},"to":{"description":"End timestamp (inclusive) for filtering outbox entries based on the status timestamp.","format":"date-time","nullable":true,"type":"string"}},"type":"object"},"PageInfo":{"description":"Meta data about the current page and query.","properties":{"number":{"description":"Page number of total pages available.","format":"int32","type":"integer"},"size":{"description":"Size of the page as specified by the query.","format":"int32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.","format":"int64","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.","format":"int32","type":"integer"}},"type":"object"},"PagedResponseAddressResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AddressResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseAddressValidationConfiguration":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AddressValidationConfiguration"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseCustomerSlimResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"oneOf":[{"$ref":"#/components/schemas/CustomerSlimResponse"},{"$ref":"#/components/schemas/CustomerResponse"}]},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOutboxEntryResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OutboxEntryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseSellerOperatingSiteResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/SellerOperatingSiteResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseSellerResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/SellerResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseTaxClassificationResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/TaxClassificationResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"Property":{"description":"A customer property is a key-value pair that can be used to expand the set parameters in the customer model as needed.","properties":{"propertyId":{"description":"Is set by Nitrobox system. Any values entered for GET, POST and PUT requests will be overwritten.","format":"int64","type":"integer"},"propertyIdent":{"description":"Can be any key. The same propertyIdent can be used across multiple debtors.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"propertyValue":{"description":"Can be any value.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["propertyIdent","propertyValue"],"type":"object"},"SellerAddressRequest":{"description":"Address of the seller's operating site, including address lines, city, postal code, and country.","properties":{"addressLine1":{"description":"The primary address line, typically including the street name and number or a P.O. Box.","example":"Musterweg 12A","type":"string"},"addressLine2":{"description":"An optional secondary address line, such as apartment, suite, unit, building, or floor information.","example":"3. Etage","type":"string"},"addressLine3":{"description":"An additional optional address line for further location details, such as care-of (c/o), attention (Attn), or other delivery instructions.","example":"c/o Hans Mustermann","type":"string"},"city":{"description":"The name of the city or locality associated with the address.","example":"Hamburg","type":"string"},"country":{"description":"Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","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","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","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","IC","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","NT","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","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"postalCode":{"description":"The postal or ZIP code corresponding to the specified address. Accepts numeric or alphanumeric values depending on the country format.","example":"20354","type":"string"},"state":{"description":"The full name of the state, province, or region, depending on the country.","example":"Hamburg","type":"string"},"stateCode":{"description":"The abbreviated code for the state or region, typically following country-specific standards.","example":"HH","type":"string"}},"required":["country"],"type":"object"},"SellerAddressResponse":{"description":"Address of the seller's operating site, including address lines, city, postal code, and country.","properties":{"addressLine1":{"description":"The primary address line, typically including the street name and number or a P.O. Box.","example":"Musterweg 12A","type":"string"},"addressLine2":{"description":"An optional secondary address line, such as apartment, suite, unit, building, or floor information.","example":"3. Etage","type":"string"},"addressLine3":{"description":"An additional optional address line for further location details, such as care-of (c/o), attention (Attn), or other delivery instructions.","example":"c/o Hans Mustermann","type":"string"},"city":{"description":"The name of the city or locality associated with the address.","example":"Hamburg","type":"string"},"country":{"description":"Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","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","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","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","IC","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","NT","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","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"example":"DE","type":"string"},"postalCode":{"description":"The postal or ZIP code corresponding to the specified address. Accepts numeric or alphanumeric values depending on the country format.","example":"20354","type":"string"},"state":{"description":"The full name of the state, province, or region, depending on the country.","example":"Hamburg","type":"string"},"stateCode":{"description":"The abbreviated code for the state or region, typically following country-specific standards.","example":"HH","type":"string"}},"required":["country"],"type":"object"},"SellerCreateRequest":{"description":"Request object for creating a seller.","properties":{"commercialRegistrationNumber":{"description":"The commercial registration number of the seller.","example":"HRB 125192","type":"string"},"courtOfRegistration":{"description":"The court where the seller is registered.","example":"Amtsgericht Hamburg","type":"string"},"ident":{"description":"Unique identifier of the seller. Cannot be changed afterwards.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"a954deb7-f57d-4e18-b377-23343a7c18b1","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"The seller name.\nMust not be blank.","example":"Nitrobox GmbH","minLength":1,"type":"string"},"operatingSites":{"description":"Operating sites associated with the seller. At least one operating site must be provided.\nMust not be empty.","items":{"$ref":"#/components/schemas/NestedSellerOperatingSiteCreateRequest"},"minItems":1,"type":"array"}},"required":["ident","name","operatingSites"],"type":"object"},"SellerOperatingSiteBankInformationDto":{"description":"A bank account associated with the operating site.","properties":{"bankName":{"description":"The full name of the bank where the account is held. Required for payment processing and accurate identification of the financial institution.","example":"Musterbank","type":"string"},"bic":{"description":"The Bank Identifier Code (BIC), also known as SWIFT code, used to uniquely identify a financial institution in international transactions. Must follow the ISO 9362 format.","example":"MARKDEF1100","type":"string"},"iban":{"description":"The International Bank Account Number (IBAN) used to uniquely identify a customer's bank account across borders. Must comply with the ISO 13616 standard and include country code, check digits, and account number.\nMust not be blank.","example":"DE91100000000123456789","minLength":1,"type":"string"}},"required":["iban"],"type":"object"},"SellerOperatingSiteCreateRequest":{"description":"Request object for adding a new seller operating site to an existing seller.","properties":{"address":{"$ref":"#/components/schemas/SellerAddressRequest"},"bankInformation":{"$ref":"#/components/schemas/SellerOperatingSiteBankInformationDto"},"directorsAndOfficers":{"description":"Directors and officers responsible for the operating site.","items":{"$ref":"#/components/schemas/SellerOperatingSiteDirectorsAndOfficersDto"},"type":"array"},"ident":{"description":"Unique identifier of the operating site. Cannot be changed afterwards.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"a954deb7-f57d-4e18-b377-23343a7c18b1","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"properties":{"description":"Additional properties related to the operating site, such as opening hours or special notes.","items":{"$ref":"#/components/schemas/SellerOperatingSitePropertyDto"},"type":"array"},"sellerIdent":{"description":"Unique identifier of the associated seller.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"a954deb7-f57d-4e18-b377-23343a7c18b1","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"supportInformation":{"description":"Support contact methods such as email or phone.","items":{"$ref":"#/components/schemas/SellerOperatingSiteSupportInformationDto"},"type":"array"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity\nby their tax authority such as the German Steuernummer or Italian Codice Fiscale.","example":"3012034567890","type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN).\nAn identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.","example":"DE1234567890","type":"string"}},"required":["address","ident","sellerIdent"],"type":"object"},"SellerOperatingSiteDirectorsAndOfficersDto":{"description":"Directors and officers responsible for the operating site.","properties":{"corporateTitle":{"description":"The corporate title of the person.","example":"CEO","type":"string"},"name":{"description":"Full name of the director or officer.","example":"Max Mustermann","type":"string"}},"type":"object"},"SellerOperatingSitePropertyDto":{"description":"Additional property related to the operating site, such as opening hours or special notes.","properties":{"key":{"description":"Identifier or key of the property.","example":"openingHours","type":"string"},"value":{"description":"Value associated with the property.","example":"Mo-Fr 09:00-18:00","type":"string"}},"type":"object"},"SellerOperatingSiteResponse":{"description":"Response object containing detailed information about a seller's operating site and the associated seller.","properties":{"address":{"$ref":"#/components/schemas/SellerAddressResponse"},"bankInformation":{"$ref":"#/components/schemas/SellerOperatingSiteBankInformationDto"},"directorsAndOfficers":{"description":"Directors and officers responsible for the operating site.","items":{"$ref":"#/components/schemas/SellerOperatingSiteDirectorsAndOfficersDto"},"type":"array"},"ident":{"description":"Unique identifier of the operating site.","example":"a954deb7-f57d-4e18-b377-23343a7c18b1","type":"string"},"properties":{"description":"Additional properties related to the operating site, such as opening hours or special notes.","items":{"$ref":"#/components/schemas/SellerOperatingSitePropertyDto"},"type":"array"},"seller":{"$ref":"#/components/schemas/SellerResponse"},"supportInformation":{"description":"Support contact methods such as email or phone.","items":{"$ref":"#/components/schemas/SellerOperatingSiteSupportInformationDto"},"type":"array"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity\nby their tax authority such as the German Steuernummer or Italian Codice Fiscale.","example":"3012034567890","type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN).\nAn identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.","example":"DE1234567890","type":"string"}},"type":"object"},"SellerOperatingSiteSupportInformationDto":{"description":"Support contact method such as email, phone.","properties":{"supportInformationType":{"description":"Type of support information, 'email' or 'phone'.\nMust be one of:\n|       |                                    |\n| ----- | ---------------------------------- |\n| EMAIL | Support information of type EMAIL. |\n| PHONE | Support information of type PHONE. |","example":"EMAIL","type":"string"},"value":{"description":"Value of the support information, depending on the type.","example":"info@nitrobox.com","type":"string"}},"type":"object"},"SellerOperatingSiteUpdateRequest":{"description":"Request object for updating a seller operating site.","properties":{"address":{"$ref":"#/components/schemas/SellerAddressRequest"},"bankInformation":{"$ref":"#/components/schemas/SellerOperatingSiteBankInformationDto"},"directorsAndOfficers":{"description":"Directors and officers responsible for the operating site.","items":{"$ref":"#/components/schemas/SellerOperatingSiteDirectorsAndOfficersDto"},"type":"array"},"properties":{"description":"Additional properties related to the operating site, such as opening hours or special notes.","items":{"$ref":"#/components/schemas/SellerOperatingSitePropertyDto"},"type":"array"},"supportInformation":{"description":"Support contact methods such as email or phone.","items":{"$ref":"#/components/schemas/SellerOperatingSiteSupportInformationDto"},"type":"array"},"taxNumber":{"description":"The taxNumber is the local country tax number given to a legal entity\nby their tax authority such as the German Steuernummer or Italian Codice Fiscale.","example":"3012034567890","type":"string"},"vatId":{"description":"Also known as VAT identification number (VATIN).\nAn identifier used by countries for Value Added Tax purposes to identify legal entities, especially in the EU.","example":"DE1234567890","type":"string"}},"required":["address"],"type":"object"},"SellerResponse":{"description":"Response object containing detailed information about the seller.","properties":{"commercialRegistrationNumber":{"description":"The commercial registration number of the seller.","example":"HRB 125192","type":"string"},"courtOfRegistration":{"description":"The court where the seller is registered.","example":"Amtsgericht Hamburg","type":"string"},"ident":{"description":"Unique identifier of the seller.","example":"a954deb7-f57d-4e18-b377-23343a7c18b1","type":"string"},"name":{"description":"The seller name.","example":"Nitrobox GmbH","type":"string"}},"type":"object"},"SellerUpdateRequest":{"description":"Request object for updating a seller.","properties":{"commercialRegistrationNumber":{"description":"The commercial registration number of the seller.","example":"HRB 125192","type":"string"},"courtOfRegistration":{"description":"The court where the seller is registered.","example":"Amtsgericht Hamburg","type":"string"},"name":{"description":"The seller name.\nMust not be blank.","example":"Nitrobox GmbH","minLength":1,"type":"string"}},"required":["name"],"type":"object"},"StatusHistory":{"description":"The status history","properties":{"status":{"description":"The status","enum":["ENQUEUED","PROCESSING","WAITING","PROCESSED","FAILED"],"type":"string"},"timestamp":{"description":"The timestamp when the status occurred","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"TaxClassificationCreateRequest":{"description":"Request body for creating a new tax classification.","properties":{"code":{"description":"Unique tax classification code. Used as the identifier when assigning tax classifications to customers.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Name of the tax classification.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["code"],"type":"object"},"TaxClassificationResponse":{"description":"Represents a tax classification that can be assigned to customers and used for tax rule selection.","properties":{"code":{"description":"Unique tax classification code. Used as the identifier when assigning tax classifications to customers.","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"name":{"description":"Name of the tax classification.","type":"string"}},"required":["code","createdAt","lastModifiedAt"],"type":"object"},"TaxClassificationUpdateRequest":{"description":"Request body for updating an existing tax classification.","properties":{"name":{"description":"Updated name of the tax classification.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"type":"object"},"WidgetStatisticsQueryParameter":{"description":"Values used for the statistic query.","properties":{"aggregationType":{"description":"The given type of aggregation.\nMust not be null.","example":"SUM","type":"string"},"dateField":{"description":"The given date field.\nMust not be null.","example":"createdAt","type":"string"},"field":{"description":"The given field to query for.\nMust not be null.","example":"IDENT","type":"string"},"groupedBy":{"description":"The given field for grouping.\nMust not be null.","example":"NONE","type":"string"},"query":{"description":"Rsql query used to limit the result set.","example":"IDENT==client123","type":"string"}},"required":["aggregationType","dateField","field","groupedBy","query"],"type":"object"},"WidgetStatisticsResponse":{"description":"Result of a statistic query.","properties":{"queryParameter":{"$ref":"#/components/schemas/WidgetStatisticsQueryParameter"},"results":{"items":{"$ref":"#/components/schemas/WidgetStatisticsResult"},"type":"array"}},"required":["queryParameter","results"],"type":"object"},"WidgetStatisticsResult":{"description":"Single result of a statistic query.","properties":{"groupedByContent":{"description":"If group by is used, this field contains the specific value of the grouping. Otherwise it is null.","example":"2025","type":"string"},"value":{"description":"Sum or Counted value.\nMust not be null.","example":3.1235,"type":"number"}},"required":["groupedByContent","value"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-accounting-management-read":"Scope nbx-accounting-management-read","nbx-accounting-management-write":"Scope nbx-accounting-management-write","nbx-customer-management-read":"Scope nbx-customer-management-read","nbx-customer-management-write":"Scope nbx-customer-management-write","nbx-internal":"Scope nbx-internal","nbx-tenant-management-read":"Scope nbx-tenant-management-read","nbx-tenant-management-write":"Scope nbx-tenant-management-write"},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for Customer","title":"Customer API","version":"v2-preview-1.14.1"},"openapi":"3.0.1","paths":{"/v2/address-validation/actions/validate-unvalidated":{"post":{"description":"Check for all addresses of customers on tenant if validation is required and requeue them if necessary.","operationId":"checkAllAddresses","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}},"text/plain":{"schema":{"type":"string"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Check validation of all addresses","tags":["Configurations"]}},"/v2/address-validation/configuration":{"get":{"description":"Get or query all address validation configurations","operationId":"getAllAddressValidationConfigs","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"addressProvider==AVALARA","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'addressProvider'.","in":"query","name":"sort","schema":{"default":["addressProvider"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAddressValidationConfiguration"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Get all address validation configs","tags":["Configurations"]},"post":{"description":"Create or update configuration of an address validation provider","operationId":"createOrUpdateAddressValidationConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressValidationConfiguration"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressValidationConfiguration"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Create or update address validation config","tags":["Configurations"]}},"/v2/address-validation/configuration/{addressProvider}":{"delete":{"description":"Delete the configuration of an address validation provider","operationId":"deleteAddressValidationConfigs","parameters":[{"description":"The provider that should be used for address validation.","in":"path","name":"addressProvider","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Delete address validation config","tags":["Configurations"]},"get":{"description":"Get the configuration of an address validation provider","operationId":"getAddressValidationConfig","parameters":[{"description":"The provider that should be used for address validation.","in":"path","name":"addressProvider","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressValidationConfiguration"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Get address validation config","tags":["Configurations"]}},"/v2/customers":{"post":{"description":"A new customer can be created together with their addresses (at least one) and properties (optional).\nThe ident is required and must be unique.\n","operationId":"createCustomer","parameters":[{"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","in":"query","name":"slimResponse","schema":{"default":false,"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomerSlimResponse"},{"$ref":"#/components/schemas/CustomerResponse"}]}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Create customer","tags":["Customers"]}},"/v2/customers/pageable":{"get":{"description":"Returns a paged result with 100 customers by default. Customers are sorted in descending order by ident. This can be changed with the\noptional direction and orderBy parameters.\n","operationId":"queryCustomers","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"If set to false, the response objects will be larger (a lot!) and also contain nested collection fields, i.e. Addresses. This is not recommended!","in":"query","name":"slimResponse","schema":{"default":true,"description":"If set to false, the response objects will be larger (a lot!) and also contain nested collection fields, i.e. Addresses. This is not recommended!","type":"boolean"}},{"description":"Zero-based page index (0..N). Defines the index of the displayed page.","in":"query","name":"pageNumber","schema":{"default":0,"description":"Zero-based page index (0..N). Defines the index of the displayed page.","format":"int32","type":"integer"}},{"description":"Defines the number of objects per page to be returned.","in":"query","name":"pageSize","schema":{"default":100,"description":"Defines the number of objects per page to be returned.","format":"int32","type":"integer"}},{"description":"Defines the criteria by which the result is ordered.","in":"query","name":"orderBy","schema":{"default":"ident","description":"Defines the criteria by which the result is ordered.","type":"string"}},{"description":"Defines the direction of the ordered response. Default order is descending.","in":"query","name":"direction","schema":{"default":"DESC","description":"Defines the direction of the ordered response. Default order is descending.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseCustomerSlimResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Query customers","tags":["Customers"]}},"/v2/customers/{ident}":{"get":{"description":"Get a specific customer by it's ident","operationId":"getCustomer","parameters":[{"description":"Unique external reference.","in":"path","name":"ident","required":true,"schema":{"type":"string"}},{"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","in":"query","name":"slimResponse","schema":{"default":false,"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomerSlimResponse"},{"$ref":"#/components/schemas/CustomerResponse"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Retrieve customer","tags":["Customers"]},"put":{"description":"When updating the customer, the address data cannot be changed in the same call. To change address data, use put for the\nendpoint customer/{ident}/addresses/{addressId}  and update individually.\nOnly language, customerType, preferredDocumentDelivery and properties can be changed. The debtorAccountNumber cannot be changed.\nWhen properties are provided in the update, all existing properties not present in the update will be removed!\nMatching (by name) properties will be updated, new ones will be added\nThe body needs to contain all the customer addresses for the update to work.\nPlease see Customer Model below for more information regarding required values and input type.\n","operationId":"updateCustomer","parameters":[{"description":"Unique external reference.","in":"path","name":"ident","required":true,"schema":{"type":"string"}},{"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","in":"query","name":"slimResponse","schema":{"default":false,"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomerSlimResponse"},{"$ref":"#/components/schemas/CustomerResponse"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Update customer","tags":["Customers"]}},"/v2/customers/{ident}/actions/anonymize":{"post":{"description":"Deletes all personal data from the customer.","operationId":"anonymizeCustomer","parameters":[{"description":"Unique external reference.\nMust not be null.","in":"path","name":"ident","required":true,"schema":{"type":"string"}},{"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","in":"query","name":"slimResponse","schema":{"default":false,"description":"If set to true, the response objects will be smaller and not contain nested collection fields, i.e. Addresses.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomerSlimResponse"},{"$ref":"#/components/schemas/CustomerResponse"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Anonymize customer","tags":["preview"]}},"/v2/customers/{ident}/addresses":{"post":{"description":"Create a new address for a specific customer","operationId":"createAddressForCustomer","parameters":[{"description":"Unique external reference.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Create address","tags":["Customers"]}},"/v2/customers/{ident}/addresses/pageable":{"get":{"description":"Get a paged result of assigned addresses for a specific customer. Returns\na page with 100 addresses by default. Addresses are sorted in descending order by addressId. This can be changed with the optional direction and\norderBy parameters.\n","operationId":"queryAddressesForCustomer","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N). Defines the index of the displayed page.","in":"query","name":"pageNumber","schema":{"default":0,"description":"Zero-based page index (0..N). Defines the index of the displayed page.","format":"int32","type":"integer"}},{"description":"Defines the number of objects per page to be returned.","in":"query","name":"pageSize","schema":{"default":100,"description":"Defines the number of objects per page to be returned.","format":"int32","type":"integer"}},{"description":"Defines the criteria by which the result is ordered.","in":"query","name":"orderBy","schema":{"default":"addressId","description":"Defines the criteria by which the result is ordered.","type":"string"}},{"description":"Defines the direction of the ordered response. Default order is descending.","in":"query","name":"direction","schema":{"default":"DESC","description":"Defines the direction of the ordered response. Default order is descending.","type":"string"}},{"description":"Unique external reference.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAddressResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Query customer addresses","tags":["Customers"]}},"/v2/customers/{ident}/addresses/{addressIdent}":{"get":{"description":"Get a specific Address of customer by ident.","operationId":"getAddress","parameters":[{"description":"Unique external reference.","in":"path","name":"addressIdent","required":true,"schema":{"type":"string"}},{"description":"Unique external reference.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Retrieve address","tags":["Customers"]},"put":{"description":"Please see Address Model below for\nmore information regarding required values and input type.\n","operationId":"updateAddress","parameters":[{"description":"Unique external reference.","in":"path","name":"addressIdent","required":true,"schema":{"type":"string"}},{"description":"Unique external reference.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Update address","tags":["Customers"]}},"/v2/customers/{ident}/dunning-block":{"put":{"description":"Enable or disable customer's dunning block, will overwrite all opos-case dunning blocks if active.\n","operationId":"updateCustomerDunningBlock","parameters":[{"description":"Unique external reference.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningBlockRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningBlockResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Update customer dunning block","tags":["Customers"]}},"/v2/seller-operating-sites":{"get":{"description":"Returns a paginated list of all seller operating sites matching the specified RSQL query.\nResults are sorted by sellerIdent in ascending order.\nThis can be changed with the optional direction and orderBy parameter.\n","operationId":"querySellerOperatingSites","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'seller.ident'.","in":"query","name":"sort","schema":{"default":["seller.ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSellerOperatingSiteResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Query seller operating sites","tags":["Sellers"]},"post":{"description":"Creates a new seller operating site. This operation validates the input data, persists\n        the new seller operating site, and returns the created seller operating site's details\n        in the response.\n","operationId":"createSellerOperatingSite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerOperatingSiteCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerOperatingSiteResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Create a new seller operating site","tags":["Sellers"]}},"/v2/seller-operating-sites/{sellerOperatingSiteIdent}":{"get":{"description":"        Retrieves the details of an existing seller operating site identified by the given\nsellerOperatingSiteIdent.\n","operationId":"retrieveSellerOperatingSite","parameters":[{"description":"unique identifier.","example":"seller-operating-site_12345","in":"path","name":"sellerOperatingSiteIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerOperatingSiteResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Retrieve an existing seller operating site","tags":["Sellers"]},"put":{"description":"    Updates an existing seller operating site identified by the provided sellerOperatingSiteIdent. This operation\n    verifies the seller operating site's existence, applies the updates, and returns the\n    updated seller operating site details in the response.\n","operationId":"updateSellerOperatingSite","parameters":[{"description":"unique identifier.","example":"seller-operating-site_12345","in":"path","name":"sellerOperatingSiteIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerOperatingSiteUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerOperatingSiteResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Update an existing seller operating site","tags":["Sellers"]}},"/v2/sellers":{"get":{"description":"Returns a paginated list of all sellers matching the specified RSQL query.\nResults are sorted by sellerIdent in ascending order.\nThis can be changed with the optional direction and orderBy parameter.\n","operationId":"querySellers","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSellerResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Query sellers","tags":["Sellers"]},"post":{"description":"        Creates a new seller. This operation validates the input data, persists\n        the new seller, and returns the created seller's details\n        in the response.\n","operationId":"createSeller","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Create a new seller","tags":["Sellers"]}},"/v2/sellers/{sellerIdent}":{"get":{"description":"Retrieves the details of an existing seller identified by the given\nsellerIdent.\n","operationId":"retrieveSeller","parameters":[{"description":"unique identifier.","example":"seller_12345","in":"path","name":"sellerIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-read"]}],"summary":"Retrieve an existing seller","tags":["Sellers"]},"put":{"description":"    Updates an existing seller identified by the provided sellerIdent. This operation\n    verifies the seller's existence, applies the updates, and returns the\n    updated seller details in the response.\n","operationId":"updateSeller","parameters":[{"description":"unique identifier.","example":"seller_12345","in":"path","name":"sellerIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-customer-management-write"]}],"summary":"Update an existing seller","tags":["Sellers"]}},"/v2/tax-classifications":{"get":{"description":"Returns a paged list of tax classifications available for the tenant. Supports RSQL filtering on available fields such as `code` and `name`. Use pagination parameters to control result size and sorting.\n","operationId":"queryTaxClassifications","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'code'.","in":"query","name":"sort","schema":{"default":["code"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseTaxClassificationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-read"]}],"summary":"Query tax classifications","tags":["Tax Classifications"]},"post":{"description":"Creates a new tax classification. Tax classifications can be assigned to customers and are used to select the correct tax rule during tax calculation.\n","operationId":"createTaxClassification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxClassificationCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxClassificationResponse"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-write"]}],"summary":"Create tax classification","tags":["Tax Classifications"]}},"/v2/tax-classifications/{code}":{"put":{"description":"Updates the display name of an existing tax classification.\nThe tax classification is identified by its unique `code`.\n","operationId":"updateTaxClassification","parameters":[{"description":"Unique identifier of the tax classification to be updated.","in":"path","name":"code","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxClassificationUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxClassificationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-write"]}],"summary":"Update tax classification","tags":["Tax Classifications"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"endpoints for preview","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"preview"},{"description":"endpoints for Customers","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Customers"},{"description":"endpoints for Sellers","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Sellers"},{"description":"Endpoints for managing tax classifications. A tax classification can be assigned to customers and is used to determine applicable tax rules.","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tax Classifications"},{"description":"endpoints for Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Configurations"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}