Get credit notes analytics

GET
/analytics/credit_notes

Retrieve aggregated statistics for payables with different breakdowns.

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

dimensionenumOptional
metricenumRequired
Allowed values: idtotal_amount
aggregation_functionenumRequired
Allowed values: countaveragesummaryminmax
date_dimension_breakdownenumOptional
Allowed values: dailyweeklymonthlyquarterlyyearly
limitintegerOptional>=1<=400Defaults to 100

The number of items (0 .. 400) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

created_at__gtdatetimeOptional
created_at__ltdatetimeOptional
created_at__gtedatetimeOptional
created_at__ltedatetimeOptional
issued_atstringOptional
issued_at__gtstringOptional
issued_at__ltstringOptional
issued_at__gtestringOptional
issued_at__ltestringOptional
document_idstringOptional
document_id__iexactstringOptional
document_id__containsstringOptional
document_id__icontainsstringOptional
total_amount__gtintegerOptional
total_amount__ltintegerOptional
total_amount__gteintegerOptional
total_amount__lteintegerOptional
subtotal__gtintegerOptional
subtotal__ltintegerOptional
subtotal__gteintegerOptional
subtotal__lteintegerOptional
based_onstringOptional
counterpart_idstringOptional
created_by_entity_user_idstringOptional
statusenumOptional
status__inenumOptional
status__not_inenumOptional
originenumOptional
Allowed values: uploadeinvoicing
currencyenumOptional
project_idstringOptional
project_id__instringOptionalformat: "uuid"

Response

Successful Response

datalist of objects

Errors

Get payables analytics