{"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":{"AdditionalPriceTaxCalculationRequestDto":{"description":"Additional price for the tax calculation.","properties":{"ident":{"description":"Ident of the additional price.","type":"string"},"price":{"description":"The price value for tax calculation.","type":"number"}},"required":["ident","price"],"type":"object"},"AdditionalPriceTaxCalculationResponseDto":{"description":"Result of additional price tax calculation.","properties":{"ident":{"description":"Ident of the additional price.","type":"string"},"price":{"$ref":"#/components/schemas/PriceDto"},"taxInformation":{"items":{"$ref":"#/components/schemas/AdditionalPriceTaxInformationDto"},"type":"array"}},"required":["ident","price","taxInformation"],"type":"object"},"AdditionalPriceTaxInformationDto":{"description":"Tax information for additional price.","properties":{"jurisdiction":{"allOf":[{"$ref":"#/components/schemas/JurisdictionDto"}],"nullable":true,"type":"object"},"tax":{"description":"The tax amount.","type":"number"},"taxCode":{"description":"The tax code.","nullable":true,"type":"string"},"taxName":{"description":"The tax name.","nullable":true,"type":"string"},"taxRate":{"description":"The tax rate.","type":"number"},"taxType":{"description":"The tax type.","nullable":true,"type":"string"}},"required":["tax","taxRate"],"type":"object"},"AddressDto":{"description":"Address details.","properties":{"city":{"description":"The city.","nullable":true,"type":"string"},"countryCode":{"description":"Two or three digit country code.\nMust not be null.","example":"US","type":"string"},"postalCode":{"description":"The postal code.\nSize must be between 0 and 16.","maxLength":16,"nullable":true,"type":"string"},"state":{"description":"State.","example":"California","nullable":true,"type":"string"},"stateCode":{"description":"Code of the state.","example":"CA","nullable":true,"type":"string"},"street":{"description":"The street.","nullable":true,"type":"string"},"streetNumber":{"description":"The street number.","nullable":true,"type":"string"},"vatId":{"deprecated":true,"description":"DEPRECATED.\nThe tax identification number. Must be between 0 and 20 characters/elements.","example":"DE1234567890","nullable":true,"type":"string"}},"required":["countryCode"],"type":"object"},"AvalaraClientLoggingEntryDto":{"description":"Avalara client logging 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).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"ident":{"description":"Ident of the client log entry.","type":"string"},"method":{"description":"Method associated with this log entry.","type":"string"},"referenceCode":{"description":"Reference code of Avalara transaction.","nullable":true,"type":"string"},"referenceIdent":{"description":"Reference ident of the client log entry.","nullable":true,"type":"string"},"request":{"description":"Request sent to Avalara AvaTax","type":"string"},"response":{"description":"Response received by Avalara AvaTax or in case of an error, the error message.","type":"string"},"taxProviderProperties":{"description":"Avalara tax provider properties when the avalara request was sent.","type":"string"}},"required":["createdAt","ident","method","referenceCode","referenceIdent","request","response","taxProviderProperties"],"type":"object"},"AvalaraCompanyDto":{"description":"Reduced set of company data from Avalara","properties":{"companyCode":{"description":"A unique code that references this company within your account.","nullable":true,"type":"string"},"isActive":{"description":"This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions.","nullable":true,"type":"boolean"},"isDefault":{"description":"This flag is true if this company is the default company for this account. Only one company may be set as the default.","nullable":true,"type":"boolean"},"name":{"description":"The name of this company, as shown to customers.","nullable":true,"type":"string"}},"required":["companyCode","isActive","isDefault","name"],"type":"object"},"AvalaraTaxProviderProperties":{"allOf":[{"$ref":"#/components/schemas/TaxProviderProperties"},{"properties":{"avaTaxCalculation":{"description":"Flag to enable the avaTax tax calculation.\nMust not be null.","example":false,"type":"boolean"},"clientSideLogging":{"description":"Flag to enable the communication logging between NBX and Avalara.\nMust not be null.","example":false,"type":"boolean"},"companyCode":{"description":"Used company code used in Avalara. The company must be configured in Avalara.\nMust not be null.","example":"DEFAULT","type":"string"},"documentRecording":{"description":"Flag to enable the document recording.\nMust not be null.","example":false,"type":"boolean"},"sandboxMode":{"description":"Flag to enable the sandbox mode for Avalara.\nMust not be null.","example":false,"type":"boolean"}},"type":"object"}],"description":"Avalara tax provider properties. The taxProviderType is always set to 'AVALARA'","required":["avaTaxCalculation","clientSideLogging","companyCode","documentRecording","sandboxMode"],"type":"object"},"BillingGroupConfiguration":{"description":"Tax service configurations for a billing group.","properties":{"currencyConfigurations":{"default":[],"description":"List of configured currencies with deviations from the ISO standard.","items":{"$ref":"#/components/schemas/CurrencyConfigurationDto"},"readOnly":true,"type":"array"},"vatIdCheckEnabled":{"default":false,"description":"The VAT ID check is enabled or disabled.","type":"boolean"}},"required":["vatIdCheckEnabled"],"type":"object"},"CreateOrUpdateTaxClassificationRequest":{"description":"Create or update tax classification request","properties":{"code":{"description":"Tax classification code.\nMust not be blank.","minLength":1,"type":"string"},"name":{"description":"Tax classification name.\nMust not be blank.","minLength":1,"type":"string"}},"required":["code","name"],"type":"object"},"CreateTaxExemptionRequest":{"description":"Create tax exemption request.","properties":{"description":{"description":"Tax exemption description.","nullable":true,"type":"string"},"ident":{"description":"Tax exemption unique identifier.\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"},"invoiceCountry":{"description":"Tax exemption invoice country.\n\nMust be a valid alpha-2 ('DE') code.\nMust not be null.","example":"DE","type":"string"},"taxCategoryCode":{"description":"Tax exemption tax category code.\nMust not be blank.","minLength":1,"type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code.\nMust not be blank.","minLength":1,"type":"string"},"taxExemptionReasonText":{"description":"Tax exemption reason text.","nullable":true,"type":"string"}},"required":["ident","invoiceCountry","taxCategoryCode","taxExemptionReasonCode"],"type":"object"},"CreateTaxProviderConfigDto":{"description":"Create a tax provider assignment to a country.","properties":{"billingGroupIdent":{"description":"Billing group ident for detailed filtering to select a tax provider.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Country code, must be a valid alpha-2 ('DE') code.\nMust not be null.","example":"DE","type":"string"},"taxProvider":{"description":"Tax provider for a country assignment.\nMust not be null.\nMust be one of:\n|                 |\n| --------------- |\n| AVALARA         |\n| FINANCE_ENABLER |\n| NITROBOX        |","example":"NITROBOX","type":"string"}},"required":["country","taxProvider"],"type":"object"},"CredentialsDto":{"properties":{"password":{"description":"Must not be blank.","minLength":1,"type":"string"},"taxProviderType":{"description":"Must not be null.","enum":["AVALARA","FINANCE_ENABLER"],"type":"string"},"username":{"description":"Must not be blank.","minLength":1,"type":"string"}},"required":["password","taxProviderType","username"],"type":"object"},"CurrencyConfigurationDto":{"properties":{"currency":{"description":"Currency code.","type":"string"},"minorUnits":{"description":"Currency minor units.","format":"int32","nullable":true,"type":"integer"}},"required":["currency"],"type":"object"},"CustomerInformationDto":{"description":"Customer details.","properties":{"ident":{"description":"Unique identifier for the customer.\nMust not be null.","nullable":true,"type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/AddressDto"},"shippingAddress":{"allOf":[{"$ref":"#/components/schemas/AddressDto"}],"nullable":true,"type":"object"},"taxClassifications":{"default":[],"description":"List of tax classifications.\nSize must be between 0 and 1.","items":{"$ref":"#/components/schemas/TaxClassificationDto"},"maxItems":1,"type":"array"},"type":{"description":"Correct customer type.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| B2B        |\n| B2C        |\n| AFFILIATED |\n| OTHER      |","example":"B2C","nullable":true,"type":"string"},"vatId":{"description":"VAT identification number","nullable":true,"type":"string"}},"required":["invoiceAddress"],"type":"object"},"DocumentItemTaxDetailDto":{"properties":{"taxInformation":{"default":[],"description":"List of tax information for this line item.","items":{"$ref":"#/components/schemas/DocumentItemTaxInformationDto"},"type":"array"},"taxProviderName":{"description":"Name of the tax provider.\nMust not be blank.","minLength":1,"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`.\nMust not be null.","type":"number"}},"required":["taxProviderName","taxRate"],"type":"object"},"DocumentItemTaxInformationDto":{"description":"Tax information for this line item.","properties":{"jurisdiction":{"allOf":[{"$ref":"#/components/schemas/Jurisdiction"}],"nullable":true,"type":"object"},"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"},"taxCategoryCode":{"description":"Tax category code, usually from [UNCL5305](https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5305.htm).","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/).","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","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.","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.","type":"number"}},"required":["originalRowTotalTax","rowTotalTax","taxRate","unitPriceTax"],"type":"object"},"DocumentTaxCalculationClaimDto":{"properties":{"billingGroupIdent":{"description":"Billing group ident to control billing group specific configurations.\nMust not be blank.","minLength":1,"type":"string"},"customer":{"$ref":"#/components/schemas/CustomerInformationDto"},"documentDateTime":{"description":"The date of the document. Mandatory for Avalara if not a forecast.","format":"date-time","nullable":true,"type":"string"},"forecast":{"default":false,"description":"Tax calculation forecast.","type":"boolean"},"items":{"description":"List of line items of the document. Must not be empty.\nMust not be empty.","items":{"$ref":"#/components/schemas/LineItemCalculationClaimDto"},"minItems":1,"type":"array"},"properties":{"default":[],"description":"Document properties.","items":{"$ref":"#/components/schemas/PropertyDto"},"nullable":true,"type":"array"},"referencedDocumentNumber":{"description":"Reference document number for credit notes.","nullable":true,"type":"string"},"requestId":{"description":"If forecast leave null. If not forecast mandatory.","nullable":true,"type":"string"},"type":{"description":"Type of the document.\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| UNKNOWN                         |","nullable":true,"type":"string"},"vatIdValidationResult":{"allOf":[{"$ref":"#/components/schemas/DocumentVatIdValidationResultDto"}],"nullable":true,"type":"object"}},"required":["billingGroupIdent","customer","items"],"type":"object"},"DocumentTaxCalculationResultDto":{"properties":{"id":{"deprecated":true,"description":"DEPRECATED","format":"int64","nullable":true,"type":"integer"},"lineItems":{"items":{"$ref":"#/components/schemas/LineItemCalculationResultDto"},"type":"array"},"originalTotalAmount":{"allOf":[{"$ref":"#/components/schemas/PriceDto"}],"nullable":true,"type":"object"},"taxProviderType":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"string"},"totalAmount":{"allOf":[{"$ref":"#/components/schemas/PriceDto"}],"nullable":true,"type":"object"},"totalTaxSummary":{"deprecated":true,"description":"DEPRECATED","items":{"$ref":"#/components/schemas/SingleTaxResultDto"},"nullable":true,"type":"array"},"transactionCode":{"nullable":true,"type":"string"},"vatIdValidationResult":{"allOf":[{"$ref":"#/components/schemas/DocumentVatIdValidationResultDto"}],"nullable":true,"type":"object"}},"required":["lineItems","transactionCode"],"type":"object"},"DocumentVatIdValidationResultDto":{"description":"Result of the VAT ID validation for this customer. If it is used in a request, it overwrites any VAT ID validation.","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.","format":"date-time","type":"string"},"validationProvider":{"description":"Validation provider 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"},"EntityUseCodeDto":{"description":"Avalara entity use code","properties":{"code":{"description":"Entity use code.\nMust not be blank.","minLength":1,"type":"string"},"name":{"description":"Entity use code name.\nMust not be blank.","minLength":1,"type":"string"}},"required":["code","name"],"type":"object"},"FinanceEnablerTaxProviderProperties":{"allOf":[{"$ref":"#/components/schemas/TaxProviderProperties"},{"properties":{"sendItemsWithClientProvidedTax":{"description":"Flag to send Items with client provided taxes as well to FinanceEnabler.","type":"boolean"}},"type":"object"}],"description":"Finance Enabler tax provider properties. The taxProviderType is always set to 'FINANCE_ENABLER'","required":["sendItemsWithClientProvidedTax"],"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"},"ItemExtraCalculationClaimDto":{"properties":{"description":{"nullable":true,"type":"string"},"ident":{"description":"Must not be null.","type":"string"},"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":1.9,"type":"number"},"taxInformation":{"default":[],"description":"List of tax information for this item extra.","items":{"$ref":"#/components/schemas/ItemExtraTaxInformationDto"},"type":"array"},"taxRate":{"description":"Tax rate.\nMust not be null.","example":19,"type":"number"},"type":{"description":"Type of the item extra.\nMust not be null.\nMust be one of:\n|                        |\n| ---------------------- |\n| VOUCHER                |\n| DISCOUNT               |\n| SINGLE_PURPOSE_VOUCHER |","type":"string"},"value":{"description":"Value of discount.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":20,"type":"number"}},"required":["ident","tax","taxRate","type","value"],"type":"object"},"ItemExtraCalculationResultDto":{"properties":{"ident":{"type":"string"},"taxInformation":{"default":[],"description":"Taxes that appear in the `taxInformation` collection are intended to be displayed to the customer and charged as a 'tax' on the invoice.","items":{"$ref":"#/components/schemas/ItemExtraTaxInformationDto"},"type":"array"},"taxRate":{"type":"number"},"value":{"$ref":"#/components/schemas/PriceDto"}},"required":["ident","taxRate","value"],"type":"object"},"ItemExtraTaxInformationDto":{"properties":{"jurisdiction":{"allOf":[{"$ref":"#/components/schemas/JurisdictionDto"}],"description":"Tax jurisdiction","nullable":true,"type":"object"},"tax":{"description":"Tax amount.\nMust not be null.","type":"number"},"taxCode":{"description":"Tax code","nullable":true,"type":"string"},"taxName":{"description":"Tax name","type":"string"},"taxRate":{"description":"Tax rate.\nMust not be null.","type":"number"},"taxType":{"description":"Tax type","nullable":true,"type":"string"}},"required":["tax","taxName","taxRate"],"type":"object"},"JsonNode":{"type":"object"},"Jurisdiction":{"description":"Jurisdiction in charge of the Tax","properties":{"code":{"description":"Jurisdiction code.","nullable":true,"type":"string"},"name":{"description":"Jurisdiction name.","nullable":true,"type":"string"},"type":{"description":"Jurisdiction type.","nullable":true,"type":"string"}},"type":"object"},"JurisdictionDto":{"description":"The tax jurisdiction.","properties":{"code":{"description":"Jurisdiction code.","type":"string"},"name":{"description":"Jurisdiction name.","type":"string"},"type":{"description":"Jurisdiction type.","type":"string"}},"required":["code","name","type"],"type":"object"},"LineItemCalculationClaimDto":{"properties":{"extras":{"default":[],"items":{"$ref":"#/components/schemas/ItemExtraCalculationClaimDto"},"type":"array"},"ident":{"description":"Optional identifier of the item.\nMust not be blank.","example":"1234","nullable":true,"type":"string"},"operatingSite":{"allOf":[{"$ref":"#/components/schemas/OperatingSiteDto"}],"nullable":true,"type":"object"},"performanceLocation":{"$ref":"#/components/schemas/LocationDto"},"productInformation":{"$ref":"#/components/schemas/ProductInformationDto"},"taxDate":{"description":"Datetime of taxation.\nMust not be null.","format":"date-time","type":"string"},"taxDetail":{"allOf":[{"$ref":"#/components/schemas/DocumentItemTaxDetailDto"}],"nullable":true,"type":"object"},"taxExemption":{"allOf":[{"$ref":"#/components/schemas/TaxExemptionDto"}],"nullable":true,"type":"object"},"taxInformationSource":{"description":"Tax information source.","nullable":true,"type":"string"},"taxLocation":{"$ref":"#/components/schemas/LocationDto"}},"required":["performanceLocation","productInformation","taxDate","taxLocation"],"type":"object"},"LineItemCalculationResultDto":{"description":"Tax calculation result for a line item.","properties":{"additionalPrices":{"default":[],"description":"List of additional prices for a tax calculation.","items":{"$ref":"#/components/schemas/AdditionalPriceTaxCalculationResponseDto"},"type":"array"},"currency":{"description":"The currency. Must be one of:","example":"EUR","type":"string"},"extras":{"default":[],"description":"Line item list of item extras.\nMust not be null.","items":{"$ref":"#/components/schemas/ItemExtraCalculationResultDto"},"type":"array"},"ident":{"description":"Unique identifier for the line item.","type":"string"},"operatingSite":{"allOf":[{"$ref":"#/components/schemas/TaxCalculationOperatingSiteResponse"}],"nullable":true,"type":"object"},"originalRowTotal":{"$ref":"#/components/schemas/PriceDto"},"properties":{"default":[],"description":"Line item properties.","items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"rowTotal":{"$ref":"#/components/schemas/PriceDto"},"taxInformation":{"description":"Line item list of tax information.","items":{"$ref":"#/components/schemas/TaxInformationDto"},"type":"array"},"taxLocation":{"$ref":"#/components/schemas/LocationDto"},"taxProviderProductCode":{"description":"Line item product code.","nullable":true,"type":"string"},"taxProviderType":{"description":"Tax provider type.","type":"string"},"taxRate":{"description":"Cumulated tax rate of all taxes in taxDetails.","type":"number"},"unitPrice":{"$ref":"#/components/schemas/PriceDto"}},"required":["currency","ident","operatingSite","originalRowTotal","properties","rowTotal","taxInformation","taxLocation","taxProviderType","taxRate","unitPrice"],"type":"object"},"LocationDto":{"description":"Location details.","properties":{"city":{"description":"Name of the location city.","example":"de-by","nullable":true,"type":"string"},"country":{"description":"Two or three digit country code.\nMust not be null.","example":"DE","type":"string"},"postalCode":{"description":"Postal code of the location.","nullable":true,"type":"string"},"region":{"description":"Country region.","example":"de-by","nullable":true,"type":"string"},"state":{"description":"State of the location.","nullable":true,"type":"string"},"street":{"description":"Name of the location street, including house number.","nullable":true,"type":"string"}},"required":["country"],"type":"object"},"OperatingSiteDto":{"description":"Operating site.","properties":{"address":{"allOf":[{"$ref":"#/components/schemas/AddressDto"}],"nullable":true,"type":"object"},"ident":{"description":"Operating site ident.\nMust not be blank.","nullable":true,"type":"string"}},"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"},"PagedResponseAvalaraClientLoggingEntryDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AvalaraClientLoggingEntryDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseAvalaraCompanyDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AvalaraCompanyDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseEntityUseCodeDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/EntityUseCodeDto"},"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"},"PagedResponseTaxCodeDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/TaxCodeDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseTaxExemptionDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/TaxExemptionDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseTaxProviderConfigDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/TaxProviderConfigDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseTaxRuleDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/TaxRuleDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseTenantTaxProviderDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/TenantTaxProviderDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PriceDto":{"description":"Structure containing the result of the tax calculation. All numbers are rounded to a scale of 4 with bankers' rounding.","properties":{"gross":{"description":"Calculated gross for the price of one unit of an item.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":4,"type":"number"},"net":{"description":"Calculated net for the total of all quantities of one item after discounts.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":12.8,"type":"number"},"tax":{"description":"Calculated tax for the total of all quantities of one item before discounts.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":16,"type":"number"}},"required":["gross","net","tax"],"type":"object"},"Prices":{"description":"Group of unit price, row total and original row total.","properties":{"netGrossIndicator":{"default":"NET","description":"Indicator to define type of price. Defaults to NET if not provided.\nMust not be null.\nMust be one of:\n|       |\n| ----- |\n| NET   |\n| GROSS |","type":"string"},"originalRowTotal":{"description":"Total of all quantities of one item before discounts.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":100,"type":"number"},"rowTotal":{"description":"Total of all quantities of one item after discounts.\nMust not be null.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":80,"type":"number"},"unitPrice":{"description":"Price of one unit of an item.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":25,"nullable":true,"type":"number"}},"required":["originalRowTotal","rowTotal"],"type":"object"},"ProductInformationDto":{"description":"Product information.","properties":{"additionalPrices":{"items":{"$ref":"#/components/schemas/AdditionalPriceTaxCalculationRequestDto"},"nullable":true,"type":"array"},"articleNumber":{"description":"Article number.","nullable":true,"type":"string"},"avalaraProductTaxCode":{"deprecated":true,"description":"DEPRECATED.\nThe Avalara product tax code.","nullable":true,"type":"string"},"category":{"description":"Line item type.\nMust not be blank.","minLength":1,"type":"string"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","type":"string"},"customProductTaxCode":{"deprecated":true,"description":"DEPRECATED.\nThe code for the product used by the tax provider.","nullable":true,"type":"string"},"description":{"description":"Description of the product.","nullable":true,"type":"string"},"grossPrices":{"allOf":[{"$ref":"#/components/schemas/Prices"}],"nullable":true,"type":"object"},"netPrices":{"allOf":[{"$ref":"#/components/schemas/Prices"}],"nullable":true,"type":"object"},"prices":{"$ref":"#/components/schemas/Prices"},"quantity":{"description":"Quantity of items.\nMust be greater than 0.","nullable":true,"type":"number"},"taxProviderProductCodes":{"default":[],"description":"Product tax codes for the respective provider.","items":{"$ref":"#/components/schemas/TaxProviderValueDto"},"type":"array"}},"required":["category","currency","prices"],"type":"object"},"PropertyDto":{"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"},"SingleTaxResultDto":{"properties":{"jurisdiction":{"allOf":[{"$ref":"#/components/schemas/JurisdictionDto"}],"description":"Jurisdiction of the tax","nullable":true,"type":"object"},"originalTotalTax":{"description":"Sum of all taxes  for a line item before applying reductions","type":"number"},"rowTotalTax":{"description":"Sum of all taxes for a line item","type":"number"},"taxCode":{"description":"Tax code","type":"string"},"taxName":{"description":"Name of the tax","type":"string"},"taxRate":{"description":"Tax rate","type":"number"},"taxType":{"description":"Type of the tax","type":"string"}},"required":["originalTotalTax","rowTotalTax","taxCode","taxName","taxRate","taxType"],"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"},"TaxCalculationOperatingSiteResponse":{"description":"The operating site is the result of the tax calculation.","properties":{"ident":{"description":"Operating site ident","type":"string"}},"required":["ident"],"type":"object"},"TaxClassificationDto":{"description":"Tax classification query model","properties":{"code":{"description":"Tax classification code","example":"A","type":"string"},"name":{"description":"Tax classification name","example":"Federal Government","nullable":true,"type":"string"}},"required":["code","name"],"type":"object"},"TaxCodeDto":{"description":"Avalara tax code","properties":{"description":{"description":"Tax code description.\nMust not be blank.","minLength":1,"type":"string"},"taxCode":{"description":"Tax code.\nMust not be blank.","minLength":1,"type":"string"}},"required":["description","taxCode"],"type":"object"},"TaxExemptionDto":{"description":"Tax exemption.","properties":{"description":{"description":"Tax exemption description.","nullable":true,"type":"string"},"ident":{"description":"Tax exemption unique identifier.","type":"string"},"invoiceCountry":{"description":"Tax exemption invoice country.\n\nMust be a valid alpha-2 ('DE') code.","example":"DE","type":"string"},"taxCategoryCode":{"description":"Tax exemption tax category code.","type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code.","type":"string"},"taxExemptionReasonText":{"description":"Tax exemption reason text.","nullable":true,"type":"string"}},"required":["ident","invoiceCountry","taxCategoryCode","taxExemptionReasonCode"],"type":"object"},"TaxInformationDto":{"properties":{"jurisdiction":{"allOf":[{"$ref":"#/components/schemas/JurisdictionDto"}],"description":"The jurisdiction.","nullable":true,"type":"object"},"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"},"taxCategoryCode":{"description":"The tax exemption tax category code.","nullable":true,"type":"string"},"taxCode":{"description":"The tax code.","nullable":true,"type":"string"},"taxExemptionReasonCode":{"description":"The tax exemption reason code.","nullable":true,"type":"string"},"taxExemptionReasonText":{"description":"The tax exemption reason text.","nullable":true,"type":"string"},"taxName":{"description":"The tax name.","nullable":true,"type":"string"},"taxRate":{"description":"The tax rate.","type":"number"},"taxRuleIdent":{"description":"The used tax rule ident of the ISX tax provider to calculate this tax.","nullable":true,"type":"string"},"taxType":{"description":"The tax type.","nullable":true,"type":"string"},"unitPriceTax":{"description":"The unit tax amount without item extras for this tax.","type":"number"}},"required":["originalRowTotalTax","rowTotalTax","taxRate","unitPriceTax"],"type":"object"},"TaxProviderConfigDto":{"description":"Tax provider assignment to a country.","properties":{"billingGroupIdent":{"description":"Billing group ident for detailed filtering to select a tax provider.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"country":{"description":"Country code, must be a valid alpha-2 ('DE') code.","example":"DE","type":"string"},"taxProvider":{"description":"Tax provider for a country assignment.\nMust be one of:\n|                 |\n| --------------- |\n| AVALARA         |\n| FINANCE_ENABLER |\n| NITROBOX        |","example":"NITROBOX","type":"string"}},"required":["country","taxProvider"],"type":"object"},"TaxProviderProperties":{"discriminator":{"mapping":{"AVALARA":"#/components/schemas/AvalaraTaxProviderProperties","FINANCE_ENABLER":"#/components/schemas/FinanceEnablerTaxProviderProperties"},"propertyName":"taxProviderType"},"properties":{"taxProviderType":{"type":"string"}},"required":["taxProviderType"],"type":"object"},"TaxProviderValueDto":{"properties":{"provider":{"description":"Tax provider.\nMust not be null.\nMust be one of:\n|         |\n| ------- |\n| CUSTOM  |\n| AVALARA |","type":"string"},"value":{"description":"Product tax code.\nMust not be blank.","minLength":1,"type":"string"}},"required":["provider","value"],"type":"object"},"TaxRuleDto":{"description":"A tax rule for a country, containing different filter values.","properties":{"applicableCustomerTypes":{"default":[],"description":"Set of customer types for which rule applies. If nothing is specified, the rule will be apply to all options. Currently the following are supported: 'AFFILIATED', 'B2B', 'B2C', and 'OTHER'.","example":"B2C","items":{"type":"string"},"type":"array","uniqueItems":true},"applicableInvoiceAddressCountries":{"default":[],"description":"Set of countries the invoice address to which the rule should apply.","items":{"description":"Country code must be a valid alpha-2 ('DE') code.","example":"DE","type":"string"},"type":"array","uniqueItems":true},"applicablePurchaseItemTypes":{"default":[],"description":"Set of purchase item types for which rule applies. If nothing is specified, the rule will be apply to all options.\nCurrently the following are supported: 'DIGITAL_PRODUCT', 'DIGITAL_PRODUCT_RENTAL', 'ELECTRICITY', 'ELECTRICITY_RESALE',\n'LABOR_COST', 'LOGISTIC_COST', 'PHYSICAL_PRODUCT', 'PHYSICAL_PRODUCT_RENTAL', 'SERVICE', 'VOUCHER'.\n","example":"DIGITAL_PRODUCT","items":{"type":"string"},"type":"array","uniqueItems":true},"applicableRegions":{"default":[],"description":"Set of regions for which rule applies. If nothing is specified, the rule will be apply to all options.","example":"de-by","items":{"type":"string"},"type":"array","uniqueItems":true},"applicableTaxClassifications":{"default":[],"description":"This is the set of tax classification codes to which the rule applies. If nothing is specified, the rule will be apply to all options.","items":{"description":"Tax classification code","type":"string"},"type":"array","uniqueItems":true},"considerOperatingSiteCountry":{"description":"Country of the operating site to which the rule should apply. Must be a valid alpha-2 ('DE') code. If it is set to null, then all countries will be applied.","example":"DE","nullable":true,"type":"string"},"considerVatId":{"description":"Include/Exclude customers having a VAT ID for this rule. true=customer must have a VAT ID, false=customer must not have a VAT ID, null=customer can have or not have a VAT ID.","example":true,"nullable":true,"type":"boolean"},"country":{"description":"Must be the country for which rule should be applied. Must be a valid alpha-2 ('DE') code.\nMust not be null.","example":"DE","type":"string"},"taxRuleIdent":{"description":"Must be the unique identifier for tax rule.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"de-vat-19","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"taxRuleVariants":{"default":[],"description":"Set of variants for this tax rule. If no taxRuleVariant is given, the taxRule won't be applied.","items":{"$ref":"#/components/schemas/TaxRuleVariantDto"},"type":"array","uniqueItems":true}},"required":["country","taxRuleIdent"],"type":"object"},"TaxRuleUpdateRequest":{"properties":{"applicableCustomerTypes":{"default":[],"description":"Set of customer types for which rule applies. If nothing is specified, the rule will be apply to all options. Currently the following are supported: 'AFFILIATED', 'B2B', 'B2C', and 'OTHER'.","items":{"example":"B2C","type":"string"},"type":"array","uniqueItems":true},"applicableInvoiceAddressCountries":{"default":[],"description":"Set of countries the invoice address to which the rule should apply.","items":{"description":"Country code must be a valid alpha-2 ('DE') code.","example":"DE","type":"string"},"type":"array","uniqueItems":true},"applicablePurchaseItemTypes":{"default":[],"description":"Set of purchase item types for which rule applies. If nothing is specified, the rule will be apply to all options.\nCurrently the following are supported: 'DIGITAL_PRODUCT', 'DIGITAL_PRODUCT_RENTAL', 'ELECTRICITY', 'ELECTRICITY_RESALE',\n'LABOR_COST', 'LOGISTIC_COST', 'PHYSICAL_PRODUCT', 'PHYSICAL_PRODUCT_RENTAL', 'SERVICE', 'VOUCHER'.\n","items":{"example":"DIGITAL_PRODUCT","type":"string"},"type":"array","uniqueItems":true},"applicableRegions":{"default":[],"description":"Set of regions for which rule applies. If nothing is specified, the rule will be apply to all options.","items":{"example":"de-by","type":"string"},"type":"array","uniqueItems":true},"applicableTaxClassifications":{"default":[],"description":"This is the set of tax classification codes to which the rule applies. If nothing is specified, the rule will be apply to all options.","items":{"description":"Tax classification code","type":"string"},"type":"array","uniqueItems":true},"considerOperatingSiteCountry":{"description":"Country of the operating site to which the rule should apply. Must be a valid alpha-2 ('DE') code. If it is set to null, then all countries will be applied.","example":"DE","nullable":true,"type":"string"},"considerVatId":{"description":"Include/Exclude customers having a VAT ID for this rule. true=customer must have a VAT ID, false=customer must not have a VAT ID, null=customer can have or not have a VAT ID.","example":true,"nullable":true,"type":"boolean"},"country":{"description":"Must be the country for which rule should be applied. Must be a valid alpha-2 ('DE') code.\nMust not be null.","example":"DE","type":"string"},"taxRuleVariants":{"default":[],"deprecated":true,"description":"Tax rule variants can not be updated, when updating the tax rule. Please use the dedicated tax rule variant endpoint.","items":{"$ref":"#/components/schemas/TaxRuleVariantDto"},"type":"array","uniqueItems":true}},"required":["country"],"type":"object"},"TaxRuleVariantCreationRequest":{"description":"A tax rule variant. Each variant of a tax rule has a beginning date, rate, name and code.","properties":{"applicableFrom":{"description":"Date from which rule becomes active e.g., 2020-06-12T12:00:00. It needs to be unique per tax rule, to have a sequence.\nMust not be null.","format":"date-time","type":"string"},"taxCode":{"description":"Code of the tax.\nMust not be blank.","example":"A1","maxLength":255,"minLength":1,"type":"string"},"taxExemptionIdent":{"description":"Ident of the tax exemption assigned to this tax rule variant.\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"},"taxName":{"description":"Name of the tax.\nMust not be blank.","example":"reduced tax due to corona","maxLength":255,"minLength":1,"type":"string"},"taxRate":{"description":"Tax rate which should be applied with this taxRuleVariant. The Maximum number of fractional digits accepted for this number is 4.\nMust not be null.\nMust be greater than or equal to 0.0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":16,"minimum":0,"type":"number"},"taxRuleVariantIdent":{"description":"Must be the unique identifier for tax rule variant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"de_vat_reduced_to_16","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["applicableFrom","taxCode","taxName","taxRate","taxRuleVariantIdent"],"type":"object"},"TaxRuleVariantDto":{"description":"A tax rule variant. Each variant of a tax rule has a beginning date, rate, name and code.","properties":{"applicableFrom":{"description":"Date from which rule becomes active e.g., 2020-06-12T12:00:00. It needs to be unique per tax rule, to have a sequence.\nMust not be null.","format":"date-time","type":"string"},"taxCode":{"description":"Code of the tax.\nMust not be blank.","example":"A1","maxLength":255,"minLength":1,"type":"string"},"taxExemptionIdent":{"description":"Ident of the tax exemption assigned to this tax rule variant.\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"},"taxName":{"description":"Name of the tax.\nMust not be blank.","example":"reduced tax due to corona","maxLength":255,"minLength":1,"type":"string"},"taxRate":{"description":"Tax rate which should be applied with this taxRuleVariant. The Maximum number of fractional digits accepted for this number is 4.\nMust not be null.\nMust be greater than or equal to 0.0.\nMust be a number with up to 15 integral digits and up to 4 fractional digits.","example":16,"minimum":0,"type":"number"},"taxRuleVariantIdent":{"description":"Must be the unique identifier for tax rule variant.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"de_vat_reduced_to_16","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}},"required":["applicableFrom","taxCode","taxName","taxRate","taxRuleVariantIdent"],"type":"object"},"TenantConfiguration":{"description":"Tax service configurations for a tenant.","properties":{"vatIdCheckEnabled":{"default":false,"description":"The VAT ID check is enabled or disabled for this tenant. Finally, the VAT ID check can be enabled for the desired billing group.","type":"boolean"}},"required":["vatIdCheckEnabled"],"type":"object"},"TenantTaxProviderDto":{"description":"Tax provider configured for tenant.","properties":{"taxProvider":{"description":"Tax provider","type":"string"}},"required":["taxProvider"],"type":"object"},"UpdateTaxExemptionRequest":{"description":"Update tax exemption request.","properties":{"description":{"description":"Tax exemption description.","nullable":true,"type":"string"},"invoiceCountry":{"description":"Tax exemption invoice country.\n\nMust be a valid alpha-2 ('DE') code.\nMust not be null.","example":"DE","type":"string"},"taxCategoryCode":{"description":"Tax exemption tax category code.\nMust not be blank.","minLength":1,"type":"string"},"taxExemptionReasonCode":{"description":"Tax exemption reason code.\nMust not be blank.","minLength":1,"type":"string"},"taxExemptionReasonText":{"description":"Tax exemption reason text.","nullable":true,"type":"string"}},"required":["invoiceCountry","taxCategoryCode","taxExemptionReasonCode"],"type":"object"},"VatIdValidationResultDto":{"description":"Result of the VAT ID validation.","properties":{"content":{"description":"This is the raw HTTP request and response for the external call to check the VAT ID.","type":"string"},"error":{"description":"Error message if validation failed.","nullable":true,"type":"string"},"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"},"tenantId":{"description":"Tenant ID","format":"int64","type":"integer"},"validatedAt":{"description":"Must not be null.","format":"date-time","type":"string"},"validationProvider":{"description":"Must not be null.","enum":["VIES","NONE"],"type":"string"},"vatId":{"description":"Validated VAT ID","type":"string"}},"required":["content","error","ident","status","tenantId","validatedAt","validationProvider","vatId"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-accounting-management-read":"Scope nbx-accounting-management-read","nbx-accounting-management-write":"Scope nbx-accounting-management-write","nbx-document-management-read":"Scope nbx-document-management-read","nbx-internal":"Scope nbx-internal","nbx-tenant-management-read":"Scope nbx-tenant-management-read","nbx-tenant-management-write":"Scope nbx-tenant-management-write"},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for Taxes","title":"Tax API","version":"v2-preview-4.4.0"},"openapi":"3.0.1","paths":{"/v2/tax/billing-group-configs/{billingGroupIdent}":{"get":{"operationId":"getTaxServiceBillingGroupConfiguration","parameters":[{"description":"Billing group identifier","in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupConfiguration"}}},"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 the tax service configuration for a billing group.","tags":["Tax Service Billing Group Configuration"]},"post":{"operationId":"createOrUpdateTaxServiceBillingGroupConfiguration","parameters":[{"description":"Billing group identifier","in":"path","name":"billingGroupIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupConfiguration"}}},"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 or update the tax service configuration for a billing group.","tags":["Tax Service Billing Group Configuration"]}},"/v2/tax/calculate/documents":{"post":{"description":"Calculate tax information for a specific document. For more information on tax calculation please see the model below.","operationId":"calculateTax","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTaxCalculationClaimDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTaxCalculationResultDto"}}},"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":"Calculate tax for a document","tags":["Tax Calculation"]}},"/v2/tax/rules":{"get":{"description":"Returns a page of tax rules.","operationId":"queryTaxRules","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"country==US","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).","in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"description":"The size of the page to be returned.","in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"description":"The field name by which the ordering shall happen.","in":"query","name":"orderBy","schema":{"default":"taxRuleIdent","type":"string"}},{"description":"Sorting direction (ASC|DESC).","in":"query","name":"direction","schema":{"default":"ASC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseTaxRuleDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-read"]}],"summary":"Query tax rules","tags":["Tax Rules Configuration"]},"post":{"description":"Creates a new tax rule.","operationId":"createTaxRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-write"]}],"summary":"Create tax rule","tags":["Tax Rules Configuration"]}},"/v2/tax/rules/{taxRuleIdent}":{"get":{"description":"Get existing tax rule by it's ident.","operationId":"getTaxRule","parameters":[{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"taxRuleIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-read"]}],"summary":"Retrieve tax rule","tags":["Tax Rules Configuration"]},"put":{"description":"Updates a tax rule.","operationId":"updateTaxRule","parameters":[{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"taxRuleIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-write"]}],"summary":"Update tax rule","tags":["Tax Rules Configuration"]}},"/v2/tax/rules/{taxRuleIdent}/variants":{"post":{"description":"Creates a new tax rule variant for a existing tax rule.","operationId":"addTaxRuleVariant","parameters":[{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"taxRuleIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleVariantCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-write"]}],"summary":"Add variant to tax rule","tags":["Tax Rules Configuration"]}},"/v2/tax/rules/{taxRuleIdent}/variants/{taxRuleVariantIdent}":{"get":{"description":"Get existing tax rule variant by tax rule variant ident.","operationId":"getTaxRuleVariant","parameters":[{"in":"path","name":"taxRuleIdent","required":true,"schema":{"type":"string"}},{"description":"Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","in":"path","name":"taxRuleVariantIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRuleVariantDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-read"]}],"summary":"Retrieve tax rule variant","tags":["Tax Rules Configuration"]}},"/v2/tax/tax-provider-config":{"get":{"operationId":"getAllTaxProviderConfigurations","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"country==US","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/PagedResponseTaxProviderConfigDto"}}},"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 the tax provider configurations","tags":["Tax Provider Configuration"]},"post":{"operationId":"createTaxProviderConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaxProviderConfigDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxProviderConfigDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Create or update the tax provider configuration for a country","tags":["Tax Provider Configuration"]}},"/v2/tax/tax-provider-config/{country}":{"delete":{"operationId":"deleteTaxProviderConfigurationByCountry","parameters":[{"description":"Country code, must be a valid alpha-2 ('DE') code.","in":"path","name":"country","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 the tax provider configuration for a country","tags":["Tax Provider Configuration"]}},"/v2/tax/tax-provider-config/{country}/{billingGroupIdent}":{"delete":{"operationId":"deleteTaxProviderConfigurationByCountryAndBillingGroupIdent","parameters":[{"description":"Country code, must be a valid alpha-2 ('DE') code.","in":"path","name":"country","required":true,"schema":{"type":"string"}},{"description":"Billing group ident","in":"path","name":"billingGroupIdent","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 the tax provider configuration for a country and billing group","tags":["Tax Provider Configuration"]}},"/v2/tax/tax-provider-credentials":{"get":{"operationId":"getAllTaxProviderCredentials","parameters":[{"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":{"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-read"]}],"summary":"Get usernames of all present tax provider credentials","tags":["Tax Provider Configuration"]},"post":{"operationId":"createTaxProviderCredentials","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialsDto"}}},"required":true},"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":"Create or update tax provider credentials","tags":["Tax Provider Configuration"]}},"/v2/tax/tax-provider-credentials/{taxProvider}":{"delete":{"operationId":"deleteTaxProviderCredentials","parameters":[{"description":"Tax provider type","in":"path","name":"taxProvider","required":true,"schema":{"enum":["AVALARA","FINANCE_ENABLER"],"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 tax provider credentials","tags":["Tax Provider Configuration"]},"get":{"operationId":"getTaxProviderCredentials","parameters":[{"description":"Tax provider type","in":"path","name":"taxProvider","required":true,"schema":{"enum":["AVALARA","FINANCE_ENABLER"],"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-read"]}],"summary":"Get username of tax provider credentials if present","tags":["Tax Provider Configuration"]}},"/v2/tax/tax-provider-properties":{"post":{"operationId":"createTaxProviderProperties","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AvalaraTaxProviderProperties"},{"$ref":"#/components/schemas/FinanceEnablerTaxProviderProperties"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AvalaraTaxProviderProperties"},{"$ref":"#/components/schemas/FinanceEnablerTaxProviderProperties"}]}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Create tax properties for a provider","tags":["Tax Provider Configuration"]},"put":{"operationId":"updateTaxProviderProperties","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AvalaraTaxProviderProperties"},{"$ref":"#/components/schemas/FinanceEnablerTaxProviderProperties"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AvalaraTaxProviderProperties"},{"$ref":"#/components/schemas/FinanceEnablerTaxProviderProperties"}]}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Update tax properties for a provider","tags":["Tax Provider Configuration"]}},"/v2/tax/tax-provider-properties/{taxProviderType}":{"delete":{"operationId":"deleteTaxProviderProperties","parameters":[{"in":"path","name":"taxProviderType","required":true,"schema":{"enum":["AVALARA","FINANCE_ENABLER"],"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 tax properties for a provider","tags":["Tax Provider Configuration"]},"get":{"operationId":"getTaxProviderProperties","parameters":[{"in":"path","name":"taxProviderType","required":true,"schema":{"enum":["AVALARA","FINANCE_ENABLER"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AvalaraTaxProviderProperties"},{"$ref":"#/components/schemas/FinanceEnablerTaxProviderProperties"}]}}},"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 tax properties for a provider","tags":["Tax Provider Configuration"]}},"/v2/tax/tax-providers":{"get":{"operationId":"getTenantEnabledTaxProviders","parameters":[{"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: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseTenantTaxProviderDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Get all enabled tax providers for tenant","tags":["Tax Provider Configuration"]}},"/v2/tax/tenant-configs":{"get":{"operationId":"getTaxServiceTenantConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantConfiguration"}}},"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 the tax service configuration for a tenant.","tags":["Tax Service Tenant Configuration"]},"post":{"operationId":"createOrUpdateTaxServiceTenantConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantConfiguration"}}},"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 or update the tax service configuration for a tenant.","tags":["Tax Service Tenant Configuration"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"endpoints for Tax Calculation","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tax Calculation"},{"description":"endpoints for Tax Rules Configuration","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tax Rules Configuration"},{"description":"endpoints for Tax Provider Configuration","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tax Provider Configuration"},{"description":"endpoints for Tax Service Tenant Configuration","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tax Service Tenant Configuration"},{"description":"endpoints for Tax Service Billing Group Configuration","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tax Service Billing Group Configuration"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}