For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API StatusPartner Portal
HomeGuidesAPI ExplorerSDKsGitHubSupport
HomeGuidesAPI ExplorerSDKsGitHubSupport
  • API Concepts
    • Overview
    • Environments and URLs
    • Authentication
    • API versioning
    • Rate limiting
    • HTTP headers
    • Pagination, sorting, and filtering
  • General
  • Common
      • GETGet credit notes analytics
      • GETGet payables analytics
      • GETGet receivables analytics
  • Accounts payable
  • Accounts receivable
  • E-invoicing
  • Payments
  • Accounting integration
  • Expense management
  • Utilities
LogoLogo
API StatusPartner Portal
CommonAnalytics

Get credit notes analytics

GET
/analytics/credit_notes
GET
/v1/analytics/credit_notes
$curl -G https://api.sandbox.monite.com/v1/analytics/credit_notes \
> -H "x-monite-version: 2023-09-01" \
> -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
> -H "Authorization: Bearer <token>" \
> -d metric=id \
> -d aggregation_function=count
1{
2 "data": [
3 {
4 "metric_value": 1.1,
5 "dimension_value": "dimension_value"
6 }
7 ]
8}
Retrieve aggregated statistics for payables with different breakdowns.
Was this page helpful?
Previous

Get payables analytics

Next
Built with

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
status__inenumOptional
status__not_inenumOptional
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
500
Get Analytics Credit Notes Request Internal Server Error