{"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":{"AvailableMigrationsDto":{"properties":{"migrations":{"description":"List of available migrations.\nMust not be null.","items":{"description":"List of available migrations","type":"string"},"type":"array"}},"required":["migrations"],"type":"object"},"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"},"JsonNode":{},"MigrationParametersRequest":{"properties":{"batchSize":{"description":"Migration type.\nMust not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"delayBetweenBatches":{"description":"Delay between batches.\nMust not be null.","type":"string"},"lockAtLeastFor":{"description":"Lock minimum duration.\nMust not be null.","type":"string"},"lockAtMostFor":{"description":"Lock timeout.\nMust not be null.","type":"string"},"tenantIds":{"description":"Tenant ids to migrate","items":{"description":"Tenant ids to migrate","format":"int64","type":"integer"},"type":"array","uniqueItems":true}},"required":["batchSize","delayBetweenBatches","lockAtLeastFor","lockAtMostFor","tenantIds"],"type":"object"},"MigrationStatusDto":{"properties":{"itemsToMigrate":{"description":"Number of items to migrate.\nMust not be null.","format":"int64","type":"integer"},"itemsToSetup":{"description":"Number of items to setup.\nMust not be null.","format":"int64","type":"integer"}},"required":["itemsToMigrate","itemsToSetup"],"type":"object"},"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"},"PagedResponseAvalara_elr.company.Response":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/avalara_elr.company.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseAvalara_elr.mandate_mapping.QueryResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/avalara_elr.mandate_mapping.QueryResponse"},"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"},"PagedResponseWorkflow.RsqlResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/workflow.RsqlResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"Property":{"properties":{"key":{"description":"Key of the property, unique within a property list.\nMust not be null.\nSize must be between 1 and 2147483647.","maxLength":2147483647,"minLength":1,"type":"string"},"value":{"description":"Value of the property.\nMust not be null.","type":"string"}},"required":["key","value"],"type":"object"},"ShedlockDto":{"properties":{"lockUntil":{"description":"Lock until.\nMust not be null.","format":"date-time","type":"string"},"lockedAt":{"description":"Lock at.\nMust not be null.","format":"date-time","type":"string"},"lockedBy":{"description":"Lock by.\nMust not be blank.","minLength":1,"type":"string"},"name":{"description":"Name of the lock.\nMust not be blank.","minLength":1,"type":"string"}},"required":["lockUntil","lockedAt","lockedBy","name"],"type":"object"},"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"},"avalara_elr.ActiveMandate":{"description":"Active mandate.","properties":{"mandate":{"description":"Name of the mandate.\nMust not be null.","type":"string"}},"required":["mandate"],"type":"object"},"avalara_elr.ActiveMandateCompany":{"description":"Company with active mandates by country.","properties":{"countries":{"default":[],"description":"Countries with active mandates.\nMust not be null.","items":{"$ref":"#/components/schemas/avalara_elr.ActiveMandateCountry"},"type":"array"},"ident":{"description":"Unique ident of the Company.\nMust not be null.","type":"string"},"name":{"description":"Name of the Company.\nMust not be null.","type":"string"}},"required":["countries","ident","name"],"type":"object"},"avalara_elr.ActiveMandateCountry":{"description":"Country with active mandates.","properties":{"country":{"description":"Country code of the mandate.\nMust not be null.","type":"string"},"mandates":{"default":[],"description":"Active mandates.\nMust not be null.","items":{"$ref":"#/components/schemas/avalara_elr.ActiveMandate"},"type":"array"}},"required":["country","mandates"],"type":"object"},"avalara_elr.ActiveMandatesResponse":{"description":"Active mandates in Avalara ELR.","properties":{"companies":{"default":[],"description":"Companies with active mandates by country.\nMust not be null.","items":{"$ref":"#/components/schemas/avalara_elr.ActiveMandateCompany"},"type":"array"}},"required":["companies"],"type":"object"},"avalara_elr.CredentialRequest":{"description":"Avalara ELR credential.","properties":{"clientId":{"description":"ClientId of the Avalara ELR API Key.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"clientSecret":{"description":"ClientSecret of the Avalara ELR API Key.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"environment":{"description":"Environment to use with the Avalara ELR API Key.\nMust not be null.\nMust be one of:\n|            |                                            |\n| ---------- | ------------------------------------------ |\n| SANDBOX    | Use the Avalara ELR sandbox environment    |\n| PRODUCTION | Use the Avalara ELR production environment |","type":"string"}},"required":["clientId","clientSecret","environment"],"type":"object"},"avalara_elr.CredentialResponse":{"description":"Stored Avalara ELR credential. Contains not the clientSecret.","properties":{"clientId":{"description":"ClientId of the Avalara ELR API Key.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"environment":{"description":"Environment to use with the Avalara ELR API Key.\nMust not be null.\nMust be one of:\n|            |                                            |\n| ---------- | ------------------------------------------ |\n| SANDBOX    | Use the Avalara ELR sandbox environment    |\n| PRODUCTION | Use the Avalara ELR production environment |","type":"string"}},"required":["clientId","environment"],"type":"object"},"avalara_elr.FieldNameSpace":{"description":"The namespace of the UBL element","properties":{"prefix":{"description":"The namespace prefix for the UBL Element.\nMust not be null.","example":"cbc","type":"string"},"value":{"description":"Value of the namspace.\nMust not be null.","example":"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2","type":"string"}},"required":["prefix","value"],"type":"object"},"avalara_elr.Mandate":{"description":"Available mandates in Avalara ELR.","properties":{"country":{"description":"country to which this mandate applies.\nMust not be null.","type":"string"},"description":{"description":"mandate description.\nMust not be null.","type":"string"},"ident":{"description":"mandate unique identifier.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["country","description","ident"],"type":"object"},"avalara_elr.MandateInputFields":{"description":"The Data Input Field","properties":{"acceptedValues":{"default":[],"description":"An Array representing the acceptable values for this field.\nMust not be null.","items":{"type":"string"},"type":"array"},"cardinality":{"description":"Represents the number of times an element can appear within the document.\nMust not be null.","example":"1..1","type":"string"},"dataType":{"description":"The data type of this field.\nMust not be null.","example":"object","type":"string"},"description":{"description":"A description of this field.\nMust not be null.","example":"Specification identifier: An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.","type":"string"},"documentationLink":{"description":"An example of the content for this field.\nMust not be null.","example":"https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/cbc-CustomizationID","type":"string"},"exampleOrFixedValue":{"description":"An example of the content for this field.\nMust not be null.","example":"urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0","type":"string"},"fieldId":{"description":"Field ID.\nMust not be null.","example":"1","type":"string"},"fieldName":{"description":"Field name.\nMust not be null.","example":"cbc:CustomizationID","type":"string"},"nameSpace":{"$ref":"#/components/schemas/avalara_elr.FieldNameSpace"},"optionality":{"description":"Determines if the field if Required/Conditional/Optional or not required.\nMust not be null.","example":"Required","type":"string"},"path":{"description":"Path to this field.\nMust not be null.","example":"Invoice/cbc:CustomizationID","type":"string"},"pathType":{"description":"The type of path.\nMust not be null.","example":"xpath","type":"string"},"ublDocumentType":{"description":"The ubl document type.\nMust not be null.","example":"ubl-inovice","type":"string"},"ublDocumentVersion":{"description":"The ubl document version.\nMust not be null.","example":"2.1","type":"string"}},"required":["acceptedValues","cardinality","dataType","description","documentationLink","exampleOrFixedValue","fieldId","fieldName","nameSpace","optionality","path","pathType","ublDocumentType","ublDocumentVersion"],"type":"object"},"avalara_elr.MandateInputFieldsResponse":{"description":"List of Data Input Fields available for this mandate in Avalara ELR.","properties":{"fields":{"default":[],"description":"Available mandates in Avalara ELR.\nMust not be null.","items":{"$ref":"#/components/schemas/avalara_elr.MandateInputFields"},"type":"array"}},"required":["fields"],"type":"object"},"avalara_elr.MandateResponse":{"description":"List of available mandates in Avalara ELR.","properties":{"mandates":{"default":[],"description":"Available mandates in Avalara ELR.\nMust not be null.","items":{"$ref":"#/components/schemas/avalara_elr.Mandate"},"type":"array"}},"required":["mandates"],"type":"object"},"avalara_elr.company.Response":{"description":"Company configured in Avalara","properties":{"code":{"description":"Company code","nullable":true,"type":"string"},"defaultCountry":{"description":"Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"ident":{"description":"Unique identifier.\nMust not be null.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"name":{"description":"Company name.\nMust not be null.","type":"string"}},"required":["code","defaultCountry","ident","name"],"type":"object"},"avalara_elr.jsonata_defaults.Response":{"description":"Jsonata defaults used internally for the mapping form Nitrobox DocumentDto to UBL/JSON","properties":{"defaultJsonataMapping":{"description":"A simple default jsonata mapping. It should match most fields.\nMust not be null.","type":"string"}},"required":["defaultJsonataMapping"],"type":"object"},"avalara_elr.jsonata_utilities.Response":{"description":"Jsonata utilities used internally for the mapping form Nitrobox DocumentDto to UBL/JSON","properties":{"additionalMethods":{"description":"Helper methods for the Jsonata transformation.\nMust not be null.","type":"string"}},"required":["additionalMethods"],"type":"object"},"avalara_elr.mandate_mapping.CreateRequest":{"description":"Request to create an Avalara Mandate Mapping, mapping documents to Avalara&#39;s UBL","properties":{"companyIdent":{"description":"Ident of the company configured in Avalara used by this mapping.\nMust not be null.","type":"string"},"ident":{"description":"Unique identifier of mandate mapping.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"invoiceAddressCountry":{"description":"Country of the invoice address. Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"jsonataMapping":{"description":"JSONata mapping, mapping from NBX document to UBL format for e-invoicing.\nMust not be null.","type":"string"},"mandateIdent":{"description":"Identifier of the avalara mandate.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"validationDocumentIdent":{"description":"Optional ident of a document a.k.a. document number.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","nullable":true,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},"required":["companyIdent","ident","invoiceAddressCountry","jsonataMapping","mandateIdent"],"type":"object"},"avalara_elr.mandate_mapping.DryRunMandateMappingRequest":{"description":"Request to dry run a mandate mapping","properties":{"jsonataMapping":{"description":"JSONata mapping, mapping from NBX document to UBL format for e-invoicing.\nMust not be null.","type":"string"},"validationDocumentIdent":{"description":"Ident of the document a.k.a. document number.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},"required":["jsonataMapping","validationDocumentIdent"],"type":"object"},"avalara_elr.mandate_mapping.DryRunMandateMappingResponse":{"description":"Response containing the result UBL as string in XML and JSON format","properties":{"jsonUblString":{"description":"JSON result as string in UBL format.\nMust not be null.","type":"string"},"xmlUblString":{"description":"XML result as string in UBL format.\nMust not be null.","type":"string"}},"required":["jsonUblString","xmlUblString"],"type":"object"},"avalara_elr.mandate_mapping.QueryResponse":{"description":"Avalara Mandate Mapping, mapping documents to Avalara&#39;s UBL without the JSONata mapping. Returned from the paged endpoint.","properties":{"companyIdent":{"description":"Ident of the company configured in Avalara used by this mapping.\nMust not be null.","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"ident":{"description":"Unique identifier of mandate mapping.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"invoiceAddressCountry":{"description":"Country of the invoice address. Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"mandateIdent":{"description":"Identifier of the avalara mandate.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"validationDocumentIdent":{"description":"Optional ident of a document a.k.a. document number.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","nullable":true,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},"required":["companyIdent","createdAt","ident","invoiceAddressCountry","lastModifiedAt","mandateIdent"],"type":"object"},"avalara_elr.mandate_mapping.Response":{"description":"Avalara Mandate Mapping, mapping documents to Avalara&#39;s UBL","properties":{"companyIdent":{"description":"Ident of the company configured in Avalara used by this mapping.\nMust not be null.","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"ident":{"description":"Unique identifier of mandate mapping.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"invoiceAddressCountry":{"description":"Country of the invoice address. Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"jsonataMapping":{"description":"JSONata mapping, mapping from NBX document to UBL format for e-invoicing.\nMust not be null.","type":"string"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"mandateIdent":{"description":"Identifier of the avalara mandate.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"validationDocumentIdent":{"description":"Optional ident of a document a.k.a. document number.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","nullable":true,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},"required":["companyIdent","createdAt","ident","invoiceAddressCountry","jsonataMapping","lastModifiedAt","mandateIdent"],"type":"object"},"avalara_elr.mandate_mapping.UpdateRequest":{"description":"Request to update an Avalara Mandate Mapping, mapping documents to Avalara&#39;s UBL","properties":{"companyIdent":{"description":"Ident of the company configured in Avalara used by this mapping.\nMust not be null.","type":"string"},"invoiceAddressCountry":{"description":"Country of the invoice address. Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","example":"DE","type":"string"},"jsonataMapping":{"description":"JSONata mapping, mapping from NBX document to UBL format for e-invoicing.\nMust not be null.","type":"string"},"mandateIdent":{"description":"Identifier of the avalara mandate.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"validationDocumentIdent":{"description":"Optional ident of a document a.k.a. document number.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","nullable":true,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},"required":["companyIdent","invoiceAddressCountry","jsonataMapping","mandateIdent"],"type":"object"},"avalara_elr.mandate_mapping.ValidationErrorResponse":{"description":"Response containing a detailed report of validation errors encountered during the mapping from DocumentDto to UBL/XML with the given document.","properties":{"message":{"description":"Message returned by validation.\nMust not be null.","type":"string"},"steps":{"default":[],"description":"Results of each ran validation step.\nMust not be null.","items":{"$ref":"#/components/schemas/avalara_elr.mandate_mapping.ValidationStepDto"},"type":"array"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries.\nMust not be null.","type":"string"}},"required":["message","steps","uuid"],"type":"object"},"avalara_elr.mandate_mapping.ValidationStepDto":{"description":"Result of a dedicated validation step.","properties":{"errorMessage":{"description":"Optional error message of the step. Only filled if field result is false.","nullable":true,"type":"string"},"name":{"description":"Name of the step.\nMust not be null.","type":"string"},"result":{"description":"Result of the step.\nMust not be null.","type":"boolean"}},"required":["name","result"],"type":"object"},"avalara_elr.tenant_configuration.Request":{"description":"Avalara ELR tenant configuration","properties":{"enabled":{"description":"Enable or disable Avalara ELR.\nMust not be null.","type":"boolean"},"logging":{"description":"Enable or disable Avalara ELR log recording.\nMust not be null.","type":"boolean"}},"required":["enabled","logging"],"type":"object"},"avalara_elr.tenant_configuration.Response":{"description":"Avalara ELR tenant configuration","properties":{"enabled":{"description":"Avalara ELR enabled state.\nMust not be null.","type":"boolean"},"logging":{"description":"Avalara ELR record logs state.\nMust not be null.","type":"boolean"}},"required":["enabled","logging"],"type":"object"},"support.avalara_elr.tenant_configuration.Request":{"properties":{"enabled":{"description":"Enable or disable Avalara ELR.\nMust not be null.","type":"boolean"},"integrationType":{"description":"Type of Avalara ELR integration.\nMust not be null.\nMust be one of:\n|                               |                                                                                       |\n| ----------------------------- | ------------------------------------------------------------------------------------- |\n| TECHNICAL_PARTNER_INTEGRATION | Use the technical partner integration with an Avalara account provided by the tenant. |\n| EMBEDDED_SOLUTION             | Use the embedded solution with an Avalara account managed and provided by Nitrobox.   |","type":"string"},"logging":{"description":"Enable or disable Avalara ELR log recording.\nMust not be null.","type":"boolean"}},"required":["enabled","integrationType","logging"],"type":"object"},"support.avalara_elr.tenant_configuration.Response":{"properties":{"enabled":{"description":"Avalara ELR enabled state.\nMust not be null.","type":"boolean"},"integrationType":{"description":"Type of Avalara ELR integration.\nMust not be null.\nMust be one of:\n|                               |                                                                                       |\n| ----------------------------- | ------------------------------------------------------------------------------------- |\n| TECHNICAL_PARTNER_INTEGRATION | Use the technical partner integration with an Avalara account provided by the tenant. |\n| EMBEDDED_SOLUTION             | Use the embedded solution with an Avalara account managed and provided by Nitrobox.   |","type":"string"},"logging":{"description":"Avalara ELR record logs state.\nMust not be null.","type":"boolean"}},"required":["enabled","integrationType","logging"],"type":"object"},"workflow.ExternalIdentDto":{"description":"External idents delivered by the eInvoicing provider","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"},"ident":{"description":"Ident of the document.\nMust not be null.\nMust not be blank.\nSize must be between 0 and 255.","maxLength":255,"type":"string"}},"required":["createdAt","ident"],"type":"object"},"workflow.HistoryDto":{"description":"History of all changes of the workflow","properties":{"action":{"description":"Processing result of the action.\nMust not be null.\nMust be one of:\n|                       |                                               |\n| --------------------- | --------------------------------------------- |\n| EVENT_RECEIVED        | An event was received.                        |\n| REQUEST_SENT          | Workflow was sent to expernal provider.       |\n| NOTIFICATION_RECEIVED | Received a message from the external provider |\n| RESEND_TRIGGERED      | Workflow was sent to expernal provider again. |\n| IGNORED               | The workflow was manually set to be ignored.  |","type":"string"},"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"description":{"description":"Description set manually or delivered by external provider or internal process.\nSize must be between 0 and 1020.","maxLength":1020,"nullable":true,"type":"string"},"externalIdent":{"description":"External ident of the document.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"externalStatus":{"description":"External status of the document.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"newProcessingStatus":{"description":"Indicates the new current status of the workflow.\nMust not be null.\nMust be one of:\n|                       |                                                                                                           |\n| --------------------- | --------------------------------------------------------------------------------------------------------- |\n| NOT_SENT_TO_PROVIDER  | The document was not sent to the chosen eInvoicing provider yet, or a retry is wanted.                    |\n| DELIVERED_TO_PROVIDER | The document was submitted to the chosen eInvoicing provider. Waiting for the final response.             |\n| PROCESSED_BY_PROVIDER | The document was successful submitted to the chosen eInvoicing provider and the counterpart acknowledged. |\n| ERROR                 | An unrecoverable Error happened. Manual actions are needed.                                               |\n| IGNORED               | The workflow was manually set to be ignored.                                                              |","type":"string"},"origin":{"description":"Processing result of the action.\nMust not be null.\nMust be one of:\n|                   |                                            |\n| ----------------- | ------------------------------------------ |\n| API               | Action was triggered by API.               |\n| EXTERNAL_PROVIDER | Action was triggered by external provider. |\n| EVENT             | Action was triggered by an event.          |","type":"string"},"properties":{"default":[],"description":"Additional properties.\nMust not be null.","items":{"$ref":"#/components/schemas/workflow.JsonProperty"},"type":"array"},"resultStatus":{"description":"Processing result of the action.\nMust not be null.\nMust be one of:\n|         |                            |\n| ------- | -------------------------- |\n| SUCCESS | Action was successful.     |\n| ERROR   | Action was not successful. |\n| INFO    | Information was attached.  |","type":"string"}},"required":["action","createdAt","newProcessingStatus","origin","properties","resultStatus"],"type":"object"},"workflow.IgnoreRequest":{"description":"Body of the ignore workflow request","properties":{"description":{"description":"Description of the workflow history entry created by this request.\nSize must be between 0 and 1020.","maxLength":1020,"nullable":true,"type":"string"}},"type":"object"},"workflow.JsonProperty":{"description":"Property containing a JSON value","properties":{"key":{"description":"Key of the property, unique within a property list.\nMust not be null.\nSize must be between 1 and 2147483647.","maxLength":2147483647,"minLength":1,"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/JsonNode"}],"description":"Value of the property.","type":"object"}},"required":["key","value"],"type":"object"},"workflow.LatestHistoryEntry":{"description":"Latest workflow history entry","nullable":true,"properties":{"description":{"description":"Description at latest workflow history entry","nullable":true,"type":"string"},"externalIdent":{"description":"External ident at latest workflow history entry","nullable":true,"type":"string"},"externalStatus":{"description":"External status at latest workflow history entry","nullable":true,"type":"string"}},"type":"object"},"workflow.Response":{"description":"Workflow","properties":{"availableMediaTypes":{"default":[],"description":"List of supported media types (e.g., 'application/pdf', 'application/xml') that can be requested from the external eInvoicing provider for this workflow.\nMust not be null.","items":{"type":"string"},"type":"array"},"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"},"documentIdent":{"description":"Ident of a document a.k.a. document number.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"},"documentType":{"description":"The type of the document.\nMust not be null.","type":"string"},"einvoicingMethod":{"description":"External provider used for eInvoicing.\nMust not be null.","type":"string"},"externalIdents":{"default":[],"description":"Idents provided by e-invoicing provider.\nMust not be null.","items":{"$ref":"#/components/schemas/workflow.ExternalIdentDto"},"type":"array"},"history":{"default":[],"description":"History of the workflow changes.\nMust not be null.","items":{"$ref":"#/components/schemas/workflow.HistoryDto"},"type":"array"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"latestHistoryEntry":{"$ref":"#/components/schemas/workflow.LatestHistoryEntry"},"processingStatus":{"description":"Indicates the current status of the workflow.\nMust not be null.\nMust be one of:\n|                       |                                                                                                           |\n| --------------------- | --------------------------------------------------------------------------------------------------------- |\n| NOT_SENT_TO_PROVIDER  | The document was not sent to the chosen eInvoicing provider yet, or a retry is wanted.                    |\n| DELIVERED_TO_PROVIDER | The document was submitted to the chosen eInvoicing provider. Waiting for the final response.             |\n| PROCESSED_BY_PROVIDER | The document was successful submitted to the chosen eInvoicing provider and the counterpart acknowledged. |\n| ERROR                 | An unrecoverable Error happened. Manual actions are needed.                                               |\n| IGNORED               | The workflow was manually set to be ignored.                                                              |","type":"string"},"properties":{"default":[],"description":"Additional properties.\nMust not be null.","items":{"$ref":"#/components/schemas/Property"},"type":"array"}},"required":["availableMediaTypes","createdAt","documentIdent","documentType","einvoicingMethod","externalIdents","history","lastModifiedAt","processingStatus","properties"],"type":"object"},"workflow.RsqlResponse":{"description":"Workflows","properties":{"availableMediaTypes":{"default":[],"description":"List of supported media types (e.g., 'application/pdf', 'application/xml') that can be requested from the external eInvoicing provider for this workflow.\nMust not be null.","items":{"type":"string"},"type":"array"},"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"},"documentIdent":{"description":"Ident of a document a.k.a. document number.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"},"documentType":{"description":"The type of the document.\nMust not be null.","type":"string"},"einvoicingMethod":{"description":"External provider used for eInvoicing.\nMust not be null.","type":"string"},"externalIdents":{"default":[],"description":"Idents provided by e-invoicing provider.\nMust not be null.","items":{"$ref":"#/components/schemas/workflow.ExternalIdentDto"},"type":"array"},"lastModifiedAt":{"description":"Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"latestHistoryEntry":{"$ref":"#/components/schemas/workflow.LatestHistoryEntry"},"processingStatus":{"description":"Indicates the current status of the workflow.\nMust not be null.\nMust be one of:\n|                       |                                                                                                           |\n| --------------------- | --------------------------------------------------------------------------------------------------------- |\n| NOT_SENT_TO_PROVIDER  | The document was not sent to the chosen eInvoicing provider yet, or a retry is wanted.                    |\n| DELIVERED_TO_PROVIDER | The document was submitted to the chosen eInvoicing provider. Waiting for the final response.             |\n| PROCESSED_BY_PROVIDER | The document was successful submitted to the chosen eInvoicing provider and the counterpart acknowledged. |\n| ERROR                 | An unrecoverable Error happened. Manual actions are needed.                                               |\n| IGNORED               | The workflow was manually set to be ignored.                                                              |","type":"string"}},"required":["availableMediaTypes","createdAt","documentIdent","documentType","einvoicingMethod","externalIdents","lastModifiedAt","processingStatus"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-document-management-read":"Scope nbx-document-management-read","nbx-document-management-write":"Scope nbx-document-management-write","nbx-internal":"Scope nbx-internal","nbx-tenant-management-read":"Scope nbx-tenant-management-read","nbx-tenant-management-write":"Scope nbx-tenant-management-write"},"tokenUrl":"https://api.isx-stage-westeurope.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for Electronic Invoice","title":"Electronic Invoice API","version":"v2-preview-1.4.3"},"openapi":"3.0.1","paths":{"/v2/workflows":{"get":{"description":"Get a list of all Workflows. To reduce the result set, please use the RSQL query.","operationId":"searchWorkflows","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":20,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["documentIdent,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseWorkflow.RsqlResponse"}}},"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 workflows","tags":["Electronic Invoicing Workflows"]}},"/v2/workflows/{documentIdent}":{"get":{"description":"Retrieves a workflow by its documentIdent","operationId":"retrieveWorkflow","parameters":[{"description":"Ident of the document for this workflow.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","in":"path","name":"documentIdent","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/workflow.Response"}}},"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 workflow","tags":["Electronic Invoicing Workflows"]}},"/v2/workflows/{documentIdent}/actions/ignore":{"post":{"description":"Set workflow to be ignored. The workflow must be in `processingStatus` `ERROR`.","operationId":"ignoreWorkflow","parameters":[{"description":"Ident of the document for this workflow.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","in":"path","name":"documentIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow.IgnoreRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow.Response"}}},"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-write"]}],"summary":"Ignore workflow","tags":["Electronic Invoicing Workflows"]}},"/v2/workflows/{documentIdent}/actions/resend-to-provider":{"post":{"description":"Resend a workflow. The workflow must be in `processingStatus` `ERROR` or `IGNORED`.","operationId":"resendWorkfow","parameters":[{"description":"Ident of the document for this workflow.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","in":"path","name":"documentIdent","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/workflow.Response"}}},"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-write"]}],"summary":"Resend workflow","tags":["Electronic Invoicing Workflows"]}},"/v2/workflows/{documentIdent}/file":{"get":{"description":"Download resulting eInvoicing file related to the Workflow. If no ACCEPT header is set, we try to retrieve the file as PDF or XML. A result can only be delivered when the workflow has the processingStatus PROCESSED_BY_PROVIDER.","operationId":"retrieveWorkflowFile","parameters":[{"description":"Ident of the document for this workflow.\nMust not be null.\nMust match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~/ -]{1,100}'.","in":"path","name":"documentIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~/ -]{1,100}","type":"string"}},{"in":"header","name":"Accept","schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"format":"binary","type":"string"}},"application/json":{"schema":{"format":"binary","type":"string"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-document-management-read"]}],"summary":"Retrieve eInvoicing File","tags":["Electronic Invoicing Workflows"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"Electronic Invoicing Workflows API","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Electronic Invoicing Workflows"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}