API Response Formats
Overview of API response formats and data structures. All endpoints return standardized JSON with a success indicator and message. List endpoints support pagination.
Screenshots and a more detailed guide are coming soon.
Standard response
Most API endpoints return a standard response with fields: 'success' (boolean — whether the operation succeeded) and 'message' (string — text message about the result, especially on error). Some endpoints return an extended response with a 'result' field containing the result data object (e.g., created invoice or extracted data).
Paginated list
The list endpoint /api/invoice-isdoc returns a response with fields: 'items' (array of invoice objects with complete data), 'hasMore' (boolean — whether more records exist beyond the current page), 'totalCount' (total record count in database). Pagination is controlled by 'offset' (starting record) and 'limit' (number of records, default 25) parameters.