Update Bank Entry

PATCH /banking/bank-entries/{id}

Group: Banking › Bank Entries · Operation ID: updateBankEntry

Updates the bank entry with the given identifier. Only the fields in the request body change. Use the bank entry's id, not its bankEntryNumber.

Only the fields in the request body change, and the response is empty. Read the result with GET banking/bank-entries/:id.

Lines are edited through three arrays: createLines, updateLines and deleteLines. They are applied in that order, deletes first, then updates, then creates. Omit an array for no operations of that kind, and omit all three to leave the lines unchanged. Lines you do not name are kept.

Every line id in updateLines or deleteLines must belong to this entry. One that does not fails with LINE_NOT_FOUND and nothing is written.

The resulting lines are still subject to the whole-entry rules: at least one line, no line of zero, and a non-zero total.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the bank entry to update.

Request body

Required, application/json: updateBankEntryInput.

Field Type Required Description
entityId string no The legal entity the entry is posted under. See id on GET base/entities.
bankAccountId string no The general-ledger account behind the bank account this entry posts against. See id on GET accounting/accounts/:id.
transactionDate string (date) no The date the transaction took place. Use format YYYY-MM-DD. Changing it re-resolves the posting period.
currency string no The currency of the entry. Format ISO 4217, for example 'USD'. When supplied it must match the account's currency.
status string no The reconciliation status. Accepted values: 'matched', 'unmatched', 'voided', 'integrated'.
name string no A short name for the entry.
description string no A free-form description of the entry.
serviceDate string (date) no The date the goods or services were delivered. Use format YYYY-MM-DD.
origin string no The system or process the entry originated from.
externalUrl string no A link to the entry in the originating system.
createLines array of object no Lines to add. Each has the same shape as a line on create, with no id because the line does not exist yet.
createLines[].accountId string yes The general-ledger account this line posts to. It must not be a grouping account. See id on GET accounting/accounts/:id.
createLines[].amount string (decimal) yes The line amount, as a decimal in the entry currency. It must be non-zero.
createLines[].description string no A free-form description of the line.
createLines[].departmentId string no The department this line is attributed to. See id on GET departments/:id.
createLines[].businessUnitId string no The business unit this line is attributed to. There is no endpoint for it.
createLines[].businessPartnerId string no The business partner this line is attributed to. Required when vatPercentage is supplied. There is no endpoint for it.
createLines[].lineType string no The kind of line. Accepted values: 'oneTime', 'prepaid'. Derived from the account's sub-type when omitted.
createLines[].vatPercentage string (decimal) no The VAT rate applied, as a percentage. For example, 19 means 19%. Supplying it requires businessPartnerId.
createLines[].vatAccountId string no The general-ledger account the VAT posts to. See id on GET accounting/accounts/:id.
createLines[].reverseVatAccountId string no The general-ledger account the reverse-charge VAT posts to. See id on GET accounting/accounts/:id.
createLines[].vatAmount string (decimal) no The VAT amount, as a decimal in the entry currency. Omit to derive it from vatPercentage.
createLines[].netAmount string (decimal) no The net amount, as a decimal in the entry currency. Omit to derive it from amount less VAT.
updateLines array of object no Lines to change, each addressed by its id. Every field but the id is optional, and omitting one leaves that field unchanged.
updateLines[].id string yes The unique identifier for the line to change. It must belong to this bank entry.
updateLines[].accountId string no The general-ledger account this line posts to. It must not be a grouping account. See id on GET accounting/accounts/:id.
updateLines[].amount string (decimal) no The line amount, as a decimal in the entry currency. It must be non-zero.
updateLines[].description string no A free-form description of the line.
updateLines[].departmentId string no The department this line is attributed to. See id on GET departments/:id.
updateLines[].businessUnitId string no The business unit this line is attributed to. There is no endpoint for it.
updateLines[].businessPartnerId string no The business partner this line is attributed to. Required when vatPercentage is supplied. There is no endpoint for it.
updateLines[].lineType string no The kind of line. Accepted values: 'oneTime', 'prepaid'. Derived from the account's sub-type when omitted.
updateLines[].vatPercentage string (decimal) no The VAT rate applied, as a percentage. For example, 19 means 19%. Supplying it requires businessPartnerId.
updateLines[].vatAccountId string no The general-ledger account the VAT posts to. See id on GET accounting/accounts/:id.
updateLines[].reverseVatAccountId string no The general-ledger account the reverse-charge VAT posts to. See id on GET accounting/accounts/:id.
updateLines[].vatAmount string (decimal) no The VAT amount, as a decimal in the entry currency. Omit to derive it from vatPercentage.
updateLines[].netAmount string (decimal) no The net amount, as a decimal in the entry currency. Omit to derive it from amount less VAT.
deleteLines array of string no The identifiers of lines to remove. Each must belong to this bank entry.

Example:

{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transactionDate": "2026-01-15",
  "currency": "<currency>",
  "status": "<status>",
  "name": "February bank fees — revised",
  "description": "<description>",
  "serviceDate": "2026-01-15",
  "origin": "<origin>",
  "externalUrl": "<externalUrl>",
  "createLines": [
    {
      "accountId": "9994c3ed-f812-44c1-9454-7f36b2bfb0fb",
      "amount": "-25.00",
      "description": "Wire fee"
    }
  ],
  "updateLines": [
    {
      "id": "7a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
      "amount": "-150.00"
    }
  ],
  "deleteLines": [
    "1f2e3d4c-5b6a-7089-9a8b-7c6d5e4f3a2b"
  ]
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
LINE_NOT_FOUND 400
REFERENCE_NOT_FOUND 400
INVALID_FIELD_VALUE 400
POSTING_PERIOD_NOT_OPEN 400
CURRENCY_MISMATCH 400
ACCOUNT_ENTITY_MISMATCH 400
GROUPING_ACCOUNT_NOT_ALLOWED 400
BUSINESS_PARTNER_REQUIRED_FOR_VAT 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses