Get payables analytics

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,

due_date,

project_id

metric

enum<string>

required

Available options:

id,

total_amount,

amount_due

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>

Return only payables created in Monite after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm].

created_at__lt

string<date-time>

Return only payables created in Monite before the specified date and time.

created_at__gte

string<date-time>

Return only payables created in Monite on or after the specified date and time.

created_at__lte

string<date-time>

Return only payables created in Monite before or on the specified date and time.

status

enum<string>

Return only payables that have the specified status.

To query multiple statuses at once, use the status__in parameter instead.

Available options:

draft,

new,

approve_in_progress,

waiting_to_be_paid,

partially_paid,

paid,

canceled,

rejected

status__in

enum<string>[]

Return only payables that have the specified statuses.

To specify multiple statuses, repeat this parameter for each value: status__in=draft&status__in=new

Available options:

draft,

new,

approve_in_progress,

waiting_to_be_paid,

partially_paid,

paid,

canceled,

rejected

id__in

string<uuid>[]

Return only payables with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results.

To specify multiple IDs, repeat this parameter for each value: id__in=<id1>&id__in=<id2>

total_amount

integer

Return only payables with the exact specified total amount. The amount must be specified in the minor units of currency. For example, $12.5 is represented as 1250.

total_amount__gt

integer

Return only payables whose total amount (in minor units) exceeds the specified value.

total_amount__lt

integer

Return only payables whose total amount (in minor units) is less than the specified value.

total_amount__gte

integer

Return only payables whose total amount (in minor units) is greater than or equal to the specified value.

total_amount__lte

integer

Return only payables whose total amount (in minor units) is less than or equal to the specified value.

amount

integer

Return only payables with the specified amount.

amount__gt

integer

Return only payables whose amount (in minor units) exceeds the specified value.

amount__lt

integer

Return only payables whose amount (in minor units) is less than the specified value.

amount__gte

integer

Return only payables whose amount (in minor units) is greater than or equal to the specified value.

amount__lte

integer

Return only payables whose amount (in minor units) is less than or equal to the specified value.

currency

enum<string>

Return only payables that use the specified currency.

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

counterpart_name

string

Return only payables received from counterparts with the specified name (exact match, case-sensitive).

For counterparts of type = individual, the full name is formatted as first_name last_name.

counterpart_name__contains

string

Return only payables received from counterparts whose name contains the specified string (case-sensitive).

counterpart_name__icontains

string

Return only payables received from counterparts whose name contains the specified string (case-insensitive).

search_text

string

Apply the icontains condition to search for the specified text in the document_id and counterpart_name fields in the payables.

due_date

string<date>

Return payables that are due on the specified date (YYYY-MM-DD)

due_date__gt

string<date>

Return payables that are due after the specified date (exclusive, YYYY-MM-DD).

due_date__lt

string<date>

Return payables that are due before the specified date (exclusive, YYYY-MM-DD).

due_date__gte

string<date>

Return payables that are due on or after the specified date (YYYY-MM-DD).

due_date__lte

string<date>

Return payables that are due before or on the specified date (YYYY-MM-DD).

issued_at

string<date>

Return payables that are issued at the specified date (YYYY-MM-DD)

issued_at__gt

string<date>

Return payables that are issued after the specified date (exclusive, YYYY-MM-DD).

issued_at__lt

string<date>

Return payables that are issued before the specified date (exclusive, YYYY-MM-DD).

issued_at__gte

string<date>

Return payables that are issued on or after the specified date (YYYY-MM-DD).

issued_at__lte

string<date>

Return payables that are issued before or on the specified date (YYYY-MM-DD).

document_id

string

Return a payable with the exact specified document number (case-sensitive).

The document_id is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (id).

document_id__contains

string

Return only payables whose document number (document_id) contains the specified string (case-sensitive).

document_id__icontains

string

Return only payables whose document number (document_id) contains the specified string (case-insensitive).

was_created_by_user_id

string<uuid>

Return only payables created in Monite by the entity user with the specified ID.

counterpart_id

string<uuid>

Return only payables received from the counterpart with the specified ID.

Counterparts that have been deleted but have associated payables will still return results here because the payables contain a frozen copy of the counterpart data.

If the specified counterpart ID does not exist and never existed, no results are returned.

source_of_payable_data

enum<string>

Return only payables coming from the specified source.

Available options:

ocr,

user_specified,

einvoicing

ocr_status

enum<string>

Return only payables with specific OCR statuses.

Available options:

processing,

error,

success

line_item_id

string<uuid>

Search for a payable by the identifier of the line item associated with it.

purchase_order_id

string<uuid>

Search for a payable by the identifier of the purchase order associated with it.

project_id

string<uuid>

Return only payables assigned to the project with the specified ID.

Valid but nonexistent project IDs do not raise errors but return no results.

project_id__in

string<uuid>[]

Return only payables whose project_id include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results.

tag_ids

string<uuid>[]

Return only payables whose tags include at least one of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce no results.

tag_ids__not_in

string<uuid>[]

Return only payables whose tags do not include any of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce the results.

has_tags

boolean

Filter objects based on whether they have tags. If true, only objects with tags are returned. If false, only objects without tags are returned.

origin

enum<string>

Return only payables from a given origin ['einvoice', 'upload', 'email']

Available options:

upload,

email,

einvoicing

has_file

boolean

Return only payables with or without attachments (files)

Response

Successful Response

data

object[]

required

Show child attributes

API Concepts

General

Common

Accounts payable

Accounts receivable

E-invoicing

Payments

Accounting integration

Expense management

Utilities

Get payables analytics

Authorizations

Headers

Query Parameters

Response