Analytics

GET
/payables/analytics

Retrieve aggregated statistics for payables, including total amount and count, both overall and by status.

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

created_at__gtdatetimeOptional
created_at__ltdatetimeOptional
created_at__gtedatetimeOptional
created_at__ltedatetimeOptional
statusenumOptional
status__inenumOptional
id__instringOptional
total_amountintegerOptional
total_amount__gtintegerOptional
total_amount__ltintegerOptional
total_amount__gteintegerOptional
total_amount__lteintegerOptional
amountintegerOptional
amount__gtintegerOptional
amount__ltintegerOptional
amount__gteintegerOptional
amount__lteintegerOptional
currencyenumOptional
counterpart_namestringOptional
counterpart_name__containsstringOptional
counterpart_name__icontainsstringOptional
search_textstringOptional
due_datestringOptional
due_date__gtstringOptional
due_date__ltstringOptional
due_date__gtestringOptional
due_date__ltestringOptional
document_idstringOptional
document_id__containsstringOptional
document_id__icontainsstringOptional
was_created_by_user_idstringOptional
counterpart_idstringOptional
source_of_payable_data"ocr" or "user_specified"Optional
Allowed values: ocruser_specified
ocr_statusenumOptional
Allowed values: processingerrorsuccess
line_item_idstringOptional

Search for a payable by the identifier of the line item associated with it.

purchase_order_idstringOptional

Search for a payable by the identifier of the purchase order associated with it.

project_idstringOptional

Search for a payable by the identifier of the project associated with it.

tag_idsstringOptional

Search for a payable by the identifiers of the tags associated with it.

Response

Successful Response

countinteger

The total count of payables across all statuses.

datalist of objects

A list of aggregated items, each representing a status with its associated sum of the amount field and count.

sum_total_amountinteger

The total sum of the amount field for all payables across all statuses.

Errors

Upload a payable from a file