REST API

Reports API

ERP reporting API for accounts receivable and payable aging, sales, purchases, and expiring inventory.

Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.

GET /reports/ap-aging

Get Accounts Payable Aging Report

Return accounts payable aging by supplier, grouped into aging buckets from outstanding purchasing documents.

Responses

StatusDescriptionBody
200Returns the requested accounts payable aging report result.object

Example

curl -X GET http://localhost:8000/reports/ap-aging \
  -H "Authorization: Bearer $TOKEN"

GET /reports/ar-aging

Get Accounts Receivable Aging Report

Return accounts receivable aging by customer, grouped into aging buckets from outstanding sales documents.

Responses

StatusDescriptionBody
200Returns the requested accounts receivable aging report result.object

Example

curl -X GET http://localhost:8000/reports/ar-aging \
  -H "Authorization: Bearer $TOKEN"

GET /reports/expiring

Get Expiring Inventory Report

Return inventory items that expire within the requested number of days, ordered by soonest expiration.

Parameters

NameInRequiredTypeDescription
daysquery--integerNumber of days ahead to include when finding expiring inventory.

Responses

StatusDescriptionBody
200Returns the requested expiring inventory report result.object
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/reports/expiring \
  -H "Authorization: Bearer $TOKEN"

GET /reports/purchases

Get Purchasing Report

Return purchasing activity for the requested reporting period, with supported grouping and filters.

Parameters

NameInRequiredTypeDescription
group_byquery--stringDimension used to group the report results.
periodquery--stringReporting period or period granularity requested by the endpoint.
date_fromquery--string, optionalStart date for the requested reporting or search period.
date_toquery--string, optionalEnd date for the requested reporting or search period.

Responses

StatusDescriptionBody
200Returns the requested purchasing report result.object
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/reports/purchases \
  -H "Authorization: Bearer $TOKEN"

GET /reports/sales

Get Sales Report

Return sales revenue, cost, and profit for the requested reporting period, with supported grouping and filters.

Parameters

NameInRequiredTypeDescription
group_byquery--stringDimension used to group the report results.
periodquery--stringReporting period or period granularity requested by the endpoint.
date_fromquery--string, optionalStart date for the requested reporting or search period.
date_toquery--string, optionalEnd date for the requested reporting or search period.

Responses

StatusDescriptionBody
200Returns the requested sales report result.object
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/reports/sales \
  -H "Authorization: Bearer $TOKEN"