Payables

Get payables analytics

Retrieve aggregated statistics for payables, including total amount and count, both overall and by status.

For more flexible configuration and retrieval of other data types, use GET /analytics/payables.

get/payables/analytics

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/payables/analytics
  • Auth: HTTP bearer

Query parameters

created_at__gtstring 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__ltstring date-time

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

created_at__gtestring date-time

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

created_at__ltestring date-time

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

status'draft' | 'new' | 'approve_in_progress' | 'waiting_to_be_paid' | 'partially_paid' | 'paid' | 'canceled' | 'rejected'

Return only payables that have the specified status.

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

status__in'draft' | 'new' | 'approve_in_progress' | 'waiting_to_be_paid' | 'partially_paid' | 'paid' | 'canceled' | 'rejected'

Return only payables that have the specified statuses.

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

id__instring 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_amountinteger

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__gtinteger

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

total_amount__ltinteger

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

total_amount__gteinteger

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

total_amount__lteinteger

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

amountinteger

Return only payables with the specified amount.

amount__gtinteger

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

amount__ltinteger

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

amount__gteinteger

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

amount__lteinteger

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

currency'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'

Return only payables that use the specified currency.

counterpart_namestring

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__containsstring

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

counterpart_name__icontainsstring

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

search_textstring

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

due_datestring date

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

due_date__gtstring date

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

due_date__ltstring date

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

due_date__gtestring date

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

due_date__ltestring date

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

issued_atstring date

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

issued_at__gtstring date

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

issued_at__ltstring date

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

issued_at__gtestring date

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

issued_at__ltestring date

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

document_idstring

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__containsstring

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

document_id__icontainsstring

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

was_created_by_user_idstring uuid

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

counterpart_idstring 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'ocr' | 'user_specified' | 'einvoicing'

Return only payables coming from the specified source.

ocr_status'processing' | 'error' | 'success'

Return only payables with specific OCR statuses.

line_item_idstring uuid

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

purchase_order_idstring uuid

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

project_idstring 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__instring 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_idsstring 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_instring 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_tagsboolean

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'upload' | 'email' | 'einvoicing'

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

has_fileboolean

Return only payables with or without attachments (files)

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Response

Successful Response

countinteger required

The total count of payables across all statuses.

sum_total_amountinteger required

The total sum of the amount field for all payables across all statuses.

Changes

No recorded changes to this operation across all 1 revision of this API.