Financing

Get invoices

Returns a list of invoices requested for financing

get/financing_invoices

Request

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

Query parameters

order'asc' | 'desc'

Sort order (ascending by default). Typically used together with the sort parameter.

limitinteger

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstring

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sort'id' | 'created_at'

The field to sort the results by. Typically used together with the order parameter.

invoice_idstring uuid

ID of a payable or receivable invoice.

invoice_id__instring uuid

List of invoice IDs.

status'DRAFT' | 'NEW' | 'FUNDED' | 'PAID' | 'LATE' | 'REJECTED' | 'DEFAULTED'
  • DRAFT: The invoice is in draft state. The business has not submitted the invoice for funding.
  • NEW: The business has submitted an invoice and it is under review.
  • FUNDED: The funds for the invoice have been disbursed. The business is now expected to pay back the funds.
  • PAID: A payment was made that fully paid off an outstanding invoice.
  • LATE: A payment was not made towards an outstanding invoice.
  • REJECTED: An invoice was rejected during the funding step.
  • DEFAULTED: A payment was not made towards an outstanding invoice.

Status of the invoice.

status__in'DRAFT' | 'NEW' | 'FUNDED' | 'PAID' | 'LATE' | 'REJECTED' | 'DEFAULTED'
  • DRAFT: The invoice is in draft state. The business has not submitted the invoice for funding.
  • NEW: The business has submitted an invoice and it is under review.
  • FUNDED: The funds for the invoice have been disbursed. The business is now expected to pay back the funds.
  • PAID: A payment was made that fully paid off an outstanding invoice.
  • LATE: A payment was not made towards an outstanding invoice.
  • REJECTED: An invoice was rejected during the funding step.
  • DEFAULTED: A payment was not made towards an outstanding invoice.

List of invoice statuses.

type'payable' | 'receivable'

Type of the invoice. payable or receivable.

type__in'payable' | 'receivable'

List of invoice types.

document_idstring

Document ID of the invoice.

document_id__instring

List of document IDs.

issue_date__gtstring date-time

Issue date greater than.

issue_date__ltstring date-time

Issue date less than.

issue_date__gtestring date-time

Issue date greater than or equal.

issue_date__ltestring date-time

Issue date less than or equal.

due_date__gtstring date-time

Due date greater than.

due_date__ltstring date-time

Due date less than.

due_date__gtestring date-time

Due date greater than or equal.

due_date__ltestring date-time

Due date less than or equal.

created_at__gtstring date-time

Created date greater than.

created_at__ltstring date-time

Created date less than.

created_at__gtestring date-time

Created date greater than or equal.

created_at__ltestring date-time

Created date less than or equal.

total_amountinteger

Total amount of the invoice in minor units.

total_amount__gtinteger

Total amount greater than.

total_amount__ltinteger

Total amount less than.

total_amount__gteinteger

Total amount greater than or equal.

total_amount__lteinteger

Total amount less than or equal.

Headers

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

The ID of the entity that owns the requested resource.

Response

Successful Response

next_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

prev_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).

Changes

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