CommonAnalytics

Get credit notes analytics

Retrieve aggregated statistics for payables with different breakdowns.

Headers

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:
aggregation_functionenumRequired
Allowed values:
date_dimension_breakdownenumOptional
Allowed values:
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_atstringOptionalformat: "date"
issued_at__gtstringOptionalformat: "date"
issued_at__ltstringOptionalformat: "date"
issued_at__gtestringOptionalformat: "date"
issued_at__ltestringOptionalformat: "date"
document_idstringOptional
document_id__iexactstringOptional
document_id__containsstringOptional
document_id__icontainsstringOptional
has_filebooleanOptional
total_amount__gtintegerOptional>=0
total_amount__ltintegerOptional>=0
total_amount__gteintegerOptional>=0
total_amount__lteintegerOptional>=0
subtotal__gtintegerOptional>=0
subtotal__ltintegerOptional>=0
subtotal__gteintegerOptional>=0
subtotal__lteintegerOptional>=0
based_onstringOptionalformat: "uuid"
counterpart_idstringOptionalformat: "uuid"
created_by_entity_user_idstringOptionalformat: "uuid"
statusenumOptional
status__inenumOptional
status__not_inenumOptional
originenumOptional
Allowed values:
currencyenumOptional
project_idstringOptionalformat: "uuid"
project_id__instringOptionalformat: "uuid"

Response

Successful Response

datalist of objects

Errors