v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

CheckAccount

Update an existing check account

Update a check account

put/CheckAccount/{checkAccountId}

Path parameters

checkAccountIdinteger required

ID of check account to update

Request body

namestring

Name of the check account

defaultAccount0 | 1

Defines if this check account is the default account.

autoMapTransactionsinteger nullable

Defines if transactions on this account are automatically mapped to invoice and vouchers when imported if possible.

accountingNumberstring

The booking account used for this bank account, e.g. 1800 in SKR04 and 1200 in SKR03. Must be unique among all your CheckAccounts. Ignore to use a sensible default.

ibanstring

IBAN of a bank account

bicstring

BIC of the related bank

Example request

{
  "name": "Iron Bank"
}

Response

Successful operation - Returns changed check account resource

idstring

The check account id

objectNamestring

The check account object name

createstring date-time

Date of check account creation

updatestring date-time

Date of last check account update

namestring

Name of the check account

ibanstring nullable

The IBAN of the account

type'online' | 'offline' | 'register'

The type of the check account. Account with a CSV or MT940 import are regarded as online.

importType'CSV' | 'MT940' | 'null' nullable

Import type, for accounts that are type "online" but not connected to a data provider.

currencystring

The currency of the check account.

defaultAccountstring

Defines if this check account is the default account.

baseAccountstring

This will be 1 if the account is your base account that comes with every sevdesk setup.

prioritystring

Defines the sorting of accounts, highest is first.

status'0' | '100'

Status of the check account. 0 <-> Archived - 100 <-> Active

balancestring nullable

The account balance as reported by PayPal or finAPI. Not set for other types of accounts.

bankServerstring nullable

Bank server of check account, only set if the account is connected to a data provider

autoMapTransactionsstring nullable

Defines if transactions on this account are automatically mapped to invoice and vouchers when imported if possible.

autoSyncTransactionsstring

If this is 1 the account will be automatically updated through PayPal or finAPI. Only applicable for connected online accounts.

lastSyncstring date-time

Timepoint of the last payment import through PayPal or finAPI.

accountingNumberstring

The booking account used for this account, e.g. 1800 in SKR04 and 1200 in SKR03. Must be unique among all your CheckAccounts.

bicstring nullable

The BIC of the bank this account belongs to

Example response

{
  "id": "2",
  "objectName": "CheckAccount",
  "create": "2024-06-28T14:42:58+02:00",
  "update": "2024-06-28T14:42:58+02:00",
  "sevClient": {
    "id": "0",
    "objectName": "SevClient"
  },
  "name": "Iron Bank",
  "iban": "DE02100500000054540402",
  "type": "online",
  "importType": "CSV",
  "currency": "EUR",
  "baseAccount": "1",
  "priority": "2",
  "status": "100",
  "balance": "12.34",
  "bankServer": "FINAPI",
  "lastSync": "2024-06-28T14:42:58+02:00",
  "accountingNumber": "1800",
  "bic": "BELADEBEXXX"
}