{"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":{"AddressDto":{"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":{"type":"string"},"addressAddition":{"type":"string"},"agencyProfessionTitle":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"customerType":{"enum":["b2b","b2c","affiliated"],"type":"string"},"department":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"gender":{"enum":["none","male","female","family","other"],"type":"string"},"ident":{"description":"Unique external reference.","type":"string"},"lastName":{"type":"string"},"postOfficeBox":{"type":"string"},"postalCode":{"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"state":{"type":"string"},"stateCode":{"type":"string"},"street":{"type":"string"},"streetNumber":{"type":"string"},"taxNumber":{"description":"Tax number, maximum of 20 characters","type":"string"},"vatId":{"description":"VAT identification number, maximum of 20 characters","type":"string"}},"type":"object"},"AgreedDepositDto":{"properties":{"debitCreditIndicator":{"description":"Indicator how the deposit should be used.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"CREDIT","type":"string"},"grossValue":{"description":"Gross value of this agreed deposit.","type":"number"},"ident":{"description":"Unique external reference.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"name":{"description":"Human readable name of the deposit, can be printed on pdf.","example":"50% Deposit","type":"string"},"netValue":{"description":"Net value of this agreed deposit.","type":"number"},"properties":{"description":"Additional agreed deposit properties.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"status":{"description":"Status of the Agreed Deposit.\nMust be one of:\n|          |\n| -------- |\n| EXPECTED |\n| PAID     |","example":"EXPECTED","type":"string"},"taxInformation":{"description":"List of tax information of this agreed deposit.","items":{"$ref":"#/components/schemas/AgreedDepositTaxInformationDto"},"type":"array"},"taxValue":{"description":"Sum of all tax value of this agreed deposit.","type":"number"},"value":{"deprecated":true,"description":"DEPRECATED.\nAmount of this agreed deposit.","example":0.5,"type":"number"}},"required":["ident"],"type":"object"},"AgreedDepositTaxInformationDto":{"description":"List of tax information of this agreed deposit.","properties":{"taxCode":{"type":"string"},"taxRate":{"type":"number"},"taxValue":{"type":"number"}},"type":"object"},"BankAccountDto":{"properties":{"bic":{"type":"string"},"holderName":{"type":"string"},"iban":{"type":"string"}},"type":"object"},"CustomerPaymentAccountDto":{"description":"Contains information about the customer payment account that is going to be used to pay this document.","properties":{"accountHolderName":{"description":"Name of the account holder of the account.","type":"string"},"displayName":{"description":"Name of the account.","type":"string"},"ident":{"description":"Ident of the customer payment account.","type":"string"},"paymentCardType":{"description":"Payment card type of the customer payment account.","nullable":true,"type":"string"},"paymentMethod":{"description":"Payment method used with the account.","type":"string"}},"type":"object"},"DepositDto":{"properties":{"assignmentIdent":{"description":"Unique internal reference for the assignment to a payment.","type":"string"},"debitCreditIndicator":{"description":"Indicator how the deposit should be used.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"CREDIT","type":"string"},"grossValue":{"description":"Gross value of this deposit.","type":"number"},"ident":{"description":"Unique internal reference for the deposit.\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"},"netValue":{"description":"Net value of this deposit.","type":"number"},"paymentIdent":{"description":"Unique internal reference to a payment.","type":"string"},"taxInformation":{"description":"List of tax information of this deposit.","items":{"$ref":"#/components/schemas/AgreedDepositTaxInformationDto"},"type":"array"},"taxValue":{"description":"Sum of all tax value of this deposit.","type":"number"},"value":{"deprecated":true,"description":"DEPRECATED.\nAmount of this deposit.","type":"number"}},"required":["ident"],"type":"object"},"DocumentItemTaxDetailDto":{"properties":{"taxInformation":{"description":"A list of individual taxes for this document item.","items":{"$ref":"#/components/schemas/DocumentItemTaxInformationDto"},"type":"array"},"taxProviderName":{"description":"Name of tax provider used to calculate taxes.\nMust be one of:\n|                   |\n| ----------------- |\n| NITROBOX          |\n| AVALARA           |\n| FINANCE_ENABLER   |\n| CUSTOMER_PROVIDED |\n| CLIENT_PROVIDED   |","type":"string"},"taxProviderProductCode":{"description":"TaxProvider specific code which was used to calculate this line item.","type":"string"},"taxRate":{"description":"Summed up tax rate for `taxInformation`","type":"number"},"taxScheme":{"description":"Is taxation handled via Europe OSS.\nMust be one of:\n|         |\n| ------- |\n| OSS     |\n| DEFAULT |","type":"string"}},"type":"object"},"DocumentItemTaxInformationDto":{"description":"A list of individual taxes for this document item.","properties":{"jurisdiction":{"$ref":"#/components/schemas/DocumentItemTaxInformationJurisdictionDto"},"originalRowTotalTax":{"description":"The row total tax amount without item extras for this tax.","type":"number"},"rowTotalTax":{"description":"The row total tax amount for this tax.","type":"number"},"taxCode":{"description":"The tax code of this tax detail.","type":"string"},"taxName":{"description":"The name of the tax against which this tax amount was calculated.","type":"string"},"taxRate":{"description":"The rate at which this tax detail was calculated.","type":"number"},"taxType":{"description":"The type of tax that was calculated.","type":"string"},"unitPriceTax":{"description":"The unit tax amount without item extras for this tax.","type":"number"}},"type":"object"},"DocumentItemTaxInformationJurisdictionDto":{"description":"Jurisdiction in charge of the Tax","properties":{"code":{"type":"string"},"name":{"type":"string"},"type":{"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":{"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"},"InvoiceDto":{"description":"Each InvoiceDto represents one document. The kind of the document is specified by the type.","properties":{"address":{"$ref":"#/components/schemas/AddressDto"},"billingGroupIdent":{"description":"Ident of the billing group of the related contract.","type":"string"},"businessSegmentIdent":{"deprecated":true,"description":"Ident of the business segment of the related contract. If one uses several contracts per invoice, the ident from the contract that is processed first is used. DEPRECATED: contains the billingGroupIdent which replaced businessSegmentIdent -> please use billingGroup. The businessSegmentIdent can be found in item.properties[key=business_segment_ident]","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"currency":{"description":"Three letter abbreviation of the currency used for the document.","example":"EUR","type":"string"},"customerPaymentAccount":{"$ref":"#/components/schemas/CustomerPaymentAccountDto"},"debtorAccountNumber":{"description":"Debtor account number.","nullable":true,"type":"string"},"debtorIdent":{"description":"Ident of the debtor related to this document.\nMust not be blank.","minLength":1,"type":"string"},"depositReceivableRelevant":{"description":"Determines if a deposit invoice should be treated as a receivables opening document or not","type":"boolean"},"documentReason":{"description":"Reason of document creation.\nMust be one of:\n|                 |\n| --------------- |\n| CANCELLATION    |\n| CORRECTION      |\n| CLOSING_INVOICE |\n| UNKNOWN         |","type":"string"},"dueDate":{"description":"ISO_8601 formatted date due date of the document.\nMust not be null.","format":"date-time","type":"string"},"id":{"description":"Internal Nitrobox id of the document.","format":"int64","type":"integer"},"invoiceCreatedTimestamp":{"description":"ISO_8601 formatted date of internal creation of this document. At this timestamp the ident of the document was generated if it was not delivered by the tenant.","format":"date-time","type":"string"},"invoiceDateTimestamp":{"description":"The ISO_8601 formatted document date. This will be used for the PDF generation as document date.\nMust not be null.","format":"date-time","type":"string"},"invoiceDelivery":{"$ref":"#/components/schemas/ShipmentEmailDto"},"invoiceIdent":{"description":"Number of the document as delivered by the tenant or generated by Nitrobox, depending on the tenant configuration.","type":"string"},"items":{"description":"List of all items included in this document.\nMust not be empty.","items":{"$ref":"#/components/schemas/InvoiceItemDto"},"minItems":1,"type":"array"},"labels":{"description":"Set of labels aligned to this document.","items":{"$ref":"#/components/schemas/LabelDto"},"type":"array","uniqueItems":true},"language":{"description":"Language which should be used for PDF generation.","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"nextStatusTimestamp":{"description":"ISO_8601 formatted date of the next planned dunning escalation if the invoice is not payed.","format":"date-time","type":"string"},"operatingSite":{"$ref":"#/components/schemas/OperatingSiteDto"},"oposCase":{"$ref":"#/components/schemas/OposCaseDto"},"orderDate":{"description":"ISO_8601 formatted date when the items for the document were collected or the contract date.","format":"date-time","type":"string"},"payment":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PaymentAchDto"},{"$ref":"#/components/schemas/PaymentAlipayDto"},{"$ref":"#/components/schemas/PaymentAmazonPayDto"},{"$ref":"#/components/schemas/PaymentApplePayDto"},{"$ref":"#/components/schemas/PaymentBanktransferDto"},{"$ref":"#/components/schemas/PaymentCreditCardDto"},{"$ref":"#/components/schemas/PaymentDirectDebitDto"},{"$ref":"#/components/schemas/PaymentGooglePayDto"},{"$ref":"#/components/schemas/PaymentIdealDto"},{"$ref":"#/components/schemas/PaymentKlarnaDto"},{"$ref":"#/components/schemas/PaymentKlarnaInstallmentDto"},{"$ref":"#/components/schemas/PaymentKlarnaPayLaterDto"},{"$ref":"#/components/schemas/PaymentNewDto"},{"$ref":"#/components/schemas/PaymentOtherDto"},{"$ref":"#/components/schemas/PaymentPayUDto"},{"$ref":"#/components/schemas/PaymentPaypalDto"},{"$ref":"#/components/schemas/PaymentPurchaseOrderDto"},{"$ref":"#/components/schemas/PaymentRatePayDto"},{"$ref":"#/components/schemas/PaymentSofortDto"},{"$ref":"#/components/schemas/PaymentUnionPayDto"},{"$ref":"#/components/schemas/PaymentWeChatDto"},{"$ref":"#/components/schemas/PaymentWireTransferDto"},{"$ref":"#/components/schemas/PaymentYandexDto"}],"type":"object"},"paymentCollection":{"$ref":"#/components/schemas/PaymentCollectionDto"},"paymentTerm":{"$ref":"#/components/schemas/PaymentTermDto"},"postTaxExtras":{"description":"Additional reductions of this item.","items":{"$ref":"#/components/schemas/InvoicePostTaxItemExtraDto"},"type":"array"},"preferredDocumentDelivery":{"default":"NONE","description":"Defines the preferred way of delivering documents to this debtor. Must be one of:.\nMust be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","example":"EMAIL","type":"string"},"properties":{"description":"Additional document properties","items":{"$ref":"#/components/schemas/InvoicePropertyDto"},"type":"array"},"referenceIdent":{"description":"For single contract/order per document, it is representing the contractIdent or the orderIdent. For multiple contracts per document, it is represents the exernal reference of the contracts.","type":"string"},"referenceIdents":{"description":"List of tuples containing the reference ident and the reference type","items":{"$ref":"#/components/schemas/InvoiceOriginReferenceDto"},"type":"array"},"relatedInvoiceIdent":{"description":"Relation between invoices, e.g. CORRECTION/CANCELLATION/CLOSING invoice and original invoice ","type":"string"},"safT":{"$ref":"#/components/schemas/InvoiceSafTDto"},"serviceCountry":{"description":"The country where the product or service was sold. Contains a valid ISO 3166-1 alpha-3 or alpha-2 code.","example":"DEU","type":"string"},"shippingAddress":{"$ref":"#/components/schemas/AddressDto"},"status":{"description":"Status of this document. Shows if it was payed or a dunning process was started. [invoiced] document was created; [reminded1] - [reminded4] a specific reminder document (1-4) was sent out; [completed] document was settled;.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| invoiced  |\n| reminded1 |\n| reminded2 |\n| reminded3 |\n| reminded4 |\n| completed |","type":"string"},"taxable":{"description":"Flag to show if the document is tax relevant.\nMust be one of:\n|     |\n| --- |\n| yes |\n| no  |","type":"string"},"totalInvoiceSum":{"$ref":"#/components/schemas/TotalSumDto"},"type":{"description":"Type of this document.\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"},"vatIdValidationResult":{"$ref":"#/components/schemas/InvoiceVatIdValidationResultDto"},"webPortalPdfLink":{"description":"Deep link to aligned PDF document in the Nitrobox Portal. Will be null until the PDF was successfully generated and archived.","type":"string"}},"required":["address","createdAt","debtorIdent","dueDate","invoiceDateTimestamp","items","lastModifiedAt","status","type"],"type":"object"},"InvoiceItemDto":{"description":"List of all items included in this document.","properties":{"agreedDeposits":{"description":"List of all agreed Deposits before the document was created.","items":{"$ref":"#/components/schemas/AgreedDepositDto"},"type":"array"},"amount":{"description":"Amount of units.\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"},"billingPeriod":{"$ref":"#/components/schemas/IntervalDto"},"category":{"description":"Category of the item.\nMust be one of:\n|                         |\n| ----------------------- |\n| DIGITAL_PRODUCT         |\n| DIGITAL_PRODUCT_RENTAL  |\n| LABOR_COST              |\n| LOGISTIC_COST           |\n| PHYSICAL_PRODUCT        |\n| PHYSICAL_PRODUCT_RENTAL |\n| SERVICE                 |\n| VOUCHER                 |\n| VOUCHER_APPLICATION     |\n| DISCOUNT                |\n| ELECTRICITY             |\n| ELECTRICITY_RESALE      |","type":"string"},"deposits":{"description":"Actually paid deposits for this item.","items":{"$ref":"#/components/schemas/DepositDto"},"type":"array"},"description":{"description":"Description of the item.","type":"string"},"duration":{"description":"Duration of the item.","format":"int64","type":"integer"},"extras":{"description":"Additional reductions of this item.","items":{"$ref":"#/components/schemas/InvoiceItemExtraDto"},"type":"array"},"id":{"description":"Internal Nitrobox id of the document item.","format":"int64","type":"integer"},"itemGroup":{"description":"Identifier to cluster the items to groups.","example":"Options","maxLength":64,"type":"string"},"itemPeriodEndTimestamp":{"deprecated":true,"description":"ISO_8601 formatted date of the end date of the item. DEPRECATED: Pleace use `servicePeriod.end`","format":"date-time","type":"string"},"itemPeriodStartTimestamp":{"deprecated":true,"description":"ISO_8601 formatted date of the start date of the item. DEPRECATED: Please use `servicePeriod.start`.","format":"date-time","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 item.","type":"string"},"originalRowTotalExclusiveVat":{"description":"Base Amount without Tax and before any extra was applied.","type":"number"},"originalRowTotalInclusiveVat":{"description":"Base Amount with Tax and before any extra was applied.","type":"number"},"originalRowTotalVat":{"description":"Tax of the Base Amount before any extra was applied.","type":"number"},"performanceLocation":{"$ref":"#/components/schemas/PerformanceLocationDto"},"productIdent":{"description":"Unique external reference.\nMust not be blank.","minLength":1,"type":"string"},"properties":{"description":"Additional item properties","items":{"$ref":"#/components/schemas/InvoiceItemPropertyDto"},"type":"array"},"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":"Ident that link contract and invoice item","type":"string"},"referenceType":{"description":"Type of linking between contract and invoice item , e.g. CONTRACT,ORDER.\nMust be one of:\n|          |\n| -------- |\n| CONTRACT |\n| ORDER    |\n| INVOICE  |\n| EXTERNAL |","type":"string"},"refundabilityType":{"description":"Shows the refundability of this item.\nMust be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","type":"string"},"rowTotalExclusiveVat":{"description":"Final amount without tax. Extras were applied.\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"rowTotalInclusiveVat":{"description":"Final Amount with Tax. Extras were applied.\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"rowTotalVat":{"description":"Tax amount of final Amount. Extras were applied.\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"servicePeriod":{"$ref":"#/components/schemas/IntervalDto"},"taxCode":{"description":"Tax code applicable to this item.","type":"string"},"taxDetail":{"$ref":"#/components/schemas/DocumentItemTaxDetailDto"},"taxLocation":{"$ref":"#/components/schemas/TaxLocationDto"},"taxScheme":{"deprecated":true,"description":"DEPRECATED.\nShows the tax scheme of this item.","enum":["OSS","DEFAULT"],"type":"string"},"type":{"description":"Type of the item.\nMust not be null.\nMust be one of:\n|              |\n| ------------ |\n| deposit      |\n| discount     |\n| nonbookable  |\n| product      |\n| shipping     |\n| subscription |","type":"string"},"unitPriceExclusiveVat":{"description":"Price per unit exclusive tax.\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"unitPriceInclusiveVat":{"description":"Price per unit inclusive tax.\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"unitPriceVat":{"description":"Tax per unit.\nMust not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"vatRatePercent":{"deprecated":true,"description":"DEPRECATED.\nVat rate applied to this item. For multi-tax case have a look at the properties.","type":"number"}},"required":["amount","billingPeriod","lineItemType","productIdent","quantityType","rowTotalExclusiveVat","rowTotalInclusiveVat","rowTotalVat","servicePeriod","type","unitPriceExclusiveVat","unitPriceInclusiveVat","unitPriceVat"],"type":"object"},"InvoiceItemExtraDto":{"description":"Additional reductions of this item.","properties":{"externalIdent":{"description":"External ident.","type":"string"},"externalReference":{"description":"External reference.","type":"string"},"id":{"description":"Internal Nitrobox id of the document item extra.","format":"int64","type":"integer"},"name":{"description":"Name of the item extra.","type":"string"},"properties":{"description":"Additional item extra properties","items":{"$ref":"#/components/schemas/InvoiceItemExtraPropertyDto"},"type":"array"},"refundabilityType":{"description":"If this item extra is of type voucher, it is showing its refundability.\nMust be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","type":"string"},"type":{"description":"Type of the item extra.\nMust be one of:\n|                        |\n| ---------------------- |\n| voucher                |\n| discount               |\n| single_purpose_voucher |","type":"string"},"valueExclusiveVat":{"description":"Amount without tax.","type":"number"},"valueInclusiveVat":{"description":"Amount with tax.","type":"number"},"valueTotalVat":{"description":"Amount of tax.","type":"number"},"vatRatePercent":{"description":"Applied tax rate.","type":"number"}},"type":"object"},"InvoiceItemExtraPropertyDto":{"description":"Additional item extra properties","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"InvoiceItemPropertyDto":{"description":"Additional item properties","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"InvoiceOriginReferenceDto":{"description":"List of tuples containing the reference ident and the reference type","properties":{"referenceIdent":{"description":"For single contract/order per document, it is representing the contractIdent or the orderIdent. For multiple contracts per document, it is represents the exernal reference of the contracts.","type":"string"},"referenceType":{"description":"Type of linking between contract and invoice item , e.g. CONTRACT,ORDER.\nMust be one of:\n|          |\n| -------- |\n| CONTRACT |\n| ORDER    |\n| INVOICE  |\n| EXTERNAL |","type":"string"}},"type":"object"},"InvoicePostTaxItemExtraDto":{"description":"Additional reductions of this item.","properties":{"description":{"description":"Additional description of the post tax item extra.","type":"string"},"externalReference":{"description":"Additional reference for third party system.","type":"string"},"id":{"description":"Internal Nitrobox id of the document item extra.","format":"int64","type":"integer"},"ident":{"description":"identifier.","type":"string"},"name":{"description":"Name of the item extra.","type":"string"},"properties":{"description":"Additional item extra properties","items":{"$ref":"#/components/schemas/InvoiceItemExtraPropertyDto"},"type":"array"},"refundabilityType":{"description":"If this item extra is of type voucher, it is showing its refundability.\nMust be one of:\n|                |\n| -------------- |\n| REFUNDABLE     |\n| NON_REFUNDABLE |","type":"string"},"type":{"description":"Type of the post tax item extra.\nMust be one of:\n|                       |\n| --------------------- |\n| MULTI_PURPOSE_VOUCHER |","type":"string"},"value":{"description":"Amount.","type":"number"}},"type":"object"},"InvoicePropertyDto":{"description":"Additional document properties","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"InvoiceSafTDto":{"description":"Is an international standard for electronic exchange of reliable accounting data from organizations to a national tax authority or external auditors. Saf-T Reports might differ from service country per document.","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.","type":"string"},"certificationNumber":{"description":"Certification number allocated to the invoicing system.","type":"string"},"documentSeries":{"description":"Identifier of the document series that was requested and approved beforehand by the tax authority.","type":"string"},"documentTypeInternalCode":{"description":"Identifier of the document type. Obtained beforehand by the tax authority.","type":"string"},"hash":{"description":"Signature of a document that is created based on several parameters using RSA-SHA1.","type":"string"},"publicKeyVersion":{"description":"Version of the asymmetric public key to identify which key has to be used to decrypt the hash.","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.","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.","type":"string"},"sequenceNumber":{"description":"Sequence number of the invoice.","format":"int64","type":"integer"}},"type":"object"},"InvoiceVatIdValidationResultDto":{"description":"Result of the VatId validation for this customer.","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.","type":"string"}},"required":["ident","status","validatedAt","validationProvider","vatId"],"type":"object"},"LabelDto":{"description":"Set of labels aligned to this document.","properties":{"ident":{"description":"Unique external reference and name of the Label","type":"string"}},"type":"object"},"LegacyAddressDto":{"properties":{"academic_title":{"type":"string"},"address_addition":{"type":"string"},"agency_profession_title":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"customer_type":{"enum":["b2b","b2c","affiliated"],"type":"string"},"department":{"type":"string"},"email":{"type":"string"},"forename":{"type":"string"},"gender":{"enum":["none","male","female","family","other"],"type":"string"},"ident":{"type":"string"},"post_office_box":{"type":"string"},"postal_code":{"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"state":{"type":"string"},"state_code":{"type":"string"},"street":{"type":"string"},"street_number":{"type":"string"},"surname":{"type":"string"},"tax_number":{"description":"Tax number, maximum of 20 characters","type":"string"},"vat_id":{"description":"VAT identification number, maximum of 20 characters","type":"string"}},"type":"object"},"LegacyBankAccountDto":{"properties":{"bic":{"type":"string"},"holder_name":{"type":"string"},"iban":{"type":"string"}},"type":"object"},"LegacyInvoiceDto":{"properties":{"address":{"$ref":"#/components/schemas/LegacyAddressDto"},"business_client_id":{"description":"Must not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"created_timestamp":{"format":"int64","type":"integer"},"currency":{"type":"string"},"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":{"type":"boolean"},"document_reason":{"enum":["CANCELLATION","CORRECTION","CLOSING_INVOICE","UNKNOWN"],"type":"string"},"id":{"format":"int64","type":"integer"},"ident":{"type":"string"},"invoice_delivery":{"$ref":"#/components/schemas/LegacyShipmentEmailDto"},"items":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/LegacyInvoiceItemDto"},"minItems":1,"type":"array"},"labels":{"description":"Set of labels aligned to this document.","items":{"$ref":"#/components/schemas/LabelDto"},"type":"array","uniqueItems":true},"language":{"type":"string"},"next_status_timestamp":{"format":"int64","type":"integer"},"operating_site":{"$ref":"#/components/schemas/OperatingSiteDto"},"order_date":{"format":"int64","type":"integer"},"origin":{"type":"string"},"payment":{"oneOf":[{"$ref":"#/components/schemas/LegacyPaymentAchDto"},{"$ref":"#/components/schemas/LegacyPaymentAlipayDto"},{"$ref":"#/components/schemas/LegacyPaymentApplePayDto"},{"$ref":"#/components/schemas/LegacyPaymentBanktransferDto"},{"$ref":"#/components/schemas/LegacyPaymentCreditCardDto"},{"$ref":"#/components/schemas/LegacyPaymentDirectDebitDto"},{"$ref":"#/components/schemas/LegacyPaymentIdealDto"},{"$ref":"#/components/schemas/LegacyPaymentKlarnaInstallmentDto"},{"$ref":"#/components/schemas/LegacyPaymentKlarnaPayLaterDto"},{"$ref":"#/components/schemas/LegacyPaymentNewDto"},{"$ref":"#/components/schemas/LegacyPaymentPayUDto"},{"$ref":"#/components/schemas/LegacyPaymentPaypalDto"},{"$ref":"#/components/schemas/LegacyPaymentPurchaseOrderDto"},{"$ref":"#/components/schemas/LegacyPaymentSofortDto"},{"$ref":"#/components/schemas/LegacyPaymentUnionPayDto"},{"$ref":"#/components/schemas/LegacyPaymentWeChatDto"},{"$ref":"#/components/schemas/LegacyPaymentWireTransferDto"},{"$ref":"#/components/schemas/LegacyPaymentYandexDto"}]},"post_tax_extras":{"items":{"$ref":"#/components/schemas/LegacyInvoicePostTaxItemDto"},"type":"array"},"preferred_document_delivery":{"default":"NONE","description":"Defines the preferred way of delivering documents to this debtor. Must be one of:.\nMust be one of:\n|        |\n| ------ |\n| EMAIL  |\n| LETTER |\n| NONE   |","example":"EMAIL","type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoicePropertyDto"},"type":"array"},"reference_ident":{"type":"string"},"reference_idents":{"description":"List of tuples containing the reference ident and the reference type","items":{"$ref":"#/components/schemas/InvoiceOriginReferenceDto"},"type":"array"},"related_invoice_ident":{"type":"string"},"saf_t":{"$ref":"#/components/schemas/InvoiceSafTDto"},"service_country":{"type":"string"},"shipping_address":{"$ref":"#/components/schemas/LegacyAddressDto"},"status":{"description":"Must not be null.","enum":["invoiced","reminded1","reminded2","reminded3","reminded4","completed"],"type":"string"},"taxable":{"enum":["yes","no"],"type":"string"},"total_invoice_sum":{"$ref":"#/components/schemas/TotalSumDto"},"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"},"web_portal_pdf_link":{"type":"string"}},"required":["address","business_client_id","date_timestamp","debtor_ident","items","status","type"],"type":"object"},"LegacyInvoiceItemDto":{"properties":{"agreed_deposits":{"items":{"$ref":"#/components/schemas/AgreedDepositDto"},"type":"array"},"amount":{"description":"Must not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"billing_period":{"$ref":"#/components/schemas/IntervalDto"},"category":{"description":"Category of the item.\nMust be one of:\n|                         |\n| ----------------------- |\n| DIGITAL_PRODUCT         |\n| DIGITAL_PRODUCT_RENTAL  |\n| LABOR_COST              |\n| LOGISTIC_COST           |\n| PHYSICAL_PRODUCT        |\n| PHYSICAL_PRODUCT_RENTAL |\n| SERVICE                 |\n| VOUCHER                 |\n| VOUCHER_APPLICATION     |\n| DISCOUNT                |\n| ELECTRICITY             |\n| ELECTRICITY_RESALE      |","type":"string"},"deposits":{"items":{"$ref":"#/components/schemas/DepositDto"},"type":"array"},"description":{"type":"string"},"duration":{"format":"int64","type":"integer"},"extras":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemExtraDto"},"type":"array"},"id":{"format":"int64","type":"integer"},"ident":{"description":"Must not be blank.","minLength":1,"type":"string"},"item_group":{"type":"string"},"item_period_end_timestamp":{"format":"int64","type":"integer"},"item_period_start_timestamp":{"format":"int64","type":"integer"},"line_item_type":{"description":"Must not be null.","enum":["SALES","SELF_BILLING"],"type":"string"},"name":{"type":"string"},"original_row_total_exclusive_vat":{"type":"number"},"original_row_total_inclusive_vat":{"type":"number"},"original_row_total_vat":{"type":"number"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemPropertyDto"},"type":"array"},"quantity_type":{"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_ident":{"type":"string"},"reference_type":{"enum":["CONTRACT","ORDER","INVOICE","EXTERNAL"],"type":"string"},"row_total_exclusive_vat":{"description":"Must not be null.\nMust be greater than 0.\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 greater than 0.\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 greater than 0.\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":{"type":"string"},"tax_scheme":{"enum":["OSS","DEFAULT"],"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 greater than 0.\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 greater than 0.\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 greater than 0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","type":"number"},"vat_rate_percent":{"description":"Must not be null.\nMust be greater than 0.\nMust be a number with up to 15 integral digits and up to 2 fractional digits.","type":"number"},"voucher_type":{"enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"}},"required":["amount","ident","line_item_type","quantity_type","row_total_exclusive_vat","row_total_inclusive_vat","row_total_vat","type","unit_price_exclusive_vat","unit_price_inclusive_vat","unit_price_vat","vat_rate_percent"],"type":"object"},"LegacyInvoiceItemExtraDto":{"properties":{"external_ident":{"type":"string"},"external_reference":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemExtraPropertyDto"},"type":"array"},"refundability_type":{"enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"},"type":{"enum":["voucher","discount","single_purpose_voucher"],"type":"string"},"value_exclusive_vat":{"type":"number"},"value_inclusive_vat":{"type":"number"},"value_total_vat":{"type":"number"},"vat_rate_percent":{"type":"number"}},"type":"object"},"LegacyInvoiceItemExtraPropertyDto":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"LegacyInvoiceItemPropertyDto":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"LegacyInvoicePostTaxItemDto":{"properties":{"description":{"type":"string"},"external_reference":{"type":"string"},"id":{"format":"int64","type":"integer"},"ident":{"type":"string"},"name":{"type":"string"},"properties":{"items":{"$ref":"#/components/schemas/LegacyInvoiceItemExtraPropertyDto"},"type":"array"},"refundability_type":{"enum":["REFUNDABLE","NON_REFUNDABLE"],"type":"string"},"type":{"enum":["MULTI_PURPOSE_VOUCHER"],"type":"string"},"value":{"type":"number"}},"type":"object"},"LegacyInvoicePropertyDto":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"LegacyPaymentAchDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentAlipayDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentApplePayDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentBanktransferDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentCreditCardDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentDirectDebitDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"debit_bank_account":{"$ref":"#/components/schemas/LegacyBankAccountDto"},"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentDto":{"discriminator":{"propertyName":"payment_method"},"properties":{"payment_method":{"type":"string"}},"required":["payment_method"],"type":"object"},"LegacyPaymentIdealDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentKlarnaInstallmentDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentKlarnaPayLaterDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentNewDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentPayUDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentPaypalDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentPurchaseOrderDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentSofortDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentUnionPayDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentWeChatDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentWireTransferDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"bank_account":{"$ref":"#/components/schemas/LegacyBankAccountDto"},"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyPaymentYandexDto":{"allOf":[{"$ref":"#/components/schemas/LegacyPaymentDto"},{"properties":{"payment_method":{"type":"string"}},"type":"object"}],"required":["payment_method"],"type":"object"},"LegacyShipmentEmailDto":{"deprecated":true,"description":"DEPRECATED: This Field is deprecated and end of live. Please use field preferredDocumentDelivery as replacement.","nullable":true,"properties":{"alternate_email":{"deprecated":true,"description":"DEPRECATED: This Field is deprecated and end of live. Please use field preferredDocumentDelivery as replacement.","nullable":true,"type":"string"},"shipment_method":{"deprecated":true,"description":"DEPRECATED: This Field is deprecated and end of live. Please use field preferredDocumentDelivery as replacement.","nullable":true,"type":"string"}},"type":"object"},"OperatingSiteBankAccountDto":{"description":"Bank account of the company.","properties":{"bankName":{"description":"Name of the bank.","type":"string"},"bic":{"description":"BIC of the bank.","type":"string"},"iban":{"description":"IBAN of the bank account.","type":"string"}},"type":"object"},"OperatingSiteDto":{"description":"Is as a fixed place of business serving the activities of the tenant.","properties":{"addressAddition":{"description":"Optional additional address information that helps to identify the exact location.","type":"string"},"bankAccount":{"$ref":"#/components/schemas/OperatingSiteBankAccountDto"},"city":{"description":"City where the operating site is located.","type":"string"},"company":{"deprecated":true,"description":"DEPRECATED.\nCompany name is the name of a company which must be entered in the commercial register.","type":"string"},"companyRegistration":{"$ref":"#/components/schemas/TenantRegistrationDto"},"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.","type":"string"},"countryCode":{"deprecated":true,"description":"DEPRECATED.\nCountry 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.","type":"string"},"directors":{"description":"List of directors of the operating site.","items":{"description":"List of directors of the operating site.","type":"string"},"type":"array"},"email":{"description":"Email that is used to contact the operating site.","type":"string"},"name":{"description":"Company name is the name of a company which must be entered in the commercial register.","type":"string"},"operatingSiteIdent":{"description":"Identifier of the operating site. It is unique per tenant.\nMust not be empty.","minLength":1,"type":"string"},"phoneNumber":{"description":"The phone number to get in touch with the operating site.","type":"string"},"poBox":{"deprecated":true,"description":"DEPRECATED.\nNumber of the post office box from operating site.","type":"string"},"postOfficeBox":{"description":"Number of the post office box from operating site.","type":"string"},"postalCode":{"deprecated":true,"description":"DEPRECATED.\nPostcode where the operating site is located.","type":"string"},"state":{"description":"State where the operating site is located.","type":"string"},"stateCode":{"description":"State code where the operating site is located.","type":"string"},"street":{"description":"Street of the operating site.","type":"string"},"streetNumber":{"description":"Street number of the operating site.","type":"string"},"taxNumber":{"description":"Tax number of the registered operating site.","type":"string"},"tenantRegistration":{"$ref":"#/components/schemas/TenantRegistrationDto"},"type":{"description":"Type of the operating site.","type":"string"},"vatId":{"description":"VatId of the registered operating site.","type":"string"},"vatNumber":{"deprecated":true,"description":"DEPRECATED please change to vat id.","type":"string"},"zip":{"description":"Postcode where the operating site is located.","type":"string"}},"required":["operatingSiteIdent"],"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.","type":"string"},"type":{"description":"Type of the document.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"type":"object"},"OposCaseAssignmentDto":{"description":"List of all documents and payments related to this case.","properties":{"amount":{"description":"Amount of this assignment.","type":"number"},"creationDate":{"description":"Creation date of this assignment.","format":"date-time","type":"string"},"currency":{"default":"EUR","description":"Currency of this assignment.","example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Indicator if the amount is DEBIT or CREDIT.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"paymentAssignmentIdent":{"description":"Ident of the assignment of a payment, otherwise null.","type":"string"},"reason":{"description":"Reason why this assigment was created.\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| UNKNOWN                     |","type":"string"},"sourceIdent":{"description":"Ident of the source document or payment.","type":"string"},"sourceType":{"description":"Type of the source document.\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 target document.","type":"string"},"targetType":{"description":"Type of the target document.\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"}},"type":"object"},"OposCaseDto":{"description":"Is as a fixed place of business serving the activities of the tenant.","properties":{"activeDocuments":{"description":"List of all active/uncancelled documents for this opos case. Meaning the latest invoice/selfbilling-invoice/deposit-invoice and its children.","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. It's about the amount that should be charged or refunded to balance the opos - even if it is in a temporary correction state.","type":"number"},"amountDueDebitCreditIndicator":{"description":"Indicates if this amountDue is debit or credit.\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.","type":"number"},"amountPrebookedDebitCreditIndicator":{"description":"Indicates if amountPrebooked is debit or credit.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"assignments":{"description":"List of all documents and payments related to this case.","items":{"$ref":"#/components/schemas/OposCaseAssignmentDto"},"type":"array"},"balance":{"description":"Current sum of all assignments. Debit assignments increase the amount and credit assignments decrease it.","type":"number"},"balanceDebitCreditIndicator":{"description":"Indicates if this balance is debit or credit.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","type":"string"},"creationDate":{"description":"Creation date of this case.","format":"date-time","type":"string"},"creditSum":{"description":"Current sum of all credit assignments.","type":"number"},"currency":{"default":"EUR","description":"Currency of this opos case. Must be one of:","example":"EUR","type":"string"},"debitSum":{"description":"Current sum of all debit assignments.","type":"number"},"debtorIdent":{"description":"Ident of the debtor of the document.","type":"string"},"ident":{"description":"Ident of this opos case.","type":"string"},"initialDocumentIdent":{"description":"Ident of the document that opened this case.","type":"string"},"lastModified":{"description":"Last modification of this case.","format":"date-time","type":"string"},"prebookedItems":{"description":"List of all prebooked items for this opos case.","items":{"$ref":"#/components/schemas/OposCasePrebookedItemDto"},"type":"array"},"referenceDocumentIdent":{"description":"Ident of the document that is the last referenced document.","type":"string"},"status":{"description":"Current status of the case. Either BALANCED or UNBALANCED.\nMust be one of:\n|            |\n| ---------- |\n| BALANCED   |\n| UNBALANCED |","example":"UNBALANCED","type":"string"}},"type":"object"},"OposCasePrebookedItemDto":{"description":"List of all prebooked items for this opos case.","properties":{"amount":{"description":"Amount of this prebooked item.\nMust not be null.","type":"number"},"currency":{"description":"Currency of the amount.\nMust not be null.","type":"string"},"debitCreditIndicator":{"description":"Indicator if the amount 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.","type":"string"},"paymentIntentIdent":{"description":"Ident of the prebooked item's payment intent.\nMust not be null.","type":"string"},"paymentTransactionIdent":{"description":"Ident of the prebooked item's payment transaction.","type":"string"}},"required":["amount","currency","debitCreditIndicator","documentIdent","paymentIntentIdent"],"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"},"PagedResponseInvoiceDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/InvoiceDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PaymentAchDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentAlipayDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentAmazonPayDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentApplePayDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentBanktransferDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentCollectionDto":{"description":"Contains information about the payment collection for this document.","properties":{"customerPaymentAccountIdent":{"description":"Valid customer payment account ident, needed for automatic payment collection by NBX.","type":"string"},"paymentControl":{"description":"If paymentControl == CHARGE, it enables the automatic payment collection by NBX.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| CHARGE   |\n| NOCHARGE |","example":"NOCHARGE","type":"string"}},"required":["paymentControl"],"type":"object"},"PaymentCreditCardDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentDirectDebitDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"debitBankAccount":{"$ref":"#/components/schemas/BankAccountDto"},"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentDto":{"description":"Contains the used payment method. Optionally it can contain further information.","discriminator":{"mapping":{"accel":"#/components/schemas/PaymentNewDto","ach":"#/components/schemas/PaymentAchDto","affirm":"#/components/schemas/PaymentNewDto","affirm_qr":"#/components/schemas/PaymentNewDto","afterpay":"#/components/schemas/PaymentNewDto","alipay":"#/components/schemas/PaymentAlipayDto","alipay_plus":"#/components/schemas/PaymentNewDto","alma":"#/components/schemas/PaymentNewDto","amazonpay":"#/components/schemas/PaymentAmazonPayDto","ancv":"#/components/schemas/PaymentNewDto","apple_pay":"#/components/schemas/PaymentApplePayDto","atome":"#/components/schemas/PaymentNewDto","baloto":"#/components/schemas/PaymentNewDto","bancontact":"#/components/schemas/PaymentNewDto","banktransfer":"#/components/schemas/PaymentBanktransferDto","billie":"#/components/schemas/PaymentNewDto","bizum":"#/components/schemas/PaymentNewDto","blik":"#/components/schemas/PaymentNewDto","boletobancario":"#/components/schemas/PaymentNewDto","carnet":"#/components/schemas/PaymentNewDto","cartes_bancaires":"#/components/schemas/PaymentNewDto","cash_app_pay":"#/components/schemas/PaymentNewDto","clearpay":"#/components/schemas/PaymentNewDto","credit_card":"#/components/schemas/PaymentCreditCardDto","dana":"#/components/schemas/PaymentNewDto","direct_debit":"#/components/schemas/PaymentDirectDebitDto","doku_virtual_accounts":"#/components/schemas/PaymentNewDto","dragonpay":"#/components/schemas/PaymentNewDto","duitnow":"#/components/schemas/PaymentNewDto","eps":"#/components/schemas/PaymentNewDto","fiserv":"#/components/schemas/PaymentNewDto","fpx":"#/components/schemas/PaymentNewDto","gcash":"#/components/schemas/PaymentNewDto","girocard":"#/components/schemas/PaymentNewDto","giropay":"#/components/schemas/PaymentNewDto","givex":"#/components/schemas/PaymentNewDto","googlepay":"#/components/schemas/PaymentGooglePayDto","gopay":"#/components/schemas/PaymentNewDto","grabpay":"#/components/schemas/PaymentNewDto","ideal":"#/components/schemas/PaymentIdealDto","intersolve":"#/components/schemas/PaymentNewDto","kakaopay":"#/components/schemas/PaymentNewDto","klarna":"#/components/schemas/PaymentKlarnaDto","klarna_installment":"#/components/schemas/PaymentKlarnaInstallmentDto","klarna_pay_later":"#/components/schemas/PaymentKlarnaPayLaterDto","klarna_pay_now":"#/components/schemas/PaymentNewDto","mbway":"#/components/schemas/PaymentNewDto","mobile_pay":"#/components/schemas/PaymentNewDto","momo":"#/components/schemas/PaymentNewDto","multibanco":"#/components/schemas/PaymentNewDto","naverpay":"#/components/schemas/PaymentNewDto","other":"#/components/schemas/PaymentOtherDto","oxxo":"#/components/schemas/PaymentNewDto","pay_now":"#/components/schemas/PaymentNewDto","paybright":"#/components/schemas/PaymentNewDto","payme":"#/components/schemas/PaymentNewDto","paypal":"#/components/schemas/PaymentPaypalDto","paypay":"#/components/schemas/PaymentNewDto","paypo":"#/components/schemas/PaymentNewDto","paytm":"#/components/schemas/PaymentNewDto","payu":"#/components/schemas/PaymentPayUDto","pix":"#/components/schemas/PaymentNewDto","promptpay":"#/components/schemas/PaymentNewDto","purchase_order":"#/components/schemas/PaymentPurchaseOrderDto","ratepay":"#/components/schemas/PaymentRatePayDto","riverty":"#/components/schemas/PaymentNewDto","samsung_pay":"#/components/schemas/PaymentNewDto","scalapay":"#/components/schemas/PaymentNewDto","sepa":"#/components/schemas/PaymentNewDto","sofort":"#/components/schemas/PaymentSofortDto","stored_value_solutions":"#/components/schemas/PaymentNewDto","swish":"#/components/schemas/PaymentNewDto","touch_n_go":"#/components/schemas/PaymentNewDto","twint":"#/components/schemas/PaymentNewDto","union_pay":"#/components/schemas/PaymentUnionPayDto","venmo":"#/components/schemas/PaymentNewDto","vipps":"#/components/schemas/PaymentNewDto","wechat":"#/components/schemas/PaymentWeChatDto","wire_transfer":"#/components/schemas/PaymentWireTransferDto","yandex":"#/components/schemas/PaymentYandexDto","zaver":"#/components/schemas/PaymentNewDto","zip":"#/components/schemas/PaymentNewDto"},"propertyName":"paymentMethod"},"properties":{"paymentMethod":{"type":"string"}},"required":["paymentMethod"],"type":"object"},"PaymentGooglePayDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentIdealDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentKlarnaDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentKlarnaInstallmentDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentKlarnaPayLaterDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentNewDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentOtherDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentPayUDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentPaypalDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentPurchaseOrderDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentRatePayDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentSofortDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentTermDto":{"description":"Contains information about the payment term for this document.","properties":{"periodInDays":{"description":"Payment term period in days.","format":"int32","type":"integer"}},"type":"object"},"PaymentUnionPayDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentWeChatDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentWireTransferDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"bankAccount":{"$ref":"#/components/schemas/BankAccountDto"},"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PaymentYandexDto":{"allOf":[{"$ref":"#/components/schemas/PaymentDto"},{"properties":{"paymentMethod":{"type":"string"}},"type":"object"}],"required":["paymentMethod"],"type":"object"},"PerformanceLocationDto":{"description":"Location of the performance of this item.","properties":{"city":{"description":"Name of the location city.\nSize must be between 0 and 255.","example":"de-by","maxLength":255,"type":"string"},"country":{"description":"The country where the product or service was provided. Should be a valid ISO 3166-1 alpha-2 code.\nMust not be null.","example":"DE","type":"string"},"postalCode":{"description":"Postal code of the location.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"region":{"description":"The region where the product or service was provided.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"state":{"description":"State of the location.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"street":{"description":"Name of the location street, including house number.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["country"],"type":"object"},"PropertyDto":{"description":"Additional agreed deposit properties.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"ShipmentEmailDto":{"deprecated":true,"description":"DEPRECATED: This Field is deprecated and end of live. Please use field preferredDocumentDelivery as replacement.","nullable":true,"properties":{"alternateEmail":{"deprecated":true,"description":"DEPRECATED: This Field is deprecated and end of live. Please use field preferredDocumentDelivery as replacement.","nullable":true,"type":"string"},"shipmentMethod":{"deprecated":true,"description":"DEPRECATED: This Field is deprecated and end of live. Please use field preferredDocumentDelivery as replacement.","nullable":true,"type":"string"}},"type":"object"},"StatisticsResponse":{"properties":{"groupedBy":{"description":"The group by value of the statistic","nullable":true,"type":"object"},"value":{"description":"The value of the statistic","nullable":true,"type":"object"}},"type":"object"},"TaxLocationDto":{"description":"Location of the taxation of this item.","properties":{"city":{"description":"Name of the location city.\nSize must be between 0 and 255.","example":"de-by","maxLength":255,"type":"string"},"country":{"description":"The country where the document will be taxed. Should be a valid ISO 3166-1 alpha-2 code.\nMust not be null.","example":"DE","type":"string"},"postalCode":{"description":"Postal code of the location.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"region":{"description":"The region where the document will be taxed.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"state":{"description":"State of the location.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"street":{"description":"Name of the location street, including house number.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["country"],"type":"object"},"TenantRegistrationDto":{"description":"Operating site tenant registration details","properties":{"authority":{"description":"Name of the authority where the Tenant is commercially registered.","type":"string"},"registrationNumber":{"description":"Commercial registration number is given authority at headquarter of the company.","type":"string"}},"type":"object"},"TotalSumDto":{"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.","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.","type":"number"},"originalTotalTax":{"description":"Sum of all item line tax amounts without allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.","type":"number"},"totalAmount":{"description":"Sum of all amounts of items.","type":"number"},"totalDepositSum":{"description":"Sum of all deposits. Is always negative.","type":"number"},"totalDocumentAccountDue":{"description":"Sum of all item lines with line allowances and post tax allowances (a.k.a. post tax extras).","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.","type":"number"},"totalGrossSum":{"description":"Sum of all item line net amounts with line allowances (a.k.a. item extras). Uses a sign for DEBIT or CREDIT.\nMust not be null.","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.","type":"number"},"totalPostTaxSum":{"description":"Sum of all post tax allowances (a.k.a. post tax extras). Is always positive.","type":"number"},"totalTaxSum":{"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.","type":"number"}},"required":["totalGrossSum","totalNetSum","totalTaxSum"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-document-management-read":"Scope nbx-document-management-read"},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for accessing Invoices","title":"Data Access API","version":"v2-preview-2.32.0"},"openapi":"3.0.1","paths":{"/v2/invoices/pageable":{"get":{"deprecated":true,"description":"| &#x26A0; <b>This operation has been deprecated and will be removed in the future!</b> &#x26A0;<br>Reason: Endpoint updated and moved to other service.<br>This operation is replaced by <a href='https://docs.instellix.io/reference/querydocuments'>https://docs.instellix.io/reference/querydocuments</a>. |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Deprecated since: 2026-01-28<br><p style='color:red;font-weight:bold'>Sunset at the latest: 2027-01-28</p>                                                                                                                                                                                                   |\n| Please refer to our \"API Lifecycle Management\" and our \"API Migration Guide\" to find out more.                                                                                                                                                                                                               |\nGet a list of all invoices. To reduce the result set, please use the RSQL query. Returns a pageable list with 100 items per page as default. Invoices are sorted in descending order by invoiceId. This can be changed with the optional direction and orderBy parameters.","operationId":"getAllInvoicesPageable","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Page number that shall be shown.","in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"description":"Entries per page.\nMust be less than or equal to 100.","in":"query","name":"pageSize","schema":{"default":100,"format":"int32","maximum":100,"type":"integer"}},{"description":"By which property shall the entries be ordered.","in":"query","name":"orderBy","schema":{"default":"invoiceId","type":"string"}},{"description":"Direction of ordering ASC or DESC.","in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseInvoiceDto"}}},"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-document-management-read"]}],"summary":"Query invoices","tags":["Invoices"]}},"/v2/invoices/{invoiceIdent}":{"get":{"deprecated":true,"description":"| &#x26A0; <b>This operation has been deprecated and will be removed in the future!</b> &#x26A0;<br>Reason: Endpoint updated and moved to other service.<br>This operation is replaced by <a href='https://docs.instellix.io/reference/getdocument'>https://docs.instellix.io/reference/getdocument</a>. |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Deprecated since: 2026-01-28<br><p style='color:red;font-weight:bold'>Sunset at the latest: 2027-01-28</p>                                                                                                                                                                                             |\n| Please refer to our \"API Lifecycle Management\" and our \"API Migration Guide\" to find out more.                                                                                                                                                                                                         |\nGet an invoice by it's ident.","operationId":"getDocumentByIdent","parameters":[{"in":"path","name":"invoiceIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDto"}}},"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-document-management-read"]}],"summary":"Retrieve invoice","tags":["Invoices"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}