Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "BookedEntry": { "required": [ "accountNumber", "entryNumber" ], "type": "object", "properties": { "entryNumber": { "type": "integer", "description": "The unique number of the entry.Read-only: true
Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "readOnly": true, "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "accountNumber": { "type": "integer", "description": "The account number to which the entry was registered.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "amount": { "type": "number", "description": "The amount set on the entry using the currency set on the entry.Filterable: eq, ne, lt, lte, gt, gte
Sortable: true
", "format": "double", "x-filterable": "eq, ne, lt, lte, gt, gte", "x-sortable": true }, "amountInBaseCurrency": { "type": "number", "description": "The amount of the entry using the base currency for the agreementFilterable: eq, ne, lt, lte, gt, gte
Sortable: true
", "format": "double", "x-filterable": "eq, ne, lt, lte, gt, gte", "x-sortable": true }, "currencyCode": { "type": [ "null", "string" ], "description": "The code of the currency set on the entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "date": { "type": "string", "description": "The date of the entry.Filterable: eq, ne, lt, lte, gt, gte
Sortable: true
", "format": "date-time", "x-filterable": "eq, ne, lt, lte, gt, gte", "x-sortable": true }, "text": { "type": [ "null", "string" ], "description": "The text associated with the entry.Filterable: eq, ne, lt, lte, gt, gte, like
Sortable: false
", "x-filterable": "eq, ne, lt, lte, gt, gte, like", "x-sortable": false }, "type": { "allOf": [ { "description": "Filterable: eq, ne
Sortable: true
", "x-filterable": "eq, ne", "x-sortable": true }, "vatAccountNumber": { "type": [ "null", "string" ], "description": "The VAT account number .Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "voucherNumber": { "type": [ "null", "integer" ], "description": "The voucher number of the entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "invoiceNumber": { "type": [ "null", "integer" ], "description": "The invoice number of the entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "customerNumber": { "type": [ "null", "integer" ], "description": "The customer number of the entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "objectVersion": { "type": [ "null", "string" ], "description": "The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "BookedEntryCursorResults": { "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "description": "Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all.Read-only: true
Filterable: not filterable
Sortable: false
", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BookedEntry" }, "description": "Max number of items returned is 1000.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false, "description": "Array of objects along with a cursor.", "example": { "cursor": "234", "items": [ { "id": "13", "name": "Patrick" }, { "id": "16", "name": "John" } ] }, "x-cursor-page-size": 1000 }, "BookingParameters": { "required": [ "fromDate", "toDate" ], "type": "object", "properties": { "fromDate": { "type": "string", "description": "Start date of the booking intervalFilterable: not filterable
Sortable: false
", "format": "date-time", "x-filterable": "not filterable", "x-sortable": false }, "toDate": { "type": "string", "description": "End date of the booking intervalFilterable: not filterable
Sortable: false
", "format": "date-time", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "CreatedResult": { "type": "object", "properties": { "number": { "type": "integer", "description": "Filterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "DimensionData": { "required": [ "dimensionKey", "dimensionNumber", "entryNumber" ], "type": "object", "properties": { "entryNumber": { "type": "integer", "description": "The entry number the dimension related.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "dimensionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The unique number of the dimension related with entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "dimensionKey": { "type": "integer", "description": "The unique number of the selected value of the dimension related with entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "isDistribution": { "type": "boolean", "description": "The flag indicates if the selected entity is a dimension value or a dimension distribution.Read-only: true
Filterable: not filterable
Sortable: false
", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "objectVersion": { "type": [ "null", "string" ], "description": "The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "DimensionDataCreatedResult": { "type": "object", "properties": { "dimensionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The unique number of the dimension related with entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true } }, "additionalProperties": false }, "DimensionDataCursorResults": { "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "description": "Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all.Read-only: true
Filterable: not filterable
Sortable: false
", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DimensionData" }, "description": "Max number of items returned is 1000.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false, "description": "Array of objects along with a cursor.", "example": { "cursor": "234", "items": [ { "id": "13", "name": "Patrick" }, { "id": "16", "name": "John" } ] }, "x-cursor-page-size": 1000 }, "DraftEntries": { "type": "object", "properties": { "entries": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DraftEntry" }, "description": "List of entriesFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "DraftEntry": { "required": [ "amount", "currency", "date", "entryTypeNumber", "journalNumber" ], "type": "object", "properties": { "entryNumber": { "type": [ "null", "integer" ], "description": "The unique number of the entry. It is assigned by the system when the entry is created and must be supplied when updating an entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "entryTypeNumber": { "pattern": "2|3|4|5|10", "type": "integer", "description": "The entry type. \nIt has 5 types: \n- 2: Customer Payment \n- 3: Supplier Invoice \n- 4: Supplier Payment \n- 5: Finance Voucher \n- 10: Manual Customer Invoice \r\nFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "voucherNumber": { "maximum": 999999999, "minimum": 0, "type": [ "null", "integer" ], "description": "The voucher number of the entry. Must be within the max/min value defined on the journal and always below or equal to 999999999. On create, omit to have the server generate a unique voucher number for the journal.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "journalNumber": { "type": "integer", "description": "The number of the journal that this entry belongs to.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "date": { "type": "string", "description": "The date of the entry.Filterable: eq, ne, lt, lte, gt, gte
Sortable: false
", "format": "date-time", "x-filterable": "eq, ne, lt, lte, gt, gte", "x-sortable": false }, "accountNumber": { "type": [ "null", "integer" ], "description": "The account number of the entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "vatCode": { "type": [ "null", "string" ], "description": "The VAT code of the entry.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "amount": { "type": "number", "description": "The amount of the entryFilterable: not filterable
Sortable: false
", "format": "double", "x-filterable": "not filterable", "x-sortable": false }, "currency": { "minLength": 1, "type": "string", "description": "The currency of the entryFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "exchangeRate": { "type": [ "null", "number" ], "description": "The exchange rate of the entryFilterable: not filterable
Sortable: false
", "format": "double", "x-filterable": "not filterable", "x-sortable": false }, "contraAccountNumber": { "type": [ "null", "integer" ], "description": "The contra account number of the entryFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "contraVatCode": { "type": [ "null", "string" ], "description": "The contra VAT code of the entryFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "text": { "type": [ "null", "string" ], "description": "Text description of the entryFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "projectNumber": { "type": [ "null", "integer" ], "description": "The project number of the entryFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "costTypeNumber": { "type": [ "null", "integer" ], "description": "The cost type number of the entryFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "customerNumber": { "type": [ "null", "integer" ], "description": "The customer number of the entryFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "customerInvoiceNumber": { "type": [ "null", "string" ], "description": "The customer invoice number of the entryFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "supplierNumber": { "type": [ "null", "integer" ], "description": "The supplier numberFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: false
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": false }, "supplierInvoiceNumber": { "type": [ "null", "string" ], "description": "The supplier invoice numberFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "supplierPaymentType": { "pattern": "^(-1|1|2|5|7|10|17)$", "type": [ "null", "integer" ], "description": "description: \"The supplier payment type. \n It has 8 types: \n- -1: None \n- 1: Plus71 \n- 2: Plus73 \n- 5: Plus04 \n- 7: BankTransfer \n- 10: Iban \n- 17: Plus75 \r\nFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "supplierPaymentBank": { "type": [ "null", "string" ], "description": "The supplier payment bank detailsFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "supplierPaymentMessage": { "type": [ "null", "string" ], "description": "The supplier payment messageFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "dueDate": { "type": [ "null", "string" ], "description": "The due date of the entryFilterable: not filterable
Sortable: false
", "format": "date-time", "x-filterable": "not filterable", "x-sortable": false }, "objectVersion": { "type": [ "null", "string" ], "description": "The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "DraftEntryAccrual": { "required": [ "accountNumber", "endDate", "entryNumber", "journalNumber", "startDate" ], "type": "object", "properties": { "entryNumber": { "type": "integer", "description": "The unique entry number that relates to this accrual.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "journalNumber": { "type": "integer", "description": "The journal number where the related entry belongsFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "accountNumber": { "type": "integer", "description": "The account number associated with the accrualFilterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "startDate": { "type": "string", "description": "The start date for the accrualFilterable: not filterable
Sortable: false
", "format": "date-time", "x-filterable": "not filterable", "x-sortable": false }, "endDate": { "type": "string", "description": "The end date for the accrualFilterable: not filterable
Sortable: false
", "format": "date-time", "x-filterable": "not filterable", "x-sortable": false }, "months": { "type": [ "null", "integer" ], "description": "The duration of the accrual in monthsRead-only: true
Filterable: not filterable
Sortable: false
", "format": "int32", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "objectVersion": { "type": [ "null", "string" ], "description": "The object version, required for PUT requests to help ensure that updates made by others don’t get overwritten by your update request.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "DraftEntryAccrualCreatedResult": { "type": "object", "properties": { "entryNumber": { "type": "integer", "description": "The unique entry number that relates to this accrual.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true } }, "additionalProperties": false }, "DraftEntryAccrualCursorResults": { "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "description": "Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all.Read-only: true
Filterable: not filterable
Sortable: false
", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DraftEntryAccrual" }, "description": "Max number of items returned is 1000.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false, "description": "Array of objects along with a cursor.", "example": { "cursor": "234", "items": [ { "id": "13", "name": "Patrick" }, { "id": "16", "name": "John" } ] }, "x-cursor-page-size": 1000 }, "DraftEntryCreatedResult": { "type": "object", "properties": { "entryNumber": { "type": [ "null", "integer" ], "description": "The unique number of the entry. It is assigned by the system when the entry is created and must be supplied when updating an entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true } }, "additionalProperties": false }, "DraftEntryCreatedResultArray": { "type": "object", "properties": { "entryNumbers": { "type": "array", "items": { "type": [ "null", "integer" ], "description": "The unique number of the entry. It is assigned by the system when the entry is created and must be supplied when updating an entry.Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true } } }, "additionalProperties": false }, "DraftEntryCursorResults": { "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "description": "Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all.Read-only: true
Filterable: not filterable
Sortable: false
", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DraftEntry" }, "description": "Max number of items returned is 1000.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false, "description": "Array of objects along with a cursor.", "example": { "cursor": "234", "items": [ { "id": "13", "name": "Patrick" }, { "id": "16", "name": "John" } ] }, "x-cursor-page-size": 1000 }, "EntryTypeNames": { "type": "integer", "oneOf": [ { "const": 0, "title": "All" }, { "const": 1, "title": "CustomerInvoice" }, { "const": 2, "title": "CustomerPayment" }, { "const": 3, "title": "SupplierInvoice" }, { "const": 4, "title": "SupplierPayment" }, { "const": 5, "title": "FinanceVoucher" }, { "const": 6, "title": "Reminder" }, { "const": 7, "title": "OpeningEntry" }, { "const": 8, "title": "TransferredOpeningEntry" }, { "const": 9, "title": "SystemEntry" }, { "const": 10, "title": "ManualCustomerInvoice" } ], "description": "Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "errorCode": { "type": [ "null", "string" ], "description": "Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "property": { "type": [ "null", "string" ], "description": "Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "Journal": { "required": [ "allowPartialBooking", "autoApprove", "balancingBehavior", "isStandingJournal", "lockVatCodes", "name", "repeatText", "requireAdminApproval", "requireBalancePerVoucherId" ], "type": "object", "properties": { "number": { "type": "integer", "description": "The unique number of the journal.Read-only: true
Filterable: eq, ne, lt, lte, gt, gte, in, nin
Sortable: true
", "format": "int32", "readOnly": true, "x-filterable": "eq, ne, lt, lte, gt, gte, in, nin", "x-sortable": true }, "balancingBehavior": { "type": "boolean", "description": "If set to true the balance is summed by month. If set to false the balance is summed by date.Filterable: eq, ne, lt, lte, gt, gte
Sortable: false
", "x-filterable": "eq, ne, lt, lte, gt, gte", "x-sortable": false }, "autoApprove": { "type": "boolean", "description": "Auto approve entries created by an adminFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "isStandingJournal": { "type": "boolean", "description": "Controls if the entries in the journal will stay after bookingFilterable: eq, ne, lt, lte, gt, gte
Sortable: false
", "x-filterable": "eq, ne, lt, lte, gt, gte", "x-sortable": false }, "requireAdminApproval": { "type": "boolean", "description": "Controls if the entries requires approval from an adminFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "lockVatCodes": { "type": "boolean", "description": "Controls if VAT codes are locked (only affects e-conomic UI)Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "nextVoucherNumber": { "type": [ "null", "integer" ], "description": "Defined the next voucher number used by journal entriesFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "minimumVoucherNumber": { "type": [ "null", "integer" ], "description": "Defines the miminum voucher number used by journal entriesFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "maximumVoucherNumber": { "type": [ "null", "integer" ], "description": "Defines the maximum voucher number used by journal entriesFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "customerContraAccount": { "type": [ "null", "integer" ], "description": "Defines a contra account automatically set when creating customer entriesFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "supplierContraAccount": { "type": [ "null", "integer" ], "description": "Defines a contra account automatically set when creating supplier entriesFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "customerPaymentText": { "type": [ "null", "string" ], "description": "Defines a payment text automatically set when creating customer entriesFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "supplierPaymentText": { "type": [ "null", "string" ], "description": "Defines a payment text automatically set when creating supplier entriesFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The name of the journalFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "priority": { "type": [ "null", "integer" ], "description": "Defines the UI order of all journals in e-conomicFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "allowPartialBooking": { "type": "boolean", "description": "When booking multiple entries with both approved and unapproved entries this controls whether to allow booking of the approved entries or none at allFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "requireBalancePerVoucherId": { "type": "boolean", "description": "When booking multiple entries with both balanced and unbalanced entries this controls whether to allow booking of the balanced entries or none at allFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "repeatText": { "type": "boolean", "description": "Controls whether to repeat text when creating multi legged entriesFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "paymentMessageText": { "type": [ "null", "string" ], "description": "Defines a text that is automatically applied to the message on paymentsFilterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false }, "defaultDepartment": { "type": [ "null", "integer" ], "description": "Defines a default department for entriesFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "allowedEntryType": { "pattern": "0|2|3|4|5|10", "type": [ "null", "integer" ], "description": "Restricts entries within the journal to a specific entry type. \nIt has 6 options: \n- 0: All types \n- 2: Customer Payment \n- 3: Supplier Invoice \n- 4: Supplier Payment \n- 5: Finance Voucher \n- 10: Manual Customer InvoiceFilterable: not filterable
Sortable: false
", "format": "int32", "x-filterable": "not filterable", "x-sortable": false }, "objectVersion": { "type": [ "null", "string" ], "description": "The object version, required for PUT requests to help ensure that updates made by others don't get overwritten by your update request.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false }, "JournalCursorResults": { "type": "object", "properties": { "cursor": { "type": [ "null", "string" ], "description": "Use this continuation cursor in a request back to continue the list. In case there are no more items to retrieve, the cursor is not returned at all.Read-only: true
Filterable: not filterable
Sortable: false
", "readOnly": true, "x-filterable": "not filterable", "x-sortable": false }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Journal" }, "description": "Max number of items returned is 1000.Filterable: not filterable
Sortable: false
", "x-filterable": "not filterable", "x-sortable": false } }, "additionalProperties": false, "description": "Array of objects along with a cursor.", "example": { "cursor": "234", "items": [ { "id": "13", "name": "Patrick" }, { "id": "16", "name": "John" } ] }, "x-cursor-page-size": 1000 }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/Error" } }, "traceId": { "type": "string" }, "errorCode": { "type": "string" }, "traceTimeUtc": { "type": "string" } }, "additionalProperties": false } }, "securitySchemes": { "X-AppSecretToken": { "type": "apiKey", "description": "Application secret token needed to access the endpoints.", "name": "X-AppSecretToken", "in": "header" }, "X-AgreementGrantToken": { "type": "apiKey", "description": "Agreement grant token needed to access the endpoints.", "name": "X-AgreementGrantToken", "in": "header" } } }, "security": [ { "X-AppSecretToken": [ ], "X-AgreementGrantToken": [ ] } ], "tags": [ { "name": "BookedEntries", "description": "BookedEntries allows booked entries and its related data to be fetched.\n\n### Notice\nThis endpoint is being deprecated in favor of /bookedEntriesApi/booked-entries/\n\n\n#### Examples of use cases:\n\n* Retrieve all booked entries\n* Retrieve all dimensions related with booked entries\n\n\n\n**Required application roles:** SuperUser or Bookkeeping [More info](https://www.e-conomic.com/developer/permissions)",
"x-required-roles": [
"Bookkeeping",
"SuperUser"
]
},
{
"name": "BookedEntryDimensions",
"description": "BookedEntryDimensions allows dimensions data related to booked entry to be fetched.\n\n### Notice\nThis endpoint is being deprecated in favor of /bookedEntriesApi/booked-entries/dimensions\n\n#### Examples of use cases:\n\n* Retrieve all dimensions related with booked entries;\n\n\n\n**Required application roles:** SuperUser or Bookkeeping [More info](https://www.e-conomic.com/developer/permissions)",
"x-required-roles": [
"Bookkeeping",
"SuperUser"
]
},
{
"name": "DraftEntries",
"description": "draft-entries endpoints allow draft entries to created, fetched, updated and deleted.\n\n\n#### Examples of use cases:\n\n* Create new draft entry\n* Update existing draft entry\n* Get all draft entries\n* Get single draft entry\n* Create up to 500 draft entries in bulk\n* Update up to 500 draft entries in bulk\n* Delete all draft entries within a journal\n\nDraftEntries endpoints allow journal entries to be booked.\n\n### Notice\nThis endpoint is being deprecated in favor of /journalsApi/draft-entries\n\n#### Examples of use cases:\n\n* Book all entries within a given interval;\n* Book all entries in a journal;\n\n\n\n**Required application roles:** SuperUser or Bookkeeping [More info](https://www.e-conomic.com/developer/permissions)",
"x-required-roles": [
"Bookkeeping",
"SuperUser"
]
},
{
"name": "DraftEntryAccruals",
"description": "draft-entries endpoints allow draft entries to created, fetched, updated and deleted.\n\n\n#### Examples of use cases:\n\n* Create new draft entry\n* Update existing draft entry\n* Get all draft entries\n* Get single draft entry\n* Create up to 500 draft entries in bulk\n* Update up to 500 draft entries in bulk\n* Delete all draft entries within a journal\n\ndraft-entries/dimensions allows dimensions data related to draft entry to be fetched.\n\n\n#### Examples of use cases:\n\n* Retrieve all dimensions related with draft entries;\n* Add new dimensions to draft entries;\n* Update existing dimensions on draft entries;\n* Delete existing dimensions from draft entries;\n\n\n\n**Required application roles:** SuperUser or Bookkeeping [More info](https://www.e-conomic.com/developer/permissions)",
"x-required-roles": [
"Bookkeeping",
"SuperUser"
]
},
{
"name": "JournalBooking",
"description": "journals endpoints allow draft entries to be booked and journals to be managed\n\n\n#### Examples of use cases:\n\n* Book all entries within a given interval\n* Book all entries in a journal\n* Fetch all journals in an agreement\n* Create new journals\n* Update existing journals\n* Delete existing journals\n\nRelated guide for users: [e-copedia](https://www.e-conomic.dk/support/artikler/opret-eller-slet-en-kassekladde) (Danish)\n\n\n\n**Required application roles:** SuperUser or Bookkeeping [More info](https://www.e-conomic.com/developer/permissions)",
"x-required-roles": [
"Bookkeeping",
"SuperUser"
]
},
{
"name": "Journals",
"description": "journals endpoints allow draft entries to be booked and journals to be managed\n\n\n#### Examples of use cases:\n\n* Book all entries within a given interval\n* Book all entries in a journal\n* Fetch all journals in an agreement\n* Create new journals\n* Update existing journals\n* Delete existing journals\n\nRelated guide for users: [e-copedia](https://www.e-conomic.dk/support/artikler/opret-eller-slet-en-kassekladde) (Danish)\n\n\n