Bank Document API

Manage bank financial documents — retrieval, creation, update and deletion

Base URL

https://{tenant}.logzi.com/api/cash/

Bank documents are managed through the cash document (/api/cash/) API. Bank and cash documents share the same endpoint — they are distinguished by cashstock_id: the identifier of the cash stock assigned to the bank account must be provided. On success result.code == 1, on error result.code == 0.

GET /api/cash/get

Retrieve a single bank document by identifier, including its line item and related documents.

Query Parameters

ParameterTypeRequiredDescription
idintUnique identifier of the bank document

Example Request

GET /api/cash/get?id=88
X-API-KEY: {your_api_key}
GET /api/cash/list

Retrieve a paginated list of bank documents with filtering options.

Query Parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_countintNumber of records per page
list_condition[identify]stringFilter by document number (LIKE)
list_condition[partner_name]stringFilter by partner name (LIKE)
list_condition[cashstock_id]intFilter by bank account / cash stock identifier
list_condition[type_id]intFilter by document type (income / expense)
list_condition[date_create_from]dateCreation date — from (YYYY-MM-DD)
list_condition[date_create_to]dateCreation date — to (YYYY-MM-DD)

Example Request

GET /api/cash/list?list_offset=0&list_condition[cashstock_id]=2
X-API-KEY: {your_api_key}
POST /api/cash/save

Create or update a bank document. The value of cashstock_id determines whether a cash document or a bank document is created. Use data[id] = 0 for a new document.

POST Fields — data object

FieldTypeRequiredDescription
idint0 = new document, >0 = update
company_idintCompany identifier
company_user_idintResponsible employee ID
cashstock_idintBank account / cash stock identifier
receipt_type_idintDocument type (income / expense)
currency_idintCurrency identifier
partner_idintPartner identifier
date_performdatePerformance / value date (YYYY-MM-DD)
price_bruttofloatDocument amount (gross)
comment_topstringComment / remittance note
itemarrayRelated document line items (e.g. invoice reference)

Example Request

POST /api/cash/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "cashstock_id": 2,
    "receipt_type_id": 27,
    "currency_id": 1,
    "partner_id": 8,
    "date_perform": "2024-07-01",
    "price_brutto": 127000,
    "comment_top": "Számla kiegyenlítés"
  }
}
POST /api/cash/delete

Delete a bank document. Only documents that are not closed can be deleted.

POST Fields — data object

FieldTypeRequiredDescription
receipt_idintIdentifier of the bank document to delete

Example Request

POST /api/cash/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 88 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!