Access tokens2

Accounting connections5

Accounting data pull4

Accounting synchronized records3

Accounting tax rates5

Analytics3

Approval policies9

Approval requests6

Comments5

Cost centers5

Counterpart addresses5

Counterpart bank accounts7

Counterpart contacts6

Counterpart e-invoicing credentials5

Counterpart VAT IDs5

Counterparts7

Credit notes21

Custom VAT rates5

Data export4

Data export - extra data5

Delivery notes7

E-invoicing connections6

E-invoicing search1

Entities17

Entity bank accounts7

Entity onboarding data3

Entity persons5

Entity users8

Entity VAT IDs5

Events2

Files4

Financing4

Ledger accounts5

Mail templates8

Mailbox domains4

Mailboxes4

Measure units5

OCR4

Onboarding documents4

Onboarding requirements2

Overdue reminders5

Partner settings2

Payable line items6

Payables24

Payment intents4

Payment links3

Payment methods2

Payment records7

Payment reminders5

Payment terms5

PDF templates5

Products5

Projects5

Purchase orders8

Receipts11

Receivables26

Recurrences7

Roles5

System health1

Tags5

Text templates6

Transactions6

VAT rates1

Webhook deliveries1

Webhook subscriptions8

Payment records

Get payment records

get/payment_records

Request

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

Query parameters

order'asc' | 'desc'

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

limitinteger

Max is 100

pagination_tokenstring

A token, obtained from previous page. Prior over other filters

sort'paid_at' | 'amount' | 'overpaid_amount'

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

is_externalboolean

Identifies whether payment is from our rails or external system

object_idstring uuid

ID of the object, that is connected to payment

object_id__instring uuid

List of IDs of the objects, that are connected to payments

object_type'receivable' | 'payable'

Type of an object, which is connected with payment

created_at__gtstring date-time

Created after this datetime (exclusive)

created_at__ltstring date-time

Created before this datetime (exclusive)

updated_at__gtstring date-time

Updated after this datetime (exclusive)

updated_at__ltstring date-time

Updated before this datetime (exclusive)

paid_at__gtstring date-time

Paid after this datetime (exclusive)

paid_at__ltstring date-time

Paid before this datetime (exclusive)

planned_payment_datestring date

Optional date of the upcoming payment (equality)

planned_payment_date__gtstring date

Planned after this date (exclusive)

planned_payment_date__ltstring date

Planned before this date (exclusive)

planned_payment_date__gtestring date

Planned at or after this date (inclusive)

planned_payment_date__ltestring date

Planned at or before this date (inclusive)

status'created' | 'processing' | 'succeeded' | 'canceled'

One of the payment record statuses

payment_intent_statusstring

Payment intent status as a raw string

payment_methodstring

Payment method used for the transaction

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.