{"components":{"parameters":{"outbox.OutboxQueryParams.createdFrom":{"description":"Start timestamp (inclusive) for filtering by the creation time of the outbox entry.","explode":false,"in":"query","name":"createdFrom","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.createdTo":{"description":"End timestamp (inclusive) for filtering by the creation time of the outbox entry.","explode":false,"in":"query","name":"createdTo","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.from":{"description":"Start timestamp (inclusive) for filtering outbox entries based on the status timestamp.","explode":false,"in":"query","name":"from","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}},"outbox.OutboxQueryParams.to":{"description":"End timestamp (inclusive) for filtering outbox entries based on the status timestamp.","explode":false,"in":"query","name":"to","schema":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}},"schemas":{"Amount":{"properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","examples":[23.56],"type":"number"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["amount","currency"],"type":"object"},"ClientError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Client error","type":"object"},"CommonError":{"description":"Common error","properties":{"errors":{"description":"Optional list of multiple errors occurred.\nMust not be null.","items":{"type":"object"},"type":"array"},"message":{"description":"Message describing the error.\nMust not be null.","type":"string"},"path":{"description":"URL path where the error occurred.\nMust not be null.","type":"string"},"status":{"description":"Textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400.\nMust not be null.","type":"string"},"timestamp":{"description":"Timestamp in UTC when the error occurred.\nMust not be null.","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.\nMust not be null.","type":"string"}},"required":["status","message","timestamp","path","uuid","errors"],"type":"object"},"CurrencyCode":{"description":"Currency code. Three letters ISO-4217 format.\n","examples":["EUR"],"type":"string"},"DebitCreditIndicator":{"description":"Indicates if value is debit or credit.\nOne of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","examples":["DEBIT"],"type":"string"},"Ident":{"description":"Unique identifier.","examples":["613c060c-52bc-472e-bb2f-16cd431fef7b"],"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]*","type":"string"},"Origin":{"description":"One of:\n|           |\n| --------- |\n| AUTOMATED |\n| MANUAL    |","type":"string"},"Page":{"description":"Pagination metadata","properties":{"number":{"description":"Page number of total pages available.\nMust not be null.","format":"uint32","type":"integer"},"size":{"description":"Size of the page as specified by the query.\nMust not be null.","format":"uint32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.\nMust not be null.","format":"uint32","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.\nMust not be null.","format":"uint32","type":"integer"}},"required":["size","number","totalElements","totalPages"],"type":"object"},"ServerError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Server error","type":"object"},"TargetType":{"description":"Type of the assignment target.\n\n*NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments,\n     as for the ident of orders with a single associated document the payment will be assigned to the\n     document instead.\nOne of:\n|          |                          |\n| -------- | ------------------------ |\n| DOCUMENT | The target is a document |\n| ORDER    | The target is an order   |","type":"string"},"assignment.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/assignment.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Assignments","type":"object"},"assignment.Request":{"description":"Create payment assignment request. If the assigned amount is not explicitly set, the remaining transaction amount is used for payment transaction assignments, and the batch item amount is used for batch items","properties":{"amount":{"anyOf":[{"$ref":"#/components/schemas/Amount"},{"type":"null"}],"description":"Assigned amount. If not explicitly set, the remaining transaction amount is used for payment transaction assignments, and the batch item amount is used for batch items"},"ident":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"Unique ident of the payment assignment.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"paymentBatchItemIdent":{"description":"Ident of the payment transaction batch item","type":["string","null"]},"paymentIdent":{"description":"Ident of the payment transaction.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"targetIdent":{"description":"Ident of the assignment target, i.e. document or order ident.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"targetIdentType":{"description":"Type of the assignment target.\nMust not be null.\nType of the assignment target.\n\n*NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments,\n     as for the ident of orders with a single associated document the payment will be assigned to the\n     document instead.\nOne of:\n|          |                          |\n| -------- | ------------------------ |\n| DOCUMENT | The target is a document |\n| ORDER    | The target is an order   |","type":"string"}},"required":["ident","paymentIdent","targetIdent","targetIdentType"],"type":"object"},"assignment.Response":{"description":"Payment Assignment","properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/Amount"}],"description":"Assigned amount.\nMust not be null."},"beforeSettlement":{"description":"Indicates if the assignment happened before settlement.\nMust not be null.","type":"boolean"},"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"},"creditDebitIndicator":{"$ref":"#/components/schemas/DebitCreditIndicator"},"ident":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"Unique ident of the payment assignment.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"origin":{"description":"Indicates if an assignment was made automatically by Nitrobox or as a manual REST API request.\nMust not be null.\nOne of:\n|           |\n| --------- |\n| AUTOMATED |\n| MANUAL    |","type":"string"},"paymentBatchItemIdent":{"description":"Ident of the payment transaction batch item","type":["string","null"]},"paymentIdent":{"description":"Ident of the payment transaction.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"paymentIntentIdent":{"description":"Ident of the payment intent","type":["string","null"]},"reversedAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"If this assignment was reversed, the timestamp of the reversal."},"status":{"description":"Specifies if an assignment is assigned or reversed.\nMust not be null.\nOne of:\n|          |\n| -------- |\n| ASSIGNED |\n| REVERSED |","type":"string"},"targetIdent":{"description":"Ident of the assignment target, i.e. document or order ident.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"targetType":{"description":"Type of the assignment target.\nMust not be null.\nOne of:\n|                                 |\n| ------------------------------- |\n| ORDER                           |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"required":["ident","paymentIdent","targetIdent","paymentIntentIdent","targetType","origin","beforeSettlement","amount","creditDebitIndicator","status","reversedAt","createdAt"],"type":"object"},"assignment.SpecificTargetType":{"description":"One of:\n|                                 |\n| ------------------------------- |\n| ORDER                           |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"},"assignment.Status":{"description":"One of:\n|          |\n| -------- |\n| ASSIGNED |\n| REVERSED |","type":"string"},"assignment_register.Assignment":{"description":"A assignment","properties":{"ident":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"Ident of the assignment.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."}},"required":["ident"],"type":"object"},"assignment_register.PaymentAssignmentStatus":{"description":"One of:\n|                     |\n| ------------------- |\n| UNASSIGNED          |\n| PARTIALLY_ASSIGNED  |\n| COMPLETELY_ASSIGNED |","type":"string"},"assignment_register.Response":{"description":"A assignment register which accumulates all assignments for a payment transaction","properties":{"assigned":{"allOf":[{"$ref":"#/components/schemas/Amount"}],"description":"Amount assigned to the payment.\nMust not be null."},"assignments":{"description":"Assignments done for the payment.\nMust not be null.","items":{"$ref":"#/components/schemas/assignment_register.Assignment"},"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"},"ident":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"The ident of the assignment register corresponds to the ident of the payment transaction.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"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"},"leftOver":{"allOf":[{"$ref":"#/components/schemas/Amount"}],"description":"Leftover amount to be assigned.\nMust not be null."},"paymentAssignmentStatus":{"description":"Assignment status of the payment.\nMust not be null.\nOne of:\n|                     |\n| ------------------- |\n| UNASSIGNED          |\n| PARTIALLY_ASSIGNED  |\n| COMPLETELY_ASSIGNED |","type":"string"}},"required":["ident","assigned","leftOver","assignments","paymentAssignmentStatus","createdAt","lastModifiedAt"],"type":"object"},"attempt.AssignmentResult":{"description":"One of:\n|            |\n| ---------- |\n| ASSIGNED   |\n| UNASSIGNED |","type":"string"},"attempt.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/attempt.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Assignment attempts","type":"object"},"attempt.Response":{"description":"Assignment attempt","properties":{"assignmentOrigin":{"anyOf":[{"$ref":"#/components/schemas/Origin"},{"type":"null"}],"description":"The original trigger of the assignment"},"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":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"Ident of the assignment.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"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"},"paymentBatchItemIdent":{"anyOf":[{"$ref":"#/components/schemas/Ident"},{"type":"null"}],"description":"Ident of the payment batch item from which the money originated"},"paymentIdent":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"Ident of the payment from which the money originated.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"result":{"description":"The result of the assignment.\nMust not be null.\nOne of:\n|            |\n| ---------- |\n| ASSIGNED   |\n| UNASSIGNED |","type":"string"},"targetIdent":{"description":"Ident of the target the money was assigned to.\nMust not be null.","type":"string"},"targetType":{"description":"The target type.\nMust not be null.\nType of the assignment target.\n\n*NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments,\n     as for the ident of orders with a single associated document the payment will be assigned to the\n     document instead.\nOne of:\n|          |                          |\n| -------- | ------------------------ |\n| DOCUMENT | The target is a document |\n| ORDER    | The target is an order   |","type":"string"}},"required":["ident","paymentIdent","paymentBatchItemIdent","targetIdent","targetType","result","assignmentOrigin","createdAt","lastModifiedAt"],"type":"object"},"configuration.RegexMatchingStrategy":{"description":"Regex matching strategy","properties":{"failOnMultipleRegexMatches":{"default":false,"description":"Should the strategy fail instead of searching a target for each regex match if the regex matched multiple times.","type":["boolean","null"]},"ident":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"Unique ident of the matching strategy.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"regexPattern":{"description":"Specifies the regular expression that we will try to find in payment description.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"targetIdentPattern":{"description":"If specified, this will be used instead of the regular expression's match to search for the ident. \\\n         Supports referencing capture groups, e.g. `$123` or `${name}` and `$` can be escaped with `\\\\$`.\n         Example:\n         - with a payment description of `INV/01234567/89`\n         - a `regularExpression` of `(\\\\d*)/(\\\\d*)` would match `01234567/89`, with the capture groups `01234567` and `89`\n         - a `replaceWith` of `$1-$2` would yield `01234567-89`\n\n         Therefor the payment would be assigned to an invoice with ident `01234567-89`.\nSize must be less than or equal to 255.","maxLength":255,"type":["string","null"]},"targetIdentType":{"description":"Type of the assignment target.\n\n*NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments,\n         as for the ident of orders with a single associated document the payment will be assigned to the\n         document instead.\nMust not be null.\nType of the assignment target.\n\n*NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments,\n     as for the ident of orders with a single associated document the payment will be assigned to the\n     document instead.\nOne of:\n|          |                          |\n| -------- | ------------------------ |\n| DOCUMENT | The target is a document |\n| ORDER    | The target is an order   |","type":"string"}},"required":["ident","targetIdentType","regexPattern"],"type":"object"},"configuration.RegexMatchingStrategySelection":{"description":"Defines the priority of a regex matching strategy","properties":{"ident":{"description":"Ident of the regex matching strategy.\nMust not be null.\nSize must be between 1 and 100.\nMust match the regular expression ^\\S(.*\\S)?$.","examples":["613c060c-52bc-472e-bb2f-16cd431fef7b"],"maxLength":100,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"priority":{"description":"The priority of the matching strategy selection.\nMust not be null.","format":"int64","type":"integer"}},"required":["priority","ident"],"type":"object"},"configuration.RegexMatchingStrategyUpdateRequest":{"description":"Request to update a regex matching strategy","properties":{"failOnMultipleRegexMatches":{"default":false,"description":"Should the strategy fail instead of searching a target for each regex match if the regex matched multiple times.","type":["boolean","null"]},"regexPattern":{"description":"Specifies the regular expression that we will try to find in payment description.\nMust not be null.\nSize must be between 1 and 255.\nMust match the regular expression ^\\S(.*\\S)?$.","maxLength":255,"minLength":1,"pattern":"^\\S(.*\\S)?$","type":"string"},"targetIdentPattern":{"description":"If specified, this will be used instead of the regular expression's match to search for the ident. \\\n         Supports referencing capture groups, e.g. `$123` or `${name}` and `$` can be escaped with `\\\\$`.\n         Example:\n         - with a payment description of `INV/01234567/89`\n         - a `regularExpression` of `(\\\\d*)/(\\\\d*)` would match `01234567/89`, with the capture groups `01234567` and `89`\n         - a `replaceWith` of `$1-$2` would yield `01234567-89`\n\n         Therefor the payment would be assigned to an invoice with ident `01234567-89`.\nSize must be less than or equal to 255.","maxLength":255,"type":["string","null"]},"targetIdentType":{"description":"Type of the assignment target.\n\n*NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments,\n         as for the ident of orders with a single associated document the payment will be assigned to the\n         document instead.\nMust not be null.\nType of the assignment target.\n\n*NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments,\n     as for the ident of orders with a single associated document the payment will be assigned to the\n     document instead.\nOne of:\n|          |                          |\n| -------- | ------------------------ |\n| DOCUMENT | The target is a document |\n| ORDER    | The target is an order   |","type":"string"}},"required":["targetIdentType","regexPattern"],"type":"object"},"configuration.Request":{"description":"Payment Assignment Configuration Request","properties":{"overpaymentAssignment":{"deprecated":true,"description":"Are automatic over payment assignments allowed for documents. Replaced by overpaymentAssignmentToDocuments","type":["boolean","null"]},"overpaymentAssignmentToDocuments":{"default":false,"description":"Are automatic over payment assignments allowed for documents.\nMust not be null.","type":"boolean"},"overpaymentAssignmentToOrders":{"default":false,"description":"Are automatic over payment assignments allowed for orders.\nMust not be null.","type":"boolean"},"regexMatchingStrategies":{"anyOf":[{"items":{"$ref":"#/components/schemas/configuration.RegexMatchingStrategySelection"},"type":"array"},{"type":"null"}],"default":[],"description":"Regex matching strategies for this merchant payment account"},"underpaymentAssignment":{"deprecated":true,"description":"Are automatic under payment assignments allowed for documents. Replaced by underpaymentAssignmentToDocuments","type":["boolean","null"]},"underpaymentAssignmentToDocuments":{"default":false,"description":"Are automatic under payment assignments allowed for documents.\nMust not be null.","type":"boolean"},"underpaymentAssignmentToOrders":{"default":true,"description":"Are automatic under payment assignments allowed for orders.\nMust not be null.","type":"boolean"}},"type":"object"},"configuration.Response":{"description":"Payment Assignment Configuration","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"},"merchantPaymentAccountIdent":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"Ident of the payment account.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"overpaymentAssignment":{"deprecated":true,"description":"Are automatic over payment assignments allowed for documents. Replaced by overpaymentAssignmentToDocuments.\nMust not be null.","type":"boolean"},"overpaymentAssignmentToDocuments":{"description":"Are automatic over payment assignments allowed for documents.\nMust not be null.","type":"boolean"},"overpaymentAssignmentToOrders":{"description":"Are automatic over payment assignments allowed for orders.\nMust not be null.","type":"boolean"},"regexMatchingStrategies":{"description":"Regex matching strategies for this merchant payment account.\nMust not be null.","items":{"$ref":"#/components/schemas/configuration.RegexMatchingStrategySelection"},"type":"array"},"underpaymentAssignment":{"deprecated":true,"description":"Are automatic under payment assignments allowed for documents. Replaced by underpaymentAssignmentToDocuments.\nMust not be null.","type":"boolean"},"underpaymentAssignmentToDocuments":{"description":"Are automatic under payment assignments allowed for documents.\nMust not be null.","type":"boolean"},"underpaymentAssignmentToOrders":{"description":"Are automatic under payment assignments allowed for orders.\nMust not be null.","type":"boolean"}},"required":["createdAt","merchantPaymentAccountIdent","regexMatchingStrategies","underpaymentAssignment","overpaymentAssignment","underpaymentAssignmentToDocuments","underpaymentAssignmentToOrders","overpaymentAssignmentToDocuments","overpaymentAssignmentToOrders"],"type":"object"},"configuration.collection.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/configuration.Response"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Assignment configurations","type":"object"},"configuration.regex_matching_strategy.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/configuration.RegexMatchingStrategy"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Regex matching strategies","type":"object"},"outbox.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":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The delete timestamp"},"failures":{"description":"Number of failures.\nMust not be null.","format":"int32","minimum":0,"type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be null.\nSize must be greater than or equal to 1.\nMust match the regular expression ^\\S(.*\\S)?$.","minLength":1,"pattern":"^\\S(.*\\S)?$","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.","type":["string","null"]},"lastFailureMessage":{"description":"Last failure message","type":["string","null"]},"nextRetryAt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The next retry timestamp"},"payload":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"The payload"},"status":{"description":"The status of the outbox entry.\nMust not be null.\nOne of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"statusHistory":{"description":"The status history.\nMust not be null.","items":{"$ref":"#/components/schemas/outbox.StatusHistory"},"type":"array"},"statusTimestamp":{"description":"The timestamp of the last status change.\nMust not be null.","format":"date-time","type":"string"},"tracingAttributes":{"description":"Tracing attributes.\nMust not be null.","type":"object","unevaluatedProperties":{"type":"string"}}},"required":["id","status","statusTimestamp","failures","createdAt","statusHistory","tracingAttributes"],"type":"object"},"outbox.QueueStatus":{"description":"One of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"outbox.StatusHistory":{"description":"Status history entry","properties":{"status":{"description":"The status.\nMust not be null.\nOne 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"},"outbox.entry.PagedResponse":{"allOf":[{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/outbox.OutboxEntryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"}],"description":"Page of Outbox Entries","type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"accounts-receivable-management-read":"","accounts-receivable-management-write":"","internal":"","tenant-management-read":"","tenant-management-write":""},"tokenUrl":"https://api.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"Endpoints to assign payments and configure the assignments","title":"Payment Assignment Service","version":"v2-1.2.6"},"openapi":"3.1.0","paths":{"/v2/merchant-payment-accounts/{merchantPaymentAccountIdent}/assignment-configuration":{"delete":{"description":"Deletes merchant payment account assignment configuration.","operationId":"deletePaymentAssignmentMerchantAccountConfiguration","parameters":[{"description":"Ident of merchant payment account","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.Response"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Delete payment account assignment configurations","tags":["Assignment Configuration"]},"get":{"description":"Retrieves merchant payment account's assignment configuration.","operationId":"getMerchantPaymentAccountAssignmentConfiguration","parameters":[{"description":"Ident of merchant payment account","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.Response"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Retrieve payment account's assignment configuration","tags":["Assignment Configuration"]},"post":{"description":"Creates or updates merchant payment account's payment assignment configuration.","operationId":"createMerchantPaymentAccountAssignmentConfiguration","parameters":[{"description":"Ident of merchant payment account","in":"path","name":"merchantPaymentAccountIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.Request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.Response"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create or update payment account's assignment configurations","tags":["Assignment Configuration"]}},"/v2/payment-assignment-regex-matching-strategies":{"get":{"description":"Search regex matching strategies with RSQL.","operationId":"queryRegexMatchingStrategies","parameters":[{"description":"Use RSQL query language.\nSee: https://aboullaite.me/rsql/.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Must be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100. Must be greater than or equal to 1.","in":"query","name":"size","schema":{"default":10,"minimum":1,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.","in":"query","name":"sort","schema":{"default":"ident","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.regex_matching_strategy.PagedResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["tenant-management-read"]}],"summary":"Query regex matching strategies","tags":["RegexMatchingStrategy"]},"post":{"description":"Creates regular expression payment matching strategy.","operationId":"createRegexMatchingStrategy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.RegexMatchingStrategy"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.RegexMatchingStrategy"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Create regex matching strategy","tags":["RegexMatchingStrategy"]}},"/v2/payment-assignment-regex-matching-strategies/{ident}":{"delete":{"description":"Deletes regular expression payment matching strategy with given ident.","operationId":"deleteRegexMatchingStrategy","parameters":[{"description":"Ident of matching strategy","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Delete regex matching strategy","tags":["RegexMatchingStrategy"]},"put":{"description":"Updates regular expression payment matching strategy with given ident.","operationId":"updateRegexMatchingStrategy","parameters":[{"description":"Ident of matching strategy","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.RegexMatchingStrategyUpdateRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration.RegexMatchingStrategy"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["tenant-management-write"]}],"summary":"Update regex matching strategy","tags":["RegexMatchingStrategy"]}},"/v2/payment-assignments":{"get":{"description":"Search payment assignments with RSQL.","operationId":"queryPaymentAssignment","parameters":[{"description":"Use RSQL query language.\nSee: https://aboullaite.me/rsql/.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Must be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100. Must be greater than or equal to 1.","in":"query","name":"size","schema":{"default":10,"minimum":1,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.","in":"query","name":"sort","schema":{"default":"ident","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/assignment.PagedResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Query payment assignments","tags":["Assignments"]},"post":{"description":"Create manual assignment between a payment and a given entity: DOCUMENT (invoice, credit memo, ...) or ORDER.\n\n        NOTE: When assigning to an order, if the order has exactly one associated document the payment will be assigned to that document instead.","operationId":"createPaymentAssignment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/assignment.Request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/assignment.Response"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Assign Payment","tags":["Assignments"]}},"/v2/payment-assignments/{ident}":{"get":{"description":"Retrieve assignment for given assignment ident.","operationId":"getPaymentAssignment","parameters":[{"description":"Ident of payment assignment","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/assignment.Response"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-read"]}],"summary":"Retrieve payment assignment","tags":["Assignments"]}},"/v2/payment-assignments/{ident}/actions/reverse":{"post":{"description":"Reversing a payment assignment results in recalculating outstanding leftover amount in a payment.","operationId":"reversePaymentAssignment","parameters":[{"description":"Ident of payment assignment","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/assignment.Response"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["accounts-receivable-management-write"]}],"summary":"Reverse payment assignment","tags":["Assignments"]}}},"servers":[{"description":"Instellix Production","url":"https://api.instellix.io"}],"tags":[{"description":"endpoints for RegexMatchingStrategy","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"RegexMatchingStrategy"},{"description":"Assignment Configuration API","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Assignment Configuration"},{"description":"Assignments API","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Assignments"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}