Skip to main content
GET
/
analytics
/
credit_notes
Get credit notes analytics
curl --request GET \
  --url https://api.sandbox.monite.com/v1/analytics/credit_notes \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "metric_value": 123,
      "dimension_value": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Query Parameters

​
dimension
enum<string>
Available options:
created_at,
status,
counterpart_id,
currency,
issued_at,
project_id
​
metric
enum<string>
required
Available options:
id,
total_amount
​
aggregation_function
enum<string>
required
Available options:
count,
average,
summary,
min,
max
​
date_dimension_breakdown
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
yearly
​
limit
integer
default: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.

Required range: 1 <= x <= 400
​
created_at__gt
string<date-time>
​
created_at__lt
string<date-time>
​
created_at__gte
string<date-time>
​
created_at__lte
string<date-time>
​
issued_at
string<date>
​
issued_at__gt
string<date>
​
issued_at__lt
string<date>
​
issued_at__gte
string<date>
​
issued_at__lte
string<date>
​
document_id
string
​
document_id__iexact
string
​
document_id__contains
string
​
document_id__icontains
string
​
has_file
boolean
​
total_amount__gt
integer
Required range: x >= 0
​
total_amount__lt
integer
Required range: x >= 0
​
total_amount__gte
integer
Required range: x >= 0
​
total_amount__lte
integer
Required range: x >= 0
​
subtotal__gt
integer
Required range: x >= 0
​
subtotal__lt
integer
Required range: x >= 0
​
subtotal__gte
integer
Required range: x >= 0
​
subtotal__lte
integer
Required range: x >= 0
​
based_on
string<uuid>
​
counterpart_id
string<uuid>
​
created_by_entity_user_id
string<uuid>
​
status
enum<string>

Credit note statuses (used in accounts payable).

Available options:
new,
draft,
applied,
approved,
rejected,
canceled,
submitted_for_approval
​
status__in
enum<string>[]

Credit note statuses (used in accounts payable).

Available options:
new,
draft,
applied,
approved,
rejected,
canceled,
submitted_for_approval
​
status__not_in
enum<string>[]

Credit note statuses (used in accounts payable).

Available options:
new,
draft,
applied,
approved,
rejected,
canceled,
submitted_for_approval
​
origin
enum<string>
Available options:
upload,
einvoicing
​
currency
enum<string>
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
project_id
string<uuid>
​
project_id__in
string<uuid>[]

Response

Successful Response

​
data
object[]
required