API Reference

Get a list of invoices

get
https://api.stage.payouts.com/invoice-widgets

Required permissions for this API:

  • READ:MARKETING
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
Defaults to 0

Page number, starts from 0.

number
1 to 100
Defaults to 10

Number of results per page

status
array of strings
status
excludeInvoiceIds
array of numbers
excludeInvoiceIds
connectorId
array of numbers
connectorId
date-time

From invoice.requestDate in ISO8601 format

date-time

To invoice.requestDate in ISO8601 format

date-time

From invoice.createdAt in ISO8601 format

date-time

To invoice.createdAt in ISO8601 format

baseCurrency
array of strings
deprecated

Invoice in base currency. According to the current state of the implementation, it should be considered as deprecated and not used.

baseCurrency
invoiceCurrencies
array of strings
invoiceCurrencies
number

From source amount

number

To source Amount

sourceCurrency
array of strings
sourceCurrency
number

From source amount

number

To source Amount

recipientCurrency
array of strings
recipientCurrency
number

From recipient amount

number

To recipient Amount

string
Defaults to USD

Currency for calculating total payment amount (3-letter ISO-4217 code)

string

Payment method

number

Vendor id

string
enum

Account type

Allowed:
string

Search in firstName, lastName and invoiceId

boolean

Include not payable invoices

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?