Get Invoices

get

https://testapi.payarc.net/v1/invoices/

Query Params

limit

int32

Defaults to 25

A number that represents the number of records to be listed.

page

int32

Defaults to 1

A number that represents the current page number.

created_at[intl]

int32

In the specified number of days.

created_at[eq]

string

Invoice creation date.
Format: YYYY/MM/DD

created_at[gte]

string

Invoices created after or equal to date.
Format: YYYY/MM/DD

created_at[lte]

string

Invoices created before or equal to date.
Format: YYYY/MM/DD

created_at[gt]

string

Invoices created after date.
Format: YYYY/MM/DD

created_at[lt]

string

Invoice created before date.
Format: YYYY/MM/DD

total[eq]

int32

Total is equal to

total[gte]

int32

Total is greater than or equal to

total[lte]

int32

Total is less than or equal to

total[gt]

int32

Total is greater than

total[lt]

int32

Total is less than

invoice_number[like]

string

Invoice number contains

draft[eq]

boolean

Invoice is a draft

closed[eq]

boolean

Invoice is closed

attempted[eq]

boolean

An attempt was made to pay the invoice.

forgiven[eq]

boolean

Invoice has been forgiven

open

boolean

Invoice is open for payment

past_due

boolean

Invoice is past due

paid

boolean

Invoice has been paid

string

Search for invoices by name, email, description, invoice type, status amount, created date

excel

string

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

401401