Retrieving a List of Write-offs

Open in

View as Markdown

Open in ChatGPT Open in Claude

Maxim

Last updated on Oct 8, 2026

Returns the company's write-offs, from newest to oldest: by date, and within one date by ID. Lines are not included in the list; they are returned by v1/writeoffs/get_entry.

v1/writeoffs/get_list.php

Parameters

Field	Type	Required	Description
date_from	string	No	Write-offs from this date inclusive, YYYY-MM-DD
date_to	string	No	Write-offs up to this date inclusive, YYYY-MM-DD
status	int	No	Status: 0 Plan, 1 Written off
limit	int	No	Page size, from 1 to 1000
offset	int	No	How many records to skip

Without limit the whole list is returned. See Common Rules for pagination.

Response

An array writeoffs with the write-off's fields:

Field	Type	Description
id	int	Write-off ID
num	string	Number
date	string	Write-off date, YYYY-MM-DD
status	int	Status: 0 Plan, 1 Written off
materials_storage_id	int	Storage location materials are written off from
materials_storage_name	string	Materials storage location name
products_storage_id	int	Storage location products are written off from
products_storage_name	string	Products storage location name
cost	float	Cost of what was written off
amount	float	Total quantity. null if the items have different units
lines	int	Number of lines
notes	string	Notes

The total field holds the total number of write-offs matching the filters.

Example request

{
    "date_from": "2026-10-01",
    "date_to": "2026-10-31",
    "limit": 100,
    "offset": 0
}

Example response

{
    "success": true,
    "writeoffs": [
        {
            "id": 19291,
            "num": "48",
            "date": "2026-10-06",
            "status": 1,
            "materials_storage_id": 3998,
            "materials_storage_name": "Main",
            "products_storage_id": 4001,
            "products_storage_name": "Finished goods",
            "cost": 26350,
            "amount": null,
            "lines": 2,
            "notes": "Defect while cutting"
        }
    ],
    "total": 1
}

Errors

Error	Reason
Date is not a valid date in format YYYY-MM-DD	Invalid date_from or date_to
Invalid status value. Must be a number	status is not a number
Invalid limit value. Must be between 1 and 1000	Invalid limit
Offset requires limit	offset passed without limit