{"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":{"ArchiveConfigurationDto":{"description":"Request that contain the archive strategy chosen by tenant with it's details","properties":{"archiveStrategy":{"default":"DISABLED","description":"Archive strategy that is used by tenant.\nMust be one of:\n|             |\n| ----------- |\n| NBX_CLOUD   |\n| TRUSTWEAVER |\n| DISABLED    |","type":"string"},"archiveStrategyDetailedConfigurations":{"default":[],"description":"Details of archive strategy that is used by tenant","items":{"$ref":"#/components/schemas/ArchiveStrategyDetailedConfigurationDto"},"type":"array","uniqueItems":true}},"type":"object"},"ArchiveStrategyDetailedConfigurationDto":{"default":[],"description":"Request that contain details of specific archive strategy","properties":{"configIdent":{"description":"ident of specific archive config.\nMust not be null.","type":"string"},"contentType":{"description":"The output document format that will be produced.\nMust not be null.\nMust be one of:\n|     |\n| --- |\n| PDF |","type":"string"},"invoiceType":{"description":"The type of invoice for which configuration should be applied, e.g. INVOICE/CREDITMEMO.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| ALL                             |\n| INVOICE                         |\n| CREDITMEMO                      |\n| ORDER                           |\n| DEPOSITINVOICE                  |\n| DEPOSITINVOICECANCELLATION      |\n| CREDITMEMO_GOODWILL             |\n| CREDITMEMO_WARRANTY             |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"},"trustWeaverSection":{"$ref":"#/components/schemas/TrustWeaverSectionDto"}},"required":["configIdent","contentType","invoiceType","trustWeaverSection"],"type":"object"},"AttachmentDto":{"description":"Container for the File name of the attachment.","properties":{"attachmentFileName":{"description":"File name of the attachment. Can be used to retrieve the attachment.\nMust not be null.","type":"string"},"contentType":{"description":"Media type of the attachment.\nMust not be null.","type":"string"}},"required":["attachmentFileName","contentType"],"type":"object"},"AvailableMigrationsDto":{"properties":{"migrations":{"description":"List of available migrations.\nMust not be null.","items":{"description":"List of available migrations","type":"string"},"type":"array"}},"required":["migrations"],"type":"object"},"CreateTranslationRequest":{"description":"Add translations for a new or existing key","properties":{"key":{"description":"The translation key that shall be translated.\nMust not be blank.","minLength":1,"type":"string"},"translations":{"description":"All translations that should be stored under this translation key.\nMust not be empty.","items":{"$ref":"#/components/schemas/Translation"},"minItems":1,"type":"array"}},"required":["key","translations"],"type":"object"},"DeleteTranslation":{"description":"A translation to be removed from a key","properties":{"language":{"description":"The language for which to delete the translation.\nMust not be null.","type":"string"}},"required":["language"],"type":"object"},"DeleteTranslationRequest":{"description":"Translations to be removed from a key","properties":{"translations":{"description":"The list of translations to remove.\nMust not be empty.","items":{"$ref":"#/components/schemas/DeleteTranslation"},"minItems":1,"type":"array"}},"required":["translations"],"type":"object"},"DocumentConfigurationDto":{"description":"Request that contain the document creation configuration.","properties":{"accessibilityFeaturesEnabled":{"default":false,"description":"If enabled, accessibility features will be enabled for the documents.","type":"boolean"},"billingGroupIdentsWithEnabledRatedUsageEnrichment":{"description":"Billing groups for which rated usages are to be enriched.\nMust not be null.","items":{"description":"Billing groups for which rated usages are to be enriched","type":"string"},"type":"array","uniqueItems":true},"createDunningDocuments":{"default":true,"description":"If enabled, dunning PDFs will be created. Otherwise, dunning letters will be skipped.","type":"boolean"},"documentCreationStrategy":{"default":"DISABLED","description":"Document creation strategy that is used by tenant.\nMust be one of:\n|                                      |\n| ------------------------------------ |\n| XML_BASED_STRATEGY                   |\n| XML_BASED_STRATEGY_WITH_TRANSLATIONS |\n| DISABLED                             |","type":"string"},"translationStrategy":{"default":"TEMPLATE_PROVIDED","description":"Translation Strategy that is used by the tenant. Recommended when documentCreationStrategy is not DISABLED.\nMust be one of:\n|                   |\n| ----------------- |\n| TEMPLATE_PROVIDED |\n| SERVICE_PROVIDED  |","type":"string"},"useDefaultTemplate":{"default":false,"description":"If enabled the default template is used. Otherwise a custom template must be configured","type":"boolean"}},"required":["billingGroupIdentsWithEnabledRatedUsageEnrichment"],"type":"object"},"ExternalDocumentDto":{"properties":{"documentData":{"description":"Must not be null.","format":"byte","type":"string"},"documentIdent":{"description":"Must not be null.","type":"string"},"documentType":{"description":"Must not be null.","enum":["INVOICE","CREDIT_MEMO","ORDER","DEPOSIT_INVOICE","DEPOSIT_INVOICE_CANCELLATION","UNKNOWN","CREDIT_MEMO_GOODWILL","CREDIT_MEMO_WARRANTY","SELF_BILLING_INVOICE","SELF_BILLING_INVOICE_CORRECTION"],"type":"string"},"serviceCountry":{"description":"Must not be null.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"}},"required":["documentData","documentIdent","documentType","serviceCountry"],"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":{"type":"object"},"KeyValuesDto":{"description":"A translation key with the translations for each configured locale.","properties":{"key":{"description":"The translation key.\nMust not be blank.","minLength":1,"type":"string"},"translations":{"description":"All translations for this translation key.\nMust not be empty.","items":{"$ref":"#/components/schemas/TranslationDto"},"minItems":1,"type":"array"}},"required":["key","translations"],"type":"object"},"LocalesDto":{"description":"All locales configured for the tenant.","properties":{"locales":{"description":"All locales configured for the tenant.\nMust not be null.","items":{"description":"All locales configured for the tenant.","type":"string"},"type":"array"}},"required":["locales"],"type":"object"},"MigrationParametersRequest":{"properties":{"batchSize":{"description":"Migration type.\nMust not be null.\nMust be greater than 0.","format":"int32","type":"integer"},"delayBetweenBatches":{"description":"Delay between batches.\nMust not be null.","type":"string"},"lockAtLeastFor":{"description":"Lock minimum duration.\nMust not be null.","type":"string"},"lockAtMostFor":{"description":"Lock timeout.\nMust not be null.","type":"string"},"tenantIds":{"description":"Tenant ids to migrate","items":{"description":"Tenant ids to migrate","format":"int64","type":"integer"},"type":"array","uniqueItems":true}},"required":["batchSize","delayBetweenBatches","lockAtLeastFor","lockAtMostFor","tenantIds"],"type":"object"},"MigrationStatusDto":{"properties":{"itemsToMigrate":{"description":"Number of items to migrate.\nMust not be null.","format":"int64","type":"integer"},"itemsToSetup":{"description":"Number of items to setup.\nMust not be null.","format":"int64","type":"integer"}},"required":["itemsToMigrate","itemsToSetup"],"type":"object"},"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"},"PagedResponseAttachmentDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AttachmentDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseKeyValuesDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/KeyValuesDto"},"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"},"PagedResponsePersisted_documents.Response":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/persisted_documents.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PatchDocumentConfigurationDto":{"description":"Update the document creation configuration.\n\nThis is a PATCH request following [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386),\nthis means only fields that are set (to `null` or a value) will update the configuration.\nFields that are omitted (in JS terms `undefined`) will not be changed.\n\n**Important: `null` is not the same as omitting a field.**\n","properties":{"accessibilityFeaturesEnabled":{"default":false,"description":"If enabled, accessibility features will be enabled for the documents.","type":"boolean"},"billingGroupIdentsWithEnabledRatedUsageEnrichment":{"description":"Billing groups for which rated usages are to be enriched.\nMust not be null.","items":{"description":"Billing groups for which rated usages are to be enriched","type":"string"},"type":"array","uniqueItems":true},"createDunningDocuments":{"description":"If enabled, dunning PDFs will be created. Otherwise, dunning letters will be skipped.\nMust not be null.","type":"boolean"},"documentCreationStrategy":{"description":"Document creation strategy that is used by tenant.\nMust be one of:\n|                                      |\n| ------------------------------------ |\n| XML_BASED_STRATEGY                   |\n| XML_BASED_STRATEGY_WITH_TRANSLATIONS |\n| DISABLED                             |","type":"string"},"translationStrategy":{"description":"Translation Strategy that is used by the tenant. Recommended when documentCreationStrategy is not DISABLED.\nMust not be null.\nMust be one of:\n|                   |\n| ----------------- |\n| TEMPLATE_PROVIDED |\n| SERVICE_PROVIDED  |","type":"string"},"useDefaultTemplate":{"description":"If enabled the default template is used. Otherwise a custom template must be configured.\nMust not be null.","type":"boolean"}},"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"},"SingleSectionDto":{"description":"Trustwaver global section name and country","properties":{"sectionName":{"description":"Trustweaver section name.\nMust not be null.","type":"string"},"trustWeaverSectionCountry":{"description":"Country that trustweaver section is applied.\nMust not be null.","type":"string"}},"required":["sectionName","trustWeaverSectionCountry"],"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"},"Translation":{"description":"The translation value for a specific language","properties":{"language":{"description":"The language for which this translation will be used.\nMust not be null.","type":"string"},"value":{"description":"The translated text for this language/country.\nMust not be null.","type":"string"}},"required":["language","value"],"type":"object"},"TranslationDto":{"description":"A translation for a specific language/country","properties":{"inherited":{"description":"When an entry is marked as \"inherited\", then there is no value stored for this particular language/country, but there is a value stored that is higher up the hierarchy, that is used instead. This allows you to store translations once for a single language and reuse that translation in multiple countries for example.\nMust not be null.","type":"boolean"},"inheritedFrom":{"additionalProperties":{"description":"Describes where an inherited value is actually stored in the hierarchy.","nullable":true,"type":"string"},"description":"Describes where an inherited value is actually stored in the hierarchy.","nullable":true,"type":"object"},"language":{"description":"The language for which this translation will be used.\nMust not be null.","type":"string"},"value":{"description":"The translated text for this language/country.\nMust not be null.","type":"string"}},"required":["inherited","language","value"],"type":"object"},"TranslationEntryDto":{"description":"Translation entry","properties":{"key":{"description":"The key for which this translation is stored.\nMust not be blank.","minLength":1,"type":"string"},"language":{"description":"The country for which this translation is stored.\nTwo- or three-letter language code in ISO 639-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).\nMust not be null.","example":"de","type":"string"},"locale":{"description":"The locale for which this translation is stored.\nMust not be null.","type":"string"},"value":{"description":"The translated text for this language/country.\nMust not be null.","type":"string"}},"required":["key","language","locale","value"],"type":"object"},"TranslationResponse":{"description":"Reponse containing all translations for a given locale.","properties":{"locale":{"description":"The locale for which this translation is stored.\nMust not be null.","type":"string"},"translations":{"description":"All translations for this locale.\nMust not be null.","items":{"$ref":"#/components/schemas/TranslationEntryDto"},"type":"array"}},"required":["locale","translations"],"type":"object"},"TrustWeaverCertificateRequest":{"description":"Request that contain trustWeaver certificate data.","properties":{"keystore":{"description":"Keystore for trustWeaver.\nMust not be null.","type":"string"},"keystorePassword":{"description":"password to keystore.\nMust not be null.","type":"string"}},"required":["keystore","keystorePassword"],"type":"object"},"TrustWeaverCertificateResponse":{"description":"Response that contain trustWeaver certificate data.","properties":{"keystore":{"description":"Keystore for trustWeaver.\nMust not be null.","type":"string"},"keystorePassword":{"description":"password to keystore.\nMust not be null.","type":"string"},"restEnabled":{"description":"enable certificate for rest instead of soap client.\nMust not be null.","type":"boolean"}},"required":["keystore","keystorePassword","restEnabled"],"type":"object"},"TrustWeaverSectionDto":{"description":"Trustweaver sections configuration request","properties":{"mode":{"description":"Trustwaver section mode, e.g. SINGLE/COUNTRY.\nMust not be null.\nMust be one of:\n|         |\n| ------- |\n| SINGLE  |\n| COUNTRY |","type":"string"},"singleSection":{"allOf":[{"$ref":"#/components/schemas/SingleSectionDto"}],"nullable":true,"type":"object"}},"required":["mode"],"type":"object"},"UpdateTranslationRequest":{"description":"Request to update translations for a specific translation key","properties":{"translations":{"description":"All translations that should be stored in addition or updated under this translation key.\nMust not be empty.","items":{"$ref":"#/components/schemas/Translation"},"minItems":1,"type":"array"}},"required":["translations"],"type":"object"},"files.MetadataRequest":{"description":"Metadata for the file upload.","properties":{"country":{"description":"Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","type":"string"},"customerIdent":{"description":"Ident of the customer.\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"},"documentId":{"description":"Must not be null.","format":"int64","type":"integer"},"documentType":{"description":"The 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| UNKNOWN                         |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"},"eInvoicingMethod":{"description":"The e-invoicing method.\nMust not be null.\nMust be one of:\n|             |                                        |\n| ----------- | -------------------------------------- |\n| NONE        | No e-invoice will be created           |\n| FACTUR_X    | FACTUR-X e-invoice will be created     |\n| X_RECHNUNG  | X Rechnung e-invoice will be created   |\n| BASWARE     | Basware e-invoice will be created      |\n| AVALARA_ELR | Avalara ELR  e-invoice will be created |","type":"string"}},"required":["country","customerIdent","documentId","documentType","eInvoicingMethod"],"type":"object"},"persisted_documents.Attachment":{"description":"Persistence information for a document&#39;s attachment.","properties":{"certifiedStorage":{"$ref":"#/components/schemas/persisted_documents.CertifiedStorage"},"contentType":{"description":"Content type of the file.\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"},"fileLocation":{"description":"Path of file in cloud storage.\nMust not be null.","type":"string"},"filename":{"description":"Name of the file when retrieved.\nMust not be null.","type":"string"}},"required":["contentType","createdAt","fileLocation","filename"],"type":"object"},"persisted_documents.CertifiedStorage":{"description":"Certified storage information","nullable":true,"properties":{"storedAt":{"description":"Time the document was stored in certified storage provider. 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"},"type":{"description":"Certified storage provider used, currently only `TRUSTWEAVER` is available.\nMust not be null.","enum":["TRUSTWEAVER"],"type":"string"}},"required":["storedAt","type"],"type":"object"},"persisted_documents.Response":{"description":"Persisted document meta data","properties":{"attachments":{"default":[],"description":"Attachments of the document.\nMust not be null.","items":{"$ref":"#/components/schemas/persisted_documents.Attachment"},"type":"array"},"certifiedStorage":{"$ref":"#/components/schemas/persisted_documents.CertifiedStorage"},"contentType":{"description":"Content type of the file.\nMust not be null.","type":"string"},"country":{"description":"Two- or three-letter country code in ISO 3166-1 standard. See [Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1).\nMust not be null.","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"},"customerIdent":{"description":"Ident of the customer.\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"},"deletedAt":{"description":"Date document was deleted (pdf/xml). 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"},"documentId":{"description":"Document Id, only used internally.\nMust not be null.","format":"int64","type":"integer"},"documentIdent":{"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"},"documentType":{"description":"The 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| UNKNOWN                         |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"},"fileLocation":{"description":"Path of file in cloud storage.\nMust not be null.","type":"string"},"filename":{"description":"Name of the file when retrieved.\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"}},"required":["attachments","contentType","country","createdAt","customerIdent","deletedAt","documentId","documentIdent","documentType","fileLocation","filename","lastModifiedAt"],"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 document output generation and archiving","title":"Document Output API","version":"v2-preview-4.28.0"},"openapi":"3.0.1","paths":{"/v2/files/{fileIdent}":{"get":{"description":"Files are documents that have been converted as a PDF. Download the PDF document for a given document ident/invoice number.","operationId":"getFile","parameters":[{"description":"The fileIdent is the same as  the document ident or invoiceIdent.","in":"path","name":"fileIdent","required":true,"schema":{"description":"The fileIdent is the same as  the document ident or invoiceIdent.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"byte","type":"string"}},"application/octet-stream":{"schema":{"format":"byte","type":"string"}},"application/pdf":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","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 a file","tags":["Files"]}},"/v2/files/{fileIdent}/attachments":{"get":{"description":"Get a list of attachments related to a given document ident/invoice number.","operationId":"getAttachments","parameters":[{"description":"The fileIdent is the same as the document ident/invoice number.","in":"path","name":"fileIdent","required":true,"schema":{"description":"The fileIdent is the same as the document ident/invoice number.","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 50.","in":"query","name":"size","schema":{"default":50,"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'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAttachmentDto"}}},"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 attachments","tags":["Files"]}},"/v2/files/{fileIdent}/attachments/{attachmentFileName}":{"get":{"description":"Download the PDF attachment for given document ident/invoice number and attachment file name","operationId":"getAttachment","parameters":[{"description":"The fileIdent is the same as the document ident/invoice number.","in":"path","name":"fileIdent","required":true,"schema":{"description":"The fileIdent is the same as the document ident/invoice number.","type":"string"}},{"description":"The attachmentFileName is the name of attachment and can be found with the retrieve attachments endpoint.","in":"path","name":"attachmentFileName","required":true,"schema":{"description":"The attachmentFileName is the name of attachment and can be found with the retrieve attachments endpoint.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"byte","type":"string"}},"application/octet-stream":{"schema":{"format":"byte","type":"string"}},"application/pdf":{"schema":{"format":"byte","type":"string"}},"text/xml":{"schema":{"format":"byte","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 attachment","tags":["Files"]}},"/v2/translation-configurations":{"get":{"description":"Get all translations available for all configured locales.","operationId":"getTranslations","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 50.","in":"query","name":"size","schema":{"default":50,"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'.","in":"query","name":"sort","schema":{"default":[],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseKeyValuesDto"}}},"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 Translations","tags":["Translation Configurations"]}},"/v2/translation-keys":{"post":{"description":"Stores translations for a specific translation key.","operationId":"saveTranslation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTranslationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuesDto"}}},"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":"Store Translations","tags":["Translations"]}},"/v2/translation-keys/{key}":{"delete":{"description":"Completely removes a translation key with all stored translations. Translations, that are stored system wide can not be removed completely.","operationId":"deleteTranslationKey","parameters":[{"in":"path","name":"key","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 Translation Key","tags":["Translations"]},"get":{"description":"Retrieves the translations for specific translation key.","operationId":"getKeyValues","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuesDto"}}},"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 Translations","tags":["Translations"]},"patch":{"description":"Updates the translations for some locales for a specific translation key. Translations for other locales for this key remain unchanged.","operationId":"patchTranslations","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTranslationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuesDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Update Translation","tags":["Translations"]}},"/v2/translation-keys/{key}/translations":{"delete":{"description":"Removes the translation for some locales for a specific translation key. Translations for other locales for this key remain unchanged.","operationId":"deleteTranslations","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranslationRequest"}}},"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":"Delete Translation","tags":["Translations"]}},"/v2/translation-locales":{"get":{"description":"Retrieve all locales configured for the tenant.","operationId":"getLocales","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalesDto"}}},"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 Configured Locales","tags":["Translation Configurations"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"endpoints for Translations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Translations"},{"description":"endpoints for Translation Configurations","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Translation Configurations"},{"description":"Files and Attachments","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Files"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}