EntityInvoice

Get Metrics

GET
https://api.mercoa.com/entity/:entityId/invoice-metrics

Get invoice metrics for an entity with the given filters.

Path parameters

entityId
string

Query parameters

search
optional string

Filter vendors by name. Partial matches are supported.

excludePayables
optional boolean

Only return invoices that are not payable by the entity. This will return only invoices that are receivable by the entity.

excludeReceivables
optional boolean

Only return invoices that are not receivable by the entity. This will return only invoices that are payable by the entity.

payerId
optional string

Filter invoices by payer ID.

vendorId
optional string

Filter invoices by vendor ID.

approverId
optional string

Filter invoices by assigned approver user ID.

invoiceId
optional string

Filter invoices by invoice ID.

status
optional enum

Invoice status to filter on

dueDateStart
optional datetime

Start date for invoice dueDate filter.

dueDateEnd
optional datetime

End date for invoice dueDate filter.

createdDateStart
optional datetime

Start date for invoice created on date filter.

createdDateEnd
optional datetime

End date for invoice created date filter.

currency
optional enum

Currency to filter on

Response

This endpoint return a list of objects.
totalAmount
double
totalCount
integer
averageAmount
double
currency
enum
GET
/entity/:entityId/invoice-metrics
curl -G https://api.mercoa.com/entity/:entityId/invoice-metrics \
-H "Authorization: Bearer <token>" \
-d search=string \
-d excludePayables=true
Response
[
{
"totalAmount": 1,
"totalCount": 0,
"averageAmount": 1,
"currency": "AED"
}
]