{"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"},"MinimalOposCaseDto":{"description":"Opos case contains containing only the base information.","properties":{"amountDue":{"description":"The amount due differs from the balance as it doesn't take documents With document_reason CORRECTION into account.\n    It's about the amount that should be charged or refunded to balance the opos - even if it is in a temporary correction state.\n    Use amountDueDebitCreditIndicator to determine if this amountDue is debit or credit.\nMust not be null.","type":"number"},"amountDueDebitCreditIndicator":{"description":"Indicates if amountDue is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"amountPrebooked":{"description":"Sum of prebooked items. Use amountPrebookedDebitCreditIndicator to determine if it is debit or credit.\nMust not be null.","type":"number"},"amountPrebookedDebitCreditIndicator":{"description":"Indicates if amountPrebooked is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"balance":{"description":"Current sum of all assignments. Debit assignments increase the amount and credit assignments decrease it.\nUsage of +/- sign to determine if this balance is debit or credit is deprecated and discouraged but kept for backwards compatibility.\nUse balanceDebitCreditIndicator instead.\nMust not be null.","type":"number"},"balanceDebitCreditIndicator":{"description":"Indicates if balance is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","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"},"creditSum":{"description":"Current sum of all credit assignments.\nMust not be null.","type":"number"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","example":"EUR","type":"string"},"customerIdent":{"description":"Ident of the customer of the document. Please change to customerIdent.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"debitSum":{"description":"Current sum of all debit assignments.\nMust not be null.","type":"number"},"ident":{"description":"Ident of this opos case.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"initialDocumentIdent":{"description":"Ident of the document that opened this case.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","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"},"referenceDocumentIdent":{"description":"Ident of the last referenced non-correction document . e.g. invoice, deposit-invoice, self-billing-invoice.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"},"status":{"description":"Current status of the case. Either BALANCED or UNBALANCED.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| BALANCED   |\n| UNBALANCED |","example":"UNBALANCED","type":"string"}},"required":["amountDue","amountDueDebitCreditIndicator","amountPrebooked","amountPrebookedDebitCreditIndicator","balance","balanceDebitCreditIndicator","createdAt","creditSum","currency","customerIdent","debitSum","ident","initialDocumentIdent","lastModifiedAt","referenceDocumentIdent","status"],"type":"object"},"MonetaryAmountDto":{"description":"A monetary amount along with a currency.","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"},"OposCaseActiveDocumentDto":{"description":"List of all active/uncancelled documents for this opos case. Meaning the latest invoice/selfbilling-invoice/deposit-invoice and its children.","properties":{"ident":{"description":"Ident of the document.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"},"items":{"default":[],"description":"Business segment idents of the document.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCaseDocumentItemDto"},"type":"array"},"orderIndex":{"description":"Order of the entry creation. Starting at 0.\nMust not be null.","format":"int32","type":"integer"},"type":{"description":"Type of the document.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CORRECTION      |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |","type":"string"}},"required":["ident","items","orderIndex","type"],"type":"object"},"OposCaseAssignmentDto":{"description":"List of all documents and payments related to this case.","properties":{"amount":{"description":"Amount of this assignment.\nMust not be null.","type":"number"},"creationDate":{"description":"Creation date of this assignment.\nMust not be null.","format":"date-time","type":"string"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Indicates if value is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"ident":{"description":"Ident of the assignment.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"paymentAssignmentIdent":{"description":"Ident of the assignment of a payment, otherwise null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"reason":{"description":"The reason this assignment was created.\nMust not be null.\nMust be one of:\n|                                               |\n| --------------------------------------------- |\n| CANCELLATION                                  |\n| CORRECTION                                    |\n| DECISION                                      |\n| DEPOSIT                                       |\n| DEPOSIT_CORRECTION                            |\n| DOCUMENT_CREATION                             |\n| PAYMENT_ASSIGNMENT                            |\n| PAYMENT_ASSIGNMENT_REVERSAL                   |\n| PAYMENT_ASSIGNMENT_BEFORE_SETTLEMENT          |\n| PAYMENT_ASSIGNMENT_REVERSAL_BEFORE_SETTLEMENT |\n| CHARGEBACK_FEE_ASSIGNMENT                     |\n| CHARGEBACK_FEE_ASSIGNMENT_REVERSAL            |\n| CHARGEBACK_FEE_CANCELLATION                   |\n| ISSUED_DUNNING                                |\n| ISSUED_DUNNING_FEE_CANCELLATION               |\n| UNKNOWN                                       |","type":"string"},"sourceIdent":{"description":"Ident of the assignment source.\nMust not be null.","type":"string"},"sourceType":{"description":"Type of the source assignment.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| INVOICE                         |\n| CREDIT_MEMO                     |\n| ORDER                           |\n| DEPOSIT_INVOICE                 |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |\n| PAYMENT                         |\n| OPOS_CASE_DECISION              |\n| ISSUED_DUNNING_FEE              |\n| UNKNOWN                         |","type":"string"},"targetIdent":{"description":"Ident of the assignment target.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"},"targetType":{"description":"Type of the assignment target.\nMust not be null.\nMust be one of:\n|                                 |\n| ------------------------------- |\n| ORDER                           |\n| CONTRACT                        |\n| INVOICE                         |\n| PAYMENT                         |\n| CREDIT_MEMO                     |\n| DEPOSIT_INVOICE                 |\n| CREDIT_MEMO_GOODWILL            |\n| CREDIT_MEMO_WARRANTY            |\n| DEPOSIT_INVOICE_CANCELLATION    |\n| SELF_BILLING_INVOICE            |\n| SELF_BILLING_INVOICE_CORRECTION |\n| OPOS_CASE                       |\n| UNKNOWN                         |","type":"string"}},"required":["amount","creationDate","currency","debitCreditIndicator","ident","reason","sourceIdent","sourceType","targetIdent","targetType"],"type":"object"},"OposCaseClearingDefinitionDto":{"description":"OPOS Case Clearing Definition","properties":{"currency":{"description":"Used currency of the OPOS cases.\nMust not be null.","example":"EUR","type":"string"},"debitCreditIndicator":{"description":"Indicates if the clearing is for debit or credit OPOS case balances.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"overdue":{"description":"Determines whether only overdue differences or all differences should be cleared.\nMust not be null.","example":true,"type":"boolean"},"thresholdAmount":{"description":"Threshold until which automatic clearing will occur, including this amount.\nMust not be null.\nMust be greater than or equal to 0.","example":1,"exclusiveMinimum":true,"minimum":0,"type":"number"}},"required":["currency","debitCreditIndicator","overdue","thresholdAmount"],"type":"object"},"OposCaseClearingRunCreationRequest":{"description":"Creation Request for an OPOS Case Clearing Run","properties":{"definition":{"$ref":"#/components/schemas/OposCaseClearingDefinitionDto"},"ident":{"description":"Ident of this clearing run.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},"required":["definition","ident"],"type":"object"},"OposCaseClearingRunItemResponse":{"description":"OPOS Case Clearing Run Item","properties":{"clearedAmount":{"description":"Amount cleared by this clearing run item.\nMust not be null.","example":56.5,"type":"number"},"clearedAmountDebitCreditIndicator":{"description":"Indicates if the cleared amount is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"CREDIT","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"},"definition":{"$ref":"#/components/schemas/OposCaseClearingDefinitionDto"},"ident":{"description":"Ident of this clearing run item.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","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"},"oposCase":{"$ref":"#/components/schemas/MinimalOposCaseDto"},"oposCaseClearingRunIdent":{"description":"Ident of the related OPOS case clearing run.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"oposCaseDecisionIdent":{"description":"Ident of the related OPOS case decision.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"oposCaseDecisionReversalIdent":{"description":"Optional Ident of the related reversal OPOS case decision.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"status":{"description":"Status of this clearing run item.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| PLANNED   |\n| SKIPPED   |\n| PROCESSED |\n| REVERSED  |\n| ERROR     |","example":"PLANNED","type":"string"},"statusInformation":{"description":"Optional additional information regarding the current status.","nullable":true,"type":"string"}},"required":["clearedAmount","clearedAmountDebitCreditIndicator","createdAt","definition","ident","lastModifiedAt","oposCase","oposCaseClearingRunIdent","oposCaseDecisionIdent","status"],"type":"object"},"OposCaseClearingRunResponse":{"description":"OPOS Case Clearing Run","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"},"definition":{"$ref":"#/components/schemas/OposCaseClearingDefinitionDto"},"ident":{"description":"Ident of this clearing run.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","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"},"result":{"$ref":"#/components/schemas/OposCaseClearingRunResultDto"},"status":{"description":"Status of this clearing run.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| PREPARING |\n| RUNNING   |\n| DONE      |\n| REVERSING |\n| REVERSED  |","example":"RUNNING","type":"string"}},"required":["createdAt","definition","ident","lastModifiedAt","result","status"],"type":"object"},"OposCaseClearingRunResultDto":{"description":"OPOS Case Clearing Run results. All numerical values are initialized with 0 and can change during the lifecycle of the clearing run.","properties":{"currencyOfClearedAmounts":{"description":"Currency of cleared amounts.\nMust not be null.","example":"EUR","type":"string"},"errorClearings":{"description":"Clearings in this clearing run the ran into an error. Maybe needs manual handling.\nMust not be null.","example":15,"format":"int64","type":"integer"},"plannedClearings":{"description":"Currently planned clearings in this clearing run. When the run is finished this value is 0.\nMust not be null.","example":5,"format":"int64","type":"integer"},"processedClearings":{"description":"Processed clearings in this clearing run. OPOS case decision were successfully created.\nMust not be null.","example":60,"format":"int64","type":"integer"},"reversedClearings":{"description":"Amount of clearing that were reverted afterwards.\nMust not be null.","example":0,"format":"int64","type":"integer"},"skippedClearings":{"description":"Skipped clearings in this clearing run. If the definition is not matching anymore, due to other processes changing the OPOS case.\nMust not be null.","example":20,"format":"int64","type":"integer"},"totalClearings":{"description":"Total amount of clearings in this clearing run.\nMust not be null.","example":100,"format":"int64","type":"integer"},"totalOfClearedAmounts":{"description":"Sum of the amount cleared by this clearing run.\nMust not be null.","example":56.5,"type":"number"},"totalOfClearedAmountsDebitCreditIndicator":{"description":"Indicates if the sum of cleared amounts is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"CREDIT","type":"string"}},"required":["currencyOfClearedAmounts","errorClearings","plannedClearings","processedClearings","reversedClearings","skippedClearings","totalClearings","totalOfClearedAmounts","totalOfClearedAmountsDebitCreditIndicator"],"type":"object"},"OposCaseDecisionCreationDto":{"description":"Request to create a Decision","properties":{"amount":{"description":"The amount becomes mandatory if any active prebooked item exists on the opos case. Otherwise the balance of the opos case is used as amount.\nMust be greater than or equal to 0.","minimum":0,"nullable":true,"type":"number"},"ident":{"description":"Unique ident of this opos case decision.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"note":{"description":"Optional note attached to this decision.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"type":{"description":"Type of this decision. Not all decisions are always available,\n        depending on the balanceDebitCreditIndicator of the OposCase.\n\n        For `DEBIT`:\n        - `UNCOLLECTABLE_RECEIVABLE`\n        - `DOUBTFUL_RECEIVABLE`\n        - `DISCOUNT`\n        - `CASH_DISCOUNT`\n        - `BANK_FEE`\n        - `EXTERNAL_CLOSED`\n\n        For `CREDIT`:\n        - `OTHER_REVENUE`\n        - `EXTERNAL_CLOSED`\n\nMust not be null.\nMust be one of:\n|                          |\n| ------------------------ |\n| UNCOLLECTABLE_RECEIVABLE |\n| DOUBTFUL_RECEIVABLE      |\n| DISCOUNT                 |\n| OTHER_REVENUE            |\n| CASH_DISCOUNT            |\n| BANK_FEE                 |\n| EXTERNAL_CLOSED          |","type":"string"}},"required":["ident","type"],"type":"object"},"OposCaseDecisionDto":{"description":"Decision to modify an OPOS Case.","properties":{"amount":{"$ref":"#/components/schemas/MonetaryAmountDto"},"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"},"debitCreditIndicator":{"description":"Indicates if the amount is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"ident":{"description":"Unique ident of this opos case decision.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"note":{"description":"Optional note attached to this decision.\nSize must be between 0 and 255.","maxLength":255,"nullable":true,"type":"string"},"oposCaseClearingRunIdent":{"description":"If filled the Decision was created by a clearing run. The given ident relates to a specific clearing run.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"oposCaseClearingRunItemIdent":{"description":"If filled the Decision was created by a clearing run. The given ident relates to a specific Item in the clearing run.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"oposCaseIdent":{"description":"Unique ident of the related OPOS case.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"reversionTargetIdent":{"description":"OposCaseDecision that was reverted with this decision. Only filled if type is REVERSION.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"reversionTargetType":{"description":"Type of the OposCaseDecision that was reverted with this decision. Only filled if type is REVERSION.\nMust be one of:\n|                          |\n| ------------------------ |\n| UNCOLLECTABLE_RECEIVABLE |\n| DOUBTFUL_RECEIVABLE      |\n| DISCOUNT                 |\n| OTHER_REVENUE            |\n| REVERSION                |\n| CASH_DISCOUNT            |\n| BANK_FEE                 |\n| EXTERNAL_CLOSED          |","nullable":true,"type":"string"},"reverted":{"description":"Indicates if this decision was reverted.\nMust not be null.","type":"boolean"},"type":{"description":"Type of this decision. Not all decisions are always available, depending on the balanceDebitCreditIndicator of the OposCase.\n\n     For `DEBIT`:\n     - `UNCOLLECTABLE_RECEIVABLE`\n     - `DOUBTFUL_RECEIVABLE`\n     - `DISCOUNT`\n     - `CASH_DISCOUNT`\n     - `BANK_FEE`\n     - `EXTERNAL_CLOSED`\n\n     For `CREDIT`:\n     - `OTHER_REVENUE`\n     - `EXTERNAL_CLOSED`\n\n     Additionally it can be `REVERSION` in case this decision reverses\n     another decision, which will be referenced in `reversionTargetIdent`.\nMust not be null.\nMust be one of:\n|                          |\n| ------------------------ |\n| UNCOLLECTABLE_RECEIVABLE |\n| DOUBTFUL_RECEIVABLE      |\n| DISCOUNT                 |\n| OTHER_REVENUE            |\n| REVERSION                |\n| CASH_DISCOUNT            |\n| BANK_FEE                 |\n| EXTERNAL_CLOSED          |","type":"string"}},"required":["amount","createdAt","debitCreditIndicator","ident","oposCaseIdent","reverted","type"],"type":"object"},"OposCaseDecisionReversionDto":{"description":"Request for Decision Reversion","properties":{"ident":{"description":"Unique Decision ident that shall be used for the reversal.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},"required":["ident"],"type":"object"},"OposCaseDocumentItemDto":{"description":"Business segment idents of the document.","properties":{"businessSegmentIdent":{"description":"Identifier of the business segment.","nullable":true,"type":"string"},"ident":{"description":"identifier of the product.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"}},"required":["ident"],"type":"object"},"OposCaseDto":{"description":"Opos case contains all related documents and payments with their amounts.","properties":{"activeDocuments":{"default":[],"description":"List of all active/uncancelled documents for this opos case. Meaning the latest invoice/selfbilling-invoice/deposit-invoice and its children.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCaseActiveDocumentDto"},"type":"array"},"amountDue":{"description":"The amount due differs from the balance as it doesn't take documents With document_reason CORRECTION into account.\n    It's about the amount that should be charged or refunded to balance the opos - even if it is in a temporary correction state.\n    Use amountDueDebitCreditIndicator to determine if this amountDue is debit or credit.\nMust not be null.","type":"number"},"amountDueDebitCreditIndicator":{"description":"Indicates if amountDue is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"amountPrebooked":{"description":"Sum of prebooked items. Use amountPrebookedDebitCreditIndicator to determine if it is debit or credit.\nMust not be null.","type":"number"},"amountPrebookedDebitCreditIndicator":{"description":"Indicates if amountPrebooked is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"assignments":{"default":[],"description":"List of all documents and payments related to this case.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCaseAssignmentDto"},"type":"array"},"balance":{"description":"Current sum of all assignments. Debit assignments increase the amount and credit assignments decrease it.\nUsage of +/- sign to determine if this balance is debit or credit is deprecated and discouraged but kept for backwards compatibility.\nUse balanceDebitCreditIndicator instead.\nMust not be null.","type":"number"},"balanceDebitCreditIndicator":{"description":"Indicates if balance is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","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"},"creationDate":{"deprecated":true,"description":"DEPRECATED","format":"date-time","nullable":true,"type":"string"},"creditSum":{"description":"Current sum of all credit assignments.\nMust not be null.","type":"number"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","example":"EUR","type":"string"},"customerIdent":{"description":"Ident of the customer of the document. Please change to customerIdent.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"customerPaymentAccountIdent":{"description":"Used customer payment account for payment collection. Only filled if paymentCollectionStatus is not DISABLED.","nullable":true,"type":"string"},"debitSum":{"description":"Current sum of all debit assignments.\nMust not be null.","type":"number"},"debtorIdent":{"deprecated":true,"description":"DEPRECATED","nullable":true,"type":"string"},"dunning":{"$ref":"#/components/schemas/OposCaseDunningDto"},"ident":{"description":"Ident of this opos case.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"initialDocumentIdent":{"description":"Ident of the document that opened this case.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"},"lastModified":{"deprecated":true,"description":"DEPRECATED","format":"date-time","nullable":true,"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"},"paymentCollectionStatus":{"description":"Current status of the payment collection. Can be null for legacy cases, will be migrated soon.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| INITIATED |\n| ENABLED   |\n| DISABLED  |\n| SUSPENDED |","example":"ENABLED","type":"string"},"prebookedItems":{"default":[],"description":"List of all prebooked items for this opos case.\nMust not be null.","items":{"$ref":"#/components/schemas/OposCasePrebookedItemDto"},"type":"array"},"referenceDocumentIdent":{"description":"Ident of the last referenced non-correction document . e.g. invoice, deposit-invoice, self-billing-invoice.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"},"status":{"description":"Current status of the case. Either BALANCED or UNBALANCED.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| BALANCED   |\n| UNBALANCED |","example":"UNBALANCED","type":"string"}},"required":["activeDocuments","amountDue","amountDueDebitCreditIndicator","amountPrebooked","amountPrebookedDebitCreditIndicator","assignments","balance","balanceDebitCreditIndicator","createdAt","creditSum","currency","customerIdent","debitSum","dunning","ident","initialDocumentIdent","lastModifiedAt","paymentCollectionStatus","prebookedItems","referenceDocumentIdent","status"],"type":"object"},"OposCaseDunningBlockDto":{"description":"An object that sets up the dunning block for a specific document. It includes details on whether the block is active and the reason for its setup.","properties":{"active":{"description":"A boolean value indicating whether a dunning block for the document is active {true} or not {false}.\nMust not be null.","type":"boolean"},"note":{"description":"An optional field containing a string that describes the reason or provides additional information about the dunning block.\nSize must be between 0 and 100.","maxLength":100,"nullable":true,"type":"string"},"origin":{"description":"The origin of the dunning block.\nMust be one of:\n|           |\n| --------- |\n| DEBTOR    |\n| OPOS_CASE |","nullable":true,"type":"string"}},"required":["active","note","origin"],"type":"object"},"OposCaseDunningBlockRequest":{"description":"Request body to update the OPOS case dunning block state.","properties":{"active":{"description":"A boolean value indicating whether a dunning block for the document is active {true} or not {false}.\nMust not be null.","type":"boolean"},"note":{"description":"An optional field containing a string that describes the reason or provides additional information about the dunning block.\nSize must be between 0 and 100.","maxLength":100,"nullable":true,"type":"string"}},"required":["active"],"type":"object"},"OposCaseDunningDto":{"description":"Current state and information of dunning. Has information related to dunning block","properties":{"dunningBlock":{"$ref":"#/components/schemas/OposCaseDunningBlockDto"}},"required":["dunningBlock"],"type":"object"},"OposCaseEnablePaymentCollectionRequest":{"description":"Request body to enable payment collection.","properties":{"customerPaymentAccountIdent":{"description":"The Customer payment account used for payment collection. `null` if current customer payment account should be used.","nullable":true,"type":"string"}},"type":"object"},"OposCasePrebookedItemDto":{"description":"List of all prebooked items for this opos case.","properties":{"active":{"description":"Is the prebooked item still active.\nMust not be null.","type":"boolean"},"amount":{"description":"Amount of this prebooked item.\nMust not be null.","type":"number"},"currency":{"description":"Currency code. Three letters ISO-4217 format.\nMust not be null.","example":"EUR","type":"string"},"deactivationReason":{"description":"Reason for the change from active = true to active = false. Only set if active is false.\nMust be one of:\n|                                               |\n| --------------------------------------------- |\n| PAYMENT_INTENT_CANCELLED                      |\n| PAYMENT_INTENT_FAILED_LAST_ATTEMPT            |\n| PAYMENT_ASSIGNMENT                            |\n| PAYMENT_ASSIGNMENT_REVERSAL_BEFORE_SETTLEMENT |","nullable":true,"type":"string"},"debitCreditIndicator":{"description":"Indicates if value is debit or credit.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| DEBIT  |\n| CREDIT |","example":"DEBIT","type":"string"},"documentIdent":{"description":"Ident of the prebooked item's document.\nMust not be null.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~/ -]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~/ -]*$","type":"string"},"paymentAssignmentIdent":{"description":"Ident of the prebooked item's payment assignment.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"paymentIntentIdent":{"description":"Ident of the prebooked item's payment intent.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"paymentIntentStatus":{"description":"Status of the prebooked item's payment intent.\nMust be one of:\n|             |\n| ----------- |\n| CREATED     |\n| IN_PROGRESS |\n| RETRY       |\n| FAILED      |\n| SUBMITTED   |\n| CANCELLED   |\n| PROCESSED   |","nullable":true,"type":"string"},"paymentIntentStatusTimestamp":{"description":"Timestamp of the prebooked item's payment intent status.","format":"date-time","nullable":true,"type":"string"},"paymentTransactionBatchItemIdent":{"description":"Ident of the prebooked item's payment transaction batch item.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"},"paymentTransactionIdent":{"description":"Ident of the prebooked item's payment transaction.\nSize must be between 1 and 100.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.","example":"613c060c-52bc-472e-bb2f-16cd431fef7b","maxLength":100,"minLength":1,"nullable":true,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},"required":["active","amount","currency","debitCreditIndicator","documentIdent","paymentAssignmentIdent","paymentIntentIdent","paymentIntentStatus","paymentIntentStatusTimestamp","paymentTransactionBatchItemIdent","paymentTransactionIdent"],"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"},"PagedResponseOposCaseClearingRunItemResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseClearingRunItemResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOposCaseClearingRunResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseClearingRunResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOposCaseDecisionDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseDecisionDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"PagedResponseOposCaseDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OposCaseDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"required":["_embedded","page"],"type":"object"},"SummarizedOposDecisionDto":{"description":"Summarized Opos Case Decision","properties":{"creditAmount":{"description":"credit total for item.\nMust not be null.","example":2000,"type":"number"},"debitAmount":{"description":"debit total for item.\nMust not be null.","example":2000,"type":"number"},"totalCount":{"description":"total count of item.\nMust not be null.","example":200,"format":"int64","type":"integer"},"type":{"description":"Type of decision.\nMust not be null.\nMust be one of:\n|                          |\n| ------------------------ |\n| UNCOLLECTABLE_RECEIVABLE |\n| DOUBTFUL_RECEIVABLE      |\n| DISCOUNT                 |\n| OTHER_REVENUE            |\n| REVERSION                |\n| CASH_DISCOUNT            |\n| BANK_FEE                 |\n| EXTERNAL_CLOSED          |","type":"string"}},"required":["creditAmount","debitAmount","totalCount","type"],"type":"object"},"SummarizedOposDecisionResult":{"description":"Structure representing a summarized result containing values and totals","properties":{"creditTotalAmount":{"description":"The total credit amount over all items.\nMust not be null.","example":2000,"type":"number"},"currency":{"description":"The currency used for all amount field in the response.\nMust not be null.","example":"EUR","type":"string"},"debitTotalAmount":{"description":"The total debit amount over all items.\nMust not be null.","example":2000,"type":"number"},"values":{"default":[],"description":"Lists all values that have been summarized.\nMust not be null.","items":{"$ref":"#/components/schemas/SummarizedOposDecisionDto"},"type":"array"}},"required":["creditTotalAmount","currency","debitTotalAmount","values"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"accounts-receivable-management-read":"Scope accounts-receivable-management-read","accounts-receivable-management-write":"Scope accounts-receivable-management-write","internal":"Scope internal"},"tokenUrl":"https://api.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for opos cases","title":"Opos Case API","version":"v2-0.44.3"},"openapi":"3.0.1","paths":{"/v2/opos-case-clearing-runs":{"get":{"description":"Get a list of clearing runs. To reduce the result set, please use the RSQL query.","operationId":"getOposCaseClearingRuns","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"status==DONE","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOposCaseClearingRunResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Clearing Run","tags":["Clearing Runs"]},"post":{"description":"Add a clearing run to balance open OPOS Cases","operationId":"addOposCaseClearingRun","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunCreationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunResponse"}}},"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":["accounts-receivable-management-write"]}],"summary":"Add Clearing Run","tags":["Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}":{"get":{"description":"Get a specific clearing run by its ident","operationId":"getOposCaseClearingRun","parameters":[{"description":"Ident of a OPOS Case Clearing run.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"clearingRunIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve Clearing Run","tags":["Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}/actions/reverse":{"post":{"description":"Reverse a created clearing run in status DONE.","operationId":"reverseOposCaseClearingRun","parameters":[{"description":"Ident of a OPOS Case Clearing run.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"clearingRunIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","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":["accounts-receivable-management-write"]}],"summary":"Reverse Clearing Run","tags":["Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}/items":{"get":{"description":"Get a list of clearing run items. To reduce the result set, please use the RSQL query.","operationId":"getOposCaseClearingRunItems","parameters":[{"description":"Ident of a OPOS Case Clearing run.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"clearingRunIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"status==PLANNED","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOposCaseClearingRunItemResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Clearing Run Items","tags":["Clearing Runs"]}},"/v2/opos-case-clearing-runs/{clearingRunIdent}/items/{clearingRunItemIdent}":{"get":{"description":"Get a specific clearing run item by its ident","operationId":"getOposCaseClearingRunItem","parameters":[{"description":"Ident of a OPOS Case Clearing run.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"clearingRunIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},{"description":"Ident of an OPOS Case Clearing run item.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"clearingRunItemIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseClearingRunItemResponse"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve Clearing Run Item","tags":["Clearing Runs"]}},"/v2/opos-case-decisions":{"get":{"description":"Get a list of decisions. To reduce the result set, please use the RSQL query.","operationId":"queryOposCaseDecisions","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"type==OTHER_REVENUE","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOposCaseDecisionDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Decisions","tags":["OPOS Cases"]}},"/v2/opos-cases":{"get":{"description":"Get a list of all OPOS cases for this tenant. To reduce the result set, please use the RSQL query.","operationId":"getOposCases","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"balance==0","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":20,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["initialDocumentIdent,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOposCaseDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query OPOS Cases","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}":{"get":{"description":"Get a specific OPOS case by its ident.","operationId":"getOposCase","parameters":[{"description":"Ident of the OPOS case.","in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/actions/enable-payment-collection":{"post":{"description":"Manual enabling of the payment collection of an OPOS Case.","operationId":"enableOposCasePaymentCollection","parameters":[{"description":"Ident of the OPOS case.","in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseEnablePaymentCollectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Enable OposCase payment collection","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/decisions":{"get":{"description":"Get a list of decisions for this OPOS Case. To reduce the result set, please use the RSQL query.","operationId":"getOposCaseDecisions","parameters":[{"description":"Ident of the OPOS case.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"oposCaseIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"type==OTHER_REVENUE","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..N).\nMust be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"The size of the page to be returned.\nMust be greater than or equal to 1.","in":"query","name":"size","schema":{"default":100,"minimum":1,"type":"integer"}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","schema":{"default":["ident,ASC"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseOposCaseDecisionDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Decisions for OPOS Cases","tags":["OPOS Cases"]},"post":{"description":"Add a decision to an OPOS Case","operationId":"addOposCaseDecision","parameters":[{"description":"Ident of the OPOS case.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"oposCaseIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionCreationDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Add Decision for OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/decisions/{decisionIdent}":{"get":{"description":"Get a specific decision by its ident","operationId":"getOposCaseDecision","parameters":[{"description":"Ident of the OPOS case.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"oposCaseIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},{"description":"Ident of the OPOS Case Decision.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"decisionIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionDto"}}},"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":["accounts-receivable-management-read"]}],"summary":"Retrieve Decision for OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/decisions/{decisionIdent}/revert":{"post":{"description":"Revert a specific decision by its ident","operationId":"revertOposCaseDecision","parameters":[{"description":"Ident of the OPOS case.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"oposCaseIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}},{"description":"Ident of the OPOS Case Decision.\nMust match with the regular expression '^[a-zA-Z0-9_.~-]*$'.\nSize must be between 1 and 100.","in":"path","name":"decisionIdent","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_.~-]*$","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionReversionDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDecisionDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Revert a Decision for OPOS Case","tags":["OPOS Cases"]}},"/v2/opos-cases/{oposCaseIdent}/dunning-block":{"put":{"description":"Activation or Deactivation of opos case dunning block","operationId":"oposCaseDunning","parameters":[{"description":"Ident of the OPOS case.","in":"path","name":"oposCaseIdent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDunningBlockRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OposCaseDto"}}},"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":["accounts-receivable-management-write"]}],"summary":"Update OposCase Dunning Block state","tags":["OPOS Cases"]}},"/v2/statistics/summary/opos-case-decisions":{"get":{"description":"Get a list of summarized OPOS case decisions","operationId":"getSummarizedOposCaseDecisions_1","parameters":[{"description":"filter criteria. Summary can only be applied for a single currency.\nMust not be null.","in":"query","name":"currency","required":true,"schema":{"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"],"type":"string"}},{"description":"The lower boundary of the summary. The Date and Time  is included. 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.","in":"query","name":"startDate","required":true,"schema":{"format":"date-time","type":"string"}},{"description":"The upper boundary of the summary. The Date and Time is included. 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.","in":"query","name":"endDate","required":true,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummarizedOposDecisionResult"}}},"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":["accounts-receivable-management-read"]}],"summary":"Query Summarized OPOS Cases Decisions","tags":["OPOS Cases"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Production","url":"https://api.instellix.io"}],"tags":[{"description":"OPOS Case Clearing Run API","name":"Clearing Runs"},{"description":"OPOS Case API","name":"OPOS Cases"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}