Bank accounts API

List bank accounts

GET /bank_account
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • bank_name
  • id

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 609
Content-Type: application/json
[
  {
    "id": 1,
    "name": null,
    "owner": "Muster Hans",
    "bc_nr": null,
    "bank_name": "Muster Bank",
    "bank_nr": null,
    "account_nr": null,
    "iban_nr": null,
    "currency_id": 1,
    "accounting_plan_nr": null,
    "remarks": null,
    "is_esr": true,
    "esr_besr_id": "123456",
    "esr_post_account_nr": "01-4067-7",
    "esr_payment_for_text": null,
    "esr_in_favour_of_text": null
  },
  {
    "id": 2,
    "name": "Bank 1",
    "owner": "Max Muster",
    "bc_nr": "",
    "bank_name": "Testbank",
    "bank_nr": "",
    "account_nr": "",
    "iban_nr": "",
    "currency_id": 1,
    "accounting_plan_nr": "",
    "remarks": "",
    "is_esr": false,
    "esr_besr_id": null,
    "esr_post_account_nr": null,
    "esr_payment_for_text": null,
    "esr_in_favour_of_text": null
  }
]

Search bank accounts

POST /bank_account/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "bank_name",
    "value": "Muster Bank"
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • bank_name
  • id
Name Required Type Description
bank_name optional string

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 316
Content-Type: application/json
[
  {
    "id": 1,
    "name": null,
    "owner": "Muster Hans",
    "bc_nr": null,
    "bank_name": "Muster Bank",
    "bank_nr": null,
    "account_nr": null,
    "iban_nr": null,
    "currency_id": 1,
    "accounting_plan_nr": null,
    "remarks": null,
    "is_esr": true,
    "esr_besr_id": "123456",
    "esr_post_account_nr": "01-4067-7",
    "esr_payment_for_text": null,
    "esr_in_favour_of_text": null
  }
]

Show bank account

GET /bank_account/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 91f454c4c995cc5e228e63778bfaabe0
Content-Length: 292
Content-Type: application/json
{
  "id": 2,
  "name": "Bank 1",
  "owner": "Max Muster",
  "bc_nr": "",
  "bank_name": "Testbank",
  "bank_nr": "",
  "account_nr": "",
  "iban_nr": "",
  "currency_id": 1,
  "accounting_plan_nr": "",
  "remarks": "",
  "is_esr": false,
  "esr_besr_id": null,
  "esr_post_account_nr": null,
  "esr_payment_for_text": null,
  "esr_in_favour_of_text": null
}

Create bank account

POST /bank_account
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Bank 1",
  "owner": "Max Muster",
  "bank_name": "Testbank",
  "currency_id": 1
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
bank_name required string (80)
currency_id required Resource currency
name required string (80)
owner required string (100)
account_nr optional string (50)
accounting_plan_nr optional string (20)
bank_nr optional string (50)
bc_nr optional string (20)
iban_nr optional string (50)
remarks optional string (600)

The following scopes are needed:

  • general
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 91f454c4c995cc5e228e63778bfaabe0
Content-Length: 292
Content-Type: application/json
{
  "id": 2,
  "name": "Bank 1",
  "owner": "Max Muster",
  "bc_nr": "",
  "bank_name": "Testbank",
  "bank_nr": "",
  "account_nr": "",
  "iban_nr": "",
  "currency_id": 1,
  "accounting_plan_nr": "",
  "remarks": "",
  "is_esr": false,
  "esr_besr_id": null,
  "esr_post_account_nr": null,
  "esr_payment_for_text": null,
  "esr_in_favour_of_text": null
}

Overwrite bank account

PUT /bank_account/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Bank 1",
  "owner": "Max Muster",
  "bank_name": "Testbank",
  "currency_id": 1
}
Name Required Type Description
callback optional string
Name Required Type Description
bank_name required string (80)
currency_id required Resource currency
name required string (80)
owner required string (100)
account_nr optional string (50)
accounting_plan_nr optional string (20)
bank_nr optional string (50)
bc_nr optional string (20)
iban_nr optional string (50)
remarks optional string (600)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 91f454c4c995cc5e228e63778bfaabe0
Content-Length: 292
Content-Type: application/json
{
  "id": 2,
  "name": "Bank 1",
  "owner": "Max Muster",
  "bc_nr": "",
  "bank_name": "Testbank",
  "bank_nr": "",
  "account_nr": "",
  "iban_nr": "",
  "currency_id": 1,
  "accounting_plan_nr": "",
  "remarks": "",
  "is_esr": false,
  "esr_besr_id": null,
  "esr_post_account_nr": null,
  "esr_payment_for_text": null,
  "esr_in_favour_of_text": null
}

Edit bank account

POST /bank_account/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Bank 2"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
account_nr optional string (50)
accounting_plan_nr optional string (20)
bank_name optional string (80)
bank_nr optional string (50)
bc_nr optional string (20)
currency_id optional Resource currency
iban_nr optional string (50)
name optional string (80)
owner optional string (100)
remarks optional string (600)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 91f454c4c995cc5e228e63778bfaabe0
Content-Length: 292
Content-Type: application/json
{
  "id": 2,
  "name": "Bank 2",
  "owner": "Max Muster",
  "bc_nr": "",
  "bank_name": "Testbank",
  "bank_nr": "",
  "account_nr": "",
  "iban_nr": "",
  "currency_id": 1,
  "accounting_plan_nr": "",
  "remarks": "",
  "is_esr": false,
  "esr_besr_id": null,
  "esr_post_account_nr": null,
  "esr_payment_for_text": null,
  "esr_in_favour_of_text": null
}

Delete bank account

Please note that the last bank account can not be deleted.

DELETE /bank_account/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}