{"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":{"AggregationConfigurationCreationRequest":{"description":"Please see AggregationConfigurationCreationRequest Model below for more information regarding required values and input type. Only one configuration per operatingSiteIdent possible.","properties":{"aggregationConfigurationIdent":{"description":"Unique external reference.\nMust not be null.\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"},"aggregationStrategies":{"description":"List of applied aggregations.\nMust not be empty.","items":{"description":"List of applied aggregations.","enum":["BY_TAX_RATE","BY_TAX_CODE","BY_JURISDICTION_TYPE","BY_SHIPPING_COST","BY_ITEM_EXTRA","BY_ARTICLE_NUMBER","BY_ARTICLE_NUMBER_AND_ITEM_EXTRA","BY_CANADIAN_TAX_NAME","BY_DEBIT_CREDIT","BY_ITEM_GROUP","BY_POST_TAX_ITEMS"],"type":"string"},"minItems":1,"type":"array"},"aggregationStrategiesExtended":{"description":"List of additional custom aggregations on already applied aggregations, to aggregate results of those aggregations,\ne.g., aggregate Subtotals with itemGroups containing the subTotalSum.grouping_field_value \"Test\" and \"Test2\".\n","items":{"$ref":"#/components/schemas/AggregationStrategyExtendedDto"},"nullable":true,"type":"array"},"invoiceType":{"description":"Type of document for which the aggregation shall be used.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| invoice                         |\n| creditmemo                      |\n| order                           |\n| depositinvoice                  |\n| depositinvoicecancellation      |\n| creditmemo_goodwill             |\n| creditmemo_warranty             |\n| self_billing_invoice            |\n| self_billing_invoice_correction |","type":"string"}},"required":["aggregationConfigurationIdent","aggregationStrategies","invoiceType"],"type":"object"},"AggregationConfigurationDto":{"description":"Please see AggregationConfigurationDto Model below for more information regarding required values and input type. Only one configuration per operatingSiteIdent possible.","properties":{"aggregationConfigurationIdent":{"description":"Unique external reference.\nMust not be null.\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"},"aggregationStrategies":{"description":"List of applied aggregations.\nMust not be empty.","items":{"description":"List of applied aggregations.","enum":["BY_TAX_RATE","BY_TAX_CODE","BY_JURISDICTION_TYPE","BY_SHIPPING_COST","BY_ITEM_EXTRA","BY_ARTICLE_NUMBER","BY_ARTICLE_NUMBER_AND_ITEM_EXTRA","BY_CANADIAN_TAX_NAME","BY_DEBIT_CREDIT","BY_ITEM_GROUP","BY_POST_TAX_ITEMS"],"type":"string"},"minItems":1,"type":"array"},"aggregationStrategiesExtended":{"description":"List of additional custom aggregations on already applied aggregations, to aggregate results of those aggregations,\ne.g., aggregate Subtotals with itemGroups containing the subTotalSum.grouping_field_value \"Test\" and \"Test2\".\n","items":{"$ref":"#/components/schemas/AggregationStrategyExtendedDto"},"nullable":true,"type":"array"},"creationDate":{"description":"Date when the configuration was defined the first time.\nMust not be null.","format":"date-time","type":"string"},"invoiceType":{"description":"Type of document for which the aggregation shall be used.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| invoice                         |\n| creditmemo                      |\n| order                           |\n| depositinvoice                  |\n| depositinvoicecancellation      |\n| creditmemo_goodwill             |\n| creditmemo_warranty             |\n| self_billing_invoice            |\n| self_billing_invoice_correction |","type":"string"},"lastModified":{"description":"Date when the configuration was changed the last time.\nMust not be null.","format":"date-time","type":"string"}},"required":["aggregationConfigurationIdent","aggregationStrategies","creationDate","invoiceType","lastModified"],"type":"object"},"AggregationConfigurationUpdateRequest":{"description":"Please see AggregationConfigurationUpdateRequest Model below for more information regarding required values and input type.","properties":{"aggregationStrategies":{"description":"List of applied aggregations.\nMust not be empty.","items":{"description":"List of applied aggregations.","enum":["BY_TAX_RATE","BY_TAX_CODE","BY_JURISDICTION_TYPE","BY_SHIPPING_COST","BY_ITEM_EXTRA","BY_ARTICLE_NUMBER","BY_ARTICLE_NUMBER_AND_ITEM_EXTRA","BY_CANADIAN_TAX_NAME","BY_DEBIT_CREDIT","BY_ITEM_GROUP","BY_POST_TAX_ITEMS"],"type":"string"},"minItems":1,"type":"array"},"aggregationStrategiesExtended":{"description":"List of additional custom aggregations on already applied aggregations, to aggregate results of those aggregations,\ne.g., aggregate Subtotals with itemGroups containing the subTotalSum.grouping_field_value \"Test\" and \"Test2\".\n","items":{"$ref":"#/components/schemas/AggregationStrategyExtendedDto"},"nullable":true,"type":"array"}},"required":["aggregationStrategies"],"type":"object"},"AggregationPriceDto":{"description":"Structure representing a price with its net, tax and gross amounts.","properties":{"gross":{"description":"Gross price.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":23.8,"type":"number"},"net":{"description":"Net price.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":20,"type":"number"},"tax":{"description":"Tax amount.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":3.8,"type":"number"}},"required":["gross","net","tax"],"type":"object"},"AggregationStrategyExtendedDto":{"description":"List of additional custom aggregations on already applied aggregations, to aggregate results of those aggregations,\ne.g., aggregate Subtotals with itemGroups containing the subTotalSum.grouping_field_value \"Test\" and \"Test2\".\n","nullable":true,"properties":{"customSubtotals":{"description":"List of custom aggregations on the chosen aggregation type.\nMust not be empty.","items":{"$ref":"#/components/schemas/CustomSubtotalDto"},"minItems":1,"type":"array"},"type":{"description":"Type of aggregation strategy for which the custom aggregation shall be used, this aggregation needs to be selected as well in the aggregationStrategies block.\nMust not be null.\nMust be one of:\n|                                  |\n| -------------------------------- |\n| BY_TAX_RATE                      |\n| BY_TAX_CODE                      |\n| BY_JURISDICTION_TYPE             |\n| BY_SHIPPING_COST                 |\n| BY_ITEM_EXTRA                    |\n| BY_ARTICLE_NUMBER                |\n| BY_ARTICLE_NUMBER_AND_ITEM_EXTRA |\n| BY_CANADIAN_TAX_NAME             |\n| BY_DEBIT_CREDIT                  |\n| BY_ITEM_GROUP                    |\n| BY_POST_TAX_ITEMS                |","type":"string"}},"required":["customSubtotals","type"],"type":"object"},"AgreedDepositDto":{"nullable":true,"properties":{"debitCreditIndicator":{"description":"Must be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","nullable":true,"type":"string"},"grossValue":{"nullable":true,"type":"number"},"ident":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"netValue":{"nullable":true,"type":"number"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"status":{"description":"Must be one of:\n|          |\n| -------- |\n| EXPECTED |\n| PAID     |","nullable":true,"type":"string"},"taxInformation":{"items":{"$ref":"#/components/schemas/AgreedDepositTaxInformationDto"},"nullable":true,"type":"array"},"taxValue":{"nullable":true,"type":"number"}},"type":"object"},"AgreedDepositTaxInformationDto":{"nullable":true,"properties":{"taxCode":{"nullable":true,"type":"string"},"taxRate":{"nullable":true,"type":"number"},"taxValue":{"nullable":true,"type":"number"}},"type":"object"},"AttachmentDto":{"nullable":true,"properties":{"fileName":{"description":"Must not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"ident":{"description":"Must not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["fileName","ident"],"type":"object"},"AvailableMigrationsDto":{"properties":{"migrations":{"description":"List of available migrations.\nMust not be null.","items":{"description":"List of available migrations","type":"string"},"type":"array"}},"required":["migrations"],"type":"object"},"BillingGroupSeparationCondition":{"description":"Which documents to apply the configuration to.","properties":{"billingGroupIdent":{"description":"Ident of the Billing group for which the configuration applies.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"documentType":{"description":"Document type this configuration applies to.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"required":["billingGroupIdent","documentType"],"type":"object"},"BlockPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasis"},{"properties":{"blockPrice":{"type":"number"},"blockQuantity":{"type":"number"},"blockSize":{"type":"number"},"netGrossIndicator":{"enum":["NET","GROSS"],"type":"string"},"totalPrice":{"type":"number"},"usedQuantity":{"type":"number"}},"type":"object"}],"type":"object"},"CreditMemoCreationRequest":{"description":"Creates a document of type credit memo.","properties":{"billingGroupIdent":{"description":"The `billingGroupIdent` of the document. Must be an existing billing group configured for external billing. See [Billing Group API](createbillinggroup_v3).\nMust not be blank.","minLength":1,"type":"string"},"currency":{"description":"The currency of the document. The same currency is used for all monetary values in this document.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"customerDetail":{"$ref":"#/components/schemas/CustomerDetailRequest"},"documentDate":{"description":"The date of the document. If not set the current UTC date will be used.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"ident":{"description":"Unique external reference a.k.a. document number. Depending on the document number configuration, this field is mandatory or must be omitted.","nullable":true,"type":"string"},"items":{"description":"A list of items included in the document.\nMust not be null.\nSize must be between 1 and 100.","items":{"$ref":"#/components/schemas/DocumentItemRequest"},"maxItems":100,"minItems":1,"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...).\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","example":"de","type":"string"},"operatingSiteIdent":{"description":"Ident of the operating site for the document.\nIf omitted, the default operating site is used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"Default","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"orderDate":{"description":"The date of the order.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/DocumentPaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/DocumentPaymentTermDto"},"postTaxItems":{"description":"Document post tax items","items":{"$ref":"#/components/schemas/DocumentPostTaxItemDto"},"nullable":true,"type":"array"},"properties":{"description":"Document properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"relatedDocumentIdent":{"description":"The identifier which relates to the related document. Mandatory for documents that relates to others.\nExamples:\n    - An invoice that relates to a deposit invoice\n    - A credit memo that relates to an invoice\n\nMust not be null.","type":"string"},"requestId":{"description":"Unique identifier of the creation request.\nCreation will be aborted if this `requestId` already exists.\nIf not sent, no validation will be performed.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"sellerOperatingSiteIdent":{"description":"Ident of the seller operating site for the document.\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,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"subType":{"description":"The sub-type of this credit memo.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| DEFAULT  |\n| GOODWILL |\n| WARRANTY |","type":"string"}},"required":["billingGroupIdent","currency","customerDetail","items","language","relatedDocumentIdent","requestId","subType"],"type":"object"},"CustomSubtotalDto":{"description":"List of custom aggregations on the chosen aggregation type.","properties":{"items":{"description":"Elements to be included in the custom subtotal. Must be values used in the standard aggregation strategy as groupingFieldValue.\nMust not be empty.","items":{"description":"Elements to be included in the custom subtotal. Must be values used in the standard aggregation strategy as groupingFieldValue.","type":"string"},"minItems":1,"type":"array"},"name":{"description":"Name of custom-defined subtotals that can be used for document templating.\nMust not be null.","type":"string"}},"required":["items","name"],"type":"object"},"CustomerDetailRequest":{"description":"Specifies the customer to be use for the document. Must be an existing customer in Nitrobox. [Customer API](createcustomer)","properties":{"customerIdent":{"description":"Unique identifier of the customer.\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"},"debtorAccountNumber":{"description":"Debtor account number.","nullable":true,"type":"string"},"invoiceAddressIdent":{"description":"Must be the ident of an address of type `INVOICE` belonging to the customer.\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"},"shippingAddressIdent":{"description":"Optional ident of an address of type `SHIPPING` belonging to the customer.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["customerIdent","invoiceAddressIdent"],"type":"object"},"CustomerPaymentAccountDto":{"nullable":true,"properties":{"accountHolderName":{"nullable":true,"type":"string"},"displayName":{"nullable":true,"type":"string"},"ident":{"nullable":true,"type":"string"},"paymentCardType":{"nullable":true,"type":"string"},"paymentMethod":{"nullable":true,"type":"string"}},"type":"object"},"DepositDto":{"nullable":true,"properties":{"assignmentIdent":{"nullable":true,"type":"string"},"debitCreditIndicator":{"description":"Must be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","nullable":true,"type":"string"},"grossValue":{"nullable":true,"type":"number"},"ident":{"nullable":true,"type":"string"},"netValue":{"nullable":true,"type":"number"},"paymentIdent":{"nullable":true,"type":"string"},"taxInformation":{"items":{"$ref":"#/components/schemas/AgreedDepositTaxInformationDto"},"nullable":true,"type":"array"},"taxValue":{"nullable":true,"type":"number"}},"type":"object"},"DepositInvoiceCorrectionCreationRequest":{"description":"Creates a document of type deposit invoice correction.","properties":{"billingGroupIdent":{"description":"The `billingGroupIdent` of the document. Must be an existing billing group configured for external billing. See [Billing Group API](createbillinggroup_v3).\nMust not be blank.","minLength":1,"type":"string"},"currency":{"description":"The currency of the document. The same currency is used for all monetary values in this document.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"customerDetail":{"$ref":"#/components/schemas/CustomerDetailRequest"},"documentDate":{"description":"The date of the document. If not set the current UTC date will be used.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"ident":{"description":"Unique external reference a.k.a. document number. Depending on the document number configuration, this field is mandatory or must be omitted.","nullable":true,"type":"string"},"items":{"description":"A list of items included in the document.\nMust not be null.\nSize must be between 1 and 100.","items":{"$ref":"#/components/schemas/DocumentItemRequest"},"maxItems":100,"minItems":1,"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...).\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","example":"de","type":"string"},"operatingSiteIdent":{"description":"Ident of the operating site for the document.\nIf omitted, the default operating site is used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"Default","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"orderDate":{"description":"The date of the order.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/DocumentPaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/DocumentPaymentTermDto"},"postTaxItems":{"description":"Document post tax items","items":{"$ref":"#/components/schemas/DocumentPostTaxItemDto"},"nullable":true,"type":"array"},"properties":{"description":"Document properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"relatedDocumentIdent":{"description":"The identifier which relates to the related document. Mandatory for documents that relates to others.\nExamples:\n    - An invoice that relates to a deposit invoice\n    - A credit memo that relates to an invoice\n\nMust not be null.","type":"string"},"requestId":{"description":"Unique identifier of the creation request.\nCreation will be aborted if this `requestId` already exists.\nIf not sent, no validation will be performed.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"sellerOperatingSiteIdent":{"description":"Ident of the seller operating site for the document.\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,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["billingGroupIdent","currency","customerDetail","items","language","relatedDocumentIdent","requestId"],"type":"object"},"DepositInvoiceCreationRequest":{"description":"Creates a document of type deposit invoice.","properties":{"billingGroupIdent":{"description":"The `billingGroupIdent` of the document. Must be an existing billing group configured for external billing. See [Billing Group API](createbillinggroup_v3).\nMust not be blank.","minLength":1,"type":"string"},"currency":{"description":"The currency of the document. The same currency is used for all monetary values in this document.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"customerDetail":{"$ref":"#/components/schemas/CustomerDetailRequest"},"documentDate":{"description":"The date of the document. If not set the current UTC date will be used.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"ident":{"description":"Unique external reference a.k.a. document number. Depending on the document number configuration, this field is mandatory or must be omitted.","nullable":true,"type":"string"},"items":{"description":"A list of items included in the document.\nMust not be null.\nSize must be between 1 and 100.","items":{"$ref":"#/components/schemas/DocumentItemRequest"},"maxItems":100,"minItems":1,"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...).\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","example":"de","type":"string"},"operatingSiteIdent":{"description":"Ident of the operating site for the document.\nIf omitted, the default operating site is used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"Default","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"orderDate":{"description":"The date of the order.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"paymentCollection":{"$ref":"#/components/schemas/DocumentPaymentCollectionDto"},"paymentInformation":{"$ref":"#/components/schemas/DocumentPaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/DocumentPaymentTermDto"},"postTaxItems":{"description":"Document post tax items","items":{"$ref":"#/components/schemas/DocumentPostTaxItemDto"},"nullable":true,"type":"array"},"properties":{"description":"Document properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"relatedDocumentIdent":{"description":"The identifier which relates to the related document. Mandatory for documents that relates to others.\n\nExamples:\n    - An invoice that relates to a deposit invoice\n    - A credit memo that relates to an invoice\n","nullable":true,"type":"string"},"requestId":{"description":"Unique identifier of the creation request.\nCreation will be aborted if this `requestId` already exists.\nIf not sent, no validation will be performed.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"sellerOperatingSiteIdent":{"description":"Ident of the seller operating site for the document.\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,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["billingGroupIdent","currency","customerDetail","items","language","paymentCollection","requestId"],"type":"object"},"DetailedOperatingSiteConfigurationResponse":{"description":"Please see DetailedOperatingSiteConfigurationResponse Model below for more information regarding required values and input type. Only one configuration per operatingSiteIdent possible.","properties":{"addressAddition":{"description":"Optional additional address information that helps to identify the exact location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"bankAccount":{"$ref":"#/components/schemas/OperatingSiteConfigurationBankAccountDto"},"city":{"description":"City where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Country code for the country code where the operating site is registered. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","type":"string"},"defaultOperatingSite":{"description":"Defines if the operating site is used as default if none is specified.\nMust not be null.","type":"boolean"},"directors":{"description":"List of directors of the operating site.","items":{"description":"List of directors of the operating site.","nullable":true,"type":"string"},"nullable":true,"type":"array"},"email":{"description":"Email that is used to contact the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"name":{"description":"Company name is the name of a company which must be entered in the commercial register.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"operatingSiteIdent":{"description":"Unique reference to the operating sites that refers to the tenant, set by creator of operating site.\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"},"phoneNumber":{"description":"The phone number to get in touch with the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postOfficeBox":{"description":"Number of the post office box from operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"state":{"description":"State where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"stateCode":{"description":"State code where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Street of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"streetNumber":{"description":"Street number of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxNumber":{"description":"Tax number of the registered operating site.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"taxRegistrations":{"description":"List of additional tax registrations.","items":{"$ref":"#/components/schemas/TaxRegistrationDto"},"nullable":true,"type":"array"},"type":{"description":"Denotes the type of the operating site, for example main company headquarters or non-self-sustaining subsidiary.\nMust not be null.\nMust be one of:\n|                                |\n| ------------------------------ |\n| HEADQUARTERS                   |\n| NON_SELF_SUSTAINING_SUBSIDIARY |","type":"string"},"vatId":{"description":"Vat id of the registered operating site. Can be overridden by country specific vatIDs through taxRegistrations. For Backward compatibility vatNumber is accepted as Alias.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"vatNumber":{"deprecated":true,"description":"DEPRECATED please change to vat id.","nullable":true,"type":"string"},"zip":{"description":"Postcode where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["country","defaultOperatingSite","name","operatingSiteIdent","type"],"type":"object"},"DocumentAddressDto":{"description":"The AddressDto contains all Information required for the header of the document. Is used either as recipient of the document or as recipient of the shipped goods. ","properties":{"academicTitle":{"description":"The academic title of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"addressAddition":{"description":"Additional address information.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"agencyProfessionTitle":{"description":"Agency profession title of the recipient.","nullable":true,"type":"string"},"city":{"description":"City name.\nSize must be between 0 and 255.","example":"Hamburg","maxLength":255,"nullable":true,"type":"string"},"company":{"description":"Company name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Country code for country of address.\nTwo- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"customerType":{"description":"Type of the customer.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| B2B        |\n| B2C        |\n| AFFILIATED |","type":"string"},"department":{"description":"Department name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParametersDto"},"email":{"description":"Recipient's email.\nSize must be between 0 and 255.","example":"info@customercompany.com","maxLength":255,"nullable":true,"type":"string"},"firstName":{"description":"The first name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"gender":{"description":"The recipient's gender.\nMust be one of:\n|        |\n| ------ |\n| MALE   |\n| FEMALE |\n| OTHER  |\n| NOTSET |","nullable":true,"type":"string"},"ident":{"description":"Unique external reference for the Address.\nMust not be null.\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"},"lastName":{"description":"The last name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postOfficeBox":{"description":"Number of post office box.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postalCode":{"description":"Postal code a.k.a. in US as zip code.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"properties":{"description":"Additional address properties.\nMust not be null.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"state":{"description":"Name of the state.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"stateCode":{"description":"State code.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Name of street.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"streetNumber":{"description":"Street Number.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxNumber":{"description":"Tax identification number.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"vatId":{"description":"VAT identification number.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"}},"required":["country","customerType","ident","properties"],"type":"object"},"DocumentAggregationDto":{"description":"Structured list of aggregation results.","properties":{"aggregationStrategy":{"description":"Used aggregation.\nMust not be null.\nMust be one of:\n|                                  |\n| -------------------------------- |\n| BY_TAX_RATE                      |\n| BY_TAX_CODE                      |\n| BY_JURISDICTION_TYPE             |\n| BY_SHIPPING_COST                 |\n| BY_ITEM_EXTRA                    |\n| BY_ARTICLE_NUMBER                |\n| BY_ARTICLE_NUMBER_AND_ITEM_EXTRA |\n| BY_CANADIAN_TAX_NAME             |\n| BY_DEBIT_CREDIT                  |\n| BY_ITEM_GROUP                    |\n| BY_POST_TAX_ITEMS                |","example":"BY_TAX_CODE","type":"string"},"customResults":{"description":"List of aggregation results when extended aggregation is applied to the aggregation result.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentAggregationExtendedResultDto"},"type":"array"},"results":{"description":"List of aggregation results.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentAggregationResultDto"},"type":"array"}},"required":["aggregationStrategy","customResults","results"],"type":"object"},"DocumentAggregationExtendedResultDto":{"description":"List of aggregation results when extended aggregation is applied to the aggregation result.","properties":{"items":{"description":"Items defined in the configuration for this extended aggregation.\nMust not be null.","items":{"description":"Items defined in the configuration for this extended aggregation.","type":"string"},"type":"array"},"name":{"description":"Name defined in the configuration for this extended aggregation.\nMust not be null.","example":"TAXCODES A6 and A9","type":"string"},"originalTotal":{"$ref":"#/components/schemas/AggregationPriceDto"},"total":{"$ref":"#/components/schemas/AggregationPriceDto"},"totalDepositSum":{"description":"Sum of all deposits. Is always negative. Not in all Aggregation Strategies included.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":0,"type":"number"},"totalPostTaxSum":{"description":"Sum of all post tax allowances (a.k.a. post tax extras). Is always positive. Not in all Aggregation Strategies included.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":0,"type":"number"}},"required":["items","name","originalTotal","total","totalDepositSum","totalPostTaxSum"],"type":"object"},"DocumentAggregationResponse":{"properties":{"aggregationConfigurationIdent":{"description":"Unique external reference of the aggregation configuration.\nMust not be null.","example":"BY_TAX_RATE_invoice","type":"string"},"aggregations":{"description":"Structured list of aggregation results.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentAggregationDto"},"type":"array"},"currency":{"description":"The document's currency.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"documentIdent":{"description":"Unique external reference of the document a.k.a document number.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"24-000001","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},"required":["aggregationConfigurationIdent","aggregations","currency","documentIdent"],"type":"object"},"DocumentAggregationResultDto":{"description":"List of aggregation results.","properties":{"aggregationValue":{"description":"Value of the 1st level of aggregations.\nMust not be null.","example":"A6","type":"string"},"originalTotal":{"$ref":"#/components/schemas/AggregationPriceDto"},"subResults":{"description":"List of 2nd level aggregations. Is empty if no 2nd level aggregation is available.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentAggregationSubResultDto"},"type":"array"},"total":{"$ref":"#/components/schemas/AggregationPriceDto"},"totalDepositSum":{"description":"Sum of all deposits. Is always negative. Not in all Aggregation Strategies included.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":0,"type":"number"},"totalPostTaxSum":{"description":"Sum of all post tax allowances (a.k.a. post tax extras). Is always positive. Not in all Aggregation Strategies included.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":0,"type":"number"}},"required":["aggregationValue","originalTotal","subResults","total","totalDepositSum","totalPostTaxSum"],"type":"object"},"DocumentAggregationSubResultDto":{"description":"List of 2nd level aggregations. Is empty if no 2nd level aggregation is available.","properties":{"aggregationSubValue":{"description":"Value of the 2nd level of aggregations, can be null if there is no such 2nd level.\nFor example when Aggregation BY_TAX_CODE is used the 1st level is the taxCode and the second level is the taxRate.","example":"19.0","nullable":true,"type":"string"},"originalTotal":{"$ref":"#/components/schemas/AggregationPriceDto"},"total":{"$ref":"#/components/schemas/AggregationPriceDto"},"totalDepositSum":{"description":"Sum of all deposits. Is always negative. Not in all Aggregation Strategies included.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":0,"type":"number"},"totalPostTaxSum":{"description":"Sum of all post tax allowances (a.k.a. post tax extras). Is always positive. Not in all Aggregation Strategies included.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":0,"type":"number"}},"required":["originalTotal","total","totalDepositSum","totalPostTaxSum"],"type":"object"},"DocumentBillingPeriodDto":{"description":"Billing period.","nullable":true,"properties":{"end":{"description":"End of the billing period.\nMust not be null.\nISO 8601 date-time with an offset from UTC/Greenwich (`YYYY-MM-DDThh:mm:ssZ` or `YYYY-MM-DDThh:mm:ss+hh:mm`)","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"start":{"description":"Start of the billing period.\nMust not be null.\nISO 8601 date-time with an offset from UTC/Greenwich (`YYYY-MM-DDThh:mm:ssZ` or `YYYY-MM-DDThh:mm:ss+hh:mm`)","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"}},"required":["end","start"],"type":"object"},"DocumentCounter":{"description":"A counter used to assign document numbers.","properties":{"ident":{"description":"Unique identifier.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"lowerLimit":{"default":1,"description":"Minimal counter value, used for first document. And after `reset`, if configured.\nMust not be null.\nMust be greater than or equal to 0.","format":"int64","minimum":0,"type":"integer"},"mask":{"description":"Counter mask, will be overlaid with current counter (`mask=0000` + `counter=12` => `0012`).\nSize must be between 0 and 175.","maxLength":175,"nullable":true,"type":"string"},"prefix":{"description":"Document number prefix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"},"reset":{"description":"If and when to reset the counter value.\nMust be one of:\n|          |\n| -------- |\n| NEW_YEAR |","nullable":true,"type":"string"},"suffix":{"description":"Document number suffix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"},"upperLimit":{"description":"Maximal counter value or null. When a number is provided, it defines the highest permissible value and must be above the lowerLimit.","format":"int64","nullable":true,"type":"integer"},"value":{"description":"Current counter value, i.e. the counter value that was used in the latest invoice.\nMust not be null.\nMust be greater than or equal to 0.","format":"int64","minimum":0,"type":"integer"}},"required":["ident","value"],"type":"object"},"DocumentCounterCreationRequest":{"description":"Creation request for a document counter used to assign document numbers.","properties":{"ident":{"description":"Unique identifier.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"lowerLimit":{"default":1,"description":"Minimal counter value, used for first document. And after `reset`, if configured.\nMust not be null.\nMust be greater than or equal to 0.","format":"int64","minimum":0,"type":"integer"},"mask":{"description":"Counter mask, will be overlaid with current counter (`mask=0000` + `counter=12` => `0012`).\nSize must be between 0 and 175.","maxLength":175,"nullable":true,"type":"string"},"prefix":{"description":"Document number prefix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"},"reset":{"description":"If and when to reset the counter value.\nMust be one of:\n|          |\n| -------- |\n| NEW_YEAR |","nullable":true,"type":"string"},"suffix":{"description":"Document number suffix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"},"upperLimit":{"description":"Maximal counter value or null. When a number is provided, it defines the highest permissible value and must be above the lowerLimit.","format":"int64","nullable":true,"type":"integer"}},"required":["ident"],"type":"object"},"DocumentCounterUpdateRequest":{"description":"Update request for a document counter used to assign document numbers.","properties":{"lowerLimit":{"default":1,"description":"Minimal counter value, used for first document. And after `reset`, if configured.\nMust not be null.\nMust be greater than or equal to 0.","format":"int64","minimum":0,"type":"integer"},"mask":{"description":"Counter mask, will be overlaid with current counter (`mask=0000` + `counter=12` => `0012`).\nSize must be between 0 and 175.","maxLength":175,"nullable":true,"type":"string"},"prefix":{"description":"Document number prefix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"},"reset":{"description":"If and when to reset the counter value.\nMust be one of:\n|          |\n| -------- |\n| NEW_YEAR |","nullable":true,"type":"string"},"suffix":{"description":"Document number suffix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"},"upperLimit":{"description":"Maximal counter value or null. When a number is provided, it defines the highest permissible value and must be above the lowerLimit.","format":"int64","nullable":true,"type":"integer"}},"type":"object"},"DocumentCustomerDetailDto":{"description":"Detailed information of the customer.","properties":{"contractorReferenceIdent":{"description":"Contractor (reference) id which can be used for example as customer support ident by third parties' system","nullable":true,"type":"string"},"contractorReferenceType":{"description":"Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID","nullable":true,"type":"string"},"customerIdent":{"description":"Ident of the customer for the document.\nMust not be blank.","minLength":1,"type":"string"},"debtorAccountNumber":{"description":"Debtor account number.","nullable":true,"type":"string"},"invoiceAddress":{"allOf":[{"$ref":"#/components/schemas/DocumentAddressDto"}],"type":"object"},"shippingAddress":{"allOf":[{"$ref":"#/components/schemas/DocumentAddressDto"}],"nullable":true,"type":"object"},"taxClassifications":{"description":"Customer-specific tax classification.\nMust not be null.","items":{"$ref":"#/components/schemas/TaxClassificationDto"},"type":"array"}},"required":["customerIdent","invoiceAddress","taxClassifications"],"type":"object"},"DocumentCustomerPaymentAccountDto":{"description":"Customer payment account information. Always set when `paymentControl == CHARGE`.","nullable":true,"properties":{"accountHolderName":{"description":"Account holder name used for the charging.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"displayName":{"description":"Name for the customer payment account displayed on invoices. Should not contain full payment data like credit card no, IBAN, etc. (e.g. \"**** **** *** *234\").\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"ident":{"description":"Unique identifier of the customer payment account.\nMust not be null.\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"},"paymentCardType":{"description":"The vendor of the payment card.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"paymentMethod":{"description":"Payment method associated with the customerPaymentAccount via the paymentProviderReference.The specification is only for further explanation and has no effect on the actual selection of the payment method.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["ident"],"type":"object"},"DocumentDto":{"description":"Persisted Document","properties":{"billingGroupIdent":{"description":"The `billingGroupIdent` of the document.\nMust not be blank.","minLength":1,"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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"currency":{"description":"The document's currency.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"customSubTotalSums":{"deprecated":true,"description":"DEPRECATED: Please use \"Retrieve document aggregations\" endpoint.\n\nWill be sunset latest on 2026-07-22.\n\nTotals from configured custom document aggregations.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentSubTotalSumDto"},"type":"array"},"customerDetail":{"$ref":"#/components/schemas/DocumentCustomerDetailDto"},"documentDate":{"description":"The date of the document.\nMust not be null.\nISO 8601 date (`YYYY-MM-DD`)","example":"2024-03-08","format":"date","type":"string"},"documentTotals":{"$ref":"#/components/schemas/DocumentTotalsDto"},"dueDate":{"description":"The due date of the document.\nMust not be null.\nISO 8601 date (`YYYY-MM-DD`)","example":"2024-03-08","format":"date","type":"string"},"dunningLevel":{"description":"Dunning level of the document.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| COMPLETED           |\n| WITHIN_PAYMENT_TERM |\n| DUNNING_LEVEL_1     |\n| DUNNING_LEVEL_2     |\n| DUNNING_LEVEL_3     |\n| DUNNING_LEVEL_4     |","type":"string"},"ident":{"description":"Unique document reference a.k.a. document number.\nMust not be null.\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"},"items":{"description":"Document items.\nMust not be empty.","items":{"$ref":"#/components/schemas/DocumentItemDto"},"minItems":1,"type":"array"},"labels":{"description":"List of labels assigned to this document.\nMust not be null.","items":{"$ref":"#/components/schemas/LabelDto"},"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...).\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"nextDunningLevelDate":{"description":"The UTC date-time of the next status for dunning process.\nMust not be null.\nISO 8601 date-time with an offset from UTC/Greenwich (`YYYY-MM-DDThh:mm:ssZ` or `YYYY-MM-DDThh:mm:ss+hh:mm`)","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"operatingSite":{"allOf":[{"$ref":"#/components/schemas/DocumentOperatingSiteDto"}],"description":"Operating site of the document. Is null for documents created before 2023.","nullable":true,"type":"object"},"oposCaseIdent":{"description":"Ident of the OposCase related to this document. The OposCase handles the open position management of related document and payments. Can be Empty for legacy documents.","nullable":true,"type":"string"},"orderDate":{"description":"The date of the order.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"paymentCollection":{"$ref":"#/components/schemas/DocumentPaymentCollectionDto"},"paymentInformation":{"$ref":"#/components/schemas/DocumentPaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/DocumentPaymentTermDto"},"postTaxItems":{"description":"Document post tax items.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentPostTaxItemDto"},"type":"array"},"preferredDocumentDelivery":{"default":"NONE","description":"The method by which the document should be delivered.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","type":"string"},"properties":{"description":"Document properties.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"type":"array"},"references":{"description":"The distinct references of the document's items.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentReferenceDto"},"type":"array"},"relatedDocumentDate":{"description":"The date of the related document.","format":"date","nullable":true,"type":"string"},"relatedDocumentIdent":{"description":"The identifier of the related document.","nullable":true,"type":"string"},"requestId":{"description":"Unique identifier of the creation request. It can be null for documents created with the legacy Public API or Documents created before 2024.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"safT":{"$ref":"#/components/schemas/DocumentSafTDto"},"sellerOperatingSite":{"$ref":"#/components/schemas/DocumentSellerOperatingSiteDto"},"serviceCountry":{"description":"The country where the document will be billed.\nTwo- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"subTotalSums":{"deprecated":true,"description":"DEPRECATED: Please use \"Retrieve document aggregations\" endpoint.\n\nWill be sunset latest on 2026-07-22.\n\nTotals from configured predefined document aggregations.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentSubTotalSumDto"},"type":"array"},"type":{"description":"The type of the document.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"},"vatIdValidationResult":{"$ref":"#/components/schemas/DocumentVatIdValidationResultDto"}},"required":["billingGroupIdent","createdAt","currency","customSubTotalSums","customerDetail","documentDate","documentTotals","dueDate","dunningLevel","ident","items","labels","language","lastModifiedAt","nextDunningLevelDate","paymentCollection","postTaxItems","preferredDocumentDelivery","properties","references","serviceCountry","subTotalSums","type"],"type":"object"},"DocumentIdentListDto":{"properties":{"idents":{"description":"Must not be empty.","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["idents"],"type":"object"},"DocumentItemAgreedDepositDto":{"description":"Agreed deposit of a document item.","properties":{"debitCreditIndicator":{"description":"Debit-credit indicator of this deposit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"ident":{"description":"Unique reference of the deposit.\nMust not be null.\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 agreed deposit.","nullable":true,"type":"string"},"properties":{"description":"Properties of this deposit.\nMust not be null.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"status":{"description":"Status of this agreed deposit.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| EXPECTED |\n| PAID     |","type":"string"},"taxDetail":{"$ref":"#/components/schemas/DocumentItemDepositTaxDetailDto"},"value":{"$ref":"#/components/schemas/PriceDto"}},"required":["debitCreditIndicator","ident","properties","status","taxDetail","value"],"type":"object"},"DocumentItemBlockPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/DocumentItemPriceCalculationBasis"},{"properties":{"blockPrice":{"description":"Price per started block.","type":"number"},"blockQuantity":{"description":"Number of times a block has been reached.","type":"number"},"blockSize":{"description":"Size of each block.","type":"number"},"netGrossIndicator":{"description":"If the price should be considered as net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"totalPrice":{"description":"The total price per block in case a block is started multiple times.","type":"number"},"type":{"description":"Type of price calculation basis.\nMust be one of:\n|       |\n| ----- |\n| BLOCK |","example":"BLOCK","type":"string"},"usedQuantity":{"description":"Actual quantity used within this block tier.","type":"number"}},"type":"object"}],"description":"Pricing is calculated based on predefined fixed-quantity blocks, each with its own total price, regardless of individual unit consumption. Maps to Usage Options of type contingent.","required":["type"],"type":"object"},"DocumentItemDepositDto":{"description":"Deposit of a document item.","properties":{"debitCreditIndicator":{"description":"Debit-credit indicator of this deposit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"ident":{"description":"Unique reference of the deposit.\nMust not be null.\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"},"paymentAssignmentIdent":{"description":"The [payment assignment](getpaymentassignment) of this deposit.\nMust not be null.\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"},"paymentIdent":{"description":"The [payment transaction](getpaymenttransactionbyident) of this deposit.\nMust not be null.\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"},"taxDetail":{"$ref":"#/components/schemas/DocumentItemDepositTaxDetailDto"},"value":{"$ref":"#/components/schemas/PriceDto"}},"required":["debitCreditIndicator","ident","paymentAssignmentIdent","paymentIdent","taxDetail","value"],"type":"object"},"DocumentItemDepositTaxDetailDto":{"description":"Tax detail of deposit on item","properties":{"taxInformation":{"description":"A list of tax information for this deposit.\nMust not be null.\nMust not be empty.","items":{"$ref":"#/components/schemas/DocumentItemDepositTaxInformationDto"},"minItems":1,"type":"array"}},"required":["taxInformation"],"type":"object"},"DocumentItemDepositTaxInformationDto":{"description":"A tax information for this deposit, for the specific Tax.","properties":{"tax":{"description":"The tax amount for this tax.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"taxCode":{"description":"The tax code of this tax detail.","nullable":true,"type":"string"},"taxRate":{"description":"The rate at which this tax detail was calculated.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"}},"required":["tax","taxRate"],"type":"object"},"DocumentItemDto":{"description":"An item which belongs to the document","properties":{"agreedDeposits":{"description":"Agreed deposits on the document item.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentItemAgreedDepositDto"},"type":"array"},"articleNumber":{"description":"The SKU/article number.","nullable":true,"type":"string"},"billingPeriod":{"$ref":"#/components/schemas/DocumentBillingPeriodDto"},"category":{"description":"Category of the item.\nMust not be null.\nMust be one of:\n|                         |\n| ----------------------- |\n| DIGITAL_PRODUCT         |\n| DIGITAL_PRODUCT_RENTAL  |\n| DISCOUNT                |\n| ELECTRICITY             |\n| ELECTRICITY_RESALE      |\n| LABOR_COST              |\n| LOGISTIC_COST           |\n| PHYSICAL_PRODUCT        |\n| PHYSICAL_PRODUCT_RENTAL |\n| SERVICE                 |\n| VOUCHER                 |\n| VOUCHER_APPLICATION     |","type":"string"},"deposits":{"description":"Deposits on the document item.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentItemDepositDto"},"type":"array"},"description":{"description":"The document item's description.","nullable":true,"type":"string"},"extras":{"description":"Document item extras. This are elements that can reduce the value of this item.\nFor example an item with 100 Euro original gross value is reduced by an item extra (10% voucher for this item) to 90 euro total gross value.","items":{"$ref":"#/components/schemas/DocumentItemExtraDto"},"nullable":true,"type":"array"},"ident":{"description":"Must be a 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"},"itemGroup":{"description":"The group to which an item belongs.\nSize must be between 0 and 64.","maxLength":64,"nullable":true,"type":"string"},"lineItemType":{"description":"Line item type of the document item. Determines if this item was a service rendered to your customer (SALES) or by your customer (SELF-BILLING).\nMust not be null.\nMust be one of:\n|              |\n| ------------ |\n| SALES        |\n| SELF_BILLING |","type":"string"},"name":{"description":"Name of the document item.","nullable":true,"type":"string"},"performanceLocation":{"$ref":"#/components/schemas/PerformanceLocationDto"},"priceCalculationBasis":{"description":"Base price calculation basis for a document item. Per Item only one type of priceCalculationBasis is allowed.","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentItemBlockPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemProgressiveTierPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemRecurringPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemSingleTierPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemTimeBasedUsagePriceCalculationBasisDto"}]},"nullable":true,"type":"array"},"prices":{"$ref":"#/components/schemas/PricesDto"},"properties":{"description":"Document item properties","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"quantity":{"description":"The count of items.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":100,"type":"number"},"quantityType":{"description":"Type of quantity.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| PC     |\n| KWH    |\n| SECOND |\n| MINUTE |\n| HOUR   |\n| DAY    |\n| WEEK   |\n| MONTH  |\n| YEAR   |","type":"string"},"reference":{"$ref":"#/components/schemas/DocumentReferenceDto"},"refundabilityType":{"description":"Decides whether this item is refundable or not. Is only applied if the category == VOUCHER or VOUCHER_APPLICATION.\nMust be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"servicePeriod":{"$ref":"#/components/schemas/DocumentServicePeriodDto"},"taxDetail":{"$ref":"#/components/schemas/DocumentItemTaxDetailDto"},"taxLocation":{"$ref":"#/components/schemas/TaxLocationDto"}},"required":["agreedDeposits","category","deposits","ident","lineItemType","performanceLocation","prices","quantity","quantityType","reference","taxDetail"],"type":"object"},"DocumentItemExtraDto":{"description":"Document item extras. This are elements that can reduce the value of this item.\nFor example an item with 100 Euro original gross value is reduced by an item extra (10% voucher for this item) to 90 euro total gross value.\n","properties":{"externalReference":{"description":"Additional external reference.","nullable":true,"type":"string"},"ident":{"description":"Unique external reference.\nMust not be null.\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 extra.","nullable":true,"type":"string"},"price":{"$ref":"#/components/schemas/ItemExtraPriceDto"},"properties":{"description":"Document item extra properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"refundabilityType":{"description":"Decides whether this extra item is refundable or not.\nMust not be null.\nMust be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","example":"REFUNDABLE","type":"string"},"taxDetail":{"$ref":"#/components/schemas/DocumentItemExtraTaxDetailDto"},"type":{"description":"Type of the extra.\nMust not be null.\nMust be one of:\n|                        |\n| ---------------------- |\n| VOUCHER                |\n| DISCOUNT               |\n| SINGLE_PURPOSE_VOUCHER |","example":"SINGLE_PURPOSE_VOUCHER","type":"string"}},"required":["ident","price","refundabilityType","taxDetail","type"],"type":"object"},"DocumentItemExtraTaxDetailDto":{"description":"Tax detail of item extra","properties":{"taxInformation":{"description":"A list of tax details for this document item.\nMust not be empty.","items":{"$ref":"#/components/schemas/DocumentItemExtraTaxInformationDto"},"minItems":1,"type":"array"}},"required":["taxInformation"],"type":"object"},"DocumentItemExtraTaxInformationDto":{"description":"Tax information details on item extra level.","properties":{"jurisdiction":{"$ref":"#/components/schemas/DocumentItemTaxInformationJurisdictionDto"},"tax":{"description":"The tax amount for this tax.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"taxCode":{"description":"The tax code of this tax detail.","nullable":true,"type":"string"},"taxName":{"description":"The name of the tax against which this tax amount was calculated.","nullable":true,"type":"string"},"taxRate":{"description":"The rate at which this tax detail was calculated.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"taxType":{"description":"The type of tax that was calculated.","nullable":true,"type":"string"}},"required":["tax","taxRate"],"type":"object"},"DocumentItemPriceCalculationBasis":{"description":"Provides additional context on how the values of this item was calculated.","discriminator":{"mapping":{"BLOCK":"#/components/schemas/DocumentItemBlockPriceCalculationBasisDto","RECURRING":"#/components/schemas/DocumentItemRecurringPriceCalculationBasisDto","TIER_PROGRESSIVE":"#/components/schemas/DocumentItemProgressiveTierPriceCalculationBasisDto","TIER_SINGLE":"#/components/schemas/DocumentItemSingleTierPriceCalculationBasisDto","TIME_BASED_USAGE":"#/components/schemas/DocumentItemTimeBasedUsagePriceCalculationBasisDto"},"propertyName":"type"},"properties":{"type":{"description":"Must be one of:\n|                  |\n| ---------------- |\n| BLOCK            |\n| RECURRING        |\n| TIER_SINGLE      |\n| TIER_PROGRESSIVE |\n| TIME_BASED_USAGE |","type":"string"}},"required":["type"],"type":"object"},"DocumentItemPricingPeriodDto":{"description":"Pricing period for a pricing rule.","properties":{"end":{"description":"End time of the pricing rule (exclusive). Time in format HH:mm","example":"14:30","nullable":true,"pattern":"^\\d{2}:\\d{2}$","type":"string"},"start":{"description":"Start time of the pricing rule (inclusive). Time in format HH:mm","example":"14:30","nullable":true,"pattern":"^\\d{2}:\\d{2}$","type":"string"}},"type":"object"},"DocumentItemProgressiveTierPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/DocumentItemPriceCalculationBasis"},{"properties":{"netGrossIndicator":{"description":"If the price should be considered as net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"tierQuantity":{"description":"Size of the tier.","type":"number"},"totalPrice":{"description":"The total price for the entire progressive tier.","type":"number"},"type":{"description":"Type of price calculation basis.\nMust be one of:\n|                  |\n| ---------------- |\n| TIER_PROGRESSIVE |","example":"TIER_PROGRESSIVE","type":"string"},"unitPrice":{"description":"How much each quantity costs in progressive tier.","type":"number"},"usedQuantity":{"description":"How much quantity is actually used in this tier.","type":"number"}},"type":"object"}],"description":"Pricing is calculated based on defined usage tiers, applying progressive unit rates. Maps to Usage Options of type tiered.","required":["type"],"type":"object"},"DocumentItemRecurringPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/DocumentItemPriceCalculationBasis"},{"properties":{"netGrossIndicator":{"description":"If the price should be considered as net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"servicedDaysInPeriod":{"description":"Indicates the actual number of days considered with this item - either days where service was provided or days that were credited.","format":"int64","type":"integer"},"totalDaysInPeriod":{"description":"Indicates the total number of days the service could have been provided within the billing period.","format":"int64","type":"integer"},"totalPrice":{"description":"The total price for the entire item.","type":"number"},"type":{"description":"Type of price calculation basis.\nMust be one of:\n|           |\n| --------- |\n| RECURRING |","example":"RECURRING","type":"string"}},"type":"object"}],"description":"This item has a temporal component which might lead it to be pro rata calculated. This Type of price calculation basis can only occur once per item.","required":["type"],"type":"object"},"DocumentItemRequest":{"description":"An item which belongs to the document","properties":{"articleNumber":{"description":"The SKU/article number.","nullable":true,"type":"string"},"billingPeriod":{"$ref":"#/components/schemas/DocumentBillingPeriodDto"},"category":{"description":"Category of the item.\nMust not be null.\nMust be one of:\n|                         |\n| ----------------------- |\n| DIGITAL_PRODUCT         |\n| DIGITAL_PRODUCT_RENTAL  |\n| DISCOUNT                |\n| ELECTRICITY             |\n| ELECTRICITY_RESALE      |\n| LABOR_COST              |\n| LOGISTIC_COST           |\n| PHYSICAL_PRODUCT        |\n| PHYSICAL_PRODUCT_RENTAL |\n| SERVICE                 |\n| VOUCHER                 |\n| VOUCHER_APPLICATION     |","type":"string"},"description":{"description":"The document item's description.","nullable":true,"type":"string"},"extras":{"description":"Document item extras. This are elements that can reduce the value of this item.\nFor example an item with 100 Euro original gross value is reduced by an item extra (10% voucher for this item) to 90 euro total gross value.","items":{"$ref":"#/components/schemas/DocumentItemExtraDto"},"nullable":true,"type":"array"},"ident":{"description":"Must be a 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"},"itemGroup":{"description":"The group to which an item belongs.\nSize must be between 0 and 64.","maxLength":64,"nullable":true,"type":"string"},"name":{"description":"Name of the document item.","nullable":true,"type":"string"},"performanceLocation":{"$ref":"#/components/schemas/PerformanceLocationDto"},"priceCalculationBasis":{"description":"Base price calculation basis for a document item. Per Item only one type of priceCalculationBasis is allowed.","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentItemBlockPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemProgressiveTierPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemRecurringPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemSingleTierPriceCalculationBasisDto"},{"$ref":"#/components/schemas/DocumentItemTimeBasedUsagePriceCalculationBasisDto"}]},"nullable":true,"type":"array"},"prices":{"$ref":"#/components/schemas/PricesDto"},"properties":{"description":"Document item properties","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"quantity":{"description":"The count of items.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":100,"type":"number"},"quantityType":{"description":"Type of quantity.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| PC     |\n| KWH    |\n| SECOND |\n| MINUTE |\n| HOUR   |\n| DAY    |\n| WEEK   |\n| MONTH  |\n| YEAR   |","type":"string"},"referenceIdent":{"description":"Reference ident for this item","nullable":true,"type":"string"},"refundabilityType":{"description":"Decides whether this item is refundable or not. Is only applied if the category == VOUCHER or VOUCHER_APPLICATION.\nMust be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"servicePeriod":{"$ref":"#/components/schemas/DocumentServicePeriodDto"},"taxDetail":{"$ref":"#/components/schemas/DocumentItemTaxDetailDto"},"taxLocation":{"$ref":"#/components/schemas/TaxLocationDto"}},"required":["category","ident","performanceLocation","prices","quantity","quantityType","taxDetail"],"type":"object"},"DocumentItemSingleTierPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/DocumentItemPriceCalculationBasis"},{"properties":{"netGrossIndicator":{"description":"If the price should be considered as net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"tierQuantity":{"description":"Size of the tier.","type":"number"},"totalPrice":{"description":"The total price for the entire single tier.","type":"number"},"type":{"description":"Type of price calculation basis.\nMust be one of:\n|             |\n| ----------- |\n| TIER_SINGLE |","example":"TIER_SINGLE","type":"string"},"unitPrice":{"description":"How much each quantity costs in single tier.","type":"number"},"usedQuantity":{"description":"How much quantity is actually used in this tier.","type":"number"}},"type":"object"}],"description":"Pricing is calculated based on defined usage tiers, applying a single-tier unit rate. Maps to Usage Options of type volume.","required":["type"],"type":"object"},"DocumentItemTaxDetailDto":{"description":"Tax information on item level.","properties":{"taxInformation":{"description":"A list of tax details for this document item.\n\nAt least one element must exits, even when 0% tax is applied.\n\nFor a single tax case only one element needs to be added\nand for a multiple tax cases, such as Canada or USA one needs to add as many elements as needed.\nMust not be empty.","items":{"$ref":"#/components/schemas/DocumentItemTaxInformationDto"},"minItems":1,"type":"array"},"taxProviderName":{"description":"Name of the tax provider. Not set for legacy documents.\nMust be one of:\n|                   |\n| ----------------- |\n| NITROBOX          |\n| AVALARA           |\n| FINANCE_ENABLER   |\n| CUSTOMER_PROVIDED |\n| CLIENT_PROVIDED   |","nullable":true,"readOnly":true,"type":"string"},"taxProviderProductCode":{"description":"Tax provider specific product code.","nullable":true,"type":"string"},"taxRate":{"description":"The tax rate is the total of all the taxes included in the tax information.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","nullable":true,"readOnly":true,"type":"number"},"taxScheme":{"description":"It defines the taxation procedure of a document item.\n\nOSS = One Stop Shop.\nMust not be null.\nMust be one of:\n|         |\n| ------- |\n| OSS     |\n| DEFAULT |","example":"DEFAULT","type":"string"}},"required":["taxInformation","taxScheme"],"type":"object"},"DocumentItemTaxInformationDto":{"description":"Tax information details on item level.","properties":{"jurisdiction":{"$ref":"#/components/schemas/DocumentItemTaxInformationJurisdictionDto"},"originalTotalTax":{"description":"The row total tax amount without item extras for this tax.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxCode":{"description":"The tax code of this tax.","nullable":true,"type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"The name of the tax against which this tax amount was calculated.","nullable":true,"type":"string"},"taxRate":{"description":"The rate at which this tax was calculated.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"taxType":{"description":"The type of tax that was calculated.","nullable":true,"type":"string"},"totalTax":{"description":"The row total tax amount for this tax.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"unitTax":{"description":"The unit price tax amount without item extras for this tax.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"}},"required":["originalTotalTax","taxRate","totalTax","unitTax"],"type":"object"},"DocumentItemTaxInformationJurisdictionDto":{"description":"Jurisdiction in charge of the Tax.\nFor example in USA there are multiple Taxes applied to an item by different jurisdictions, e.g., State, County, City, and Special.\nThese fields are helping to identify them.\n","nullable":true,"properties":{"code":{"description":"Code of this jurisdiction entity, e.g., 51","nullable":true,"type":"string"},"name":{"description":"Name of this jurisdiction entity, e.g., VIRGINIA","nullable":true,"type":"string"},"type":{"description":"Type of this jurisdiction entity, e.g., State","nullable":true,"type":"string"}},"type":"object"},"DocumentItemTimeBasedUsagePriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/DocumentItemPriceCalculationBasis"},{"properties":{"freeQuota":{"description":"Free quota available within this time slot before charges apply.","type":"number"},"netGrossIndicator":{"description":"If the price should be considered as net or gross.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"pricingPeriod":{"$ref":"#/components/schemas/DocumentItemPricingPeriodDto"},"quantity":{"description":"Measured usage quantity within the defined time slot (number of minutes or seconds).","type":"number"},"totalPrice":{"description":"Total calculated price for the consumed quantity within this time slot.","type":"number"},"type":{"description":"Type of price calculation basis.\nMust be one of:\n|                  |\n| ---------------- |\n| TIME_BASED_USAGE |","example":"TIME_BASED_USAGE","type":"string"},"unitPrice":{"description":"Unit price applied per defined time unit (per minute or per second).","type":"number"}},"type":"object"}],"description":"Pricing is calculated based on usage time, with different rates applicable for different time periods.","required":["type"],"type":"object"},"DocumentNumberBillingGroupSeparationStrategyConfiguration":{"description":"Configuration of a document number strategy.","properties":{"condition":{"$ref":"#/components/schemas/BillingGroupSeparationCondition"},"configuration":{"$ref":"#/components/schemas/DocumentNumberConfiguration"},"ident":{"description":"Unique identifier.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["condition","configuration","ident"],"type":"object"},"DocumentNumberConfiguration":{"description":"Document number configuration to apply","properties":{"counterIdent":{"description":"Ident of the counter to be used in this strategy.\nMust not be null.\nMust not be blank.","minLength":1,"type":"string"},"overrideCounterPrefixSuffix":{"default":true,"description":"Whether to override the prefix and suffix configured directly on the counter.\nMust not be null.","type":"boolean"},"prefix":{"description":"Document number prefix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"},"suffix":{"description":"Document number suffix pattern.\n In the pattern you can use special keywords wrapped with `##` e.g. `##YEAR_SHORT##`.\n Currently supported keywords are:\n\n | Pattern          | Expands to                  | Example for 2019-02-05 |\n | ---------------- | --------------------------- | ---------------------- |\n | `##YEAR##`       | full year, four digits      | `2019`                 |\n | `##YEAR_SHORT##` | short year, last two digits | `19`                   |\n\n **Note**: Yearly counter reset is controlled separately and independent of\n the patterns via [the reset in the counter config](createdocumentcounter).\n The length after expansion of the pre-/suffix can only be up to 20 characters.\n","nullable":true,"type":"string"}},"required":["counterIdent"],"type":"object"},"DocumentNumberDocumentTypeSeparationStrategyConfiguration":{"description":"Configuration of a document number strategy.","properties":{"condition":{"$ref":"#/components/schemas/DocumentTypeSeparationCondition"},"configuration":{"$ref":"#/components/schemas/DocumentNumberConfiguration"},"ident":{"description":"Unique identifier.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["condition","configuration","ident"],"type":"object"},"DocumentNumberServiceCountrySeparationStrategyConfiguration":{"description":"Configuration of a document number strategy.","properties":{"condition":{"$ref":"#/components/schemas/ServiceCountrySeparationCondition"},"configuration":{"$ref":"#/components/schemas/DocumentNumberConfiguration"},"ident":{"description":"Unique identifier.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["condition","configuration","ident"],"type":"object"},"DocumentNumberStrategySelection":{"properties":{"generationMode":{"description":"Generation Mode of the tenant. Who is delivering the document number? Tenant (CLIENT_PROVIDED), NBX (GENERATED), or depending on the strategy configuration (CONFIGURED_XOR_PROVIDED).\nMust not be null.\nMust be one of:\n|                         |\n| ----------------------- |\n| CLIENT_PROVIDED         |\n| GENERATED               |\n| PROVIDED_XOR_CONFIGURED |","example":"GENERATED","type":"string"},"generationStrategy":{"description":"Generation Strategy of the tenant. Which counter type shall be used? For generationMode CLIENT_PROVIDED only NONE is allowed, for CONFIGURED_XOR_PROVIDED only BILLING_GROUP_SEPARATION.\nMust not be null.\nMust be one of:\n|                            |\n| -------------------------- |\n| NONE                       |\n| DEFAULT                    |\n| DOCUMENT_TYPE_SEPARATION   |\n| SERVICE_COUNTRY_SEPARATION |\n| BILLING_GROUP_SEPARATION   |","example":"DOCUMENT_TYPE_SEPARATION","type":"string"}},"required":["generationMode","generationStrategy"],"type":"object"},"DocumentOperatingSiteBankAccountDto":{"description":"Bank account data of the operating site used for this document.","nullable":true,"properties":{"bankName":{"description":"Name of the bank.","nullable":true,"type":"string"},"bic":{"description":"BIC of the bank.","nullable":true,"type":"string"},"iban":{"description":"IBAN of the bank account.","nullable":true,"type":"string"}},"type":"object"},"DocumentOperatingSiteDto":{"description":"Operating site information used for this document.","properties":{"addressAddition":{"description":"Optional additional address information that helps to identify the exact location.","nullable":true,"type":"string"},"bankAccount":{"$ref":"#/components/schemas/DocumentOperatingSiteBankAccountDto"},"city":{"description":"City where the operating site is located.","nullable":true,"type":"string"},"country":{"description":"Country code for the country code where the operating site is registered.\nTwo- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"directors":{"description":"List of directors of the operating site.","items":{"description":"List of directors of the operating site.","nullable":true,"type":"string"},"nullable":true,"type":"array"},"email":{"description":"Email that is used to contact the operating site.","nullable":true,"type":"string"},"ident":{"description":"Identifier of the operating site. It is unique per tenant.\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":"Company name is the name of a company which must be entered in the commercial register.\nMust not be blank.","minLength":1,"type":"string"},"phoneNumber":{"description":"The phone number to get in touch with the operating site.","nullable":true,"type":"string"},"postOfficeBox":{"description":"Number of the post office box from operating site.","nullable":true,"type":"string"},"postalCode":{"description":"Postcode where the operating site is located.","nullable":true,"type":"string"},"state":{"description":"State where the operating site is located.","nullable":true,"type":"string"},"stateCode":{"description":"State code where the operating site is located.","nullable":true,"type":"string"},"street":{"description":"Street of the operating site.","nullable":true,"type":"string"},"streetNumber":{"description":"Street number of the operating site.","nullable":true,"type":"string"},"taxNumber":{"description":"Tax number of the registered operating site.","nullable":true,"type":"string"},"tenantRegistration":{"$ref":"#/components/schemas/DocumentTenantRegistrationDto"},"type":{"description":"Type of the operating site.\nMust not be null.\nMust be one of:\n|                                |\n| ------------------------------ |\n| HEADQUARTERS                   |\n| NON_SELF_SUSTAINING_SUBSIDIARY |","example":"HEADQUARTERS","type":"string"},"vatId":{"description":"VatId of the registered operating site.","nullable":true,"type":"string"}},"required":["country","ident","name","type"],"type":"object"},"DocumentPaymentCollectionDto":{"description":"Contains information about the payment collection for this document.","properties":{"customerPaymentAccount":{"$ref":"#/components/schemas/DocumentCustomerPaymentAccountDto"},"customerPaymentAccountIdent":{"description":"Valid customer payment account ident, required for automatic payment collection by NBX. Mandatory when `paymentControl` is set to CHARGE. Will be deprecated in response, use `customerPaymentAccount.ident` instead.","nullable":true,"type":"string"},"paymentControl":{"description":"If `paymentControl` is set to CHARGE, the automatic payment collection by NBX is enabled. In this case, a valid `customerPaymentAccountIdent` must be provided.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CHARGE   |\n| NOCHARGE |","example":"NOCHARGE","type":"string"}},"required":["paymentControl"],"type":"object"},"DocumentPaymentInformationDto":{"description":"The payment information for the document.","nullable":true,"properties":{"cardType":{"description":"The type of credit card you can choose. Only used, when payment method is \"CREDIT_CARD\".\nMust be one of:\n|                 |\n| --------------- |\n| VISA            |\n| MASTERCARD      |\n| JCB             |\n| AMERICANEXPRESS |\n| DINERSCLUB      |\n| OTHER           |\n| YANDEXBANKCARD  |\n| DISCOVERCARD    |\n| CARTE_BANCAIRE  |","nullable":true,"type":"string"},"displayName":{"description":"Name for the customer payment account displayed on invoices (e.g. \"** ** ** 234\").\n\nDo not send full payment data like credit card no, IBAN, etc.!.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"method":{"description":"Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.","example":"BANKTRANSFER","nullable":true,"type":"string"},"paymentReference":{"description":"Payment reference on the account statement (e.g. invoice number).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"provider":{"description":"The provider that handles the payment.\nMust be one of:\n|                   |\n| ----------------- |\n| ADYEN             |\n| AMAZONPAY         |\n| COMPUTOP          |\n| CONTOWORKS        |\n| FIRSTDATATELECASH |\n| GOCARDLESS        |\n| GOOGLEPAY         |\n| KLARNA            |\n| MOLLIE            |\n| OPTILE            |\n| PAYONE            |\n| PAYPAL            |\n| RATEPAY           |\n| STRIPE            |\n| VWFS_SMARTPAY     |\n| WORLDLINE         |","nullable":true,"type":"string"}},"type":"object"},"DocumentPaymentTermDto":{"description":"Contains information about the payment term for this document.","nullable":true,"properties":{"periodInDays":{"description":"Payment term period in days.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","type":"integer"}},"required":["periodInDays"],"type":"object"},"DocumentPostTaxItemDto":{"description":"An document post tax item extra is a representation of a voucher applied to an item.\nThose itemExtras don't reduce the taxAmount that has to be paid for this item.\n","properties":{"description":{"description":"Description of this post tax item.","nullable":true,"type":"string"},"externalReference":{"description":"Additional reference for third party system.","nullable":true,"type":"string"},"ident":{"description":"Unique external reference.\nMust not be null.\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 post tax extra.","nullable":true,"type":"string"},"price":{"description":"Price of the post tax extra.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":100,"type":"number"},"properties":{"description":"Document item post tax extra properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"refundabilityType":{"description":"Decides whether this extra item is refundable or not.\nMust not be null.\nMust be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","example":"REFUNDABLE","type":"string"},"type":{"description":"Type of the post tax extra.\nMust not be null.\nMust be one of:\n|                       |\n| --------------------- |\n| MULTI_PURPOSE_VOUCHER |","example":"MULTI_PURPOSE_VOUCHER","type":"string"}},"required":["ident","price","refundabilityType","type"],"type":"object"},"DocumentPropertyDto":{"description":"A property is a key-value pair that can be used to extend the entity with additional custom data as needed.","properties":{"key":{"description":"Key of the property.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["key","value"],"type":"object"},"DocumentReferenceDto":{"description":"Reference ident and type for this item","properties":{"ident":{"description":"Reference identifier for this document.\nMust not be blank.","minLength":1,"type":"string"},"type":{"description":"Reference type for this document.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CONTRACT |\n| ORDER    |\n| INVOICE  |\n| EXTERNAL |","type":"string"}},"required":["ident","type"],"type":"object"},"DocumentSafTDto":{"description":"Is an international standard for electronic exchange of reliable accounting data from organizations to a national tax authority or external auditors.\nSaf-T Reports might differ from service country per document.\n","nullable":true,"properties":{"atcud":{"description":"Unique document code that will need to be part of invoices in Portugal from 2022, and is separate from the internal taxpayer invoice number.\nMust not be blank.","minLength":1,"type":"string"},"certificationNumber":{"description":"Certification number allocated to the invoicing system.\nMust not be blank.","minLength":1,"type":"string"},"documentSeries":{"description":"Identifier of the document series that was requested and approved beforehand by the tax authority.\nMust not be blank.","minLength":1,"type":"string"},"documentTypeInternalCode":{"description":"Identifier of the document type. Obtained beforehand by the tax authority.\nMust not be blank.","minLength":1,"type":"string"},"hash":{"description":"Signature of a document that is created based on several parameters using RSA-SHA1.\nMust not be blank.","minLength":1,"type":"string"},"publicKeyVersion":{"description":"Version of the asymmetric public key to identify which key has to be used to decrypt the hash.\nMust not be blank.","minLength":1,"type":"string"},"qrCode":{"description":"Data for a QRCode which contains all the data about a particular invoice coded in line with technical requirements provided by tax authorities.\nMust not be blank.","minLength":1,"type":"string"},"safTCountry":{"description":"Describes for which service country of the document the saf-t rules are applied. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be blank.","minLength":1,"type":"string"},"sequenceNumber":{"description":"Sequence number of the invoice.\nMust not be null.","format":"int64","type":"integer"}},"required":["atcud","certificationNumber","documentSeries","documentTypeInternalCode","hash","publicKeyVersion","qrCode","safTCountry","sequenceNumber"],"type":"object"},"DocumentSellerAddressDto":{"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","nullable":true,"type":"string"},"addressLine2":{"description":"An optional secondary address line, such as apartment, suite, unit, building, or floor information.","example":"3. Etage","nullable":true,"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","nullable":true,"type":"string"},"city":{"description":"The name of the city or locality associated with the address.","example":"Hamburg","nullable":true,"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.","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","nullable":true,"type":"string"},"state":{"description":"The full name of the state, province, or region, depending on the country.","example":"Hamburg","nullable":true,"type":"string"},"stateCode":{"description":"The abbreviated code for the state or region, typically following country-specific standards.","example":"HH","nullable":true,"type":"string"}},"required":["addressLine1","addressLine2","addressLine3","city","country","postalCode","state","stateCode"],"type":"object"},"DocumentSellerDto":{"description":"Response object containing detailed information about the seller.","properties":{"commercialRegistrationNumber":{"description":"The commercial registration number of the seller.","example":"HRB 125192","nullable":true,"type":"string"},"courtOfRegistration":{"description":"The court where the seller is registered.","example":"Amtsgericht Hamburg","nullable":true,"type":"string"},"ident":{"description":"Unique identifier of the 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"},"name":{"description":"The seller name.\nMust not be blank.","example":"Nitrobox GmbH","minLength":1,"type":"string"}},"required":["commercialRegistrationNumber","courtOfRegistration","ident","name"],"type":"object"},"DocumentSellerOperatingSiteBankInformationDto":{"description":"A bank account associated with the operating site.","nullable":true,"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","nullable":true,"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","nullable":true,"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":["bankName","bic","iban"],"type":"object"},"DocumentSellerOperatingSiteDirectorsAndOfficersDto":{"description":"Directors and officers responsible for the operating site.","nullable":true,"properties":{"corporateTitle":{"description":"The corporate title of the person.","example":"CEO","nullable":true,"type":"string"},"name":{"description":"Full name of the director or officer.\nMust not be blank.","example":"Max Mustermann","minLength":1,"type":"string"}},"required":["corporateTitle","name"],"type":"object"},"DocumentSellerOperatingSiteDto":{"description":"Response object containing detailed information about a seller's operating site and the associated seller.","nullable":true,"properties":{"address":{"$ref":"#/components/schemas/DocumentSellerAddressDto"},"bankInformation":{"$ref":"#/components/schemas/DocumentSellerOperatingSiteBankInformationDto"},"directorsAndOfficers":{"description":"Directors and officers responsible for the operating site.","items":{"$ref":"#/components/schemas/DocumentSellerOperatingSiteDirectorsAndOfficersDto"},"nullable":true,"type":"array"},"ident":{"description":"Unique identifier of the operating site.\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/DocumentSellerOperatingSitePropertyDto"},"nullable":true,"type":"array"},"seller":{"$ref":"#/components/schemas/DocumentSellerDto"},"supportInformation":{"description":"Support contact methods such as email or phone.","items":{"$ref":"#/components/schemas/DocumentSellerOperatingSiteSupportInformationDto"},"nullable":true,"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","nullable":true,"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","nullable":true,"type":"string"}},"required":["address","ident","seller","taxNumber","vatId"],"type":"object"},"DocumentSellerOperatingSitePropertyDto":{"description":"Additional property related to the operating site, such as opening hours or special notes.","nullable":true,"properties":{"key":{"description":"Identifier or key of the property.\nMust not be blank.","example":"openingHours","minLength":1,"type":"string"},"value":{"description":"Value associated with the property.\nMust not be blank.","example":"Mo-Fr 09:00-18:00","minLength":1,"type":"string"}},"required":["key","value"],"type":"object"},"DocumentSellerOperatingSiteSupportInformationDto":{"description":"Support contact method such as email, phone.","nullable":true,"properties":{"supportInformationType":{"description":"Type of support information, 'email' or 'phone'.\nMust not be null.\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.\nMust not be blank.","example":"info@nitrobox.com","minLength":1,"type":"string"}},"required":["supportInformationType","value"],"type":"object"},"DocumentServicePeriodDto":{"description":"Service period.","nullable":true,"properties":{"end":{"description":"End of the service period.\nMust not be null.\nISO 8601 date-time with an offset from UTC/Greenwich (`YYYY-MM-DDThh:mm:ssZ` or `YYYY-MM-DDThh:mm:ss+hh:mm`)","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"start":{"description":"Start of the service period.\nMust not be null.\nISO 8601 date-time with an offset from UTC/Greenwich (`YYYY-MM-DDThh:mm:ssZ` or `YYYY-MM-DDThh:mm:ss+hh:mm`)","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"}},"required":["end","start"],"type":"object"},"DocumentStatusResponseDto":{"properties":{"documentIdent":{"description":"Unique external reference of the document.","nullable":true,"type":"string"},"processingStatus":{"description":"Processing status of the document.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| RECEIVED  |\n| PROCESSED |\n| FAILED    |","type":"string"},"requestId":{"description":"Unique identifier of the creation request.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["processingStatus","requestId"],"type":"object"},"DocumentSubTotalSumDto":{"deprecated":true,"description":"Aggregation of specific values of this document.\noriginalTotalNetSum + originalTotalTax = originalTotalGrossSum\ntotalNetSum + totalTaxSum = totalGrossSum\ntotalGrossSum +/- totalPostTaxSum = totalDocumentAccountDue (+/- depends on document type)\ntotalDocumentAccountDue +/- totalDepositSum = totalDue (+/- depends on document type)","properties":{"groupingFieldName":{"description":"Name of the grouping.","nullable":true,"type":"string"},"groupingFieldSubValue":{"description":"Optional second level value of the grouping.","nullable":true,"type":"string"},"groupingFieldValue":{"description":"First level value of the grouping.","nullable":true,"type":"string"},"originalTotalGrossSum":{"description":"Sum of all item line gross amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","nullable":true,"type":"number"},"originalTotalNetSum":{"description":"Sum of all item line net amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","nullable":true,"type":"number"},"originalTotalTaxSum":{"description":"Sum of all item line tax amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","nullable":true,"type":"number"},"totalDepositSum":{"description":"Sum of all deposits. Is always negative.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalDocumentAccountDue":{"description":"Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras).\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalDue":{"description":"Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras) and deposits. This is the amount expected to actually be paid.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalGrossSum":{"description":"Sum of all item line gross amounts with line allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalNetSum":{"description":"Sum of all item line net amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalPostTaxSum":{"description":"Sum of all post tax allowances (a.k.a. post tax extras). Is always positive.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalTaxSum":{"description":"Sum of all item line tax amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"}},"required":["totalDepositSum","totalDocumentAccountDue","totalDue","totalGrossSum","totalNetSum","totalPostTaxSum","totalTaxSum"],"type":"object"},"DocumentTenantRegistrationDto":{"description":"Official registration information of the tenant.","nullable":true,"properties":{"authority":{"description":"Name of the authority where the Tenant is commercially registered.","nullable":true,"type":"string"},"registrationNumber":{"description":"Commercial registration number is given authority at headquarter of the company.","nullable":true,"type":"string"}},"type":"object"},"DocumentTotalsDto":{"description":"Aggregation of all values of this document.\noriginalTotalNetSum + originalTotalTax = originalTotalGrossSum\ntotalNetSum + totalTaxSum = totalGrossSum\ntotalGrossSum +/- totalPostTaxSum = totalDocumentAccountDue (+/- depends on document type)\ntotalDocumentAccountDue +/- totalDepositSum = totalDue (+/- depends on document type)","properties":{"originalTotalGrossSum":{"description":"Sum of all item line gross amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","nullable":true,"type":"number"},"originalTotalNetSum":{"description":"Sum of all item line net amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","nullable":true,"type":"number"},"originalTotalTaxSum":{"description":"Sum of all item line tax amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","nullable":true,"type":"number"},"totalDepositSum":{"description":"Sum of all deposits. Is always negative.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalDocumentAccountDue":{"description":"Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras).\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalDue":{"description":"Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras) and deposits. This is the amount expected to actually be paid.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalGrossSum":{"description":"Sum of all item line gross amounts with line allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalNetSum":{"description":"Sum of all item line net amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalPostTaxSum":{"description":"Sum of all post tax allowances (a.k.a. post tax extras). Is always positive.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"totalTaxSum":{"description":"Sum of all item line tax amounts with allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"}},"required":["totalDepositSum","totalDocumentAccountDue","totalDue","totalGrossSum","totalNetSum","totalPostTaxSum","totalTaxSum"],"type":"object"},"DocumentTypeSeparationCondition":{"description":"Which documents to apply the configuration to.","properties":{"documentType":{"description":"Document type this configuration applies to.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"required":["documentType"],"type":"object"},"DocumentVatIdValidationResultDto":{"description":"Result of the VatId validation for this customer.","nullable":true,"properties":{"ident":{"description":"Unique identifier of this VatId validation.\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"},"status":{"description":"Mapped status of the validation response.\nMust not be null.\nMust be one of:\n|         |\n| ------- |\n| VALID   |\n| INVALID |\n| FAILED  |\n| NONE    |","type":"string"},"validatedAt":{"description":"Technical request date and time of the VatId validation.\nMust not be null.\nISO 8601 date-time with an offset from UTC/Greenwich (`YYYY-MM-DDThh:mm:ssZ` or `YYYY-MM-DDThh:mm:ss+hh:mm`)","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"validationProvider":{"description":"Service used to validate the VatId.\nMust not be blank.","minLength":1,"type":"string"},"vatId":{"description":"VatId used for the validation.","nullable":true,"type":"string"}},"required":["ident","status","validatedAt","validationProvider"],"type":"object"},"DunningConfigurationDto":{"description":"Please see DunningConfigurationDto Model below for more information regarding required values and input type.","properties":{"dunningActive":{"description":"Flag if the dunning is active.\nMust not be null.","type":"boolean"},"dunningLevelConfiguration":{"description":"Configuration of dunning levels","items":{"$ref":"#/components/schemas/DunningLevelConfigurationDto"},"nullable":true,"type":"array"}},"required":["dunningActive"],"type":"object"},"DunningLevelConfigurationDto":{"description":"Configuration for a specific dunning level.","nullable":true,"properties":{"level":{"description":"The dunning level to configure.\nMust not be null.\nMust be one of:\n|                 |\n| --------------- |\n| DUNNING_LEVEL_1 |\n| DUNNING_LEVEL_2 |\n| DUNNING_LEVEL_3 |\n| DUNNING_LEVEL_4 |","type":"string"},"timeUntilChangeToThisStateInSeconds":{"description":"Time in seconds until this level is reached from the prior state.\nMust not be null.\nMust be greater than 0.","format":"int64","type":"integer"}},"required":["level","timeUntilChangeToThisStateInSeconds"],"type":"object"},"DunningStatusAggregationDocumentDto":{"description":"Dunning status per document","properties":{"dunningLevel":{"description":"Dunning Level of the document.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| COMPLETED           |\n| WITHIN_PAYMENT_TERM |\n| DUNNING_LEVEL_1     |\n| DUNNING_LEVEL_2     |\n| DUNNING_LEVEL_3     |\n| DUNNING_LEVEL_4     |","type":"string"},"ident":{"description":"Unique document reference.\nMust not be null.","type":"string"}},"required":["dunningLevel","ident"],"type":"object"},"DunningStatusAggregationDto":{"description":"Aggregation of dunning status for a specific reference type and reference ident.","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"},"dunningLevelIncreasedCount":{"description":"Indicates how many times the dunning level was increased.\nMust not be null.","format":"int64","type":"integer"},"highestDunningLevel":{"description":"Highest dunning level related to reference type and reference ident.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| COMPLETED           |\n| WITHIN_PAYMENT_TERM |\n| DUNNING_LEVEL_1     |\n| DUNNING_LEVEL_2     |\n| DUNNING_LEVEL_3     |\n| DUNNING_LEVEL_4     |","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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"referenceIdent":{"description":"Unique reference for the reference type.\nMust not be null.\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"},"referenceType":{"description":"Type of reference.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CONTRACT |","type":"string"},"version":{"description":"Version of this status.\nMust not be null.","format":"int64","type":"integer"}},"required":["createdAt","dunningLevelIncreasedCount","highestDunningLevel","lastModifiedAt","referenceIdent","referenceType","version"],"type":"object"},"EInvoicingParametersDto":{"description":"E-invoicing parameters of the address.","nullable":true,"properties":{"recipientCode":{"description":"The recipient code used in the underlying network of the `recipientCodeType`","nullable":true,"type":"string"},"recipientCodeType":{"description":"For which e-invoicing scheme the `recipientCode` is relevant.","nullable":true,"type":"string"}},"type":"object"},"EventItemExtraTaxDetailDto":{"nullable":true,"properties":{"taxInformation":{"items":{"$ref":"#/components/schemas/EventItemExtraTaxInformationDto"},"nullable":true,"type":"array"},"taxRate":{"nullable":true,"type":"number"}},"type":"object"},"EventItemExtraTaxInformationDto":{"nullable":true,"properties":{"jurisdiction":{"$ref":"#/components/schemas/InvoiceItemTaxInformationJurisdictionDto"},"tax":{"description":"The tax amount for this tax.","nullable":true,"type":"number"},"taxCode":{"description":"The tax code of this tax detail.","nullable":true,"type":"string"},"taxName":{"description":"The name of the tax against which this tax amount was calculated.","nullable":true,"type":"string"},"taxRate":{"description":"The rate at which this tax detail was calculated.","nullable":true,"type":"number"},"taxType":{"description":"The type of tax that was calculated.","nullable":true,"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"},"nullable":true,"type":"array"},"message":{"description":"message describing the error","nullable":true,"type":"string"},"path":{"description":"URL path where the error occurred","nullable":true,"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","nullable":true,"type":"string"}},"required":["status","timestamp"],"type":"object"},"IntervalDto":{"nullable":true,"properties":{"end":{"description":"Must not be null.","format":"date-time","type":"string"},"start":{"description":"Must not be null.","format":"date-time","type":"string"}},"required":["end","start"],"type":"object"},"InvoiceCreationRequest":{"description":"Creates a document of type invoice.","properties":{"billingGroupIdent":{"description":"The `billingGroupIdent` of the document. Must be an existing billing group configured for external billing. See [Billing Group API](createbillinggroup_v3).\nMust not be blank.","minLength":1,"type":"string"},"currency":{"description":"The currency of the document. The same currency is used for all monetary values in this document.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"customerDetail":{"$ref":"#/components/schemas/CustomerDetailRequest"},"documentDate":{"description":"The date of the document. If not set the current UTC date will be used.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"ident":{"description":"Unique external reference a.k.a. document number. Depending on the document number configuration, this field is mandatory or must be omitted.","nullable":true,"type":"string"},"items":{"description":"A list of items included in the document.\nMust not be null.\nSize must be between 1 and 100.","items":{"$ref":"#/components/schemas/DocumentItemRequest"},"maxItems":100,"minItems":1,"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...).\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","example":"de","type":"string"},"operatingSiteIdent":{"description":"Ident of the operating site for the document.\nIf omitted, the default operating site is used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"Default","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"orderDate":{"description":"The date of the order.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"paymentCollection":{"$ref":"#/components/schemas/DocumentPaymentCollectionDto"},"paymentInformation":{"$ref":"#/components/schemas/DocumentPaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/DocumentPaymentTermDto"},"postTaxItems":{"description":"Document post tax items","items":{"$ref":"#/components/schemas/DocumentPostTaxItemDto"},"nullable":true,"type":"array"},"properties":{"description":"Document properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"relatedDocumentIdent":{"description":"The identifier which relates to the related document. Mandatory for documents that relates to others.\n\nExamples:\n    - An invoice that relates to a deposit invoice\n    - A credit memo that relates to an invoice\n","nullable":true,"type":"string"},"requestId":{"description":"Unique identifier of the creation request.\nCreation will be aborted if this `requestId` already exists.\nIf not sent, no validation will be performed.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"sellerOperatingSiteIdent":{"description":"Ident of the seller operating site for the document.\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,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["billingGroupIdent","currency","customerDetail","items","language","paymentCollection","requestId"],"type":"object"},"InvoiceItemTaxDetailDto":{"nullable":true,"properties":{"details":{"deprecated":true,"description":"DEPRECATED","items":{"$ref":"#/components/schemas/InvoiceItemTaxInformationDto"},"nullable":true,"type":"array"},"taxInformation":{"items":{"$ref":"#/components/schemas/InvoiceItemTaxInformationDto"},"nullable":true,"type":"array"},"taxProviderName":{"description":"Name of the tax provider.\nMust be one of:\n|                   |\n| ----------------- |\n| NITROBOX          |\n| AVALARA           |\n| FINANCE_ENABLER   |\n| CUSTOMER_PROVIDED |\n| CLIENT_PROVIDED   |","nullable":true,"type":"string"},"taxProviderProductCode":{"description":"Tax provider specific product code which was used to calculate this line item.","nullable":true,"type":"string"},"taxRate":{"description":"Summed up tax rate for `taxInformation`","nullable":true,"type":"number"},"taxScheme":{"description":"Is taxation handled via Europe OSS.\nMust be one of:\n|         |\n| ------- |\n| OSS     |\n| DEFAULT |","nullable":true,"type":"string"}},"type":"object"},"InvoiceItemTaxInformationDto":{"nullable":true,"properties":{"jurisdiction":{"$ref":"#/components/schemas/InvoiceItemTaxInformationJurisdictionDto"},"originalRowTotalTax":{"description":"The row total tax amount without item extras for this tax.","nullable":true,"type":"number"},"rate":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"},"rowTotalTax":{"description":"The row total tax amount for this tax.","nullable":true,"type":"number"},"tax":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxCode":{"description":"The tax code of this tax detail.","nullable":true,"type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"The name of the tax against which this tax amount was calculated.","nullable":true,"type":"string"},"taxRate":{"description":"The rate at which this tax detail was calculated.","nullable":true,"type":"number"},"taxType":{"description":"The type of tax that was calculated.","nullable":true,"type":"string"},"unitPriceTax":{"description":"The unit tax amount without item extras for this tax.","nullable":true,"type":"number"}},"type":"object"},"InvoiceItemTaxInformationJurisdictionDto":{"description":"Jurisdiction in charge of the Tax","nullable":true,"properties":{"code":{"description":"The code of the jurisdiction","nullable":true,"type":"string"},"name":{"description":"The name of the jurisdiction","nullable":true,"type":"string"},"type":{"description":"The type of the jurisdiction","nullable":true,"type":"string"}},"type":"object"},"InvoiceRetriggerResponse":{"properties":{"amount":{"description":"Must not be null.\nMust be greater than or equal to 0.","format":"int32","type":"integer"},"invoiceIdents":{"description":"Must not be null.","items":{"type":"string"},"type":"array"}},"required":["amount","invoiceIdents"],"type":"object"},"InvoiceSafTDto":{"nullable":true,"properties":{"atcud":{"nullable":true,"type":"string"},"certification_number":{"nullable":true,"type":"string"},"document_series":{"nullable":true,"type":"string"},"document_type_internal_code":{"nullable":true,"type":"string"},"hash":{"nullable":true,"type":"string"},"public_key_version":{"nullable":true,"type":"string"},"qr_code":{"nullable":true,"type":"string"},"saf_t_country":{"nullable":true,"type":"string"},"sequence_number":{"format":"int64","nullable":true,"type":"integer"}},"type":"object"},"InvoiceTaxInformationDetailDto":{"nullable":true,"properties":{"jurisType":{"nullable":true,"type":"string"},"rate":{"nullable":true,"type":"number"},"rateType":{"nullable":true,"type":"string"},"tax":{"nullable":true,"type":"number"},"taxName":{"nullable":true,"type":"string"},"taxType":{"nullable":true,"type":"string"}},"type":"object"},"InvoiceTaxInformationDto":{"nullable":true,"properties":{"details":{"items":{"$ref":"#/components/schemas/InvoiceTaxInformationDetailDto"},"nullable":true,"type":"array"},"totalTax":{"nullable":true,"type":"number"},"transactionCode":{"nullable":true,"type":"string"}},"type":"object"},"ItemExtraPriceDto":{"description":"Group of prices\n- unitPrice: all prices for a single quantity of this item,\n- originalRowTotal: all prices for all quanitities of this item without application of item.extras,\n- rowTotal: all prices for all quanitities of this item with application of item.extras\n\nAlways deliver positive amounts. NBX will take care if it is a DEBIT or CREDIT amount.\n","properties":{"gross":{"description":"Gross amount.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":23.8,"type":"number"},"net":{"description":"Net amount.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":20,"type":"number"},"tax":{"description":"Tax amount.\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":3.8,"type":"number"}},"required":["gross","net","tax"],"type":"object"},"JsonNode":{"nullable":true,"type":"object"},"LabelDto":{"description":"Result list.","properties":{"ident":{"description":"Unique external reference and name of the Label.\nMust not be null.","type":"string"}},"required":["ident"],"type":"object"},"LegacyAddressDto":{"properties":{"academic_title":{"nullable":true,"type":"string"},"address_addition":{"nullable":true,"type":"string"},"agency_profession_title":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"company":{"nullable":true,"type":"string"},"country":{"nullable":true,"type":"string"},"customer_type":{"description":"Must be one of:\n|            |\n| ---------- |\n| b2b        |\n| b2c        |\n| affiliated |","nullable":true,"type":"string"},"department":{"nullable":true,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParametersDto"},"email":{"nullable":true,"type":"string"},"forename":{"nullable":true,"type":"string"},"gender":{"description":"Must be one of:\n|        |\n| ------ |\n| none   |\n| male   |\n| female |\n| other  |\n| family |","nullable":true,"type":"string"},"ident":{"nullable":true,"type":"string"},"post_office_box":{"nullable":true,"type":"string"},"postal_code":{"description":"Size must be between 0 and 16.","maxLength":16,"nullable":true,"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"state":{"nullable":true,"type":"string"},"state_code":{"nullable":true,"type":"string"},"street":{"nullable":true,"type":"string"},"street_number":{"nullable":true,"type":"string"},"surname":{"nullable":true,"type":"string"},"tax_number":{"nullable":true,"type":"string"},"vat_id":{"nullable":true,"type":"string"}},"type":"object"},"LegacyAgreedDeposit":{"nullable":true,"properties":{"agreedDepositTaxInformationDtos":{"items":{"$ref":"#/components/schemas/LegacyAgreedDepositTaxInformationDto"},"nullable":true,"type":"array"},"debitCreditIndicator":{"description":"Must be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","nullable":true,"type":"string"},"grossValue":{"nullable":true,"type":"number"},"ident":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"netValue":{"nullable":true,"type":"number"},"properties":{"additionalProperties":{"nullable":true,"type":"string"},"nullable":true,"type":"object"},"taxValue":{"nullable":true,"type":"number"},"value":{"nullable":true,"type":"number"}},"type":"object"},"LegacyAgreedDepositTaxInformationDto":{"nullable":true,"properties":{"taxCode":{"nullable":true,"type":"string"},"taxRate":{"nullable":true,"type":"number"},"taxValue":{"nullable":true,"type":"number"}},"type":"object"},"LegacyBankAccountDto":{"nullable":true,"properties":{"bic":{"nullable":true,"type":"string"},"holder_name":{"nullable":true,"type":"string"},"iban":{"nullable":true,"type":"string"}},"type":"object"},"LegacyDeposit":{"nullable":true,"properties":{"assignmentIdent":{"nullable":true,"type":"string"},"debitCreditIndicator":{"description":"Must be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","nullable":true,"type":"string"},"grossValue":{"nullable":true,"type":"number"},"ident":{"nullable":true,"type":"string"},"netValue":{"nullable":true,"type":"number"},"paymentIdent":{"nullable":true,"type":"string"},"taxInformation":{"items":{"$ref":"#/components/schemas/LegacyAgreedDepositTaxInformationDto"},"nullable":true,"type":"array"},"taxValue":{"nullable":true,"type":"number"},"value":{"nullable":true,"type":"number"}},"type":"object"},"LegacyDocumentAddress":{"nullable":true,"properties":{"academicTitle":{"nullable":true,"type":"string"},"addressAddition":{"nullable":true,"type":"string"},"agencyProfessionTitle":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"company":{"nullable":true,"type":"string"},"country":{"nullable":true,"type":"string"},"customerType":{"description":"Must be one of:\n|            |\n| ---------- |\n| B_2_B      |\n| B_2_C      |\n| AFFILIATED |\n| UNKNOWN    |","nullable":true,"type":"string"},"department":{"nullable":true,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParametersDto"},"email":{"nullable":true,"type":"string"},"forename":{"nullable":true,"type":"string"},"gender":{"description":"Must be one of:\n|        |\n| ------ |\n| MALE   |\n| FEMALE |\n| OTHER  |\n| NOTSET |","nullable":true,"type":"string"},"ident":{"nullable":true,"type":"string"},"postOfficeBox":{"nullable":true,"type":"string"},"postalCode":{"nullable":true,"type":"string"},"properties":{"additionalProperties":{"nullable":true,"type":"string"},"nullable":true,"type":"object"},"state":{"nullable":true,"type":"string"},"stateCode":{"nullable":true,"type":"string"},"street":{"nullable":true,"type":"string"},"streetNumber":{"nullable":true,"type":"string"},"surname":{"nullable":true,"type":"string"},"taxNumber":{"nullable":true,"type":"string"},"vatId":{"nullable":true,"type":"string"}},"type":"object"},"LegacyDocumentBankAccount":{"nullable":true,"properties":{"bic":{"nullable":true,"type":"string"},"holderName":{"nullable":true,"type":"string"},"iban":{"nullable":true,"type":"string"}},"type":"object"},"LegacyDocumentCreatedEventDto":{"properties":{"address":{"$ref":"#/components/schemas/LegacyDocumentAddress"},"attachments":{"items":{"$ref":"#/components/schemas/AttachmentDto"},"nullable":true,"type":"array"},"billingGroupIdent":{"nullable":true,"type":"string"},"businessSegmentIdent":{"nullable":true,"type":"string"},"businessSegmentIdents":{"items":{"nullable":true,"type":"string"},"nullable":true,"type":"array"},"contractorReferenceIdent":{"nullable":true,"type":"string"},"contractorReferenceType":{"nullable":true,"type":"string"},"creationDate":{"format":"date-time","nullable":true,"type":"string"},"currency":{"nullable":true,"type":"string"},"customSubTotalSums":{"items":{"$ref":"#/components/schemas/TotalSumDto"},"nullable":true,"type":"array"},"customerIdent":{"nullable":true,"type":"string"},"customerPaymentAccount":{"$ref":"#/components/schemas/CustomerPaymentAccountDto"},"debtorAccountNumber":{"nullable":true,"type":"string"},"debtorIdent":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"string"},"depositReceivableRelevant":{"nullable":true,"type":"boolean"},"documentDate":{"deprecated":true,"description":"DEPRECATED","format":"date-time","nullable":true,"type":"string"},"documentIdent":{"nullable":true,"type":"string"},"documentRelation":{"$ref":"#/components/schemas/LegacyDocumentRelation"},"documentStatus":{"deprecated":true,"description":"DEPRECATED.\nMust be one of:\n|            |\n| ---------- |\n| INVOICED   |\n| REMINDED_1 |\n| REMINDED_2 |\n| REMINDED_3 |\n| REMINDED_4 |\n| COMPLETED  |\n| UNKNOWN    |","nullable":true,"type":"string"},"documentTaxable":{"description":"Must be one of:\n|         |\n| ------- |\n| YES     |\n| NO      |\n| UNKNOWN |","nullable":true,"type":"string"},"documentType":{"description":"Must be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| ORDER                           |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |\n| UNKNOWN                         |","nullable":true,"type":"string"},"dueDate":{"format":"date","nullable":true,"type":"string"},"dunningLevel":{"description":"Must be one of:\n|                     |\n| ------------------- |\n| COMPLETED           |\n| WITHIN_PAYMENT_TERM |\n| DUNNING_LEVEL_1     |\n| DUNNING_LEVEL_2     |\n| DUNNING_LEVEL_3     |\n| DUNNING_LEVEL_4     |","nullable":true,"type":"string"},"id":{"format":"int64","nullable":true,"type":"integer"},"ident":{"nullable":true,"type":"string"},"invoiceOriginReferences":{"items":{"$ref":"#/components/schemas/ReferenceDto"},"nullable":true,"type":"array"},"items":{"items":{"$ref":"#/components/schemas/LegacyDocumentItem"},"nullable":true,"type":"array"},"language":{"nullable":true,"type":"string"},"localDocumentDate":{"format":"date","nullable":true,"type":"string"},"localOrderDate":{"format":"date","nullable":true,"type":"string"},"nextStatusDate":{"format":"date-time","nullable":true,"type":"string"},"operatingSite":{"$ref":"#/components/schemas/OperatingSiteDto"},"orderDate":{"deprecated":true,"description":"DEPRECATED","format":"date-time","nullable":true,"type":"string"},"origin":{"nullable":true,"type":"string"},"outstanding":{"nullable":true,"type":"number"},"payment":{"$ref":"#/components/schemas/LegacyDocumentPayment"},"paymentCollection":{"allOf":[{"$ref":"#/components/schemas/PaymentCollectionDto"}],"nullable":true,"type":"object"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermDto"},"polishCreditMemoItems":{"items":{"$ref":"#/components/schemas/LegacyDocumentItem"},"nullable":true,"type":"array"},"postTaxExtras":{"items":{"$ref":"#/components/schemas/LegacyDocumentPostTaxItem"},"nullable":true,"type":"array"},"preferredDocumentDelivery":{"description":"Must be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","nullable":true,"type":"string"},"properties":{"additionalProperties":{"nullable":true,"type":"string"},"nullable":true,"type":"object"},"purchaseItemDetails":{"$ref":"#/components/schemas/JsonNode"},"referenceIdent":{"nullable":true,"type":"string"},"safT":{"$ref":"#/components/schemas/InvoiceSafTDto"},"sellerOperatingSite":{"$ref":"#/components/schemas/DocumentSellerOperatingSiteDto"},"serviceCountry":{"nullable":true,"type":"string"},"shippingAddress":{"$ref":"#/components/schemas/LegacyDocumentAddress"},"subTotalSums":{"items":{"$ref":"#/components/schemas/TotalSumDto"},"nullable":true,"type":"array"},"taxClassifications":{"items":{"$ref":"#/components/schemas/TaxClassificationDto"},"nullable":true,"type":"array"},"taxInformation":{"$ref":"#/components/schemas/InvoiceTaxInformationDto"},"tenantId":{"format":"int64","nullable":true,"type":"integer"},"totalCorrectionAmountGross":{"nullable":true,"type":"number"},"totalCorrectionAmountNet":{"nullable":true,"type":"number"},"totalInvoiceSum":{"$ref":"#/components/schemas/TotalSumDto"},"totalVatLines":{"items":{"$ref":"#/components/schemas/LegacyTotalVatLineDto"},"nullable":true,"type":"array"},"vatIdValidationResult":{"$ref":"#/components/schemas/VatIdValidationResultDto"},"xmlDocumentGenerationMode":{"description":"Must be one of:\n|                    |\n| ------------------ |\n| NORMAL             |\n| POLISH_CREDIT_MEMO |","nullable":true,"type":"string"}},"type":"object"},"LegacyDocumentItem":{"nullable":true,"properties":{"agreedDeposits":{"items":{"$ref":"#/components/schemas/LegacyAgreedDeposit"},"nullable":true,"type":"array"},"amount":{"nullable":true,"type":"number"},"articleNumber":{"nullable":true,"type":"string"},"billingPeriod":{"$ref":"#/components/schemas/IntervalDto"},"businessSegmentIdent":{"nullable":true,"type":"string"},"category":{"description":"Must be one of:\n|                         |\n| ----------------------- |\n| DIGITAL_PRODUCT         |\n| DIGITAL_PRODUCT_RENTAL  |\n| DISCOUNT                |\n| ELECTRICITY             |\n| ELECTRICITY_RESALE      |\n| LABOR_COST              |\n| LOGISTIC_COST           |\n| PHYSICAL_PRODUCT        |\n| PHYSICAL_PRODUCT_RENTAL |\n| SERVICE                 |\n| VOUCHER                 |\n| VOUCHER_APPLICATION     |","nullable":true,"type":"string"},"deposits":{"items":{"$ref":"#/components/schemas/LegacyDeposit"},"nullable":true,"type":"array"},"description":{"nullable":true,"type":"string"},"documentItemType":{"description":"Must be one of:\n|              |\n| ------------ |\n| DEPOSIT      |\n| DISCOUNT     |\n| NON_BOOKABLE |\n| PRODUCT      |\n| SHIPPING     |\n| SUBSCRIPTION |\n| UNKNOWN      |","nullable":true,"type":"string"},"duration":{"format":"int64","nullable":true,"type":"integer"},"extras":{"items":{"$ref":"#/components/schemas/LegacyDocumentItemExtra"},"nullable":true,"type":"array"},"id":{"format":"int64","nullable":true,"type":"integer"},"ident":{"nullable":true,"type":"string"},"itemGroup":{"nullable":true,"type":"string"},"itemPeriodEndDate":{"deprecated":true,"description":"DEPRECATED","format":"date-time","nullable":true,"type":"string"},"itemPeriodStartDate":{"deprecated":true,"description":"DEPRECATED","format":"date-time","nullable":true,"type":"string"},"lineItemType":{"description":"Must be one of:\n|              |\n| ------------ |\n| SALES        |\n| SELF_BILLING |","nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"originalRowTotalExclusiveVat":{"nullable":true,"type":"number"},"originalRowTotalInclusiveVat":{"nullable":true,"type":"number"},"originalRowTotalVat":{"nullable":true,"type":"number"},"performanceLocation":{"$ref":"#/components/schemas/PerformanceLocationDto"},"previousState":{"$ref":"#/components/schemas/LegacyDocumentItem"},"priceCalculationBasis":{"default":[],"items":{"oneOf":[{"$ref":"#/components/schemas/BlockPriceCalculationBasisDto"},{"$ref":"#/components/schemas/ProgressiveTierPriceCalculationBasisDto"},{"$ref":"#/components/schemas/RecurringPriceCalculationBasisDto"},{"$ref":"#/components/schemas/SingleTierPriceCalculationBasisDto"},{"$ref":"#/components/schemas/TimeBasedUsagePriceCalculationBasisDto"}]},"type":"array"},"properties":{"additionalProperties":{"nullable":true,"type":"string"},"nullable":true,"type":"object"},"quantityType":{"description":"Must be one of:\n|        |\n| ------ |\n| PC     |\n| KWH    |\n| SECOND |\n| MINUTE |\n| HOUR   |\n| DAY    |\n| WEEK   |\n| MONTH  |\n| YEAR   |","nullable":true,"type":"string"},"referenceIdent":{"nullable":true,"type":"string"},"referenceType":{"description":"Must be one of:\n|          |\n| -------- |\n| CONTRACT |\n| ORDER    |\n| INVOICE  |\n| EXTERNAL |","nullable":true,"type":"string"},"refundabilityType":{"description":"Must be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"rowTotalExclusiveVat":{"nullable":true,"type":"number"},"rowTotalInclusiveVat":{"nullable":true,"type":"number"},"rowTotalVat":{"nullable":true,"type":"number"},"servicePeriod":{"$ref":"#/components/schemas/IntervalDto"},"taxCode":{"nullable":true,"type":"string"},"taxDetail":{"$ref":"#/components/schemas/LegacyItemTaxDetailDto"},"taxInformation":{"$ref":"#/components/schemas/LegacyItemTaxDetailDto"},"taxLocation":{"$ref":"#/components/schemas/TaxLocationDto"},"taxScheme":{"deprecated":true,"description":"DEPRECATED","enum":["OSS","DEFAULT"],"nullable":true,"type":"string"},"unitPriceExclusiveVat":{"nullable":true,"type":"number"},"unitPriceInclusiveVat":{"nullable":true,"type":"number"},"unitPriceVat":{"nullable":true,"type":"number"},"vatRatePercent":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"}},"required":["performanceLocation","taxDetail","taxLocation"],"type":"object"},"LegacyDocumentItemExtra":{"nullable":true,"properties":{"externalIdent":{"nullable":true,"type":"string"},"externalReference":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyDocumentItemExtraPropertyDto"},"nullable":true,"type":"array"},"refundabilityType":{"description":"Must be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"taxDetail":{"$ref":"#/components/schemas/LegacyItemExtraTaxDetailDto"},"type":{"description":"Must be one of:\n|                        |\n| ---------------------- |\n| VOUCHER                |\n| DISCOUNT               |\n| SINGLE_PURPOSE_VOUCHER |\n| UNKNOWN                |","nullable":true,"type":"string"},"valueExclusiveVat":{"nullable":true,"type":"number"},"valueInclusiveVat":{"nullable":true,"type":"number"},"valueTotalVat":{"nullable":true,"type":"number"},"vatRatePercent":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"}},"required":["taxDetail"],"type":"object"},"LegacyDocumentItemExtraPropertyDto":{"nullable":true,"properties":{"key":{"nullable":true,"type":"string"},"value":{"nullable":true,"type":"string"}},"type":"object"},"LegacyDocumentPayment":{"nullable":true,"properties":{"bankAccount":{"$ref":"#/components/schemas/LegacyDocumentBankAccount"},"debitBankAccount":{"$ref":"#/components/schemas/LegacyDocumentBankAccount"},"paymentMethod":{"description":"Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.","example":"BANKTRANSFER","nullable":true,"type":"string"}},"type":"object"},"LegacyDocumentPostTaxItem":{"nullable":true,"properties":{"description":{"nullable":true,"type":"string"},"externalReference":{"nullable":true,"type":"string"},"id":{"format":"int64","nullable":true,"type":"integer"},"ident":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"properties":{"additionalProperties":{"nullable":true,"type":"string"},"nullable":true,"type":"object"},"refundabilityType":{"description":"Must be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"type":{"description":"Must be one of:\n|                       |\n| --------------------- |\n| MULTI_PURPOSE_VOUCHER |","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"}},"type":"object"},"LegacyDocumentRelation":{"nullable":true,"properties":{"documentReason":{"description":"Must be one of:\n|                 |\n| --------------- |\n| CANCELLATION    |\n| CORRECTION      |\n| CLOSING_INVOICE |\n| UNKNOWN         |","nullable":true,"type":"string"},"documentRelatedDate":{"format":"date","nullable":true,"type":"string"},"documentRelatedIdent":{"nullable":true,"type":"string"}},"type":"object"},"LegacyInvoiceCreationRequest":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/LegacyAddressDto"}],"type":"object"},"business_client_id":{"description":"Must not be null.","format":"int32","type":"integer"},"currency":{"description":"Must not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"date_timestamp":{"description":"Must not be null.","format":"int64","type":"integer"},"debtor_ident":{"description":"Must not be blank.","minLength":1,"type":"string"},"document_reason":{"description":"Must be one of:\n|                 |\n| --------------- |\n| CANCELLATION    |\n| CORRECTION      |\n| CLOSING_INVOICE |\n| UNKNOWN         |","nullable":true,"type":"string"},"id":{"format":"int32","nullable":true,"type":"integer"},"ident":{"nullable":true,"type":"string"},"items":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/LegacyInvoiceItemDto"},"minItems":1,"type":"array"},"language":{"description":"Must not be null.","enum":["undefined","aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"type":"string"},"next_status_timestamp":{"format":"int64","nullable":true,"type":"integer"},"operating_site_ident":{"nullable":true,"type":"string"},"order_date":{"format":"int64","nullable":true,"type":"integer"},"origin":{"nullable":true,"type":"string"},"payment":{"$ref":"#/components/schemas/LegacyPaymentDto"},"post_tax_extras":{"items":{"$ref":"#/components/schemas/LegacyInvoicePostTaxItemDto"},"nullable":true,"type":"array"},"preferred_document_delivery":{"description":"Must be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","nullable":true,"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoicePropertyDto"},"nullable":true,"type":"array"},"purchase_item_details":{"$ref":"#/components/schemas/JsonNode"},"reference_ident":{"nullable":true,"type":"string"},"related_invoice_ident":{"nullable":true,"type":"string"},"request_id":{"nullable":true,"type":"string"},"service_country":{"description":"Must 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"],"type":"string"},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/LegacyAddressDto"}],"nullable":true,"type":"object"},"status":{"description":"Must not be null.","enum":["invoiced","reminded1","reminded2","reminded3","reminded4","completed"],"type":"string"},"tax_information":{"$ref":"#/components/schemas/InvoiceTaxInformationDto"},"taxable":{"description":"Must be one of:\n|     |\n| --- |\n| yes |\n| no  |","nullable":true,"type":"string"},"type":{"description":"Must not be null.","enum":["invoice","creditmemo","order","depositinvoice","depositinvoicecancellation","creditmemo_goodwill","creditmemo_warranty","self_billing_invoice","self_billing_invoice_correction"],"type":"string"}},"required":["address","business_client_id","currency","date_timestamp","debtor_ident","items","language","service_country","status","type"],"type":"object"},"LegacyInvoiceDto":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/LegacyAddressDto"}],"type":"object"},"business_client_id":{"description":"Must not be null.","format":"int32","type":"integer"},"business_segment_ident":{"nullable":true,"type":"string"},"business_segment_idents":{"description":"Must not be null.","items":{"type":"string"},"type":"array"},"created_timestamp":{"format":"int64","nullable":true,"type":"integer"},"currency":{"nullable":true,"type":"string"},"customer_payment_account":{"$ref":"#/components/schemas/CustomerPaymentAccountDto"},"date_timestamp":{"description":"Must not be null.","format":"int64","type":"integer"},"debtor_ident":{"description":"Must not be blank.","minLength":1,"type":"string"},"deposit_receivable_relevant":{"description":"Must not be null.","type":"boolean"},"document_reason":{"description":"Must be one of:\n|                 |\n| --------------- |\n| CANCELLATION    |\n| CORRECTION      |\n| CLOSING_INVOICE |\n| UNKNOWN         |","nullable":true,"type":"string"},"id":{"format":"int32","nullable":true,"type":"integer"},"ident":{"nullable":true,"type":"string"},"invoice_origin_references":{"description":"Must not be null.","items":{"$ref":"#/components/schemas/ReferenceDto"},"type":"array"},"items":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/LegacyInvoiceItemDto"},"minItems":1,"type":"array"},"language":{"nullable":true,"type":"string"},"next_status_timestamp":{"format":"int64","nullable":true,"type":"integer"},"operating_site":{"$ref":"#/components/schemas/OperatingSiteDto"},"operating_site_ident":{"nullable":true,"type":"string"},"opos_case":{"allOf":[{"$ref":"#/components/schemas/OposCaseDto"}],"nullable":true,"type":"object"},"order_date":{"format":"int64","nullable":true,"type":"integer"},"origin":{"nullable":true,"type":"string"},"original_invoice_date_timestamp":{"format":"int64","nullable":true,"type":"integer"},"original_invoice_ident":{"nullable":true,"type":"string"},"payment":{"$ref":"#/components/schemas/LegacyPaymentDto"},"payment_information":{"$ref":"#/components/schemas/PaymentInformationDto"},"polish_credit_memo_items":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemDto"},"nullable":true,"type":"array"},"post_tax_extras":{"items":{"$ref":"#/components/schemas/LegacyInvoicePostTaxItemDto"},"nullable":true,"type":"array"},"preferred_document_delivery":{"description":"Must be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","nullable":true,"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoicePropertyDto"},"nullable":true,"type":"array"},"purchase_item_details":{"$ref":"#/components/schemas/JsonNode"},"reference_ident":{"nullable":true,"type":"string"},"related_document_date":{"format":"date","nullable":true,"type":"string"},"related_invoice_ident":{"nullable":true,"type":"string"},"request_id":{"nullable":true,"type":"string"},"saf_t":{"$ref":"#/components/schemas/InvoiceSafTDto"},"service_country":{"nullable":true,"type":"string"},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/LegacyAddressDto"}],"nullable":true,"type":"object"},"status":{"description":"Must not be null.","enum":["invoiced","reminded1","reminded2","reminded3","reminded4","completed"],"type":"string"},"sub_total_sums":{"items":{"$ref":"#/components/schemas/TotalSumDto"},"nullable":true,"type":"array"},"tax_information":{"$ref":"#/components/schemas/InvoiceTaxInformationDto"},"taxable":{"description":"Must be one of:\n|     |\n| --- |\n| yes |\n| no  |","nullable":true,"type":"string"},"total_correction_amount_gross":{"nullable":true,"type":"number"},"total_correction_amount_net":{"nullable":true,"type":"number"},"total_invoice_sum":{"$ref":"#/components/schemas/TotalSumDto"},"total_vat_lines":{"items":{"$ref":"#/components/schemas/TotalVatLineDto"},"nullable":true,"type":"array"},"type":{"description":"Must not be null.","enum":["invoice","creditmemo","order","depositinvoice","depositinvoicecancellation","creditmemo_goodwill","creditmemo_warranty","self_billing_invoice","self_billing_invoice_correction"],"type":"string"},"vat_id_validation_result":{"$ref":"#/components/schemas/VatIdValidationResultDto"}},"required":["address","business_client_id","business_segment_idents","date_timestamp","debtor_ident","deposit_receivable_relevant","invoice_origin_references","items","status","type"],"type":"object"},"LegacyInvoiceItemDto":{"nullable":true,"properties":{"agreed_deposits":{"items":{"$ref":"#/components/schemas/AgreedDepositDto"},"nullable":true,"type":"array"},"amount":{"description":"Must not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"article_number":{"nullable":true,"type":"string"},"billing_period":{"$ref":"#/components/schemas/IntervalDto"},"business_segment_ident":{"nullable":true,"type":"string"},"deposits":{"items":{"$ref":"#/components/schemas/DepositDto"},"nullable":true,"type":"array"},"description":{"nullable":true,"type":"string"},"duration":{"format":"int64","nullable":true,"type":"integer"},"extras":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemExtraDto"},"nullable":true,"type":"array"},"id":{"format":"int64","nullable":true,"type":"integer"},"ident":{"description":"Must not be blank.","minLength":1,"type":"string"},"item_category":{"description":"Must be one of:\n|                         |\n| ----------------------- |\n| DIGITAL_PRODUCT         |\n| DIGITAL_PRODUCT_RENTAL  |\n| DISCOUNT                |\n| ELECTRICITY             |\n| ELECTRICITY_RESALE      |\n| LABOR_COST              |\n| LOGISTIC_COST           |\n| PHYSICAL_PRODUCT        |\n| PHYSICAL_PRODUCT_RENTAL |\n| SERVICE                 |\n| VOUCHER                 |\n| VOUCHER_APPLICATION     |","nullable":true,"type":"string"},"item_group":{"nullable":true,"type":"string"},"item_period_end_timestamp":{"deprecated":true,"description":"DEPRECATED","format":"int64","nullable":true,"type":"integer"},"item_period_start_timestamp":{"deprecated":true,"description":"DEPRECATED","format":"int64","nullable":true,"type":"integer"},"line_item_type":{"description":"Must be one of:\n|              |\n| ------------ |\n| SALES        |\n| SELF_BILLING |","nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"original_row_total_exclusive_vat":{"nullable":true,"type":"number"},"original_row_total_inclusive_vat":{"nullable":true,"type":"number"},"original_row_total_vat":{"nullable":true,"type":"number"},"previous_item_state":{"$ref":"#/components/schemas/LegacyInvoiceItemDto"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemPropertyDto"},"nullable":true,"type":"array"},"reference_ident":{"nullable":true,"type":"string"},"reference_type":{"description":"Must be one of:\n|          |\n| -------- |\n| CONTRACT |\n| ORDER    |\n| INVOICE  |\n| EXTERNAL |","nullable":true,"type":"string"},"refundability_type":{"description":"Must be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"row_total_exclusive_vat":{"description":"Must not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"row_total_inclusive_vat":{"description":"Must not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"row_total_vat":{"description":"Must not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"service_period":{"$ref":"#/components/schemas/IntervalDto"},"tax_code":{"nullable":true,"type":"string"},"tax_detail":{"$ref":"#/components/schemas/InvoiceItemTaxDetailDto"},"tax_information":{"$ref":"#/components/schemas/InvoiceItemTaxDetailDto"},"tax_scheme":{"deprecated":true,"description":"DEPRECATED","enum":["OSS","DEFAULT"],"nullable":true,"type":"string"},"type":{"description":"Must not be null.","enum":["deposit","discount","nonbookable","product","shipping","subscription"],"type":"string"},"unit_price_exclusive_vat":{"description":"Must not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"unit_price_inclusive_vat":{"description":"Must not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"unit_price_vat":{"description":"Must not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"unit_quantity_type":{"description":"Must be one of:\n|        |\n| ------ |\n| PC     |\n| KWH    |\n| SECOND |\n| MINUTE |\n| HOUR   |\n| DAY    |\n| WEEK   |\n| MONTH  |\n| YEAR   |","nullable":true,"type":"string"},"vat_rate_percent":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"}},"required":["amount","ident","row_total_exclusive_vat","row_total_inclusive_vat","row_total_vat","type","unit_price_exclusive_vat","unit_price_inclusive_vat","unit_price_vat"],"type":"object"},"LegacyInvoiceItemExtraDto":{"nullable":true,"properties":{"external_ident":{"nullable":true,"type":"string"},"external_reference":{"nullable":true,"type":"string"},"id":{"format":"int64","nullable":true,"type":"integer"},"name":{"nullable":true,"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemExtraPropertyDto"},"nullable":true,"type":"array"},"refundability_type":{"description":"Must be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"tax_detail":{"$ref":"#/components/schemas/EventItemExtraTaxDetailDto"},"type":{"description":"Must not be null.","enum":["voucher","discount","single_purpose_voucher"],"type":"string"},"value_exclusive_vat":{"nullable":true,"type":"number"},"value_inclusive_vat":{"nullable":true,"type":"number"},"value_total_vat":{"nullable":true,"type":"number"},"vat_rate_percent":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"}},"required":["type"],"type":"object"},"LegacyInvoiceItemExtraPropertyDto":{"nullable":true,"properties":{"key":{"nullable":true,"type":"string"},"value":{"nullable":true,"type":"string"}},"type":"object"},"LegacyInvoiceItemPropertyDto":{"nullable":true,"properties":{"key":{"description":"Key of the property.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["key","value"],"type":"object"},"LegacyInvoicePostTaxItemDto":{"nullable":true,"properties":{"description":{"nullable":true,"type":"string"},"external_reference":{"nullable":true,"type":"string"},"id":{"format":"int64","nullable":true,"type":"integer"},"ident":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoicePostTaxItemPropertyDto"},"nullable":true,"type":"array"},"refundability_type":{"description":"Must be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","nullable":true,"type":"string"},"type":{"description":"Must be one of:\n|                       |\n| --------------------- |\n| MULTI_PURPOSE_VOUCHER |","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"}},"type":"object"},"LegacyInvoicePostTaxItemPropertyDto":{"nullable":true,"properties":{"key":{"nullable":true,"type":"string"},"value":{"nullable":true,"type":"string"}},"type":"object"},"LegacyInvoicePropertyDto":{"nullable":true,"properties":{"invoice_id":{"format":"int32","nullable":true,"type":"integer"},"key":{"description":"Key of the property.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["key","value"],"type":"object"},"LegacyItemExtraTaxDetailDto":{"properties":{"taxInformation":{"items":{"$ref":"#/components/schemas/LegacyItemExtraTaxInformationDto"},"nullable":true,"type":"array"},"taxRate":{"description":"Summed up tax rate for `taxInformation`","nullable":true,"type":"number"}},"type":"object"},"LegacyItemExtraTaxInformationDto":{"nullable":true,"properties":{"jurisdiction":{"$ref":"#/components/schemas/LegacyItemTaxInformationJurisdictionDto"},"tax":{"description":"The tax amount for this tax.","nullable":true,"type":"number"},"taxCode":{"description":"The tax code of this tax detail.","nullable":true,"type":"string"},"taxName":{"description":"The name of the tax against which this tax amount was calculated.","nullable":true,"type":"string"},"taxRate":{"description":"The rate at which this tax detail was calculated.","nullable":true,"type":"number"},"taxType":{"description":"The type of tax that was calculated.","nullable":true,"type":"string"}},"type":"object"},"LegacyItemTaxDetailDto":{"nullable":true,"properties":{"details":{"deprecated":true,"description":"DEPRECATED","items":{"$ref":"#/components/schemas/LegacyItemTaxInformationDto"},"nullable":true,"type":"array"},"taxInformation":{"items":{"$ref":"#/components/schemas/LegacyItemTaxInformationDto"},"nullable":true,"type":"array"},"taxProviderName":{"description":"Name of the tax provider.\nMust be one of:\n|                   |\n| ----------------- |\n| NITROBOX          |\n| AVALARA           |\n| FINANCE_ENABLER   |\n| CUSTOMER_PROVIDED |\n| CLIENT_PROVIDED   |","nullable":true,"type":"string"},"taxProviderProductCode":{"description":"Tax provider specific product code which was used to calculate this line item.","nullable":true,"type":"string"},"taxRate":{"description":"Summed up tax rate for `taxInformation`","nullable":true,"type":"number"},"taxScheme":{"description":"Is taxation handled via Europe OSS.\nMust be one of:\n|         |\n| ------- |\n| OSS     |\n| DEFAULT |","nullable":true,"type":"string"}},"type":"object"},"LegacyItemTaxInformationDto":{"deprecated":true,"nullable":true,"properties":{"jurisdiction":{"$ref":"#/components/schemas/LegacyItemTaxInformationJurisdictionDto"},"originalRowTotalTax":{"description":"The row total tax amount without item extras for this tax.","nullable":true,"type":"number"},"rate":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"},"rowTotalTax":{"description":"The row total tax amount for this tax.","nullable":true,"type":"number"},"tax":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"number"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxCode":{"description":"The tax code of this tax detail.","nullable":true,"type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code, e.g. [VATEX code](https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/).\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"A textual statement of the reason why the item is exempted from TAX or why no TAX is being charged.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxName":{"description":"The name of the tax against which this tax amount was calculated.","nullable":true,"type":"string"},"taxRate":{"description":"The rate at which this tax detail was calculated.","nullable":true,"type":"number"},"taxType":{"description":"The type of tax that was calculated.","nullable":true,"type":"string"},"unitPriceTax":{"description":"The unit tax amount without item extras for this tax.","nullable":true,"type":"number"}},"type":"object"},"LegacyItemTaxInformationJurisdictionDto":{"description":"Jurisdiction in charge of the Tax","nullable":true,"properties":{"code":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"}},"type":"object"},"LegacyPaymentDto":{"nullable":true,"properties":{"bank_account":{"$ref":"#/components/schemas/LegacyBankAccountDto"},"debit_bank_account":{"$ref":"#/components/schemas/LegacyBankAccountDto"},"payment_method":{"nullable":true,"type":"string"}},"type":"object"},"LegacyTotalVatLineDto":{"nullable":true,"properties":{"rate":{"nullable":true,"type":"number"},"sum":{"nullable":true,"type":"number"}},"type":"object"},"MigrationParametersRequest":{"properties":{"batchSize":{"description":"Migration type.\nMust not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"delayBetweenBatches":{"description":"Delay between batches.\nMust not be null.","type":"string"},"lockAtLeastFor":{"description":"Lock minimum duration.\nMust not be null.","type":"string"},"lockAtMostFor":{"description":"Lock timeout.\nMust not be null.","type":"string"},"tenantIds":{"description":"Tenant ids to migrate","items":{"description":"Tenant ids to migrate","format":"int64","type":"integer"},"type":"array","uniqueItems":true}},"required":["batchSize","delayBetweenBatches","lockAtLeastFor","lockAtMostFor","tenantIds"],"type":"object"},"MigrationStatusDto":{"properties":{"itemsToMigrate":{"description":"Number of items to migrate.\nMust not be null.","format":"int64","type":"integer"},"itemsToSetup":{"description":"Number of items to setup.\nMust not be null.","format":"int64","type":"integer"}},"required":["itemsToMigrate","itemsToSetup"],"type":"object"},"MinimalDocumentDto":{"properties":{"creationDate":{"format":"date-time","nullable":true,"type":"string"},"customerIdent":{"nullable":true,"type":"string"},"documentType":{"description":"Must not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| ORDER                           |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |\n| UNKNOWN                         |","type":"string"},"dunningLevel":{"description":"Must be one of:\n|                     |\n| ------------------- |\n| COMPLETED           |\n| WITHIN_PAYMENT_TERM |\n| DUNNING_LEVEL_1     |\n| DUNNING_LEVEL_2     |\n| DUNNING_LEVEL_3     |\n| DUNNING_LEVEL_4     |","nullable":true,"type":"string"},"id":{"format":"int64","nullable":true,"type":"integer"},"ident":{"description":"Must 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"},"requestId":{"nullable":true,"type":"string"},"serviceCountry":{"nullable":true,"type":"string"}},"required":["documentType","ident"],"type":"object"},"MinimalOposCaseDto":{"description":"Opos case contains containing only the base informations.","properties":{"amountDue":{"description":"The amount due differs from the balance as it doesn't take documents with document_reason CORRECTION into account.\nIt's about the amount that should be charged or refunded to balance the opos - even if it is in a temporary correction state.\nUse amountDueDebitCreditIndicator to determine if this amountDue is debit or credit.\nMust not be null.","type":"number"},"amountDueDebitCreditIndicator":{"description":"Indicates if amountDue is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"amountPrebooked":{"description":"Sum of prebooked items. Use amountPrebookedDebitCreditIndicator to determine if it is debit or credit.\nMust not be null.","type":"number"},"amountPrebookedDebitCreditIndicator":{"description":"Indicates if amountPrebooked is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"balance":{"description":"Current sum of all assignments. Debit assignments increase the amount and credit assignments decrease it.\nUsage of +/- sign to determine if this balance is debit or credit is deprecated and discouraged but kept for backwards compatibility.\nUse balanceDebitCreditIndicator instead.\nMust not be null.","type":"number"},"balanceDebitCreditIndicator":{"description":"Indicates if balance is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"creditSum":{"description":"Current sum of all credit assignments.\nMust not be null.","type":"number"},"currency":{"description":"Currency of this opos case.\nMust not be null.","example":"EUR","type":"string"},"customerIdent":{"description":"Ident of the customer of the document.\nMust not be null.\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"},"debitSum":{"description":"Current sum of all debit assignments.\nMust not be null.","type":"number"},"ident":{"description":"Ident of this opos case.\nMust not be null.\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"},"initialDocumentIdent":{"description":"Ident of the document that opened this case.\nMust not be null.","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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"referenceDocumentIdent":{"description":"Ident of the document that is the last referenced document.\nMust not be null.","type":"string"},"status":{"description":"Current status of the case. Either BALANCED or UNBALANCED.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| BALANCED   |\n| UNBALANCED |","example":"UNBALANCED","type":"string"}},"required":["amountDue","amountDueDebitCreditIndicator","amountPrebooked","amountPrebookedDebitCreditIndicator","balance","balanceDebitCreditIndicator","createdAt","creditSum","currency","customerIdent","debitSum","ident","initialDocumentIdent","lastModifiedAt","referenceDocumentIdent","status"],"type":"object"},"MonetaryAmountDto":{"description":"Amount of money with currency.","properties":{"amount":{"description":"Amount.\nMust not be null.","type":"number"},"currency":{"description":"Currency code according to 'ISO-4217'.\nMust not be null.","type":"string"}},"required":["amount","currency"],"type":"object"},"MultipleBillingGroupSeparationStrategyConfiguration":{"description":"List of document number configurations","properties":{"configurations":{"default":[],"description":"List of configurations.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentNumberBillingGroupSeparationStrategyConfiguration"},"type":"array"}},"required":["configurations"],"type":"object"},"MultipleDocumentTypeSeparationStrategyConfiguration":{"description":"List of document number configurations","properties":{"configurations":{"default":[],"description":"List of configurations.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentNumberDocumentTypeSeparationStrategyConfiguration"},"type":"array"}},"required":["configurations"],"type":"object"},"MultipleServiceCountrySeparationStrategyConfiguration":{"description":"List of document number configurations","properties":{"configurations":{"default":[],"description":"List of configurations.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentNumberServiceCountrySeparationStrategyConfiguration"},"type":"array"}},"required":["configurations"],"type":"object"},"OperatingSiteBankAccountDto":{"nullable":true,"properties":{"bank_name":{"nullable":true,"type":"string"},"bic":{"nullable":true,"type":"string"},"iban":{"nullable":true,"type":"string"}},"type":"object"},"OperatingSiteConfigurationBankAccountDto":{"description":"Please see OperatingSiteConfigurationBankAccountDto Model below for more information regarding required values and input type.","nullable":true,"properties":{"bankName":{"description":"Name of the bank of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"bic":{"description":"BIC Number of the account of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"iban":{"description":"IBAN Number of the account of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"type":"object"},"OperatingSiteConfigurationCreationDto":{"description":"Please see OperatingSiteConfigurationCreationDto Model below for more information regarding required values and input type. Only one configuration per operatingSiteIdent possible.","properties":{"addressAddition":{"description":"Optional additional address information that helps to identify the exact location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"bankAccount":{"$ref":"#/components/schemas/OperatingSiteConfigurationBankAccountDto"},"city":{"description":"City where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Country code for the country code where the operating site is registered. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","type":"string"},"directors":{"description":"List of directors of the operating site.","items":{"description":"List of directors of the operating site.","nullable":true,"type":"string"},"nullable":true,"type":"array"},"email":{"description":"Email that is used to contact the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"name":{"description":"Company name is the name of a company which must be entered in the commercial register.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"operatingSiteIdent":{"description":"Unique reference to the operating sites that refers to the tenant, set by creator of operating site.\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"},"phoneNumber":{"description":"The phone number to get in touch with the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postOfficeBox":{"description":"Number of the post office box from operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"state":{"description":"State where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"stateCode":{"description":"State code where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Street of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"streetNumber":{"description":"Street number of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxNumber":{"description":"Tax number of the registered operating site.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"type":{"description":"Denotes the type of the operating site, for example main company headquarters or non-self-sustaining subsidiary.\nMust not be null.\nMust be one of:\n|                                |\n| ------------------------------ |\n| HEADQUARTERS                   |\n| NON_SELF_SUSTAINING_SUBSIDIARY |","type":"string"},"vatId":{"description":"Vat id of the registered operating site. Can be overridden by country specific vatIDs through taxRegistrations. For Backward compatibility vatNumber is accepted as Alias.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"zip":{"description":"Postcode where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["country","name","operatingSiteIdent","type"],"type":"object"},"OperatingSiteConfigurationDto":{"description":"Please see OperatingSiteConfigurationDto Model below for more information regarding required values and input type. Only one configuration per operatingSiteIdent possible.","properties":{"addressAddition":{"description":"Optional additional address information that helps to identify the exact location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"bankAccount":{"$ref":"#/components/schemas/OperatingSiteConfigurationBankAccountDto"},"city":{"description":"City where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Country code for the country code where the operating site is registered. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","type":"string"},"defaultOperatingSite":{"description":"Defines if the operating site is used as default if none is specified.\nMust not be null.","type":"boolean"},"directors":{"description":"List of directors of the operating site.","items":{"description":"List of directors of the operating site.","nullable":true,"type":"string"},"nullable":true,"type":"array"},"email":{"description":"Email that is used to contact the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"name":{"description":"Company name is the name of a company which must be entered in the commercial register.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"operatingSiteIdent":{"description":"Unique reference to the operating sites that refers to the tenant, set by creator of operating site.\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"},"phoneNumber":{"description":"The phone number to get in touch with the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postOfficeBox":{"description":"Number of the post office box from operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"state":{"description":"State where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"stateCode":{"description":"State code where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Street of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"streetNumber":{"description":"Street number of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxNumber":{"description":"Tax number of the registered operating site.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"type":{"description":"Denotes the type of the operating site, for example main company headquarters or non-self-sustaining subsidiary.\nMust not be null.\nMust be one of:\n|                                |\n| ------------------------------ |\n| HEADQUARTERS                   |\n| NON_SELF_SUSTAINING_SUBSIDIARY |","type":"string"},"vatId":{"description":"Vat id of the registered operating site. Can be overridden by country specific vatIDs through taxRegistrations. For Backward compatibility vatNumber is accepted as Alias.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"vatNumber":{"deprecated":true,"description":"DEPRECATED please change to vat id.","nullable":true,"type":"string"},"zip":{"description":"Postcode where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["country","defaultOperatingSite","name","operatingSiteIdent","type"],"type":"object"},"OperatingSiteConfigurationUpdateDto":{"description":"Please see OperatingSiteConfigurationUpdateDto Model below for more information regarding required values and input type.","properties":{"addressAddition":{"description":"Optional additional address information that helps to identify the exact location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"bankAccount":{"$ref":"#/components/schemas/OperatingSiteConfigurationBankAccountDto"},"city":{"description":"City where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Country code for the country code where the operating site is registered. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","type":"string"},"directors":{"description":"List of directors of the operating site.","items":{"description":"List of directors of the operating site.","nullable":true,"type":"string"},"nullable":true,"type":"array"},"email":{"description":"Email that is used to contact the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"name":{"description":"Company name is the name of a company which must be entered in the commercial register.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"phoneNumber":{"description":"The phone number to get in touch with the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postOfficeBox":{"description":"Number of the post office box from operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"state":{"description":"State where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"stateCode":{"description":"State code where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Street of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"streetNumber":{"description":"Street number of the operating site.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxNumber":{"description":"Tax number of the registered operating site.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"vatId":{"description":"Vat id of the registered operating site. Can be overridden by country specific vatIDs through taxRegistrations. For Backward compatibility vatNumber is accepted as Alias.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"zip":{"description":"Postcode where the operating site is located.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["country","name"],"type":"object"},"OperatingSiteDto":{"nullable":true,"properties":{"address_addition":{"nullable":true,"type":"string"},"bank_account":{"$ref":"#/components/schemas/OperatingSiteBankAccountDto"},"city":{"nullable":true,"type":"string"},"company":{"nullable":true,"type":"string"},"company_registration":{"$ref":"#/components/schemas/TenantRegistrationDto"},"country":{"nullable":true,"type":"string"},"country_code":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"string"},"directors":{"items":{"nullable":true,"type":"string"},"nullable":true,"type":"array"},"email":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"operating_site_ident":{"description":"Must 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"},"phone_number":{"nullable":true,"type":"string"},"po_box":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"string"},"post_office_box":{"nullable":true,"type":"string"},"postal_code":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"state_code":{"nullable":true,"type":"string"},"street":{"nullable":true,"type":"string"},"street_number":{"nullable":true,"type":"string"},"tax_number":{"nullable":true,"type":"string"},"tenant_registration":{"$ref":"#/components/schemas/TenantRegistrationDto"},"type":{"nullable":true,"type":"string"},"vat_id":{"nullable":true,"type":"string"},"vat_number":{"nullable":true,"type":"string"},"zip":{"nullable":true,"type":"string"}},"required":["operating_site_ident"],"type":"object"},"OposCaseActiveDocumentDto":{"description":"List of all active/uncancelled documents for this opos case. Meaning the latest invoice/selfbilling-invoice/deposit-invoice and its children.","properties":{"ident":{"description":"Ident of the document.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"},"items":{"default":[],"description":"Business segment idents of the document.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCaseDocumentItemDto"},"type":"array"},"orderIndex":{"description":"Order of the entry creation. Starting at 0.\nMust not be null.","format":"int32","type":"integer"},"type":{"description":"Type of the document.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"required":["ident","items","orderIndex","type"],"type":"object"},"OposCaseAssignmentDto":{"description":"List of all documents and payments related to this case.","properties":{"amount":{"description":"Amount of this assignment.\nMust not be null.","type":"number"},"creationDate":{"description":"Creation date of this assignment.\nMust not be null.","format":"date-time","type":"string"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","type":"string"},"debitCreditIndicator":{"description":"Indicates if value is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"paymentAssignmentIdent":{"description":"Ident of the assignment of a payment, otherwise null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"reason":{"description":"The reason this assignment was created.\nMust not be null.\nMust be one of:\n|                                               |\n| --------------------------------------------- |\n| CANCELLATION                                  |\n| CORRECTION                                    |\n| DECISION                                      |\n| DEPOSIT                                       |\n| DEPOSIT_CORRECTION                            |\n| DOCUMENT_CREATION                             |\n| PAYMENT_ASSIGNMENT                            |\n| PAYMENT_ASSIGNMENT_REVERSAL                   |\n| PAYMENT_ASSIGNMENT_BEFORE_SETTLEMENT          |\n| PAYMENT_ASSIGNMENT_REVERSAL_BEFORE_SETTLEMENT |\n| UNKNOWN                                       |","type":"string"},"sourceIdent":{"description":"Ident of the assignment source.\nMust not be null.","type":"string"},"sourceType":{"description":"Type of the source assignment.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| ORDER                           |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |\n| PAYMENT                         |\n| OPOS_CASE_DECISION              |\n| UNKNOWN                         |","type":"string"},"targetIdent":{"description":"Ident of the assignment target.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"},"targetType":{"description":"Type of the assignment target.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| ORDER                           |\n| CONTRACT                        |\n| INVOICE                         |\n| PAYMENT                         |\n| CREDIT_MEMO                     |\n| DEPOSIT_INVOICE                 |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |\n| OPOS_CASE                       |\n| UNKNOWN                         |","type":"string"}},"required":["amount","creationDate","currency","debitCreditIndicator","reason","sourceIdent","sourceType","targetIdent","targetType"],"type":"object"},"OposCaseClearingDefinitionDto":{"description":"OPOS Case Clearing Definition","properties":{"currency":{"description":"Used currency of the OPOS cases.\nMust not be null.","example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Indicates if the clearing is for debit or credit OPOS case balances.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"overdue":{"description":"Determines whether only overdue differences or all differences should be cleared.\nMust not be null.","example":true,"type":"boolean"},"thresholdAmount":{"description":"Threshold until which automatic clearing will occur, including this amount.\nMust not be null.\nMust be greater than 0.","example":1,"type":"number"}},"required":["currency","debitCreditIndicator","overdue","thresholdAmount"],"type":"object"},"OposCaseClearingRunCreationRequest":{"description":"Creation Request for an OPOS Case Clearing Run","properties":{"definition":{"$ref":"#/components/schemas/OposCaseClearingDefinitionDto"},"ident":{"description":"Ident of this clearing run.\nMust not be null.\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"}},"required":["definition","ident"],"type":"object"},"OposCaseClearingRunItemResponse":{"description":"OPOS Case Clearing Run Item","properties":{"clearedAmount":{"description":"Amount cleared by this clearing run item.\nMust not be null.","example":56.5,"type":"number"},"clearedAmountDebitCreditIndicator":{"description":"Indicates if the cleared amount is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"CREDIT","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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"definition":{"$ref":"#/components/schemas/OposCaseClearingDefinitionDto"},"ident":{"description":"Ident of this clearing run item.\nMust not be null.\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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"oposCase":{"$ref":"#/components/schemas/MinimalOposCaseDto"},"oposCaseClearingRunIdent":{"description":"Ident of the related OPOS case clearing run.\nMust not be null.\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"},"oposCaseDecisionIdent":{"description":"Ident of the related OPOS case decision.\nMust not be null.\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"},"oposCaseDecisionReversalIdent":{"description":"Optional Ident of the related reversal OPOS case decision.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"status":{"description":"Status of this clearing run item.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| PLANNED   |\n| SKIPPED   |\n| PROCESSED |\n| REVERSED  |\n| ERROR     |","example":"RUNNING","type":"string"},"statusInformation":{"description":"Optional additional information regarding the current status.","nullable":true,"type":"string"}},"required":["clearedAmount","clearedAmountDebitCreditIndicator","createdAt","definition","ident","lastModifiedAt","oposCase","oposCaseClearingRunIdent","oposCaseDecisionIdent","oposCaseDecisionReversalIdent","status"],"type":"object"},"OposCaseClearingRunResponse":{"description":"OPOS Case Clearing Run","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"},"definition":{"$ref":"#/components/schemas/OposCaseClearingDefinitionDto"},"ident":{"description":"Ident of this clearing run.\nMust not be null.\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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"result":{"$ref":"#/components/schemas/OposCaseClearingRunResultDto"},"status":{"description":"Status of this clearing run.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| PREPARING |\n| RUNNING   |\n| DONE      |\n| REVERSING |\n| REVERSED  |","example":"RUNNING","type":"string"}},"required":["createdAt","definition","ident","lastModifiedAt","result","status"],"type":"object"},"OposCaseClearingRunResultDto":{"description":"OPOS Case Clearing Run results. All numerical values are initialized with 0 and can change during the lifecycle of the clearing run.","properties":{"currencyOfClearedAmounts":{"description":"Currency of cleared amounts.\nMust not be null.","example":"EUR","type":"string"},"errorClearings":{"description":"Clearings in this clearing run the ran into an error. Maybe needs manual handling.\nMust not be null.","example":15,"format":"int64","type":"integer"},"plannedClearings":{"description":"Currently planned clearings in this clearing run. When the run is finished this value is 0.\nMust not be null.","example":5,"format":"int64","type":"integer"},"processedClearings":{"description":"Processed clearings in this clearing run. OPOS case decision were successfully created.\nMust not be null.","example":60,"format":"int64","type":"integer"},"reversedClearings":{"description":"Amount of clearing that were reverted afterwards.\nMust not be null.","example":0,"format":"int64","type":"integer"},"skippedClearings":{"description":"Skipped clearings in this clearing run. If the definition is not matching anymore, due to other processes changing the OPOS case.\nMust not be null.","example":20,"format":"int64","type":"integer"},"totalClearings":{"description":"Total amount of clearings in this clearing run.\nMust not be null.","example":100,"format":"int64","type":"integer"},"totalOfClearedAmounts":{"description":"Sum of the amount cleared by this clearing run.\nMust not be null.","example":56.5,"type":"number"},"totalOfClearedAmountsDebitCreditIndicator":{"description":"Indicates if the sum of cleared amounts is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"CREDIT","type":"string"}},"required":["currencyOfClearedAmounts","errorClearings","plannedClearings","processedClearings","reversedClearings","skippedClearings","totalClearings","totalOfClearedAmounts","totalOfClearedAmountsDebitCreditIndicator"],"type":"object"},"OposCaseDecisionCreationDto":{"properties":{"amount":{"description":"The amount becomes mandatory if any active prebooked item exists on the opos case.\nOtherwise the balance of the opos case is used as amount.\nMust be greater than or equal to 0.","nullable":true,"type":"number"},"ident":{"description":"Unique ident of this opos case decision.\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"},"note":{"description":"Optional note attached to this decision.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"type":{"description":"Type of this decision. Not all decisions are always available,\ndepending on the balanceDebitCreditIndicator of the OposCase.\n\nFor `DEBIT`:\n- `UNCOLLECTABLE_RECEIVABLE`\n- `DOUBTFUL_RECEIVABLE`\n- `DISCOUNT`\n- `CASH_DISCOUNT`\n- `BANK_FEE`\n- `EXTERNAL_CLOSED`\n\nFor `CREDIT`:\n- `OTHER_REVENUE`\n- `EXTERNAL_CLOSED`\n\nMust not be null.","type":"string"}},"required":["ident","type"],"type":"object"},"OposCaseDecisionDto":{"description":"Decision to modify an OPOS Case.","properties":{"amount":{"$ref":"#/components/schemas/MonetaryAmountDto"},"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"},"debitCreditIndicator":{"description":"Indicates if this amount is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"ident":{"description":"Unique ident of this opos case decision.\nMust not be null.\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"},"note":{"description":"Optional note attached to this decision.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"oposCaseClearingRunIdent":{"description":"If filled the Decision was created by a clearing run. The given ident relates to a specific clearing run.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"oposCaseClearingRunItemIdent":{"description":"If filled the Decision was created by a clearing run. The given ident relates to a specific Item in the clearing run.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"oposCaseIdent":{"description":"Unique ident of the related OPOS case.\nMust not be null.\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"},"reversionTargetIdent":{"description":"OposCaseDecision that was reverted with this decision. Only filled if type is REVERSION.","nullable":true,"type":"string"},"reversionTargetType":{"description":"Type of the OposCaseDecision that was reverted with this decision. Only filled if type is REVERSION.\nMust be one of:\n|                          |\n| ------------------------ |\n| UNCOLLECTABLE_RECEIVABLE |\n| DOUBTFUL_RECEIVABLE      |\n| DISCOUNT                 |\n| OTHER_REVENUE            |\n| REVERSION                |\n| CASH_DISCOUNT            |\n| BANK_FEE                 |\n| EXTERNAL_CLOSED          |","nullable":true,"type":"string"},"reverted":{"description":"Indicates if this decision was reverted.\nMust not be null.","type":"boolean"},"type":{"description":"Type of this decision. Not all decisions are always available,\ndepending on the balanceDebitCreditIndicator of the OposCase.\n\nFor `DEBIT`:\n- `UNCOLLECTABLE_RECEIVABLE`\n- `DOUBTFUL_RECEIVABLE`\n- `DISCOUNT`\n- `CASH_DISCOUNT`\n- `BANK_FEE`\n- `EXTERNAL_CLOSED`\n\nFor `CREDIT`:\n- `OTHER_REVENUE`\n- `EXTERNAL_CLOSED`\n\nAdditionally it can be `REVERSION` in case this decision reverses\nanother decision, which will be referenced in `reversionTargetIdent`.\nMust not be null.","type":"string"}},"required":["amount","createdAt","debitCreditIndicator","ident","oposCaseIdent","reverted","type"],"type":"object"},"OposCaseDecisionReversionDto":{"properties":{"ident":{"description":"Unique opos case decision ident that shall be used for the reversal.\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"}},"required":["ident"],"type":"object"},"OposCaseDocumentItemDto":{"description":"Business segment idents of the document.","properties":{"businessSegmentIdent":{"description":"Identifier of the business segment.","nullable":true,"type":"string"},"ident":{"description":"identifier of the product.\nMust not be null.\nMust not be blank.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},"required":["ident"],"type":"object"},"OposCaseDto":{"description":"Opos case contains all related documents and payments with their amounts.","properties":{"activeDocuments":{"default":[],"description":"List of all active/uncancelled documents for this opos case. Meaning the latest invoice/selfbilling-invoice/deposit-invoice and its children.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCaseActiveDocumentDto"},"type":"array"},"amountDue":{"description":"The amount due differs from the balance as it doesn't take documents With document_reason CORRECTION into account.\n    It's about the amount that should be charged or refunded to balance the opos - even if it is in a temporary correction state.\n    Use amountDueDebitCreditIndicator to determine if this amountDue is debit or credit.\nMust not be null.","type":"number"},"amountDueDebitCreditIndicator":{"description":"Indicates if amountDue is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"amountPrebooked":{"description":"Sum of prebooked items. Use amountPrebookedDebitCreditIndicator to determine if it is debit or credit.\nMust not be null.","type":"number"},"amountPrebookedDebitCreditIndicator":{"description":"Indicates if amountPrebooked is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"assignments":{"default":[],"description":"List of all documents and payments related to this case.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCaseAssignmentDto"},"type":"array"},"balance":{"description":"Current sum of all assignments. Debit assignments increase the amount and credit assignments decrease it.\nUsage of +/- sign to determine if this balance is debit or credit is deprecated and discouraged but kept for backwards compatibility.\nUse balanceDebitCreditIndicator instead.\nMust not be null.","type":"number"},"balanceDebitCreditIndicator":{"description":"Indicates if balance is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","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).\nMust not be null.","format":"date-time","type":"string"},"creationDate":{"deprecated":true,"description":"DEPRECATED","format":"date-time","nullable":true,"type":"string"},"creditSum":{"description":"Current sum of all credit assignments.\nMust not be null.","type":"number"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","type":"string"},"customerIdent":{"description":"Ident of the customer of the document. Please change to customerIdent.\nMust not be null.","type":"string"},"customerPaymentAccountIdent":{"description":"Used customer payment account for payment collection. Only filled if paymentCollectionStatus is not DISABLED.","nullable":true,"type":"string"},"debitSum":{"description":"Current sum of all debit assignments.\nMust not be null.","type":"number"},"debtorIdent":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"string"},"dunning":{"$ref":"#/components/schemas/OposCaseDunningDto"},"ident":{"description":"Ident of this opos case.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"initialDocumentIdent":{"description":"Ident of the document that opened this case.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"},"lastModified":{"deprecated":true,"description":"DEPRECATED","format":"date-time","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).\nMust not be null.","format":"date-time","type":"string"},"paymentCollectionStatus":{"description":"Current status of the payment collection. Can be null for legacy cases, will be migrated soon.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| INITIATED |\n| ENABLED   |\n| DISABLED  |\n| SUSPENDED |","type":"string"},"prebookedItems":{"default":[],"description":"List of all prebooked items for this opos case.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCasePrebookedItemDto"},"type":"array"},"referenceDocumentIdent":{"description":"Ident of the last referenced non-correction document . e.g. invoice, deposit-invoice, self-billing-invoice.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"},"status":{"description":"Current status of the case. Either BALANCED or UNBALANCED.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| BALANCED   |\n| UNBALANCED |","type":"string"}},"required":["activeDocuments","amountDue","amountDueDebitCreditIndicator","amountPrebooked","amountPrebookedDebitCreditIndicator","assignments","balance","balanceDebitCreditIndicator","createdAt","creditSum","currency","customerIdent","debitSum","dunning","ident","initialDocumentIdent","lastModifiedAt","paymentCollectionStatus","prebookedItems","referenceDocumentIdent","status"],"type":"object"},"OposCaseDunningBlockDto":{"description":"An object that sets up the dunning block for a specific document. It includes details on whether the block is active and the reason for its setup.","properties":{"active":{"description":"A boolean value indicating whether a dunning block for the document is active {true} or not {false}.\nMust not be null.","type":"boolean"},"note":{"description":"An optional field containing a string that describes the reason or provides additional information about the dunning block.\nSize must be between 0 and 100.","maxLength":100,"nullable":true,"type":"string"},"origin":{"description":"The origin of the dunning block.\nMust be one of:\n|           |\n| --------- |\n| DEBTOR    |\n| OPOS_CASE |","nullable":true,"type":"string"}},"required":["active","note","origin"],"type":"object"},"OposCaseDunningBlockRequest":{"description":"An object that sets up the dunning block for a specific document. It includes details on whether the block is active and the reason for its setup. ","properties":{"active":{"description":"A boolean value indicating whether a dunning block for the document is active {true} or not {false}.\nMust not be null.","type":"boolean"},"note":{"description":"An optional field containing a string that describes the reason or provides additional information about the dunning block.\nSize must be between 0 and 100.","maxLength":100,"nullable":true,"type":"string"}},"required":["active"],"type":"object"},"OposCaseDunningDto":{"description":"Current state and information of dunning. Has information related to dunning block","properties":{"dunningBlock":{"$ref":"#/components/schemas/OposCaseDunningBlockDto"}},"required":["dunningBlock"],"type":"object"},"OposCaseEnablePaymentCollectionRequest":{"description":"Request body to enable payment collection.","properties":{"customerPaymentAccountIdent":{"description":"The Customer payment account used for payment collection. {@code null} if current customer payment account should be used.","nullable":true,"type":"string"}},"type":"object"},"OposCaseIdentListDto":{"properties":{"idents":{"description":"Must not be empty.","items":{"type":"string"},"minItems":1,"type":"array"}},"required":["idents"],"type":"object"},"OposCasePrebookedItemDto":{"description":"List of all prebooked items for this opos case.","properties":{"active":{"description":"Is the prebooked item still active.\nMust not be null.","type":"boolean"},"amount":{"description":"Amount of this prebooked item.\nMust not be null.","type":"number"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","type":"string"},"deactivationReason":{"description":"Reason for the change from active = true to active = false. Only set if active is false.\nMust be one of:\n|                                               |\n| --------------------------------------------- |\n| PAYMENT_INTENT_CANCELLED                      |\n| PAYMENT_ASSIGNMENT                            |\n| PAYMENT_ASSIGNMENT_REVERSAL_BEFORE_SETTLEMENT |","nullable":true,"type":"string"},"debitCreditIndicator":{"description":"Indicates if value is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"documentIdent":{"description":"Ident of the prebooked item's document.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"},"paymentAssignmentIdent":{"description":"Ident of the prebooked item's payment assignment.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentIntentIdent":{"description":"Ident of the prebooked item's payment intent.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentTransactionBatchItemIdent":{"description":"Ident of the prebooked item's payment transaction batch item.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentTransactionIdent":{"description":"Ident of the prebooked item's payment transaction.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["active","amount","currency","debitCreditIndicator","documentIdent","paymentAssignmentIdent","paymentIntentIdent","paymentTransactionBatchItemIdent","paymentTransactionIdent"],"type":"object"},"OposCaseRetriggerResponse":{"properties":{"amount":{"format":"int32","nullable":true,"type":"integer"},"oposCaseIdents":{"items":{"nullable":true,"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"OutboxEntryResponse":{"description":"Outbox Entry","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.","format":"date-time","type":"string"},"deleteAt":{"description":"The delete timestamp","format":"date-time","nullable":true,"type":"string"},"failures":{"description":"Number of failures.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","minimum":0,"type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be null.\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":{"allOf":[{"$ref":"#/components/schemas/JsonNode"}],"description":"The payload","nullable":true,"type":"object"},"status":{"description":"The status of the outbox entry.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"statusHistory":{"default":[],"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":{"default":"{}","description":"Tracing attributes","type":"string"},"default":{},"description":"Tracing attributes.\nMust not be null.","type":"object"}},"required":["createdAt","failures","id","status","statusHistory","statusTimestamp","tracingAttributes"],"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"}},"required":["number","size","totalElements","totalPages"],"type":"object"},"PagedResponseAggregationConfigurationDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AggregationConfigurationDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseDocumentCounter":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/DocumentCounter"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseDocumentItemDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/DocumentItemDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseDocumentNumberBillingGroupSeparationStrategyConfiguration":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/DocumentNumberBillingGroupSeparationStrategyConfiguration"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseDocumentNumberDocumentTypeSeparationStrategyConfiguration":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/DocumentNumberDocumentTypeSeparationStrategyConfiguration"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseDocumentNumberServiceCountrySeparationStrategyConfiguration":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/DocumentNumberServiceCountrySeparationStrategyConfiguration"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseDunningStatusAggregationDocumentDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/DunningStatusAggregationDocumentDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseLabelDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/LabelDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseLegacyInvoiceDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/LegacyInvoiceDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOperatingSiteConfigurationDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OperatingSiteConfigurationDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOposCaseClearingRunItemResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseClearingRunItemResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOposCaseClearingRunResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseClearingRunResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOposCaseDecisionDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseDecisionDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOposCaseDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"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"}},"required":["_embedded","page"],"type":"object"},"PagedResponseRsqlResultDocumentDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/RsqlResultDocumentDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseSafTConfigurationDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/SafTConfigurationDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseTaxRegistrationDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/TaxRegistrationDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PaymentCollectionDto":{"properties":{"customerPaymentAccountIdent":{"nullable":true,"type":"string"},"paymentControl":{"description":"Must not be null.","enum":["CHARGE","NOCHARGE"],"type":"string"}},"required":["paymentControl"],"type":"object"},"PaymentInformationDto":{"nullable":true,"properties":{"cardType":{"description":"Must be one of:\n|                 |\n| --------------- |\n| VISA            |\n| MASTERCARD      |\n| JCB             |\n| AMERICANEXPRESS |\n| DINERSCLUB      |\n| OTHER           |\n| YANDEXBANKCARD  |\n| DISCOVERCARD    |\n| CARTE_BANCAIRE  |","nullable":true,"type":"string"},"displayName":{"nullable":true,"type":"string"},"method":{"description":"Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.","example":"BANKTRANSFER","nullable":true,"type":"string"},"paymentReference":{"nullable":true,"type":"string"},"provider":{"description":"Must be one of:\n|                   |\n| ----------------- |\n| ADYEN             |\n| AMAZONPAY         |\n| COMPUTOP          |\n| CONTOWORKS        |\n| FIRSTDATATELECASH |\n| GOCARDLESS        |\n| GOOGLEPAY         |\n| KLARNA            |\n| MOLLIE            |\n| OPTILE            |\n| PAYONE            |\n| PAYPAL            |\n| RATEPAY           |\n| STRIPE            |\n| VWFS_SMARTPAY     |\n| WORLDLINE         |","nullable":true,"type":"string"}},"type":"object"},"PaymentTermDto":{"nullable":true,"properties":{"periodInDays":{"description":"Payment term period in days.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","type":"integer"}},"required":["periodInDays"],"type":"object"},"PerformanceLocationDto":{"description":"Place of service provision of this item.","properties":{"city":{"description":"Name of the location city.\nSize must be between 0 and 255.","example":"de-by","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"The country where the product or service was provided. Should be a valid ISO 3166-1 alpha-2 code.\nTwo- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"postalCode":{"description":"Postal code of the location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"region":{"description":"The region where the product or service was provided.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"state":{"description":"State of the location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Name of the location street, including house number.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["country"],"type":"object"},"PolishCreditMemoDto":{"properties":{"polishCreditMemoEnabled":{"nullable":true,"type":"boolean"}},"type":"object"},"PriceCalculationBasis":{"discriminator":{"propertyName":"type"},"properties":{"type":{"enum":["BLOCK","RECURRING","TIER_SINGLE","TIER_PROGRESSIVE","TIME_BASED_USAGE"],"type":"string"}},"type":"object"},"PriceDto":{"description":"Structure representing a price with its net, tax and gross amounts.","properties":{"gross":{"description":"Gross amount.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":23.8,"type":"number"},"net":{"description":"Net amount.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":20,"type":"number"},"tax":{"description":"Tax amount.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":3.8,"type":"number"}},"required":["gross","net","tax"],"type":"object"},"PricesDto":{"description":"Group of prices\n- unit: prices for a single unit of this item,\n- originalTotal: prices for `quantity` units of this item without application of item.extras,\n- total: prices for `quantity` units  of this item with application of item.extras\n","properties":{"originalTotal":{"$ref":"#/components/schemas/PriceDto"},"total":{"$ref":"#/components/schemas/PriceDto"},"unit":{"$ref":"#/components/schemas/PriceDto"}},"required":["originalTotal","total","unit"],"type":"object"},"PricingPeriodDto":{"properties":{"end":{"nullable":true,"type":"string"},"start":{"nullable":true,"type":"string"}},"type":"object"},"ProgressiveTierPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasis"},{"properties":{"netGrossIndicator":{"enum":["NET","GROSS"],"type":"string"},"tierQuantity":{"type":"number"},"totalPrice":{"type":"number"},"unitPrice":{"type":"number"},"usedQuantity":{"type":"number"}},"type":"object"}],"type":"object"},"PropertyDto":{"properties":{"key":{"description":"Must not be blank.","minLength":1,"type":"string"},"value":{"description":"Must not be null.","type":"string"}},"required":["key","value"],"type":"object"},"RecurringPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasis"},{"properties":{"netGrossIndicator":{"enum":["NET","GROSS"],"type":"string"},"servicedDaysInPeriod":{"format":"int64","type":"integer"},"totalDaysInPeriod":{"format":"int64","type":"integer"},"totalPrice":{"type":"number"}},"type":"object"}],"type":"object"},"ReferenceDto":{"properties":{"referenceIdent":{"description":"Reference identifier for this document.\nMust not be blank.","minLength":1,"type":"string"},"referenceType":{"description":"Reference type for this document.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CONTRACT |\n| ORDER    |\n| INVOICE  |\n| EXTERNAL |","type":"string"}},"required":["referenceIdent","referenceType"],"type":"object"},"ResendOperatingSitesRequest":{"description":"ResendOperatingSitesRequest","properties":{"idents":{"description":"List of operating site idents to resend.\nMust not be null.","items":{"description":"List of operating site idents to resend","type":"string"},"type":"array"}},"required":["idents"],"type":"object"},"ResendOperatingSitesResponse":{"description":"ResendOperatingSitesResponse","properties":{"amount":{"description":"Amount of operating sites that were resent","format":"int32","nullable":true,"type":"integer"},"operatingSiteIdents":{"description":"List of operating site idents that were resent.\nMust not be null.","items":{"description":"List of operating site idents that were resent","type":"string"},"type":"array"}},"required":["operatingSiteIdents"],"type":"object"},"RsqlResultDocumentAddressDto":{"description":"The AddressDto contains all Information required for the header of the document. Is used either as recipient of the document or as recipient of the shipped goods. ","nullable":true,"properties":{"academicTitle":{"description":"Academic title of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"addressAddition":{"description":"Optional additional address information.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"agencyProfessionTitle":{"description":"Agency Profession Title of the recipient.","nullable":true,"type":"string"},"city":{"description":"City name.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"company":{"description":"Company name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"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.","type":"string"},"customerType":{"description":"Type of the customer.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| B2B        |\n| B2C        |\n| AFFILIATED |","type":"string"},"department":{"description":"Department name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"eInvoicingParameters":{"$ref":"#/components/schemas/EInvoicingParametersDto"},"email":{"description":"Recipient's email. It becomes mandatory for invoice address and preferredDocumentDelivery is EMAIL.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"firstName":{"description":"First name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"gender":{"description":"Recipient's gender.\nMust be one of:\n|        |\n| ------ |\n| MALE   |\n| FEMALE |\n| OTHER  |\n| NOTSET |","nullable":true,"type":"string"},"ident":{"description":"Unique external reference for the Address.\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"},"lastName":{"description":"Last name of the recipient.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postOfficeBox":{"description":"Number of post office box.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"postalCode":{"description":"Postal code a.k.a. in US as zip code.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"state":{"description":"Name of the state.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"stateCode":{"description":"State code. ISO 3166-2 subdivision code.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Name of street.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"streetNumber":{"description":"Street Number.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"taxNumber":{"description":"Tax identification number, maximum of 20 characters.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"},"vatId":{"description":"VAT identification number, maximum of 20 characters.\nSize must be between 0 and 20.","maxLength":20,"nullable":true,"type":"string"}},"required":["country","customerType","ident"],"type":"object"},"RsqlResultDocumentCustomerDetailDto":{"description":"Detailed information of the customer.","properties":{"contractorReferenceIdent":{"description":"Contractor (reference) id which can be used for example as customer support ident by third parties' system","nullable":true,"type":"string"},"contractorReferenceType":{"description":"Additional type that can be used to distinguish contractor reference ident, e.g. DEALER_ID or CUSTOMER_ID","nullable":true,"type":"string"},"customerIdent":{"description":"Ident of the customer of the document.\nMust not be blank.","minLength":1,"type":"string"},"debtorAccountNumber":{"description":"Debtor account number.","nullable":true,"type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/RsqlResultDocumentAddressDto"},"shippingAddress":{"$ref":"#/components/schemas/RsqlResultDocumentAddressDto"},"taxClassifications":{"description":"Customer-specific tax classification.\nMust not be null.","items":{"$ref":"#/components/schemas/TaxClassificationDto"},"type":"array"}},"required":["contractorReferenceIdent","contractorReferenceType","customerIdent","debtorAccountNumber","invoiceAddress","shippingAddress","taxClassifications"],"type":"object"},"RsqlResultDocumentDto":{"description":"Persisted Document","properties":{"billingGroupIdent":{"description":"The billingGroupIdent of the document.\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"},"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"},"currency":{"description":"The currency of the document. The same currency is used for all monetary values in this document.\nMust not be null.","example":"EUR","type":"string"},"customerDetail":{"$ref":"#/components/schemas/RsqlResultDocumentCustomerDetailDto"},"documentDate":{"description":"The date of the document. desc format.\nMust not be null.\nISO 8601 date (`YYYY-MM-DD`)","example":"2024-03-08","format":"date","type":"string"},"documentTotals":{"$ref":"#/components/schemas/DocumentTotalsDto"},"dueDate":{"description":"The due date of the document. End of payment term period.\nMust not be null.","format":"date","type":"string"},"dunningLevel":{"description":"Dunning level of the document.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| COMPLETED           |\n| WITHIN_PAYMENT_TERM |\n| DUNNING_LEVEL_1     |\n| DUNNING_LEVEL_2     |\n| DUNNING_LEVEL_3     |\n| DUNNING_LEVEL_4     |","type":"string"},"ident":{"description":"Unique document identifier a.k.a. document number.\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"},"labels":{"description":"List of labels assigned to this document.\nMust not be null.","items":{"$ref":"#/components/schemas/LabelDto"},"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...). Language code in the ISO 639-1 standard.\nMust not be null.","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).\nMust not be null.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"nextDunningLevelDate":{"description":"The UTC DateTime of the next status for dunning process.\nMust not be null.\nISO 8601 date-time with an offset from UTC/Greenwich (`YYYY-MM-DDThh:mm:ssZ` or `YYYY-MM-DDThh:mm:ss+hh:mm`)","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"operatingSite":{"$ref":"#/components/schemas/RsqlResultDocumentOperatingSiteDto"},"oposCase":{"allOf":[{"$ref":"#/components/schemas/RsqlResultDocumentOposCaseDto"}],"nullable":true,"type":"object"},"paymentInformation":{"$ref":"#/components/schemas/RsqlResultDocumentPaymentInformationDto"},"properties":{"description":"Document properties.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"type":"array"},"referenceIdents":{"description":"The distinct reference idents of the document items.\nMust not be null.","items":{"$ref":"#/components/schemas/ReferenceDto"},"type":"array"},"sellerOperatingSite":{"$ref":"#/components/schemas/RsqlResultDocumentSellerOperatingSiteDto"},"serviceCountry":{"description":"Country where the service or product is billed. Should be a valid ISO 3166-1 alpha-2 code.\nMust not be null.","example":"DE","type":"string"},"type":{"description":"The type of the document.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"required":["billingGroupIdent","createdAt","currency","customerDetail","documentDate","documentTotals","dueDate","dunningLevel","ident","labels","language","lastModifiedAt","nextDunningLevelDate","operatingSite","paymentInformation","properties","referenceIdents","sellerOperatingSite","serviceCountry","type"],"type":"object"},"RsqlResultDocumentOperatingSiteDto":{"description":"Is as a fixed place of business serving the activities of the tenant.\n\n**Note**: Documents dated before 2022-09-01 may not contain an operating site.\n","properties":{"ident":{"description":"Delivered operating site ident of the document.\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":"The company name of the operating site being used.\nMust not be blank.","minLength":1,"type":"string"}},"required":["ident","name"],"type":"object"},"RsqlResultDocumentOposCaseDto":{"description":"Opos case contains status and outstanding amount. Can be Null for legacy documents.","properties":{"balance":{"description":"The sum of all OPOS assignments.\n\nFor example:\n- [Document] DEBIT of 10.00 EUR\n- [Credit memo] CREDIT of 10.00 EUR\n- [Payment] CREDIT of 10.00 EUR\n\nThe balance of these three assignments is a CREDIT of 10.00 EUR in the OPOS balance.\n\n---\n\nMust not be null.\nMust be greater than or equal to 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"balanceDebitCreditIndicator":{"description":"Indicates if this balance is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"currency":{"description":"Currency of this opos case.\nMust not be null.","example":"EUR","type":"string"},"dunning":{"$ref":"#/components/schemas/RsqlResultDocumentOposCaseDunningDto"},"ident":{"description":"Ident of this opos case.\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"},"status":{"description":"Status of this opos case. BALANCED if the balance is 0.00, otherwise UNBALANCED.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| BALANCED   |\n| UNBALANCED |","type":"string"}},"required":["balance","balanceDebitCreditIndicator","currency","dunning","ident","status"],"type":"object"},"RsqlResultDocumentOposCaseDunningBlockDto":{"description":"Information related to the dunning block status of the opos case.","properties":{"active":{"description":"A boolean value indicating whether a dunning block for the document is active {true} or not {false}.\nMust not be null.","type":"boolean"},"note":{"description":"An optional field containing a string that describes the reason or provides additional information about the dunning block.\nSize must be between 0 and 100.","maxLength":100,"nullable":true,"type":"string"}},"required":["active"],"type":"object"},"RsqlResultDocumentOposCaseDunningDto":{"description":"Current state and information of dunning. Has information related to dunning block","properties":{"dunningBlock":{"$ref":"#/components/schemas/RsqlResultDocumentOposCaseDunningBlockDto"}},"required":["dunningBlock"],"type":"object"},"RsqlResultDocumentPaymentInformationDto":{"description":"The payment information for the document.","nullable":true,"properties":{"method":{"description":"Payment method. See [documentation](https://docs.nitrobox.io/docs/self-managed-payment-methods) for valid values.","example":"BANKTRANSFER","nullable":true,"type":"string"}},"type":"object"},"RsqlResultDocumentSellerOperatingSiteDto":{"description":"Is as a fixed place of business serving the activities of the seller.\n","nullable":true,"properties":{"ident":{"description":"Used seller operating site ident for this document.\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"},"sellerIdent":{"description":"Used seller ident for this document.\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"},"sellerName":{"description":"The company name of the selller.\nMust not be blank.","minLength":1,"type":"string"}},"required":["ident","sellerIdent","sellerName"],"type":"object"},"SafTConfigurationCreationDto":{"description":"Please see SafTConfigurationCreationDto Model below for more information regarding required values and input type. Only one configuration per businessSegmentIdent, documentType, and safTCountry possible.","properties":{"businessSegmentIdent":{"description":"Reference to the business segment for which the Saf-T configuration shall be valid.\nSize must be between 0 and 255.","example":"Default","maxLength":255,"nullable":true,"type":"string"},"documentSeries":{"description":"The document number that must be requested once beforehand at PTA and confirmed by them. Part of document, part of ATCUD.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"documentType":{"description":"Type of the document to which this Saf-T configuration shall be applied.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| invoice                         |\n| creditmemo                      |\n| order                           |\n| depositinvoice                  |\n| depositinvoicecancellation      |\n| creditmemo_goodwill             |\n| creditmemo_warranty             |\n| self_billing_invoice            |\n| self_billing_invoice_correction |","example":"invoice","type":"string"},"documentTypeInternalCode":{"description":"A internal code that is mostly given by the tax authority and needed to create a unique signature.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"firstInvoiceNumber":{"description":"First invoice number that shall use this Saf-T configuration.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"safTConfigurationIdent":{"description":"Unique reference to identify this Saf-T configuration. If not delivered an artificial one will be generated.\nSize must be between 0 and 255.","example":"c9414238-8d55-4bcc-8945-e085d1326e2b","maxLength":255,"nullable":true,"type":"string"},"safTCountry":{"description":"The country where the Saf-T configuration shall be valid. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be null.","example":"PT","type":"string"},"validationCode":{"description":"Validation code that is the response of the requested documentSeries from PTA. Part of document, part of ATCUD.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["documentType","safTCountry"],"type":"object"},"SafTConfigurationDto":{"description":"Please see SafTConfigurationDto Model below for more information regarding required values and input type. Only one configuration per businessSegmentIdent, documentType, and safTCountry is possible.","properties":{"businessSegmentIdent":{"description":"Reference to the business segment for which the Saf-T configuration shall be valid.\nSize must be between 0 and 255.","example":"Default","maxLength":255,"nullable":true,"type":"string"},"createdAt":{"description":"Creation date of this configuration.\nMust not be null.","format":"date-time","type":"string"},"creationDate":{"deprecated":true,"description":"DEPRECATED please use createdAt. The date time format was missing the timezone indicator.","format":"date-time","nullable":true,"type":"string"},"documentSeries":{"description":"The document number that must be requested once beforehand at PTA and confirmed by them. Part of document, part of ATCUD.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"documentType":{"description":"Type of the document to which this Saf-T configuration shall be applied.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| invoice                         |\n| creditmemo                      |\n| order                           |\n| depositinvoice                  |\n| depositinvoicecancellation      |\n| creditmemo_goodwill             |\n| creditmemo_warranty             |\n| self_billing_invoice            |\n| self_billing_invoice_correction |","example":"invoice","type":"string"},"documentTypeInternalCode":{"description":"A internal code that is mostly given by the tax authority and needed to create a unique signature.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"documentsGeneratedCounter":{"description":"Number of Documents created with this configuration.","format":"int64","nullable":true,"type":"integer"},"firstInvoiceNumber":{"description":"First invoice number that shall use this Saf-T configuration.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"lastHashValue":{"description":"Hash value of the latest created document with this configuration.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"lastModified":{"deprecated":true,"description":"DEPRECATED please use lastModifiedAt. The date time format was missing the timezone indicator.","format":"date-time","nullable":true,"type":"string"},"lastModifiedAt":{"description":"Last modification of this configuration.\nMust not be null.","format":"date-time","type":"string"},"safTConfigurationIdent":{"description":"Unique reference to identify this Saf-T configuration. If not delivered an artificial one will be generated.\nSize must be between 0 and 255.","example":"c9414238-8d55-4bcc-8945-e085d1326e2b","maxLength":255,"nullable":true,"type":"string"},"safTCountry":{"description":"The country where the Saf-T configuration shall be valid. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be null.","example":"PT","type":"string"},"validationCode":{"description":"Validation code that is the response of the requested documentSeries from PTA. Part of document, part of ATCUD.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["createdAt","documentType","lastModifiedAt","safTCountry"],"type":"object"},"SafTConfigurationUpdateDto":{"description":"Please see SafTConfigurationUpdateDto Model below for more information regarding required values and input type. Only one configuration per businessSegmentIdent, documentType, and safTCountry possible.","properties":{"documentSeries":{"description":"The document number that must be requested once beforehand at PTA and confirmed by them. Part of document, part of ATCUD.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"documentType":{"description":"Type of the document to which this Saf-T configuration shall be applied.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| invoice                         |\n| creditmemo                      |\n| order                           |\n| depositinvoice                  |\n| depositinvoicecancellation      |\n| creditmemo_goodwill             |\n| creditmemo_warranty             |\n| self_billing_invoice            |\n| self_billing_invoice_correction |","example":"invoice","type":"string"},"documentTypeInternalCode":{"description":"A internal code that is mostly given by the tax authority and needed to create a unique signature.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"firstInvoiceNumber":{"description":"First invoice number that shall use this Saf-T configuration.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"safTCountry":{"description":"The country where the Saf-T configuration shall be valid. Must be a valid ISO 3166-1 alpha-3 or alpha-2 code.\nMust not be null.","example":"PT","type":"string"},"validationCode":{"description":"Validation code that is the response of the requested documentSeries from PTA. Part of document, part of ATCUD.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["documentType","safTCountry"],"type":"object"},"SelfBillingInvoiceCorrectionCreationRequest":{"description":"Creates a document of type self billing invoice correction.","properties":{"billingGroupIdent":{"description":"The `billingGroupIdent` of the document. Must be an existing billing group configured for external billing. See [Billing Group API](createbillinggroup_v3).\nMust not be blank.","minLength":1,"type":"string"},"currency":{"description":"The currency of the document. The same currency is used for all monetary values in this document.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"customerDetail":{"$ref":"#/components/schemas/CustomerDetailRequest"},"documentDate":{"description":"The date of the document. If not set the current UTC date will be used.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"ident":{"description":"Unique external reference a.k.a. document number. Depending on the document number configuration, this field is mandatory or must be omitted.","nullable":true,"type":"string"},"items":{"description":"A list of items included in the document.\nMust not be null.\nSize must be between 1 and 100.","items":{"$ref":"#/components/schemas/DocumentItemRequest"},"maxItems":100,"minItems":1,"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...).\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","example":"de","type":"string"},"operatingSiteIdent":{"description":"Ident of the operating site for the document.\nIf omitted, the default operating site is used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"Default","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"orderDate":{"description":"The date of the order.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/DocumentPaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/DocumentPaymentTermDto"},"postTaxItems":{"description":"Document post tax items","items":{"$ref":"#/components/schemas/DocumentPostTaxItemDto"},"nullable":true,"type":"array"},"properties":{"description":"Document properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"relatedDocumentIdent":{"description":"The identifier which relates to the related document. Mandatory for documents that relates to others.\nExamples:\n    - An invoice that relates to a deposit invoice\n    - A credit memo that relates to an invoice\n\nMust not be null.","type":"string"},"requestId":{"description":"Unique identifier of the creation request.\nCreation will be aborted if this `requestId` already exists.\nIf not sent, no validation will be performed.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"sellerOperatingSiteIdent":{"description":"Ident of the seller operating site for the document.\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,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["billingGroupIdent","currency","customerDetail","items","language","relatedDocumentIdent","requestId"],"type":"object"},"SelfBillingInvoiceCreationRequest":{"description":"Creates a document of type self billing invoice.","properties":{"billingGroupIdent":{"description":"The `billingGroupIdent` of the document. Must be an existing billing group configured for external billing. See [Billing Group API](createbillinggroup_v3).\nMust not be blank.","minLength":1,"type":"string"},"currency":{"description":"The currency of the document. The same currency is used for all monetary values in this document.\nThree-letter currency code in ISO 4217 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_4217).\nMust not be null.","example":"EUR","type":"string"},"customerDetail":{"$ref":"#/components/schemas/CustomerDetailRequest"},"documentDate":{"description":"The date of the document. If not set the current UTC date will be used.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"ident":{"description":"Unique external reference a.k.a. document number. Depending on the document number configuration, this field is mandatory or must be omitted.","nullable":true,"type":"string"},"items":{"description":"A list of items included in the document.\nMust not be null.\nSize must be between 1 and 100.","items":{"$ref":"#/components/schemas/DocumentItemRequest"},"maxItems":100,"minItems":1,"type":"array"},"language":{"description":"Preferred language for customer interactions (e.g. PDFs, email...).\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","example":"de","type":"string"},"operatingSiteIdent":{"description":"Ident of the operating site for the document.\nIf omitted, the default operating site is used.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"Default","maxLength":100,"minLength":1,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"orderDate":{"description":"The date of the order.","example":"2022-06-21","format":"date","nullable":true,"type":"string"},"paymentCollection":{"$ref":"#/components/schemas/DocumentPaymentCollectionDto"},"paymentInformation":{"$ref":"#/components/schemas/DocumentPaymentInformationDto"},"paymentTerm":{"$ref":"#/components/schemas/DocumentPaymentTermDto"},"postTaxItems":{"description":"Document post tax items","items":{"$ref":"#/components/schemas/DocumentPostTaxItemDto"},"nullable":true,"type":"array"},"properties":{"description":"Document properties.","items":{"$ref":"#/components/schemas/DocumentPropertyDto"},"nullable":true,"type":"array"},"relatedDocumentIdent":{"description":"The identifier which relates to the related document. Mandatory for documents that relates to others.\n\nExamples:\n    - An invoice that relates to a deposit invoice\n    - A credit memo that relates to an invoice\n","nullable":true,"type":"string"},"requestId":{"description":"Unique identifier of the creation request.\nCreation will be aborted if this `requestId` already exists.\nIf not sent, no validation will be performed.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"sellerOperatingSiteIdent":{"description":"Ident of the seller operating site for the document.\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,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["billingGroupIdent","currency","customerDetail","items","language","paymentCollection","requestId"],"type":"object"},"ServiceCountrySeparationCondition":{"description":"Which documents to apply the configuration to.","properties":{"documentType":{"description":"Document type this configuration applies to.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"},"operatingSiteIdent":{"description":"Optional ident of the operating site this configuration applies to, requires `serviceCountry` to be set","nullable":true,"type":"string"},"serviceCountry":{"description":"Service country this configuration applies to, if omitted the configuration is used as a fallback for countries without a configuration","nullable":true,"type":"string"}},"required":["documentType"],"type":"object"},"ShedlockDto":{"properties":{"lockUntil":{"description":"Lock until.\nMust not be null.","format":"date-time","type":"string"},"lockedAt":{"description":"Lock at.\nMust not be null.","format":"date-time","type":"string"},"lockedBy":{"description":"Lock by.\nMust not be blank.","minLength":1,"type":"string"},"name":{"description":"Name of the lock.\nMust not be blank.","minLength":1,"type":"string"}},"required":["lockUntil","lockedAt","lockedBy","name"],"type":"object"},"SingleTierPriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasis"},{"properties":{"netGrossIndicator":{"enum":["NET","GROSS"],"type":"string"},"tierQuantity":{"type":"number"},"totalPrice":{"type":"number"},"unitPrice":{"type":"number"},"usedQuantity":{"type":"number"}},"type":"object"}],"type":"object"},"StatusHistory":{"description":"Status history entry","properties":{"status":{"description":"The status.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"timestamp":{"description":"The timestamp when the status occurred.\nMust not be null.","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"SummarizedDocumentDto":{"description":"Lists all values that have been summarized","example":200,"properties":{"creditAmount":{"description":"credit total for item.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":2000,"type":"number"},"debitAmount":{"description":"debit total for item.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":2000,"type":"number"},"totalCount":{"description":"total count of item.\nMust not be null.","example":200,"format":"int64","type":"integer"},"type":{"description":"Type of document.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"required":["creditAmount","debitAmount","totalCount","type"],"type":"object"},"SummarizedOposDecisionDto":{"description":"Lists all values that have been summarized","example":200,"properties":{"creditAmount":{"description":"credit total for item.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":2000,"type":"number"},"debitAmount":{"description":"debit total for item.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":2000,"type":"number"},"totalCount":{"description":"total count of item.\nMust not be null.","example":200,"format":"int64","type":"integer"},"type":{"description":"Type of decision.\nMust not be null.\nMust be one of:\n|                          |\n| ------------------------ |\n| UNCOLLECTABLE_RECEIVABLE |\n| DOUBTFUL_RECEIVABLE      |\n| DISCOUNT                 |\n| OTHER_REVENUE            |\n| REVERSION                |\n| CASH_DISCOUNT            |\n| BANK_FEE                 |\n| EXTERNAL_CLOSED          |","type":"string"}},"required":["creditAmount","debitAmount","totalCount","type"],"type":"object"},"SummarizedResultSummarizedDocumentDto":{"description":"Structure representing a summarized result containing values and totals","properties":{"creditTotalAmount":{"description":"The total credit amount over all items.\nMust not be null.","example":2000,"type":"number"},"currency":{"description":"The currency used for all amount field in the response.\nMust not be null.","example":"EUR","type":"string"},"debitTotalAmount":{"description":"The total debit amount over all items.\nMust not be null.","example":2000,"type":"number"},"values":{"description":"Lists all values that have been summarized.\nMust not be null.","example":200,"items":{"$ref":"#/components/schemas/SummarizedDocumentDto"},"type":"array"}},"required":["creditTotalAmount","currency","debitTotalAmount","values"],"type":"object"},"SummarizedResultSummarizedOposDecisionDto":{"description":"Structure representing a summarized result containing values and totals","properties":{"creditTotalAmount":{"description":"The total credit amount over all items.\nMust not be null.","example":2000,"type":"number"},"currency":{"description":"The currency used for all amount field in the response.\nMust not be null.","example":"EUR","type":"string"},"debitTotalAmount":{"description":"The total debit amount over all items.\nMust not be null.","example":2000,"type":"number"},"values":{"description":"Lists all values that have been summarized.\nMust not be null.","example":200,"items":{"$ref":"#/components/schemas/SummarizedOposDecisionDto"},"type":"array"}},"required":["creditTotalAmount","currency","debitTotalAmount","values"],"type":"object"},"TaxClassificationDto":{"description":"Customer-specific tax classification","properties":{"code":{"description":"Unique tax classification code. Used as the identifier when assigning tax classifications to customers.\nMust not be null.\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","name"],"type":"object"},"TaxLocationDto":{"description":"Place of taxation of this item. If empty the mandatory performanceLocation is used. Country and region must be identical for all items.","nullable":true,"properties":{"city":{"description":"Name of the location city.\nSize must be between 0 and 255.","example":"de-by","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"The country where the document will be taxed. Should be a valid ISO 3166-1 alpha-2 code.\nTwo- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"postalCode":{"description":"Postal code of the location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"region":{"description":"The region where the document will be taxed.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"state":{"description":"State of the location.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"street":{"description":"Name of the location street, including house number.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"}},"required":["country"],"type":"object"},"TaxRegistrationDto":{"description":"Please see TaxRegistrationDto Model below for more information regarding required values and input type. Only one configuration per operatingSiteIdent possible.","properties":{"country":{"description":"Country code for the additional tax registration. Uses Alpha-2 or Alpha3 code (ISO 3166): https://www.iban.com/country-codes.\nMust not be null.","type":"string"},"vatId":{"description":"Vat id of the additional tax registration.\nMust not be blank.\nSize must be between 0 and 20.","maxLength":20,"type":"string"}},"required":["country","vatId"],"type":"object"},"TaxRegistrationRequest":{"description":"Please see TaxRegistrationRequest Model below for more information regarding required values and input type.","properties":{"taxRegistrations":{"description":"List of additional tax registrations.\nMust not be null.","items":{"$ref":"#/components/schemas/TaxRegistrationDto"},"type":"array"}},"required":["taxRegistrations"],"type":"object"},"TaxRegistrationResponse":{"description":"Please see TaxRegistrationResponse Model below for more information regarding required values and input type.","properties":{"taxRegistrations":{"description":"List of current tax registrations.\nMust not be null.","items":{"$ref":"#/components/schemas/TaxRegistrationDto"},"type":"array"}},"required":["taxRegistrations"],"type":"object"},"TenantRegistrationDto":{"nullable":true,"properties":{"authority":{"nullable":true,"type":"string"},"registration_number":{"nullable":true,"type":"string"}},"type":"object"},"TimeBasedUsagePriceCalculationBasisDto":{"allOf":[{"$ref":"#/components/schemas/PriceCalculationBasis"},{"properties":{"freeQuota":{"type":"number"},"netGrossIndicator":{"enum":["NET","GROSS"],"type":"string"},"pricingPeriod":{"$ref":"#/components/schemas/PricingPeriodDto"},"quantity":{"type":"number"},"totalPrice":{"type":"number"},"unitPrice":{"type":"number"}},"type":"object"}],"type":"object"},"TotalSumDto":{"nullable":true,"properties":{"grouping_field_name":{"nullable":true,"type":"string"},"grouping_field_sub_value":{"nullable":true,"type":"string"},"grouping_field_value":{"nullable":true,"type":"string"},"original_total_gross_sum":{"nullable":true,"type":"number"},"original_total_net_sum":{"nullable":true,"type":"number"},"original_total_tax":{"nullable":true,"type":"number"},"total_amount":{"nullable":true,"type":"number"},"total_deposit_sum":{"nullable":true,"type":"number"},"total_document_account_due":{"nullable":true,"type":"number"},"total_due":{"nullable":true,"type":"number"},"total_gross_sum":{"description":"Must not be null.","type":"number"},"total_net_sum":{"description":"Must not be null.","type":"number"},"total_post_tax_sum":{"nullable":true,"type":"number"},"total_tax_sum":{"description":"Must not be null.","type":"number"}},"required":["total_gross_sum","total_net_sum","total_tax_sum"],"type":"object"},"TotalVatLineDto":{"nullable":true,"properties":{"rate":{"nullable":true,"type":"number"},"sum":{"nullable":true,"type":"number"}},"type":"object"},"VatIdValidationResultDto":{"nullable":true,"properties":{"ident":{"description":"Must 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"},"status":{"description":"Must not be null.","enum":["VALID","INVALID","FAILED","NONE"],"type":"string"},"validatedAt":{"description":"Must not be null.","format":"date-time","type":"string"},"validationProvider":{"description":"Must not be blank.","minLength":1,"type":"string"},"vatId":{"nullable":true,"type":"string"}},"required":["ident","status","validatedAt","validationProvider"],"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","nullable":true,"type":"string"}},"required":["aggregationType","dateField","field","groupedBy"],"type":"object"},"WidgetStatisticsResponse":{"description":"Result of a statistic query.","properties":{"queryParameter":{"$ref":"#/components/schemas/WidgetStatisticsQueryParameter"},"results":{"description":"Must not be null.","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","nullable":true,"type":"string"},"value":{"description":"Sum or Counted value.\nMust not be null.","example":3.1235,"type":"number"}},"required":["value"],"type":"object"},"document_number.counter.CreateMultipleRequest":{"description":"List of document number configurations","properties":{"configurations":{"default":[],"description":"List of configurations.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentCounterCreationRequest"},"type":"array"}},"required":["configurations"],"type":"object"},"document_number.counter.MultipleDto":{"description":"List of document number configurations","properties":{"configurations":{"default":[],"description":"List of configurations.\nMust not be null.","items":{"$ref":"#/components/schemas/DocumentCounter"},"type":"array"}},"required":["configurations"],"type":"object"},"document_number.rule_based_strategy.ConditionRequest":{"description":"Conditions that must be met for this rule to apply.","properties":{"billingGroupIdents":{"default":[],"description":"The billing group condition as whitelist. An empty list means all billing groups will match.","items":{"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"nullable":true,"type":"array"},"customerTypes":{"default":[],"description":"The customer type condition as whitelist. An empty list means all customer types will match.","items":{"enum":["B2B","B2C","AFFILIATED","NOT_SET"],"type":"string"},"nullable":true,"type":"array"},"documentTypes":{"default":[],"description":"The document type condition as whitelist. An empty list means all document types will match.","items":{"enum":["INVOICE","CREDIT_MEMO","CREDIT_MEMO_GOODWILL","CREDIT_MEMO_WARRANTY","DEPOSIT_INVOICE","DEPOSIT_INVOICE_CORRECTION","SELF_BILLING_INVOICE","SELF_BILLING_INVOICE_CORRECTION"],"type":"string"},"nullable":true,"type":"array"},"operatingSiteIdents":{"default":[],"description":"The operating site condition as whitelist. An empty list means all operating sites will match.","items":{"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"nullable":true,"type":"array"},"taxLocationCountries":{"default":[],"description":"The tax location country condition as whitelist. An empty list means all tax location countries will match.","items":{"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"},"nullable":true,"type":"array"}},"type":"object"},"document_number.rule_based_strategy.ConditionResponse":{"description":"Conditions that must be met for this rule to apply.","properties":{"billingGroupIdents":{"default":[],"description":"The billing group condition as whitelist. An empty list means all billing groups will match.\nMust not be null.","items":{"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"type":"array"},"customerTypes":{"default":[],"description":"The customer type condition as whitelist. An empty list means all customer types will match.\nMust not be null.","items":{"enum":["B2B","B2C","AFFILIATED","NOT_SET"],"type":"string"},"type":"array"},"documentTypes":{"default":[],"description":"The document type condition as whitelist. An empty list means all document types will match.\nMust not be null.","items":{"enum":["INVOICE","CREDIT_MEMO","CREDIT_MEMO_GOODWILL","CREDIT_MEMO_WARRANTY","DEPOSIT_INVOICE","DEPOSIT_INVOICE_CORRECTION","SELF_BILLING_INVOICE","SELF_BILLING_INVOICE_CORRECTION"],"type":"string"},"type":"array"},"operatingSiteIdents":{"default":[],"description":"The operating site condition as whitelist. An empty list means all operating sites will match.\nMust not be null.","items":{"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"type":"array"},"taxLocationCountries":{"default":[],"description":"The tax location country condition as whitelist. An empty list means all tax location countries will match.\nMust not be null.","items":{"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"}},"required":["billingGroupIdents","customerTypes","documentTypes","operatingSiteIdents","taxLocationCountries"],"type":"object"},"document_number.rule_based_strategy.Request":{"description":"Request model for creating or updating rule-set strategies.","properties":{"fallbackCounterIdent":{"description":"Fallback counter identifier if none of the rules matches. If not set and no rule can be applied, the document creation is rejected.","nullable":true,"type":"string"},"rules":{"default":[],"description":"List of rules that are checked sequentially.","items":{"$ref":"#/components/schemas/document_number.rule_based_strategy.RulesRequest"},"nullable":true,"type":"array"}},"type":"object"},"document_number.rule_based_strategy.Response":{"description":"Response model for rule-set strategies.","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.","format":"date-time","type":"string"},"fallbackCounterIdent":{"description":"The configured fallback counter.","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).\nMust not be null.","format":"date-time","type":"string"},"rules":{"default":[],"description":"The configured rules.","items":{"$ref":"#/components/schemas/document_number.rule_based_strategy.RulesResponse"},"nullable":true,"type":"array"}},"required":["createdAt","lastModifiedAt","rules"],"type":"object"},"document_number.rule_based_strategy.RulesRequest":{"description":"A rule that links a condition with a counter to be used.","properties":{"condition":{"$ref":"#/components/schemas/document_number.rule_based_strategy.ConditionRequest"},"usedCounterIdent":{"description":"Identifier of the counter to be used if the condition is met.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["condition","usedCounterIdent"],"type":"object"},"document_number.rule_based_strategy.RulesResponse":{"description":"A rule that links a condition with a counter to be used.","properties":{"condition":{"$ref":"#/components/schemas/document_number.rule_based_strategy.ConditionResponse"},"index":{"description":"Priority of the rule. Lower values are checked first.\nMust not be null.","format":"int64","type":"integer"},"usedCounterIdent":{"description":"Identifier of the counter to be used if the condition is met.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["condition","index","usedCounterIdent"],"type":"object"},"invoice_history_item":{"properties":{"comment":{"description":"Size must be between 0 and 32767.","maxLength":32767,"nullable":true,"type":"string"},"created_timestamp":{"format":"int64","nullable":true,"type":"integer"},"invoice_history_item_id":{"format":"int64","nullable":true,"type":"integer"},"reference_id":{"format":"int64","nullable":true,"type":"integer"},"reference_type":{"description":"Size must be between 0 and 64.","maxLength":64,"nullable":true,"type":"string"},"type":{"description":"Must be one of:\n|                    |\n| ------------------ |\n| invoiced           |\n| reminded1          |\n| reminded2          |\n| reminded3          |\n| reminded4          |\n| completed          |\n| commented          |\n| emailed            |\n| smailed            |\n| assigned           |\n| credited           |\n| archived           |\n| fee_charged        |\n| commission_charged |\n| updated            |","nullable":true,"type":"string"}},"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"accounts-receivable-management-read":"Scope accounts-receivable-management-read","accounts-receivable-management-write":"Scope accounts-receivable-management-write","document-management-read":"Scope document-management-read","document-management-write":"Scope document-management-write","internal":"Scope internal","tenant-management-read":"Scope tenant-management-read","tenant-management-write":"Scope tenant-management-write"},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for Invoice access","title":"Invoice API","version":"v2-preview-4.15.0"},"openapi":"3.0.1","paths":{"/v2/billing/configuration/aggregation":{"get":{"description":"Get a list of all aggregation configurations. To reduce the result set, please use the RSQL query.","operationId":"getAggregations","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"documentType==invoice","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: 'aggregationConfigurationIdent'.","in":"query","name":"sort","schema":{"default":["aggregationConfigurationIdent"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAggregationConfigurationDto"}}},"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":["tenant-management-read"]}],"summary":"Query Aggregation","tags":["Aggregation Configurations"]},"post":{"description":"Create a new aggregation configuration. Aggregation configurations are an additional post processing to sum up the item amounts by certain criterias. For example BY_TAX_RATE would sum up the values of the items (rowTotalExclusiveVat, rowTotalInclusiveVat, ...) grouped by the tax rates of the items.  Only one configuration per invoiceType is possible.","operationId":"createAggregation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationConfigurationCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Create Aggregation","tags":["Aggregation Configurations"]}},"/v2/billing/configuration/aggregation/{aggregationConfigurationIdent}":{"delete":{"description":"Delete an aggregation configuration.","operationId":"deleteAggregation","parameters":[{"in":"path","name":"aggregationConfigurationIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"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":["tenant-management-write"]}],"summary":"Delete Aggregation","tags":["Aggregation Configurations"]},"get":{"description":"Get a specific aggregation configuration by its ident.","operationId":"getAggregation","parameters":[{"in":"path","name":"aggregationConfigurationIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationConfigurationDto"}}},"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":["tenant-management-read"]}],"summary":"Retrieve Aggregation","tags":["Aggregation Configurations"]},"put":{"description":"Update an aggregation configuration.","operationId":"updateAggregation","parameters":[{"in":"path","name":"aggregationConfigurationIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationConfigurationUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Update Aggregation","tags":["Aggregation Configurations"]}},"/v2/billing/configuration/attach-history-for-polish-credit-memo":{"get":{"description":"Retrieves the polish credit memo flag for a tenant. Returns the flag.","operationId":"getPolishCreditMemoFlag","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolishCreditMemoDto"}}},"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":["tenant-management-read"]}],"summary":"Get polish credit memo flag","tags":["Tenant Configurations"]}},"/v2/billing/configuration/attach-history-for-polish-credit-memo/{polishCreditMemoFlag}":{"post":{"description":"Updates the polish credit memo flag for a tenant. Returns the flag.","operationId":"setPolishCreditMemoFlag","parameters":[{"description":"Flag if the credit memo shall behave as a polish credit memo.","in":"path","name":"polishCreditMemoFlag","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolishCreditMemoDto"}}},"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":["tenant-management-write"]}],"summary":"Set polish credit memo flag","tags":["Tenant Configurations"]}},"/v2/billing/configuration/document-numbers/counters":{"get":{"description":"Search document counters with RSQL.","operationId":"queryDocumentCounters","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"value==0","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseDocumentCounter"}}},"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":"Query counters","tags":["Document Number Configurations"]},"post":{"description":"Create a document counter used to assign document numbers.","operationId":"createDocumentCounter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCounterCreationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCounter"}}},"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":"Create counter","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/counters/{ident}":{"delete":{"description":"Delete counter by its ident. Only allowed when counter is not in use.","operationId":"deleteDocumentCounter","parameters":[{"description":"Counter ident.\nMust not be null.","in":"path","name":"ident","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 counter","tags":["Document Number Configurations"]},"put":{"description":"Replace a counter configuration.","operationId":"updateDocumentCounter","parameters":[{"description":"Counter ident.\nMust not be null.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCounterUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCounter"}}},"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":"Update counter configuration","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategies/billing-group-separation":{"get":{"description":"Get a list of all billing group separation document number configurations. To reduce the result set, please use the RSQL query.","operationId":"queryBillingGroupSeparationDocumentNumberStrategies","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"condition.documentType==INVOICE","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseDocumentNumberBillingGroupSeparationStrategyConfiguration"}}},"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":"Search billing group number strategies","tags":["Document Number Configurations"]},"post":{"description":"Create a billing group separation document number configuration.","operationId":"createBillingGroupSeparationDocumentNumberStrategies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberBillingGroupSeparationStrategyConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberBillingGroupSeparationStrategyConfiguration"}}},"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":"Create billing group number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategies/billing-group-separation/{ident}":{"delete":{"description":"Delete a billing group separation document number configuration.","operationId":"deleteBillingGroupSeparationDocumentNumberStrategy","parameters":[{"description":"Ident of the strategy to delete.\nMust not be null.","in":"path","name":"ident","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 billing group number strategy","tags":["Document Number Configurations"]},"put":{"description":"Update a billing group separation document number configuration.","operationId":"updateBillingGroupSeparationDocumentNumberStrategies","parameters":[{"description":"Ident of the strategy to update.\nMust not be null.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberBillingGroupSeparationStrategyConfiguration"}}},"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":"Update billing group number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategies/default":{"delete":{"description":"Delete tenant wide document number configuration","operationId":"deleteDefaultDocumentNumberStrategy","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 default number strategy","tags":["Document Number Configurations"]},"get":{"description":"Get tenant wide document number configurations","operationId":"getDefaultDocumentNumberStrategy","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberConfiguration"}}},"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 default number strategy","tags":["Document Number Configurations"]},"post":{"description":"Create or update tenant wide document number configuration","operationId":"createDefaultDocumentNumberStrategy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberConfiguration"}}},"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":"Create default number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategies/document-type-separation":{"get":{"description":"Get a list of all document type separation document number configurations. To reduce the result set, please use the RSQL query.","operationId":"queryDocumentTypeSeparationDocumentNumberStrategies","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"condition.documentType==INVOICE","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseDocumentNumberDocumentTypeSeparationStrategyConfiguration"}}},"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":"Search document type number strategies","tags":["Document Number Configurations"]},"post":{"description":"Create a document type separation document number configuration.","operationId":"createDocumentTypeSeparationDocumentNumberStrategies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberDocumentTypeSeparationStrategyConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberDocumentTypeSeparationStrategyConfiguration"}}},"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":"Create document type number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategies/document-type-separation/{ident}":{"delete":{"description":"Delete a document type separation document number configuration.","operationId":"deleteDocumentTypeSeparationDocumentNumberStrategy","parameters":[{"description":"Ident of the strategy to delete.\nMust not be null.","in":"path","name":"ident","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 document type number strategy","tags":["Document Number Configurations"]},"put":{"description":"Update a document type separation document number configuration.","operationId":"updateDocumentTypeSeparationDocumentNumberStrategies","parameters":[{"description":"Ident of the strategy to update.\nMust not be null.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberDocumentTypeSeparationStrategyConfiguration"}}},"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":"Update document type number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategies/service-country-separation":{"get":{"description":"Get a list of all service country separation document number configurations. To reduce the result set, please use the RSQL query.","operationId":"queryServiceCountrySeparationDocumentNumberStrategies","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"condition.documentType==INVOICE","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseDocumentNumberServiceCountrySeparationStrategyConfiguration"}}},"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":"Search service country number strategies","tags":["Document Number Configurations"]},"post":{"description":"Create a service country separation document number configuration.","operationId":"createServiceCountrySeparationDocumentNumberStrategy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberServiceCountrySeparationStrategyConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberServiceCountrySeparationStrategyConfiguration"}}},"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":"Create service country number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategies/service-country-separation/{ident}":{"delete":{"description":"Delete a service country separation document number configuration.","operationId":"deleteServiceCountrySeparationDocumentNumberStrategy","parameters":[{"description":"Ident of the strategy to delete.\nMust not be null.","in":"path","name":"ident","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 service country number strategy","tags":["Document Number Configurations"]},"put":{"description":"Update a service country separation document number configuration.","operationId":"updateServiceCountrySeparationDocumentNumberStrategy","parameters":[{"description":"Ident of the strategy to update.\nMust not be null.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberServiceCountrySeparationStrategyConfiguration"}}},"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":"Update service country number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/document-numbers/strategy":{"get":{"description":"Retrieve document number strategy selection","operationId":"getCounterConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberStrategySelection"}}},"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":["tenant-management-read"]}],"summary":"Document number strategy","tags":["Document Number Configurations"]},"post":{"description":"Update document number strategy selection","operationId":"createOrUpdateCounterConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberStrategySelection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNumberStrategySelection"}}},"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":["tenant-management-write"]}],"summary":"Select document number strategy","tags":["Document Number Configurations"]}},"/v2/billing/configuration/dunning":{"get":{"description":"Get the dunning configuration.","operationId":"getDunningConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningConfigurationDto"}}},"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":["tenant-management-read"]}],"summary":"Retrieve dunning configuration","tags":["Dunning Configurations"]},"post":{"description":"Creates or updates the dunning configuration.","operationId":"createDunningConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningConfigurationDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Create dunning configuration","tags":["Dunning Configurations"]}},"/v2/billing/configuration/operating-sites":{"get":{"description":"Get a list of all Operating Sites. To reduce the result set, please use the RSQL query.","operationId":"getOperatingSites","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"documentType==invoice","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: 'operatingSiteIdent'.","in":"query","name":"sort","schema":{"default":["operatingSiteIdent"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOperatingSiteConfigurationDto"}}},"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":["tenant-management-read"]}],"summary":"Query Operating Site","tags":["Operating Site Configurations"]},"post":{"description":"Create a new Operating Site.","operationId":"createOperatingSite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperatingSiteConfigurationCreationDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperatingSiteConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Create Operating Site","tags":["Operating Site Configurations"]}},"/v2/billing/configuration/operating-sites/{operatingSiteIdent}":{"delete":{"description":"Delete an Operating Site. Only possible if this Operating Site was not applied to a document by now.","operationId":"deleteOperatingSite","parameters":[{"in":"path","name":"operatingSiteIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"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":["tenant-management-write"]}],"summary":"Delete Operating Site","tags":["Operating Site Configurations"]},"get":{"description":"Get a specific Operating Site by its ident.","operationId":"getOperatingSite","parameters":[{"in":"path","name":"operatingSiteIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailedOperatingSiteConfigurationResponse"}}},"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":["tenant-management-read"]}],"summary":"Retrieve Operating Site","tags":["Operating Site Configurations"]},"put":{"description":"Update an Operating Site. Only possible if this Operating Site was not applied to a document by now.","operationId":"updateOperatingSite","parameters":[{"in":"path","name":"operatingSiteIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperatingSiteConfigurationUpdateDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperatingSiteConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Update Operating Site","tags":["Operating Site Configurations"]}},"/v2/billing/configuration/operating-sites/{operatingSiteIdent}/actions/default":{"post":{"description":"Makes the Operating Site default. The Operating Site becomes the default and will be used if no operating site is specified on the invoice.","operationId":"makeOperatingSiteDefault","parameters":[{"in":"path","name":"operatingSiteIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperatingSiteConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Make Operating Site Default","tags":["Operating Site Configurations"]}},"/v2/billing/configuration/operating-sites/{operatingSiteIdent}/tax-registrations":{"get":{"description":"Get a list of all tax registrations. To reduce the result set, please use the RSQL query.","operationId":"getTaxRegistrationsForAnOperatingSite","parameters":[{"in":"path","name":"operatingSiteIdent","required":true,"schema":{"type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"documentType==invoice","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: 'country'.","in":"query","name":"sort","schema":{"default":["country"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseTaxRegistrationDto"}}},"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":["tenant-management-read"]}],"summary":"Query tax registrations","tags":["Operating Site Configurations"]},"post":{"description":"Create/Updates a list of tax registrations for an operating site. Returns a list of all tax registrations.","operationId":"createOrUpdateTaxRegistrations","parameters":[{"in":"path","name":"operatingSiteIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRegistrationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRegistrationResponse"}}},"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":["tenant-management-write"]}],"summary":"Create tax registrations","tags":["Operating Site Configurations"]}},"/v2/billing/configuration/operating-sites/{operatingSiteIdent}/tax-registrations/{countryCode}":{"delete":{"description":"Deletes a tax registration for an operating site.","operationId":"deleteTaxRegistration","parameters":[{"in":"path","name":"operatingSiteIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"countryCode","required":true,"schema":{"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"}}],"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":["tenant-management-write"]}],"summary":"Delete tax registrations","tags":["Operating Site Configurations"]}},"/v2/billing/configuration/saf-t":{"get":{"description":"Get a list of all Saf-T configurations. To reduce the result set, please use the RSQL query.","operationId":"getSafTConfigurations","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"documentType==invoice","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: 'safTConfigurationIdent'.","in":"query","name":"sort","schema":{"default":["safTConfigurationIdent"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseSafTConfigurationDto"}}},"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":["tenant-management-read"]}],"summary":"Query Saf-T configuration","tags":["SAF-T Configurations"]},"post":{"description":"Create a new Saf-T configuration. Until the firstInvoiceNumber was set, the configuration won't be applied.","operationId":"createSafTConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafTConfigurationCreationDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafTConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Create Saf-T configuration","tags":["SAF-T Configurations"]}},"/v2/billing/configuration/saf-t/{safTConfigurationIdent}":{"delete":{"description":"Delete a Saf-T configuration. Only possible if this configuration was not applied to a document by now.","operationId":"deleteSafTConfiguration","parameters":[{"in":"path","name":"safTConfigurationIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"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":["tenant-management-write"]}],"summary":"Delete Saf-T configuration","tags":["SAF-T Configurations"]},"get":{"description":"Get a specific Saf-T configuration by it's ident.","operationId":"getSafTConfiguration","parameters":[{"in":"path","name":"safTConfigurationIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafTConfigurationDto"}}},"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":["tenant-management-read"]}],"summary":"Retrieve Saf-T configuration","tags":["SAF-T Configurations"]},"put":{"description":"Update a Saf-T configuration. Only possible if this configuration was not applied to a document by now.","operationId":"updateSafTConfiguration","parameters":[{"in":"path","name":"safTConfigurationIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafTConfigurationUpdateDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafTConfigurationDto"}}},"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":["tenant-management-write"]}],"summary":"Update Saf-T configuration","tags":["SAF-T Configurations"]}},"/v2/document-labels":{"get":{"description":"Get a list of all labels currently in use for this tenant. To reduce the result set, please use the RSQL query.","operationId":"getLabels","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==PAID","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: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseLabelDto"}}},"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":["document-management-read"]}],"summary":"Query Labels","tags":["Document Labels"]}},"/v2/document-labels/{labelIdent}/actions/add-to-document/{documentIdent}":{"post":{"description":"Adds a label to a document.","operationId":"addLabelToDocument","parameters":[{"in":"path","name":"labelIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseLabelDto"}}},"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":["document-management-write"]}],"summary":"Add Label","tags":["Document Labels"]}},"/v2/document-labels/{labelIdent}/actions/remove-from-document/{documentIdent}":{"post":{"description":"Removes a label from a document.","operationId":"removeLabelFromDocument","parameters":[{"in":"path","name":"labelIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseLabelDto"}}},"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":["document-management-write"]}],"summary":"Remove Label","tags":["Document Labels"]}},"/v2/documents":{"get":{"description":"Get a list of all documents. To reduce the result set, please use the RSQL query.","operationId":"queryDocuments","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"type==INVOICE","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: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseRsqlResultDocumentDto"}}},"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":["document-management-read"]}],"summary":"Query documents","tags":["Documents"]}},"/v2/documents/credit-memos":{"post":{"description":"Submit a new document of type credit memo.","operationId":"createCreditMemo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditMemoCreationRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["document-management-write"]}],"summary":"Create credit memo","tags":["Documents"]}},"/v2/documents/credit-memos/{documentIdent}":{"get":{"description":"Get a document of type credit memo by it's ident.","operationId":"getCreditMemo","parameters":[{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}},"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":["document-management-read"]}],"summary":"Retrieve credit memo","tags":["Documents"]}},"/v2/documents/deposit-invoice-corrections":{"post":{"description":"Submit a new document of type deposit invoice correction.","operationId":"createDepositCorrectionInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositInvoiceCorrectionCreationRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["document-management-write"]}],"summary":"Create deposit invoice correction","tags":["Documents"]}},"/v2/documents/deposit-invoice-corrections/{documentIdent}":{"get":{"description":"Get a document of type deposit invoice correction by it's ident.","operationId":"getDepositInvoiceCorrection","parameters":[{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}},"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":["document-management-read"]}],"summary":"Retrieve deposit invoice correction","tags":["Documents"]}},"/v2/documents/deposit-invoices":{"post":{"description":"Create a new document of type deposit invoice.","operationId":"createDepositInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositInvoiceCreationRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["document-management-write"]}],"summary":"Create deposit invoice","tags":["Documents"]}},"/v2/documents/deposit-invoices/{documentIdent}":{"get":{"description":"Get a document of type deposit invoice by it's ident.","operationId":"getDepositInvoice","parameters":[{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}},"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":["document-management-read"]}],"summary":"Retrieve deposit invoice","tags":["Documents"]}},"/v2/documents/invoices":{"post":{"description":"Submit a new document of type invoice.","operationId":"createInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCreationRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["document-management-write"]}],"summary":"Create invoice","tags":["Documents"]}},"/v2/documents/invoices/{documentIdent}":{"get":{"description":"Get a document of type invoice by it's ident.","operationId":"getInvoice","parameters":[{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}},"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":["document-management-read"]}],"summary":"Retrieve invoice","tags":["Documents"]}},"/v2/documents/processing-status/{requestId}":{"get":{"description":"Get a document by it's request id.","operationId":"getDocumentByRequestId","parameters":[{"description":"Id of the request, which was used to deliver the document.","in":"path","name":"requestId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentStatusResponseDto"}}},"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":["document-management-read"]}],"summary":"Retrieve document processing status by requestId","tags":["Documents"]}},"/v2/documents/self-billing-invoice-corrections":{"post":{"description":"Submit a new document of type self billing invoice correction.","operationId":"createSelfBillingInvoiceCorrection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfBillingInvoiceCorrectionCreationRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["document-management-write"]}],"summary":"Create self billing invoice correction","tags":["Documents"]}},"/v2/documents/self-billing-invoice-corrections/{documentIdent}":{"get":{"description":"Get a document of type self billing invoice correction by it's ident.","operationId":"getSelfBillingInvoiceCorrection","parameters":[{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}},"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":["document-management-read"]}],"summary":"Retrieve self billing invoice correction","tags":["Documents"]}},"/v2/documents/self-billing-invoices":{"post":{"description":"Submit a new document of type self billing invoice.","operationId":"createSelfBillingInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfBillingInvoiceCreationRequest"}}},"required":true},"responses":{"202":{"description":"The request has been accepted for processing, but the processing has not been completed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["document-management-write"]}],"summary":"Create self billing invoice","tags":["Documents"]}},"/v2/documents/self-billing-invoices/{documentIdent}":{"get":{"description":"Get a document of type self billing invoice by it's ident.","operationId":"getSelfBillingInvoice","parameters":[{"in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}},"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":["document-management-read"]}],"summary":"Retrieve self billing invoice","tags":["Documents"]}},"/v2/documents/{documentIdent}":{"get":{"description":"Get a document by it's ident.","operationId":"getDocument","parameters":[{"description":"Ident of the document.","in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}},"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":["document-management-read"]}],"summary":"Retrieve document","tags":["Documents"]}},"/v2/documents/{documentIdent}/aggregations":{"get":{"description":"Get a document aggregations by it's ident. Needs configured aggregations for this type of documents.","operationId":"getDocumentAggregations","parameters":[{"description":"Ident of the document.","in":"path","name":"documentIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentAggregationResponse"}}},"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":["document-management-read"]}],"summary":"Retrieve document aggregations","tags":["Documents"]}},"/v2/dunning-status-aggregations/{referenceType}/{referenceIdent}":{"get":{"description":"Get the dunning status for a reference type and reference ident.","operationId":"getDunningStatusAggregation","parameters":[{"description":"Type of the reference.","in":"path","name":"referenceType","required":true,"schema":{"enum":["CONTRACT"],"type":"string"}},{"description":"Ident of the reference.","in":"path","name":"referenceIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DunningStatusAggregationDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve dunning status aggregation","tags":["Dunning Status Aggregations"]}},"/v2/dunning-status-aggregations/{referenceType}/{referenceIdent}/documents":{"get":{"description":"Get a list of all documents related to the given for a reference type and reference ident.","operationId":"getDunningStatusAggregationDocuments","parameters":[{"description":"Type of the reference.","in":"path","name":"referenceType","required":true,"schema":{"enum":["CONTRACT"],"type":"string"}},{"description":"Ident of the reference.","in":"path","name":"referenceIdent","required":true,"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: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseDunningStatusAggregationDocumentDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Lists dunning status aggregation documents","tags":["Dunning Status Aggregations"]}},"/v2/opos-case-clearing-runs":{"get":{"description":"Get a list of clearing runs. To reduce the result set, please use the RSQL query.","operationId":"getOposCaseClearingRuns","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"status==DONE","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/PagedResponseOposCaseClearingRunResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Clearing Run","tags":["OPOS Case Clearing Runs"]},"post":{"description":"Add a clearing run to balance open OPOS Cases","operationId":"addOposCaseClearingRun","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunResponse"}}},"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":["accounts-receivable-management-write"]}],"summary":"Add Clearing Run","tags":["OPOS Case Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}":{"get":{"description":"Get a specific clearing run by its ident","operationId":"getOposCaseClearingRun","parameters":[{"in":"path","name":"clearingRunIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve Clearing Run","tags":["OPOS Case Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}/actions/reverse":{"post":{"description":"Reverse a created clearing run in status DONE.\n","operationId":"reverseOposCaseClearingRun","parameters":[{"in":"path","name":"clearingRunIdent","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":["accounts-receivable-management-write"]}],"summary":"Reverse Clearing Run","tags":["OPOS Case Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}/items":{"get":{"description":"Get a list of clearing run items. To reduce the result set, please use the RSQL query.","operationId":"getOposCaseClearingRunItems","parameters":[{"in":"path","name":"clearingRunIdent","required":true,"schema":{"type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"status==PLANNED","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/PagedResponseOposCaseClearingRunItemResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Clearing Run Items","tags":["OPOS Case Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}/items/{clearingRunItemIdent}":{"get":{"description":"Get a specific clearing run item by its ident","operationId":"getOposCaseClearingRunItem","parameters":[{"in":"path","name":"clearingRunIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"clearingRunItemIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunItemResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve Clearing Run Item","tags":["OPOS Case Clearing Runs"]}},"/v2/opos-case-decisions":{"get":{"description":"Get a list of decisions. To reduce the result set, please use the RSQL query.","operationId":"queryOposCaseDecisions","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"oposCaseIdent=someIdent","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/PagedResponseOposCaseDecisionDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Decisions","tags":["OPOS Cases"]}},"/v2/opos-cases":{"get":{"description":"Get a list of all OPOS cases for this tenant. To reduce the result set, please use the RSQL query.","operationId":"getOposCases","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"balance==0","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: 'initialDocumentIdent'.","in":"query","name":"sort","schema":{"default":["initialDocumentIdent"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOposCaseDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query OPOS Cases","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}":{"get":{"description":"Get a specific OPOS case by its ident.","operationId":"getOposCase","parameters":[{"in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/actions/enable-payment-collection":{"post":{"description":"Manual enabling of the payment collection of an OposCase.","operationId":"enableOposCasePaymentCollection","parameters":[{"description":"Ident of the opos case","in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseEnablePaymentCollectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Enable OposCase payment collection","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/actions/recalculate-and-reevaluate":{"post":{"description":"Manual recalculation of Debit, Credit and Balance before reevaluation of the OposCase.","operationId":"recalculateAndReevaluateOposCase","parameters":[{"in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperatingSiteConfigurationCreationDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Recalculation and Reevaluation of OposCase","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/actions/reevaluate":{"post":{"description":"Manual reevaluation of the OposCase. Changes status of contained document, depending on the OposCase status. If BALANCED all documents are set to COMPLETED, otherwise the last DEBIT document will change status from COMPLETED to the prior status, if needed.","operationId":"reevaluateOposCase","parameters":[{"in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperatingSiteConfigurationCreationDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Reevaluation of OposCase","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/decisions":{"get":{"description":"Get a list of decisions for this OPOS case. To reduce the result set, please use the RSQL query.","operationId":"getOposCaseDecisions","parameters":[{"in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"type==OTHER_REVENUE","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/PagedResponseOposCaseDecisionDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Decisions for OPOS Cases","tags":["OPOS Cases"]},"post":{"description":"Add a decision to an OPOS Case","operationId":"addOposCaseDecision","parameters":[{"in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionCreationDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Add Decision for OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/decisions/{decisionIdent}":{"get":{"description":"Get a specific decision by its ident","operationId":"getOposCaseDecision","parameters":[{"in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"decisionIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve Decision for OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/decisions/{oposCaseDecisionIdent}/revert":{"post":{"description":"Revert a specific decision by its ident","operationId":"revertOposCaseDecision","parameters":[{"in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}},{"in":"path","name":"oposCaseDecisionIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionReversionDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Revert a Decision for OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/dunning-block":{"put":{"description":"Activation or Deactivation of opos case dunning block","operationId":"OposCaseDunning","parameters":[{"description":"Ident of the opos case","in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDunningBlockRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Update OposCase Dunning Block state","tags":["OPOS Cases"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"endpoints for Documents","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Documents"},{"description":"endpoints for Document Labels","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Document Labels"},{"description":"endpoints for Aggregation Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Aggregation Configurations"},{"description":"endpoints for Document Number Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Document Number Configurations"},{"description":"endpoints for Dunning Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Dunning Configurations"},{"description":"endpoints for Dunning Status Aggregations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Dunning Status Aggregations"},{"description":"endpoints for Operating Site Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Operating Site Configurations"},{"description":"endpoints for OPOS Cases","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"OPOS Cases"},{"description":"endpoints for OPOS Case Clearing Runs","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"OPOS Case Clearing Runs"},{"description":"endpoints for SAF-T Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"SAF-T Configurations"},{"description":"endpoints for Tenant Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tenant Configurations"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}