Receipt Status API

Manage receipt statuses — retrieval, translations, and creation

Base URL

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

Every request returns a JSON response. On success result.code == 1; on error result.code == 0. A receipt status is a state shown on documents — e.g. planned, closed, paid. Statuses can also store translations in multiple languages.

GET /api/receipt_status/get

Retrieve a single receipt status by identifier and language.

Query parameters

ParameterTypeRequiredDescription
idintStatus identifier
language_idintTranslation language identifier

Example request

GET /api/receipt_status/get?id=1&language_id=1
X-API-KEY: {your_api_key}
GET /api/receipt_status/get_all

Retrieve all receipt statuses — without filtering.

Query parameters

ParameterTypeRequiredDescription
idintOptional status identifier filter

Example request

GET /api/receipt_status/get_all
X-API-KEY: {your_api_key}
GET /api/receipt_status/list

Paginated list of receipt statuses.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_conditionobjectFilter conditions object
language_idintTranslation language identifier

Example request

GET /api/receipt_status/list?language_id=1
X-API-KEY: {your_api_key}
POST /api/receipt_status/save

Create or update a receipt status. For a new status use data[id] = 0. The data array can also contain translations in multiple languages.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new status, >0 = update
name_keystringStatus key name (translation key)
outer_resource_namestringStatus name in the external system
dataobjectTranslations object: { "1": "Tervezett", "2": "Planned" } (key = language_id)

Example request

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

{
  "data": {
    "id": 0,
    "name_key": "receipt_status_custom",
    "outer_resource_name": "PENDING",
    "data": { "1": "Várakozik", "2": "Pending" }
  }
}
POST /api/receipt_status/delete

Delete a receipt status by identifier. Only removable (removeable = 1) statuses can be deleted.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the status to delete

Example request

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

{ "data": { "id": 5 } }

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!