CommonAnalytics

Get credit notes analytics

Retrieve aggregated statistics for payables with different breakdowns.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

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:
limitintegerOptional1-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

Credit note statuses (used in accounts payable).

status__inenumOptional

Credit note statuses (used in accounts payable).

status__not_inenumOptional

Credit note statuses (used in accounts payable).

originenumOptional
Allowed values:
currencyenumOptional
project_idstringOptionalformat: "uuid"
project_id__instringOptionalformat: "uuid"

Response

Successful Response
datalist of objects

Errors

401
Get Analytics Credit Notes Request Unauthorized Error
403
Get Analytics Credit Notes Request Forbidden Error
422
Get Analytics Credit Notes Request Unprocessable Entity Error
429
Get Analytics Credit Notes Request Too Many Requests Error