Reporting

Dashboards, revenue/receivables/profit-loss reports, and exports

Get aged receivables report#

GET /api/v1/reports/aged-receivables

Requires authentication (Bearer token) and the X-Organization-Id header.

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/reports/aged-receivables" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get dashboard statistics#

GET /api/v1/reports/dashboard

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/reports/dashboard" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Export data (CSV/JSON)#

POST /api/v1/reports/export

Requires authentication (Bearer token) and the X-Organization-Id header.

Request body#

Responses#

Example request#

curl -X POST "https://app.encryptinvoice.com/api/v1/reports/export" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "string",
    "format": "string",
    "start_date": "string",
    "end_date": "string"
}'

Get profit & loss report#

GET /api/v1/reports/profit-loss

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/reports/profit-loss" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get revenue report#

GET /api/v1/reports/revenue

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/reports/revenue" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Get top customers report#

GET /api/v1/reports/top-customers

Requires authentication (Bearer token) and the X-Organization-Id header.

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/reports/top-customers" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

VAT / tax summary for a period#

GET /api/v1/reports/vat

Requires authentication (Bearer token) and the X-Organization-Id header.

Output tax collected on outbound invoices vs input tax paid on VAT-deductible expenses, and the net position — bucketed by tax rate (and category). Params: start_date, end_date (required), grouping (monthly|quarterly|annual). Amounts are decimal strings in the organization currency; multi-currency periods return per-currency sections in rows. (#846)

Parameters#

Responses#

Example request#

curl -X GET "https://app.encryptinvoice.com/api/v1/reports/vat" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"