Skip to main content
GET
/
invoices
/
reconciliation-summary
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/invoices/reconciliation-summary \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "byStatus": {},
  "totalAmountCents": 123,
  "reconciledAmountCents": 123,
  "exceptionCount": 123,
  "averageAgingDays": 123,
  "oldestUnreconciledDays": 123
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

​
from
string<date-time>

ISO 8601 start of the reporting period; omit for unbounded start.

​
to
string<date-time>

ISO 8601 end of the reporting period; omit for unbounded end.

Response

200 - application/json

OK

Aggregated reconciliation metrics for the requested period.

​
total
integer
required

Total number of invoices in the period.

​
byStatus
object
required

Invoice count grouped by status.

​
totalAmountCents
integer
required

Sum of all invoice amounts in cents.

​
reconciledAmountCents
integer
required

Sum of reconciled invoice amounts in cents.

​
exceptionCount
integer
required

Number of invoices flagged as exceptions.

​
averageAgingDays
number
required

Mean number of days invoices have been outstanding.

​
oldestUnreconciledDays
number | null
required

Age in days of the oldest unreconciled invoice, or null if all are reconciled.