Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

accounting_period_ids
string[]
accounts
enum<string>[]
Available options:
cash,
accounts_receivable,
unbilled_receivable,
deferred_revenue,
customer_credit,
tax_payable,
revenue,
contra_revenue
contract_ids
string[]
customer_ids
string[]
end_time
string<date-time>
event_types
enum<string>[]
Available options:
invoice_finalized,
invoice_voided,
credit_note_finalized,
credit_note_voided,
payment_succeeded,
payment_reversed,
refund_succeeded,
revenue_earned,
revenue_offset
expand
string
filters
object[]
journal_entry_ids
string[]
limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
pob_ids
string[]
sort
object[]
source_entity_ids
string[]
source_entity_type
enum<string>
Available options:
subscription,
subscription_line_item,
invoice,
credit_note,
payment,
refund,
pob
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived

Response

OK

items
object[]
pagination
object