{"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":{"AccountingDocumentNumberConfigRequestDto":{"properties":{"initialValue":{"description":"Must be provided if strategy equals SEQUENCE. Numeric initial value used for generating accounting document number.","format":"int64","type":"integer"},"journalEntryCategory":{"description":"Must not be empty.","minLength":1,"type":"string"},"regexPattern":{"description":"Must be provided if strategy equals PROVIDED. The regex must be phrased in a way that it only returns 1 match when applied to bookingEntry.documentReference.documentIdentifier.","type":"string"},"strategy":{"description":"Must not be null.","enum":["PROVIDED","SEQUENCE"],"type":"string"}},"required":["journalEntryCategory","strategy"],"type":"object"},"AccountingDocumentNumberConfigResponseDto":{"properties":{"journalEntryCategory":{"type":"string"},"nextAvailableNumber":{"type":"string"},"regexPattern":{"type":"string"},"strategy":{"enum":["PROVIDED","SEQUENCE"],"type":"string"}},"type":"object"},"AggregationGroup":{"properties":{"groupByFieldsAndProperties":{"items":{"type":"string"},"type":"array"},"id":{"format":"int64","type":"integer"},"specification":{"$ref":"#/components/schemas/SubledgerClosingSpecification"},"whereRsql":{"description":"Size must be between 0 and 4000.","maxLength":4000,"type":"string"}},"type":"object"},"AggregationGroupRequest":{"description":"Aggregation group: optional RSQL filter + fields/properties to group by.","properties":{"additionalGroupByFieldsAndProperties":{"description":"Additional Field or property name used as grouping key. Default aggregation is  credit and debit booking account and functional currencyAllowed: whitelisted entity fields (e.g., 'account','currency') or dynamic properties prefixed with 'properties.'.","example":"properties.value","items":{"description":"Additional Field or property name used as grouping key. Default aggregation is  credit and debit booking account and functional currencyAllowed: whitelisted entity fields (e.g., 'account','currency') or dynamic properties prefixed with 'properties.'.","example":"properties.value","maxLength":255,"minLength":1,"type":"string"},"type":"array"},"whereRsql":{"description":"RSQL filter limiting which booking entries are considered. Supports entity fields and dynamic properties via 'properties.<key>'.\nSize must be between 0 and 4000.","example":"properties.value==DE;amount>=0","maxLength":4000,"type":"string"}},"type":"object"},"AggregationGroupResponse":{"description":"Aggregation group: optional RSQL filter + fields/properties to group by.","properties":{"additionalGroupByFieldsAndProperties":{"description":"Additional Field or property name used as grouping key. Default aggregation is  credit and debit booking account and functional currencyAllowed: whitelisted entity fields (e.g., 'account','currency') or dynamic properties prefixed with 'properties.'.","example":"properties.value","items":{"description":"Additional Field or property name used as grouping key. Default aggregation is  credit and debit booking account and functional currencyAllowed: whitelisted entity fields (e.g., 'account','currency') or dynamic properties prefixed with 'properties.'.","example":"properties.value","maxLength":255,"minLength":1,"type":"string"},"type":"array"},"whereRsql":{"description":"RSQL filter limiting which booking entries are considered. Supports entity fields and dynamic properties via 'properties.<key>'.\nSize must be between 0 and 4000.","example":"properties.value==DE;amount>=0","maxLength":4000,"type":"string"}},"type":"object"},"BookingAccount":{"properties":{"accountCurrency":{"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"},"accountDescription":{"type":"string"},"accountGroup":{"type":"string"},"accountName":{"type":"string"},"accountNumber":{"format":"int64","type":"integer"},"accountType":{"enum":["EQUITY","LIABILITY","ASSET","EXPENSE","INCOME"],"type":"string"},"creationDate":{"format":"date-time","type":"string"},"debtor":{"$ref":"#/components/schemas/Debtor"},"debtorAccount":{"type":"boolean"},"deferral":{"type":"boolean"},"deferralBookingAccounts":{"items":{"$ref":"#/components/schemas/DeferralBookingAccount"},"type":"array"},"id":{"format":"int64","type":"integer"},"isCollectiveAccount":{"type":"boolean"},"oposAccount":{"type":"boolean"},"tenant":{"$ref":"#/components/schemas/Tenant"}},"type":"object"},"BookingAccountCreateRequestDto":{"properties":{"accountDescription":{"type":"string"},"accountGroup":{"description":"Must not be blank.","minLength":1,"type":"string"},"accountName":{"type":"string"},"accountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"accountType":{"description":"Must not be null.","enum":["EQUITY","LIABILITY","ASSET","EXPENSE","INCOME"],"type":"string"},"deferralBookingAccounts":{"description":"Deferral booking accounts","items":{"$ref":"#/components/schemas/DeferralBookingAccountDto"},"type":"array"},"isCollectiveAccount":{"default":false,"description":"Determines if the account can be used as a collective account instead of the subledger account in reports towards the GL. An example would be the accounts receivable account instead of a debtor.","type":"boolean"},"oposAccount":{"default":false,"description":"Indicates an opos account. All debtor accounts are opos account by default. All other accounts aren`t if not provided","example":true,"type":"boolean"}},"required":["accountGroup","accountNumber","accountType"],"type":"object"},"BookingAccountDto":{"properties":{"accountCurrency":{"description":"Must 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"],"type":"string"},"accountDescription":{"type":"string"},"accountGroup":{"description":"Must not be blank.","minLength":1,"type":"string"},"accountName":{"type":"string"},"accountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"accountType":{"description":"Must not be null.","enum":["EQUITY","LIABILITY","ASSET","EXPENSE","INCOME"],"type":"string"},"creationDate":{"format":"date-time","type":"string"},"deferralBookingAccounts":{"description":"Deferral booking accounts","items":{"$ref":"#/components/schemas/DeferralBookingAccountDto"},"type":"array"},"hasEntries":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"isCollectiveAccount":{"default":false,"description":"Determines if the account can be used as a collective account instead of the subledger account in reports towards the GL. An example would be the accounts receivable account instead of a debtor.","type":"boolean"},"oposAccount":{"default":false,"description":"Indicates an opos account. All debtor accounts are opos account by default. All other accounts aren`t if not provided","example":true,"type":"boolean"}},"required":["accountCurrency","accountGroup","accountNumber","accountType"],"type":"object"},"BookingAccountUpdateRequestDto":{"properties":{"accountDescription":{"type":"string"},"accountGroup":{"description":"Must not be blank.","minLength":1,"type":"string"},"accountName":{"type":"string"},"accountType":{"description":"Must not be null.","enum":["EQUITY","LIABILITY","ASSET","EXPENSE","INCOME"],"type":"string"},"deferralBookingAccounts":{"description":"Deferral booking accounts","items":{"$ref":"#/components/schemas/DeferralBookingAccountDto"},"type":"array"},"oposAccount":{"default":false,"description":"Indicates an opos account. All debtor accounts are opos account by default. All other accounts aren`t if not provided","example":true,"type":"boolean"}},"required":["accountGroup","accountType"],"type":"object"},"BookingEntryDto":{"properties":{"accountingDocumentNumber":{"type":"string"},"bookingDate":{"description":"Must not be null.","format":"date","type":"string"},"bookingPeriodDay":{"description":"Day of the booking period, which is part of a booking period if daily booking periods is enabled.","format":"int32","type":"integer"},"bookingPeriodMonth":{"type":"string"},"bookingReference":{"description":"Unique cross-system reference enabling traceability of Instellix bookings in external financial systems.","type":"string"},"bookingText":{"type":"string"},"businessSegment":{"type":"string"},"businessTransactionType":{"description":"Must not be blank.","minLength":1,"type":"string"},"collectiveCreditBookingAccountNumber":{"format":"int64","type":"integer"},"collectiveDebitBookingAccountNumber":{"format":"int64","type":"integer"},"costCenter":{"type":"string"},"creationDate":{"format":"date-time","type":"string"},"creditBookingAccountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"creditClearingIdent":{"type":"string"},"creditPostingKey":{"type":"string"},"creditTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"currencyExchangeEntry":{"$ref":"#/components/schemas/CurrencyExchangeEntryDto"},"debitBookingAccountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"debitClearingIdent":{"type":"string"},"debitPostingKey":{"type":"string"},"debitTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"documentDate":{"format":"date","type":"string"},"documentReference":{"$ref":"#/components/schemas/SavedDocumentReferenceDto"},"functionalValue":{"$ref":"#/components/schemas/MoneyDto"},"journalEntryBookingText":{"type":"string"},"journalEntryCategory":{"type":"string"},"orderReferenceNumber":{"type":"string"},"postingDate":{"description":"When the booking was recorded in the sub ledger.","format":"date-time","type":"string"},"profitCenter":{"description":"Determines the profit center of income related bookings.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"properties":{"additionalProperties":{"type":"object"},"type":"object"},"relatedDocument":{"$ref":"#/components/schemas/RelatedDocumentDto"},"ruleId":{"type":"string"},"serviceCountry":{"enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"},"servicePeriodEnd":{"format":"date","type":"string"},"servicePeriodStart":{"format":"date","type":"string"},"specificReference":{"$ref":"#/components/schemas/SavedSpecificReferenceDto"},"taxBaseValue":{"$ref":"#/components/schemas/MoneyDto"},"taxScheme":{"type":"string"},"tenantId":{"description":"Must not be null.","format":"int64","type":"integer"},"transactionValue":{"$ref":"#/components/schemas/MoneyDto"}},"required":["bookingDate","businessTransactionType","creditBookingAccountNumber","debitBookingAccountNumber","documentReference","functionalValue","tenantId","transactionValue"],"type":"object"},"BookingPeriodDto":{"properties":{"bookingPeriodType":{"description":"Type of the booking period.\nMust be one of:\n|       |\n| ----- |\n| MONTH |\n| DAY   |","type":"string"},"creationDate":{"format":"date-time","type":"string"},"day":{"description":"Day in the spanned month.\nMust be greater than or equal to 0.\nMust be less than or equal to 31.","format":"int32","maximum":31,"minimum":0,"type":"integer"},"enableClosings":{"description":"Whether closings are enabled for this booking period","type":"boolean"},"enableDailyBookingPeriods":{"description":"Whether daily booking periods are enabled","type":"boolean"},"id":{"format":"int64","type":"integer"},"modificationDate":{"format":"date-time","type":"string"},"spannedMonth":{"description":"Must not be null.","type":"string"},"status":{"description":"Current status of the booking period.\nMust not be null.\nMust be one of:\n|        |\n| ------ |\n| OPEN   |\n| CLOSED |","type":"string"}},"required":["spannedMonth","status"],"type":"object"},"ClearingCreationRequest":{"properties":{"creditBookingEntryIds":{"description":"Must not be empty.","items":{"format":"int64","type":"integer"},"minItems":1,"type":"array"},"debitBookingEntryIds":{"description":"Must not be empty.","items":{"format":"int64","type":"integer"},"minItems":1,"type":"array"}},"required":["creditBookingEntryIds","debitBookingEntryIds"],"type":"object"},"ClearingDto":{"properties":{"bookingAccount":{"$ref":"#/components/schemas/BookingAccountDto"},"creditBookingEntries":{"items":{"$ref":"#/components/schemas/BookingEntryDto"},"type":"array"},"debitBookingEntries":{"items":{"$ref":"#/components/schemas/BookingEntryDto"},"type":"array"},"id":{"format":"int64","type":"integer"},"ident":{"type":"string"}},"type":"object"},"ClosingBookingAccountResponse":{"description":"The booking account tied to a closing.","properties":{"accountGroup":{"description":"Must not be blank.","minLength":1,"type":"string"},"accountName":{"type":"string"},"accountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"accountType":{"description":"Account type.\nMust not be null.\nMust be one of:\n|           |\n| --------- |\n| EQUITY    |\n| LIABILITY |\n| ASSET     |\n| EXPENSE   |\n| INCOME    |","type":"string"},"isCollectiveAccount":{"description":"Determines if the account can be used as a collective account instead of the subledger account in reports towards the GL. An example would be the accounts receivable account instead of a debtor.","type":"boolean"}},"required":["accountGroup","accountNumber","accountType"],"type":"object"},"ClosingBookingEntryPropertyResponse":{"description":"Closing booking entry property.","properties":{"properties":{"items":{"$ref":"#/components/schemas/ClosingPropertyResponse"},"type":"array"}},"type":"object"},"ClosingBookingEntryResponse":{"description":"Closing booking entries.","discriminator":{"mapping":{"DOCUMENT":"#/components/schemas/DocumentClosingBookingEntryResponse","JOURNAL":"#/components/schemas/JournalClosingBookingEntryResponse"},"propertyName":"formatType"},"properties":{"formatType":{"type":"string"}},"required":["formatType"],"type":"object"},"ClosingBookingPeriodResponse":{"description":"Booking period that represents either a full calendar month or a single day within that month.\nProvide month for a month period, or month plus day for a single-day period.","properties":{"day":{"description":"Day in the spanned month.\nMust be greater than or equal to 1.\nMust be less than or equal to 31.","example":15,"format":"int32","maximum":31,"minimum":1,"nullable":true,"type":"integer"},"spannedMonth":{"description":"Must not be null.","type":"string"}},"required":["spannedMonth"],"type":"object"},"ClosingCurrencyExchangeEntryResponse":{"properties":{"exchangeRate":{"type":"number"},"origin":{"description":"Must not be blank.","minLength":1,"type":"string"}},"required":["origin"],"type":"object"},"ClosingDocumentReferenceResponse":{"properties":{"documentIdentifier":{"description":"Must not be blank.","minLength":1,"type":"string"},"documentType":{"description":"document type.\nMust not be null.\nMust be one of:\n|                 |\n| --------------- |\n| INVOICE         |\n| SETTLEMENT_FILE |\n| BOOKING         |\n| OPOS_CASE       |\n| CLEARING        |\n| UNKNOWN         |","type":"string"}},"required":["documentIdentifier","documentType"],"type":"object"},"ClosingPropertyResponse":{"properties":{"key":{"description":"Must not be blank.","minLength":1,"type":"string"},"value":{"description":"Must not be null.","type":"string"}},"required":["key","value"],"type":"object"},"ClosingRelatedDocumentResponse":{"properties":{"documentType":{"description":"documentType.\nMust not be null.\nMust be one of:\n|                 |\n| --------------- |\n| INVOICE         |\n| SETTLEMENT_FILE |\n| BOOKING         |\n| OPOS_CASE       |\n| CLEARING        |\n| UNKNOWN         |","type":"string"},"reference":{"description":"identifier.\nMust not be null.","type":"string"}},"required":["documentType","reference"],"type":"object"},"ClosingResponse":{"description":"Response representing a closing.","properties":{"bookingPeriod":{"$ref":"#/components/schemas/ClosingBookingPeriodResponse"},"closedAt":{"description":"Timestamp when the closing was completed (ISO 8601 with offset).","format":"date-time","type":"string"},"closingStatus":{"description":"Current status of the closing.\nMust be one of:\n|           |\n| --------- |\n| PENDING   |\n| CREATED   |\n| COMPLETED |\n| FAILED    |\n| DISCARDED |","type":"string"},"closingType":{"description":"Type of the closing.\nMust be one of:\n|       |\n| ----- |\n| DAY   |\n| MONTH |","type":"string"},"failureReason":{"description":"Reason for a failed closing; only set when the status indicates failure.","type":"string"},"ident":{"description":"Unique identifier of the closing ","type":"string"}},"type":"object"},"ClosingSpecificReferenceResponse":{"properties":{"identifier":{"description":"Must not be blank.","minLength":1,"type":"string"},"referenceType":{"description":"reference type.\nMust not be null.\nMust be one of:\n|                    |\n| ------------------ |\n| INVOICE_ITEM       |\n| OPOS_CASE_DECISION |\n| SETTLEMENT         |\n| ASSIGNMENT         |","type":"string"}},"required":["identifier","referenceType"],"type":"object"},"CurrencyExchangeEntryDto":{"properties":{"creationDate":{"format":"date-time","type":"string"},"exchangeRate":{"type":"number"},"id":{"description":"Must not be null.","format":"int64","type":"integer"},"origin":{"description":"Must not be blank.","minLength":1,"type":"string"}},"required":["id","origin"],"type":"object"},"Debtor":{"properties":{"bookingAccounts":{"items":{"$ref":"#/components/schemas/BookingAccount"},"type":"array"},"creationDate":{"format":"date-time","type":"string"},"id":{"format":"int64","type":"integer"},"ident":{"type":"string"},"modificationDate":{"format":"date-time","type":"string"},"tenant":{"$ref":"#/components/schemas/Tenant"}},"type":"object"},"DebtorDto":{"properties":{"creationDate":{"format":"date-time","type":"string"},"debtorAccount":{"format":"int64","type":"integer"},"debtorIdent":{"description":"Must not be blank.","minLength":1,"type":"string"},"id":{"format":"int64","type":"integer"},"modificationDate":{"format":"date-time","type":"string"},"tenantId":{"description":"Must not be null.","format":"int64","type":"integer"}},"required":["debtorIdent","tenantId"],"type":"object"},"DeferralBookingAccount":{"properties":{"bookingAccount":{"$ref":"#/components/schemas/BookingAccount"},"deferralAccount":{"$ref":"#/components/schemas/BookingAccount"},"id":{"format":"int64","type":"integer"}},"type":"object"},"DeferralBookingAccountDto":{"description":"Deferral booking accounts","properties":{"accountNumber":{"description":"Must not be null.","format":"int64","type":"integer"}},"required":["accountNumber"],"type":"object"},"DocumentClosingBookingEntryResponse":{"allOf":[{"$ref":"#/components/schemas/ClosingBookingEntryResponse"},{"properties":{"header":{"$ref":"#/components/schemas/HeaderSegment"},"itemLines":{"items":{"$ref":"#/components/schemas/ItemLine"},"type":"array"}},"type":"object"}],"type":"object"},"DocumentReferenceDto":{"properties":{"documentIdentifier":{"description":"Must not be blank.","minLength":1,"type":"string"},"documentType":{"description":"Must not be null.","enum":["INVOICE","SETTLEMENT_FILE","BOOKING","OPOS_CASE","CLEARING","UNKNOWN"],"type":"string"}},"required":["documentIdentifier","documentType"],"type":"object"},"GainLossConfig":{"properties":{"businessSegment":{"type":"string"},"businessTransactionType":{"type":"string"},"creationDate":{"format":"date-time","type":"string"},"creditPostingCode":{"type":"string"},"currencyGainAccount":{"$ref":"#/components/schemas/BookingAccount"},"currencyLossAccount":{"$ref":"#/components/schemas/BookingAccount"},"debitPostingCode":{"type":"string"},"enabled":{"type":"boolean"},"gainLossConfigProperties":{"items":{"$ref":"#/components/schemas/GainLossConfigProperty"},"type":"array"},"id":{"format":"int64","type":"integer"},"journalEntryCategory":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"serviceCountry":{"enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"},"tenant":{"$ref":"#/components/schemas/Tenant"}},"type":"object"},"GainLossConfigDto":{"properties":{"businessSegment":{"description":"Size must be between 0 and 140.","maxLength":140,"type":"string"},"businessTransactionType":{"description":"Size must be between 0 and 140.","maxLength":140,"type":"string"},"creditPostingCode":{"type":"string"},"debitPostingCode":{"type":"string"},"enabled":{"description":"Must not be null.","type":"boolean"},"gainAccountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"journalEntryCategory":{"description":"Size must be between 0 and 32.","maxLength":32,"type":"string"},"lossAccountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"properties":{"items":{"$ref":"#/components/schemas/PropertyDto"},"type":"array"},"serviceCountry":{"enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"}},"required":["enabled","gainAccountNumber","lossAccountNumber"],"type":"object"},"GainLossConfigProperty":{"properties":{"id":{"format":"int64","type":"integer"},"ident":{"type":"string"},"value":{"type":"string"}},"type":"object"},"GlAccountTotalsDto":{"properties":{"accountGroup":{"type":"string"},"accountName":{"type":"string"},"accountNumber":{"type":"string"},"balance":{"type":"number"},"creditSum":{"type":"number"},"debitSum":{"type":"number"},"functionalCurrency":{"type":"string"},"tenantId":{"format":"int64","type":"integer"}},"type":"object"},"GlobalErrorResponse":{"description":"error response providing details about the error occurred","properties":{"errors":{"description":"optional list of multiple errors occurred","items":{"type":"object"},"type":"array"},"message":{"description":"message describing the error","type":"string"},"path":{"description":"URL path where the error occurred","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","type":"string"}},"type":"object"},"HeaderSegment":{"description":"A header segment.","properties":{"accountingDocumentNumber":{"type":"string"},"bookingReference":{"type":"string"},"documentDate":{"format":"date","type":"string"},"journalEntryBookingText":{"type":"string"},"journalEntryCategory":{"type":"string"},"orderReferenceNumber":{"type":"string"}},"type":"object"},"IdocBookingAccountDto":{"properties":{"accountGroup":{"type":"string"},"accountNumber":{"format":"int64","type":"integer"}},"type":"object"},"IdocBookingEntryDto":{"properties":{"accountingDocumentNumber":{"type":"string"},"bookingCorrelationId":{"type":"string"},"bookingDate":{"format":"date","type":"string"},"bookingText":{"type":"string"},"businessSegment":{"type":"string"},"businessTransactionType":{"type":"string"},"costCenter":{"type":"string"},"creationDate":{"format":"date-time","type":"string"},"creditBookingAccount":{"$ref":"#/components/schemas/IdocBookingAccountDto"},"creditPostingKey":{"type":"string"},"creditTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"debitBookingAccount":{"$ref":"#/components/schemas/IdocBookingAccountDto"},"debitPostingKey":{"type":"string"},"debitTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"documentDate":{"format":"date","type":"string"},"functionalValue":{"$ref":"#/components/schemas/MoneyDto"},"journalEntryBookingText":{"type":"string"},"journalEntryCategory":{"type":"string"},"legalDocumentReference":{"$ref":"#/components/schemas/DocumentReferenceDto"},"orderReferenceNumber":{"type":"string"},"serviceCountry":{"enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"},"specificReference":{"$ref":"#/components/schemas/SpecificReferenceDto"},"taxScheme":{"type":"string"},"tenantId":{"format":"int64","type":"integer"},"transactionValue":{"$ref":"#/components/schemas/MoneyDto"}},"type":"object"},"IdocSearchQueryDto":{"properties":{"businessTransactionType":{"type":"string"},"countryCode":{"description":"Must not be null.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"},"creationDateRangeEnd":{"description":"Must not be null.","format":"date","type":"string"},"creationDateRangeStart":{"description":"Must not be null.","format":"date","type":"string"}},"required":["countryCode","creationDateRangeEnd","creationDateRangeStart"],"type":"object"},"ItemLine":{"description":"A closing booking entry.","properties":{"bookingAccount":{"$ref":"#/components/schemas/ClosingBookingAccountResponse"},"bookingDate":{"description":"booking date.","format":"date","type":"string"},"bookingText":{"description":"booking text.","type":"string"},"businessSegment":{"description":"business segment.","type":"string"},"businessTransactionType":{"description":"business transaction type.","type":"string"},"closingIdent":{"type":"string"},"collectiveAccount":{"$ref":"#/components/schemas/ClosingBookingAccountResponse"},"costCenter":{"description":"cost center.","type":"string"},"currencyExchangeEntry":{"$ref":"#/components/schemas/ClosingCurrencyExchangeEntryResponse"},"debitCreditIndicator":{"description":"Indicates whether the transaction is on the debit or credit side. Possible values: DEBIT, CREDIT.\nMust be one of:\n|        |\n| ------ |\n| CREDIT |\n| DEBIT  |","type":"string"},"documentReference":{"$ref":"#/components/schemas/ClosingDocumentReferenceResponse"},"functionalValue":{"$ref":"#/components/schemas/MoneyDto"},"postingDate":{"format":"date-time","type":"string"},"postingKey":{"description":"posting key.","type":"string"},"profitCenter":{"description":"Size must be between 0 and 64.","maxLength":64,"type":"string"},"property":{"$ref":"#/components/schemas/ClosingBookingEntryPropertyResponse"},"relatedDocument":{"$ref":"#/components/schemas/ClosingRelatedDocumentResponse"},"ruleId":{"description":"rule id.","type":"string"},"serviceCountry":{"type":"string"},"servicePeriodEnd":{"description":"service period end.","format":"date","type":"string"},"servicePeriodStart":{"description":"service period start.","format":"date","type":"string"},"specificReference":{"$ref":"#/components/schemas/ClosingSpecificReferenceResponse"},"taxBaseValue":{"$ref":"#/components/schemas/MoneyDto"},"taxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"taxScheme":{"description":"tax scheme.","type":"string"},"transactionValue":{"$ref":"#/components/schemas/MoneyDto"}},"type":"object"},"JournalClosingBookingEntryResponse":{"allOf":[{"$ref":"#/components/schemas/ClosingBookingEntryResponse"},{"properties":{"bookingDate":{"description":"booking date.","format":"date","type":"string"},"bookingText":{"description":"booking text.","type":"string"},"businessSegment":{"description":"business segment.","type":"string"},"businessTransactionType":{"description":"business transaction type.","type":"string"},"closingIdent":{"type":"string"},"collectiveCreditBookingAccount":{"$ref":"#/components/schemas/ClosingBookingAccountResponse"},"collectiveDebitBookingAccount":{"$ref":"#/components/schemas/ClosingBookingAccountResponse"},"costCenter":{"description":"cost center.","type":"string"},"creditBookingAccount":{"$ref":"#/components/schemas/ClosingBookingAccountResponse"},"creditPostingKey":{"description":"credit posting key.","type":"string"},"creditTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"currencyExchangeEntry":{"$ref":"#/components/schemas/ClosingCurrencyExchangeEntryResponse"},"debitBookingAccount":{"$ref":"#/components/schemas/ClosingBookingAccountResponse"},"debitPostingKey":{"description":"debit posting key.","type":"string"},"debitTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"documentReference":{"$ref":"#/components/schemas/ClosingDocumentReferenceResponse"},"functionalValue":{"$ref":"#/components/schemas/MoneyDto"},"postingDate":{"format":"date-time","type":"string"},"profitCenter":{"description":"Size must be between 0 and 64.","maxLength":64,"type":"string"},"property":{"$ref":"#/components/schemas/ClosingBookingEntryPropertyResponse"},"relatedDocument":{"$ref":"#/components/schemas/ClosingRelatedDocumentResponse"},"ruleId":{"description":"rule id.","type":"string"},"serviceCountry":{"type":"string"},"servicePeriodEnd":{"description":"service period end.","format":"date","type":"string"},"servicePeriodStart":{"description":"service period start.","format":"date","type":"string"},"specificReference":{"$ref":"#/components/schemas/ClosingSpecificReferenceResponse"},"taxBaseValue":{"$ref":"#/components/schemas/MoneyDto"},"taxScheme":{"description":"tax scheme.","type":"string"},"transactionValue":{"$ref":"#/components/schemas/MoneyDto"}},"type":"object"}],"type":"object"},"JsonNode":{"description":"The payload","nullable":true,"type":"object"},"ManualBookingEntryBatchRequestDto":{"properties":{"bookingCorrelationId":{"description":"Must not be blank.","minLength":1,"type":"string"},"documentDate":{"format":"date","type":"string"},"journalEntryBookingText":{"type":"string"},"journalEntryCategory":{"type":"string"},"list":{"description":"Must not be empty.","items":{"$ref":"#/components/schemas/ManualBookingEntryRequestDto"},"minItems":1,"type":"array"},"orderReferenceNumber":{"description":"Must 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"}},"required":["bookingCorrelationId","list"],"type":"object"},"ManualBookingEntryRequestDto":{"properties":{"bookingDate":{"description":"Must not be null.","format":"date","type":"string"},"bookingText":{"type":"string"},"businessSegment":{"type":"string"},"businessTransactionType":{"description":"Must not be blank.","minLength":1,"type":"string"},"collectiveCreditBookingAccountNumber":{"format":"int64","type":"integer"},"collectiveDebitBookingAccountNumber":{"format":"int64","type":"integer"},"costCenter":{"type":"string"},"creditBookingAccountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"creditPostingKey":{"type":"string"},"creditTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"debitBookingAccountNumber":{"description":"Must not be null.","format":"int64","type":"integer"},"debitPostingKey":{"type":"string"},"debitTaxCase":{"$ref":"#/components/schemas/TaxCaseDto"},"documentReference":{"$ref":"#/components/schemas/DocumentReferenceDto"},"functionalValue":{"$ref":"#/components/schemas/MoneyDto"},"profitCenter":{"description":"Determines the profit center of income related bookings.\nSize must be between 0 and 64.","maxLength":64,"type":"string"},"properties":{"additionalProperties":{"type":"object"},"type":"object"},"relatedDocument":{"$ref":"#/components/schemas/RelatedDocumentDto"},"serviceCountry":{"enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"],"type":"string"},"servicePeriodEnd":{"format":"date","type":"string"},"servicePeriodStart":{"format":"date","type":"string"},"specificReference":{"$ref":"#/components/schemas/SpecificReferenceDto"},"taxBaseValue":{"$ref":"#/components/schemas/MoneyDto"},"taxScheme":{"type":"string"},"transactionValue":{"$ref":"#/components/schemas/MoneyDto"}},"required":["bookingDate","businessTransactionType","creditBookingAccountNumber","debitBookingAccountNumber","documentReference","transactionValue"],"type":"object"},"MigrationDto":{"properties":{"endTime":{"format":"date-time","type":"string"},"entityName":{"type":"string"},"message":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"status":{"enum":["SCHEDULED","RUNNING","COMPLETED","FAILED","ABORTED"],"type":"string"}},"type":"object"},"MoneyDto":{"properties":{"amount":{"description":"Must not be null.\nMust be greater than or equal to 0.","minimum":0,"type":"number"},"currency":{"description":"The currency in three letter ISO 4217.\nMust not be null.","example":"EUR","type":"string"}},"required":["amount","currency"],"type":"object"},"OutboxEntryResponse":{"description":"Outbox Entry","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).\nMust not be null.","format":"date-time","type":"string"},"deleteAt":{"description":"The delete timestamp","format":"date-time","nullable":true,"type":"string"},"failures":{"description":"Number of failures.\nMust not be null.\nMust be greater than or equal to 0.","format":"int32","minimum":0,"type":"integer"},"id":{"description":"The ID of the outbox entry.\nMust not be null.\nMust not be blank.","minLength":1,"type":"string"},"ident":{"description":"The ident of the outbox entry. An entry does not necessarily require an ident. It serves as a convenience feature only.","nullable":true,"type":"string"},"lastFailureMessage":{"description":"Last failure message","nullable":true,"type":"string"},"nextRetryAt":{"description":"The next retry timestamp","format":"date-time","nullable":true,"type":"string"},"payload":{"allOf":[{"$ref":"#/components/schemas/JsonNode"}],"description":"The payload","nullable":true,"type":"object"},"status":{"description":"The status of the outbox entry.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"statusHistory":{"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"},"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"}},"type":"object"},"PagedResponseAccountingDocumentNumberConfigResponseDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/AccountingDocumentNumberConfigResponseDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseBookingAccountDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/BookingAccountDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseBookingEntryDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/BookingEntryDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseBookingPeriodDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/BookingPeriodDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseClearingDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/ClearingDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseClosingBookingEntryResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentClosingBookingEntryResponse"},{"$ref":"#/components/schemas/JournalClosingBookingEntryResponse"}]},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseClosingResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/ClosingResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"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"}},"type":"object"},"PropertyDto":{"properties":{"propertyIdent":{"description":"Must not be blank.","minLength":1,"type":"string"},"propertyValue":{"description":"Must not be null.","type":"string"}},"required":["propertyIdent","propertyValue"],"type":"object"},"RelatedDocumentDto":{"description":"Links a booking to this related document","properties":{"documentType":{"description":"Type of the document.\nMust not be null.\nMust be one of:\n|                 |\n| --------------- |\n| INVOICE         |\n| SETTLEMENT_FILE |\n| BOOKING         |\n| OPOS_CASE       |\n| CLEARING        |\n| UNKNOWN         |","type":"string"},"reference":{"description":"reference.\nMust not be null.","type":"string"}},"required":["documentType","reference"],"type":"object"},"SavedDocumentReferenceDto":{"properties":{"creationDate":{"format":"date-time","type":"string"},"documentIdentifier":{"description":"Must not be blank.","minLength":1,"type":"string"},"documentType":{"description":"Must not be null.","enum":["INVOICE","SETTLEMENT_FILE","BOOKING","OPOS_CASE","CLEARING","UNKNOWN"],"type":"string"},"id":{"format":"int64","type":"integer"}},"required":["documentIdentifier","documentType"],"type":"object"},"SavedSpecificReferenceDto":{"properties":{"creationDate":{"format":"date-time","type":"string"},"id":{"format":"int64","type":"integer"},"identifier":{"description":"Must not be blank.","minLength":1,"type":"string"},"referenceType":{"description":"Must not be null.","enum":["INVOICE_ITEM","OPOS_CASE_DECISION","SETTLEMENT","ASSIGNMENT"],"type":"string"}},"required":["identifier","referenceType"],"type":"object"},"SpecificReferenceDto":{"properties":{"identifier":{"description":"Must not be empty.","minLength":1,"type":"string"},"referenceType":{"description":"Must not be null.","enum":["INVOICE_ITEM","OPOS_CASE_DECISION","SETTLEMENT","ASSIGNMENT"],"type":"string"}},"required":["identifier","referenceType"],"type":"object"},"StatusHistory":{"description":"Status history entry","properties":{"status":{"description":"The status.\nMust not be null.\nMust be one of:\n|            |\n| ---------- |\n| ENQUEUED   |\n| PROCESSING |\n| WAITING    |\n| PROCESSED  |\n| FAILED     |","type":"string"},"timestamp":{"description":"The timestamp when the status occurred.\nMust not be null.","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"SubledgerClosingSpecification":{"properties":{"groups":{"items":{"$ref":"#/components/schemas/AggregationGroup"},"type":"array"},"id":{"format":"int64","type":"integer"}},"type":"object"},"SubledgerClosingSpecificationRequest":{"description":"The closing Aggregation feature is currently under implementation. Interface and behavior are subject to change. Specification for how bookings are aggregated during closings.","properties":{"groups":{"description":"One or more aggregation groups evaluated in order.","items":{"$ref":"#/components/schemas/AggregationGroupRequest"},"type":"array"}},"type":"object"},"SubledgerClosingSpecificationResponse":{"description":"The closing Aggregation feature is currently under implementation. Interface and behavior are subject to change. Specification for how bookings are aggregated during closings.","properties":{"groups":{"description":"One or more aggregation groups evaluated in order.","items":{"$ref":"#/components/schemas/AggregationGroupResponse"},"type":"array"}},"type":"object"},"SubledgerConfiguration":{"properties":{"closingSpecification":{"$ref":"#/components/schemas/SubledgerClosingSpecification"},"enableClosings":{"type":"boolean"},"enableDailyBookingPeriods":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"startDate":{"format":"date","type":"string"},"tenant":{"$ref":"#/components/schemas/Tenant"}},"type":"object"},"SubledgerConfigurationRequest":{"description":"Configuration for bookings.","properties":{"closingSpecification":{"$ref":"#/components/schemas/SubledgerClosingSpecificationRequest"},"enableClosings":{"description":"Enable closings.\nMust not be null.","type":"boolean"},"enableDailyBookingPeriods":{"description":"Enable daily booking periods.\nMust not be null.","type":"boolean"},"startDate":{"description":"Start date of the subledger. May only be set if the current configuration has no start date yet. Once set, this field is immutable. Any subsequent update attempt with a different value must be rejected.\nMust not be null.","format":"date","type":"string"}},"required":["enableClosings","enableDailyBookingPeriods","startDate"],"type":"object"},"SubledgerConfigurationResponse":{"description":"Configuration for bookings.","properties":{"closingSpecification":{"$ref":"#/components/schemas/SubledgerClosingSpecificationResponse"},"enableClosings":{"description":"Enable closings.\nMust not be null.","type":"boolean"},"enableDailyBookingPeriods":{"description":"Enable daily booking periods.\nMust not be null.","type":"boolean"},"startDate":{"description":"Start of the subledger","format":"date","type":"string"}},"required":["enableClosings","enableDailyBookingPeriods"],"type":"object"},"TaxCaseDto":{"properties":{"taxCode":{"type":"string"},"taxPercentage":{"type":"number"}},"type":"object"},"Tenant":{"properties":{"creationDate":{"format":"date-time","type":"string"},"functionalCurrency":{"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"},"gainLossConfig":{"$ref":"#/components/schemas/GainLossConfig"},"id":{"format":"int64","type":"integer"},"subledgerConfiguration":{"$ref":"#/components/schemas/SubledgerConfiguration"},"usesAutomaticClearing":{"type":"boolean"},"usesBookkeeping":{"type":"boolean"}},"type":"object"},"TenantCreateRequestDto":{"properties":{"automaticClearing":{"description":"Must not be null.","type":"boolean"},"functionalCurrency":{"description":"Must 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"],"type":"string"},"initialDebtorAccountNumber":{"description":"Must not be null.\nMust be greater than or equal to 10000.\nMust be less than or equal to 9223372035854775807.","format":"int64","maximum":9223372035854775000,"minimum":10000,"type":"integer"}},"required":["automaticClearing","functionalCurrency","initialDebtorAccountNumber"],"type":"object"},"TenantDto":{"properties":{"automaticClearing":{"description":"Must not be null.","type":"boolean"},"creationDate":{"format":"date-time","type":"string"},"functionalCurrency":{"description":"Must 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"],"type":"string"},"id":{"description":"Must not be null.","format":"int64","type":"integer"},"initialDebtorAccountNumber":{"description":"Must not be null.","format":"int64","type":"integer"}},"required":["automaticClearing","functionalCurrency","id","initialDebtorAccountNumber"],"type":"object"},"TenantUpdateRequest":{"properties":{"automaticClearing":{"description":"Must not be null.","type":"boolean"},"initialDebtorAccountNumber":{"description":"Determines where the automatic debtor account creation begins.\nMust not be null.\nMust be less than or equal to 9223372035854775807.","format":"int64","maximum":9223372035854775000,"type":"integer"}},"required":["automaticClearing","initialDebtorAccountNumber"],"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"nbx-accounting-clearing-read":"Scope nbx-accounting-clearing-read","nbx-accounting-clearing-write":"Scope nbx-accounting-clearing-write","nbx-accounting-management-read":"Scope nbx-accounting-management-read","nbx-accounting-management-write":"Scope nbx-accounting-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 Bookkeeping","title":"Bookkeeping API","version":"v2-preview-0.356.17"},"openapi":"3.0.1","paths":{"/v2/accountingDocumentNumberConfigurations":{"get":{"description":"Query existing accounting document number configurations, optionally provide a journalEntryCategory. Returns the existing configuration, can be an empty list.","operationId":"getDocumentNumberConfiguration","parameters":[{"in":"query","name":"journalEntryCategory","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingDocumentNumberConfigResponseDto"}}},"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":"List accounting document number configurations","tags":["preview"]},"post":{"description":"Define how to handle Accounting Document Numbers based on the Journal Entry Category - case insensitive!. Possible Strategies are 'PROVIDED' using a regEx to extract the value from a defined field or 'SEQUENCE' to generate consecutive numbers.","operationId":"createDocumentNumberConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingDocumentNumberConfigRequestDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingDocumentNumberConfigResponseDto"}}},"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":"Create accounting document number configuration","tags":["preview"]}},"/v2/accountingDocumentNumberConfigurations/search":{"get":{"description":"Query existing accounting document number configurations, optionally provide a journalEntryCategory. Returns the existing configuration, can be an empty list.","operationId":"queryDocumentNumberConfiguration","parameters":[{"in":"query","name":"pageNumber","schema":{"default":0,"format":"int32","type":"integer"}},{"in":"query","name":"pageSize","schema":{"default":100,"format":"int32","type":"integer"}},{"in":"query","name":"orderBy","schema":{"default":"journalEntryCategory","type":"string"}},{"in":"query","name":"direction","schema":{"default":"DESC","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseAccountingDocumentNumberConfigResponseDto"}}},"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 accounting document number configurations","tags":["preview"]}},"/v2/bookingAccounts":{"get":{"description":"Returns paged result with booking accounts that belong to tenant with ID equal to one provided as header. Booking accounts are sorted in descending order by bookingAccountId. This can be changed with the optional direction and orderBy parameters.","operationId":"getBookingAccounts","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"id=gt=160","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 20.","in":"query","name":"size","schema":{"default":20,"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: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseBookingAccountDto"}}},"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-accounting-management-read"]}],"summary":"Retrieve booking accounts","tags":["Booking Accounts"]},"post":{"description":"Creates booking account using data in request body and tenantId header.","operationId":"createBookingAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingAccountCreateRequestDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingAccountDto"}}},"description":"Standard response for successful HTTP requests."},"400":{"description":"Bad request. There is no tenant with given ID or account number is higher than initial number for debtor accounts or there is already account with given number."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-write"]}],"summary":"Create booking account","tags":["Booking Accounts"]}},"/v2/bookingAccounts/{accountNumber}":{"delete":{"description":"Remove a booking account which does not have any booking entries. A booking account with booking entries can not be deleted.","operationId":"deleteBookingAccountByAccountNumber","parameters":[{"in":"path","name":"accountNumber","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"Booking account removed successfully."},"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-accounting-management-write"]}],"summary":"Remove booking account","tags":["Booking Accounts"]},"get":{"description":"Returns list of booking accounts that matches given account number and belong to tenant with ID equal to one provided as header. It is sorted by creation date.","operationId":"getBookingAccountByAccountNumber","parameters":[{"in":"path","name":"accountNumber","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BookingAccountDto"},"type":"array"}}},"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-accounting-management-read"]}],"summary":"Retrieve booking accounts","tags":["Booking Accounts"]},"put":{"description":"Update booking account with matching accountNumber and tenantId using data from request body.","operationId":"updateBookingAccountByAccountNumber","parameters":[{"in":"path","name":"accountNumber","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingAccountUpdateRequestDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BookingAccountDto"},"type":"array"}}},"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-accounting-management-write"]}],"summary":"Update booking account","tags":["Booking Accounts"]}},"/v2/bookingAccounts/{accountNumber}/{accountCurrency}/clearings":{"get":{"description":"Query clearings","operationId":"queryClearing","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"ident==160","in":"query","name":"search","schema":{"type":"string"}},{"description":"The account number of the account","example":12542535,"in":"path","name":"accountNumber","required":true,"schema":{"maxLength":20,"minLength":1,"type":"integer"}},{"description":"The currency of the account","example":"EUR","in":"path","name":"accountCurrency","required":true,"schema":{"maxLength":3,"minLength":3,"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 100.","in":"query","name":"size","schema":{"default":100,"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 'desc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseClearingDto"}}},"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-accounting-clearing-read"]}],"summary":"Query clearings","tags":["Clearing"]},"post":{"description":"Clears a set of matching booking entries","operationId":"createClearing","parameters":[{"description":"Validates that account is an OPOS account","in":"query","name":"account","required":true,"schema":{"$ref":"#/components/schemas/BookingAccount"}},{"description":"The account number of the account","example":12542535,"in":"path","name":"accountNumber","required":true,"schema":{"maxLength":20,"minLength":1,"type":"integer"}},{"description":"The currency of the account","example":"EUR","in":"path","name":"accountCurrency","required":true,"schema":{"maxLength":3,"minLength":3,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingCreationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingDto"}}},"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-accounting-clearing-write"]}],"summary":"Clear booking entries","tags":["Clearing"]}},"/v2/bookingAccounts/{accountNumber}/{accountCurrency}/clearings/{clearingIdent}":{"delete":{"description":"Delete clearing","operationId":"deleteClearingByIdent","parameters":[{"in":"path","name":"clearingIdent","required":true,"schema":{"type":"string"}},{"description":"The account number of the account","example":12542535,"in":"path","name":"accountNumber","required":true,"schema":{"maxLength":20,"minLength":1,"type":"integer"}},{"description":"The currency of the account","example":"EUR","in":"path","name":"accountCurrency","required":true,"schema":{"maxLength":3,"minLength":3,"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-accounting-clearing-write"]}],"summary":"Delete clearing","tags":["Clearing"]},"get":{"description":"Retrieve clearing","operationId":"getClearingByIdent","parameters":[{"in":"path","name":"clearingIdent","required":true,"schema":{"type":"string"}},{"description":"The account number of the account","example":12542535,"in":"path","name":"accountNumber","required":true,"schema":{"maxLength":20,"minLength":1,"type":"integer"}},{"description":"The currency of the account","example":"EUR","in":"path","name":"accountCurrency","required":true,"schema":{"maxLength":3,"minLength":3,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearingDto"}}},"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-accounting-clearing-read"]}],"summary":"Retrieve clearing","tags":["Clearing"]}},"/v2/bookingEntries":{"get":{"description":"Returns list of booking entries.To provide query you need to use RSQL syntax.","operationId":"queryBookingEntries","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"invoiceIdent==20000000","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 20.","in":"query","name":"size","schema":{"default":20,"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 'desc'.\nDefault sorting criteria: 'id'.","in":"query","name":"sort","schema":{"default":["id"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseBookingEntryDto"}}},"description":"Standard response for successful HTTP requests."},"400":{"description":"Bad request. Query contain tenant ID, which is not allowed."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-read"]}],"summary":"Query booking entries","tags":["Booking Entries"]},"post":{"description":"Creates batch of booking entries that are combined together. If one of entries cannot be created, no entry of the whole batch is saved and neither is the correlation id.","operationId":"manuallyCreateBookingEntries","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualBookingEntryBatchRequestDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Standard response for successful HTTP requests."},"400":{"description":"Bad request. There is no tenant with given ID or at least one account number doesn't exist or given tenant has different functional currency than provided one in request."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-write"]}],"summary":"Create booking entries","tags":["preview"]}},"/v2/bookingEntriesCsv/{bookingPeriod}":{"get":{"description":"Returns CSV file with list of booking entries that matches data provided in request body. ","operationId":"getBookingEntriesAsCsv","parameters":[{"in":"path","name":"bookingPeriod","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/text;charset=UTF-8":{"schema":{"format":"byte","type":"string"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-accounting-management-read"]}],"summary":"List booking entries (csv format)","tags":["preview"]}},"/v2/bookingPeriods":{"get":{"description":"Returns list of booking periods that belong to tenant with ID equal to one provided as header.","operationId":"getAllBookingPeriods","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"status==CLOSED","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 20.","in":"query","name":"size","schema":{"default":20,"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 'desc'.\nDefault sorting criteria: 'spannedMonth'.","in":"query","name":"sort","schema":{"default":["spannedMonth"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseBookingPeriodDto"}}},"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-accounting-management-read"]}],"summary":"List booking periods","tags":["preview"]}},"/v2/bookingPeriods/{spanned_month}/actions/close":{"post":{"description":"Closing booking period that matches provided spanned month and tenant id from header. When period is closed service won't connect any new entry to that period.","operationId":"closeBookingPeriod","parameters":[{"in":"path","name":"spanned_month","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingPeriodDto"}}},"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-accounting-management-write"]}],"summary":"Close booking period","tags":["preview"]}},"/v2/bookingPeriods/{spanned_month}/actions/reopen":{"post":{"description":"Reopening booking period that matches provided spanned month and tenant id from header. When period is reopen service can connect any new entry to that period again.","operationId":"reopenBookingPeriod","parameters":[{"in":"path","name":"spanned_month","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingPeriodDto"}}},"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-accounting-management-write"]}],"summary":"Reopen booking period","tags":["preview"]}},"/v2/bookingPeriods/{spanned_month}/{day}/actions/close":{"post":{"description":"Closing booking period that matches provided spanned month and day and tenant id from header. When period is closed service won't connect any new entry to that period.","operationId":"closeDailyBookingPeriod","parameters":[{"description":"Year and month of the booking period","in":"path","name":"spanned_month","required":true,"schema":{"type":"string"}},{"description":"Day of the booking period","in":"path","name":"day","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingPeriodDto"}}},"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-accounting-management-write"]}],"summary":"Close daily booking period","tags":["preview"]}},"/v2/bookingPeriods/{spanned_month}/{day}/actions/reopen":{"post":{"description":"Reopening booking period that matches provided spanned month and day and tenant id from header. When period is reopen service can connect any new entry to that period again.","operationId":"reopenDailyBookingPeriod","parameters":[{"description":"Year and month of the booking period","in":"path","name":"spanned_month","required":true,"schema":{"type":"string"}},{"description":"Day of the booking period","in":"path","name":"day","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingPeriodDto"}}},"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-accounting-management-write"]}],"summary":"Reopen booking period","tags":["preview"]}},"/v2/tenants/gain-loss-config":{"get":{"description":"Get gain loss configuration using data from request body.","operationId":"getGainLossConfigByTenantById","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GainLossConfigDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-read"]}],"summary":"Get gain loss configuration","tags":["Tenants"]}},"/v2/tenants/subledger-config":{"get":{"description":"Retrieve subledger configuration.","operationId":"retrieveSubledgerConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubledgerConfigurationResponse"}}},"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 subledger configuration","tags":["preview"]},"put":{"description":"Update subledger configuration using data from request body.","operationId":"updateSubledgerConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubledgerConfigurationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubledgerConfigurationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"security":[{"oauth2":["nbx-tenant-management-write"]}],"summary":"Update subledger configuration","tags":["preview"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.isx-stage-westeurope.instellix.io"}],"tags":[{"description":"endpoints for preview","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"preview"},{"description":"endpoints for Booking Accounts","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Booking Accounts"},{"description":"endpoints for Booking Entries","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Booking Entries"},{"description":"endpoints for Clearing","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Clearing"},{"description":"endpoints for Tenants","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Tenants"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}