{"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":{"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":{"description":"The payload","nullable":true,"type":"object"},"MonetaryAmountDto":{"description":"A monetary amount along with a currency.","nullable":true,"properties":{"amount":{"description":"The value of this monetary amount in decimal format.\nMust not be null.","example":23.56,"type":"number"},"currency":{"description":"Currency code in three letter ISO-4217 format.\nMust not be null.","enum":["UNDEFINED","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"OutboxEntryResponse":{"description":"Result list.","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.","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"deleteAt":{"description":"The delete timestamp","format":"date-time","nullable":true,"type":"string"},"failures":{"description":"Number of failures","format":"int32","type":"integer"},"id":{"description":"The ID of the outbox entry.\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":{"$ref":"#/components/schemas/JsonNode"},"status":{"description":"The status of the outbox entry.\nMust not be null.","enum":["ENQUEUED","PROCESSING","WAITING","PROCESSED","FAILED"],"type":"string"},"statusHistory":{"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":{"description":"Tracing attributes","type":"string"},"description":"Tracing attributes.\nMust not be null.","type":"object"}},"required":["createdAt","failures","id","status","statusHistory","statusTimestamp","tracingAttributes"],"type":"object"},"OutboxQueryParams":{"properties":{"createdFrom":{"description":"Start timestamp (inclusive) for filtering by the creation time of the outbox entry.","format":"date-time","nullable":true,"type":"string"},"createdTo":{"description":"End timestamp (inclusive) for filtering by the creation time of the outbox entry.","format":"date-time","nullable":true,"type":"string"},"from":{"description":"Start timestamp (inclusive) for filtering outbox entries based on the status timestamp.","format":"date-time","nullable":true,"type":"string"},"to":{"description":"End timestamp (inclusive) for filtering outbox entries based on the status timestamp.","format":"date-time","nullable":true,"type":"string"}},"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"},"PagedResponseAssignment.Response":{"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/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseAttempt.Response":{"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/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"},"PagedResponsePaymentAssignmentConfiguration":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/PaymentAssignmentConfiguration"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseRegexMatchingStrategyConfiguration":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/RegexMatchingStrategyConfiguration"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PaymentAssignmentConfiguration":{"properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"merchantPaymentAccountIdent":{"description":"Ident of the payment account.\nMust not be null.","type":"string"},"overpaymentAssignment":{"default":false,"deprecated":true,"description":"DEPRECATED.\nAre automatic over payment assignments allowed for documents.\nMust not be null.","type":"boolean"},"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":{"description":"Regex matching strategies for this merchant payment account","items":{"$ref":"#/components/schemas/RegexMatchingStrategySelection"},"nullable":true,"type":"array"},"underpaymentAssignment":{"deprecated":true,"description":"DEPRECATED.\nAre automatic under payment assignments allowed.\nMust not be null.","type":"boolean"},"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"}},"required":["createdAt","merchantPaymentAccountIdent","overpaymentAssignment","overpaymentAssignmentToDocuments","overpaymentAssignmentToOrders","underpaymentAssignment","underpaymentAssignmentToDocuments","underpaymentAssignmentToOrders"],"type":"object"},"PaymentAssignmentConfigurationUpdateRequest":{"properties":{"overpaymentAssignment":{"deprecated":true,"description":"DEPRECATED.\nAre automatic over payment assignments for documents allowed.","nullable":true,"type":"boolean"},"overpaymentAssignmentToDocuments":{"default":false,"description":"Are automatic over payment assignments for documents allowed.","type":"boolean"},"overpaymentAssignmentToOrders":{"default":false,"description":"Are automatic over payment assignments for orders allowed.","type":"boolean"},"regexMatchingStrategies":{"description":"Regex matching strategies for this merchant payment account","items":{"$ref":"#/components/schemas/RegexMatchingStrategySelection"},"nullable":true,"type":"array"},"underpaymentAssignment":{"deprecated":true,"description":"DEPRECATED.\nAre automatic under payment assignments allowed.","nullable":true,"type":"boolean"},"underpaymentAssignmentToDocuments":{"default":false,"description":"Are automatic under payment assignments for documents allowed.","type":"boolean"},"underpaymentAssignmentToOrders":{"default":true,"description":"Are automatic under payment assignments for orders allowed.","type":"boolean"}},"type":"object"},"RegexMatchingStrategyConfiguration":{"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"},"ident":{"description":"Unique ident of the matching strategy.\nMust have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.","maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"regexPattern":{"description":"Specifies the regular expression that we will try to find in payment description.\nMust not be empty.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"targetIdentPattern":{"description":"If specified, this will be used instead of the regular expression's match to search for the ident. Supports referencing capture groups, e.g. `$123` or `${name}` and `$` can be escaped with `\\$`.\nExample:\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\nTherefor the payment would be assigned to an invoice with ident `01234567-89`.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"targetIdentType":{"description":"Type of the assignment target ident, i.e. is it the ident of an `ORDER` or the ident of a `DOCUMENT`.\n\n**NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments, as for the ident of orders with a single associated document the payment will be assigned to the document instead.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| DOCUMENT |\n| ORDER    |","type":"string"}},"required":["ident","regexPattern","targetIdentType"],"type":"object"},"RegexMatchingStrategySelection":{"description":"Regex matching strategies for this merchant payment account","nullable":true,"properties":{"ident":{"description":"Must not be blank.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","minLength":1,"type":"string"},"priority":{"description":"The priority of the matching strategy selection.\nMust not be null.","format":"int64","type":"integer"}},"required":["ident","priority"],"type":"object"},"RegexMatchingStrategyUpdateRequest":{"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"},"regexPattern":{"description":"Specifies the regular expression that we will try to find in payment description.\nMust not be empty.\nSize must be between 0 and 255.","maxLength":255,"type":"string"},"targetIdentPattern":{"description":"If specified, this will be used instead of the regular expression's match to search for the ident. Supports referencing capture groups, e.g. `$123` or `${name}` and `$` can be escaped with `\\$`.\nExample:\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\nTherefor the payment would be assigned to an invoice with ident `01234567-89`.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"targetIdentType":{"description":"Type of the assignment target ident, i.e. is it the ident of an `ORDER` or the ident of a `DOCUMENT`.\n\n**NOTE:** This does not necessarily need to be the actual `targetType` of the resulting assignments, as for the ident of orders with a single associated document the payment will be assigned to the document instead.\nMust not be null.\nMust be one of:\n|          |\n| -------- |\n| DOCUMENT |\n| ORDER    |","type":"string"}},"required":["regexPattern","targetIdentType"],"type":"object"},"StatusHistory":{"description":"The status history","properties":{"status":{"description":"The status","enum":["ENQUEUED","PROCESSING","WAITING","PROCESSED","FAILED"],"type":"string"},"timestamp":{"description":"The timestamp when the status occurred","format":"date-time","type":"string"}},"required":["status","timestamp"],"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":{"$ref":"#/components/schemas/MonetaryAmountDto"},"ident":{"description":"Unique ident of the payment assignment.\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"},"paymentBatchItemIdent":{"description":"Ident of the payment transaction batch item","nullable":true,"type":"string"},"paymentIdent":{"description":"Ident of the payment transaction.\nMust not be null.\nMust not be blank.","minLength":1,"type":"string"},"targetIdent":{"description":"Ident of the assignment target, i.e. document or order ident.\nMust not be null.\nMust not be blank.","minLength":1,"type":"string"},"targetIdentType":{"description":"Must not be null.\nMust be one of:\n|          |\n| -------- |\n| DOCUMENT |\n| ORDER    |","type":"string"}},"required":["ident","paymentIdent","targetIdent","targetIdentType"],"type":"object"},"assignment.Response":{"description":"Payment Assignment","properties":{"amount":{"$ref":"#/components/schemas/MonetaryAmountDto"},"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":{"description":"Indicates if value is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","type":"string"},"ident":{"description":"Unique ident of the payment assignment.\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"},"origin":{"description":"Indicates if an assignment was made automatically by Nitrobox or as a manual REST API request.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| MANUAL    |\n| AUTOMATED |","type":"string"},"paymentBatchItemIdent":{"description":"Ident of the payment transaction batch item","nullable":true,"type":"string"},"paymentIdent":{"description":"Ident of the payment transaction.\nMust not be null.\nMust not be blank.","minLength":1,"type":"string"},"paymentIntentIdent":{"description":"Ident of the payment intent","nullable":true,"type":"string"},"reversedAt":{"description":"If this assignment was reversed, the timestamp of the reversal.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"Specifies if an assignment is assigned or reversed.\nMust not be null.\nMust be one 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.\nMust not be blank.","minLength":1,"type":"string"},"targetType":{"description":"Type of the assignment target.\nMust not be null.\nMust be 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"}},"required":["amount","beforeSettlement","createdAt","creditDebitIndicator","ident","origin","paymentIdent","paymentIntentIdent","reversedAt","status","targetIdent","targetType"],"type":"object"},"assignment_register.Assignment":{"description":"A assignment","properties":{"ident":{"description":"Must 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":["ident"],"type":"object"},"assignment_register.Response":{"description":"A assignment register which accumulates all assignments for a payment transaction","properties":{"assigned":{"$ref":"#/components/schemas/MonetaryAmountDto"},"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":{"description":"The ident of the assignment register corresponds to the ident of the payment transaction.\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"},"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":{"$ref":"#/components/schemas/MonetaryAmountDto"},"paymentAssignmentStatus":{"description":"Assignment status of the payment.\nMust not be null.\nMust be one of:\n|                     |\n| ------------------- |\n| UNASSIGNED          |\n| PARTIALLY_ASSIGNED  |\n| COMPLETELY_ASSIGNED |","type":"string"}},"required":["assigned","assignments","createdAt","ident","lastModifiedAt","leftOver","paymentAssignmentStatus"],"type":"object"},"attempt.Response":{"description":"Assignment attempt","properties":{"assignmentOrigin":{"description":"Must be one of:\n|           |\n| --------- |\n| MANUAL    |\n| AUTOMATED |","nullable":true,"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":"Must 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"},"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":{"description":"Must 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,"nullable":true,"pattern":"[a-zA-Z0-9_.~-]{1,100}","type":"string"},"paymentIdent":{"description":"Must 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"},"result":{"description":"Must not be null.\nMust be one of:\n|            |\n| ---------- |\n| ASSIGNED   |\n| UNASSIGNED |","type":"string"},"targetIdent":{"description":"Must not be null.","type":"string"},"targetType":{"description":"Must not be null.\nMust be one of:\n|          |\n| -------- |\n| DOCUMENT |\n| ORDER    |","type":"string"}},"required":["assignmentOrigin","createdAt","ident","lastModifiedAt","paymentBatchItemIdent","paymentIdent","result","targetIdent","targetType"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-accounts-receivable-management-read":"Scope nbx-accounts-receivable-management-read","nbx-accounts-receivable-management-write":"Scope nbx-accounts-receivable-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 Payment Assignment","title":"Payment Assignment API","version":"v2-preview-0.212.10"},"openapi":"3.0.1","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":{"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":"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/PaymentAssignmentConfiguration"}}},"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":"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/PaymentAssignmentConfigurationUpdateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentAssignmentConfiguration"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Create or update 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. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==client123","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseRegexMatchingStrategyConfiguration"}}},"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":"Query regex matching strategies","tags":["Assignment Configuration"]},"post":{"description":"Creates regular expression payment matching strategy.","operationId":"createRegexMatchingStrategy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegexMatchingStrategyConfiguration"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegexMatchingStrategyConfiguration"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Create regex matching strategy","tags":["Assignment Configuration"]}},"/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":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Delete regex matching strategy","tags":["Assignment Configuration"]},"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/RegexMatchingStrategyUpdateRequest"}}},"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":"Update regex matching strategy","tags":["Assignment Configuration"]}},"/v2/payment-assignments":{"get":{"description":"Search payment assignments with RSQL.","operationId":"queryPaymentAssignment","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"status==ASSIGNED","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 10.","in":"query","name":"size","schema":{"default":10,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'asc'.\nDefault sorting criteria: 'ident'.","in":"query","name":"sort","schema":{"default":["ident"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAssignment.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-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.\n","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":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-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.\nMust not be null.","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":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-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.\nMust not be null.","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":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounts-receivable-management-write"]}],"summary":"Reverse payment assignment","tags":["Assignments"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}