orders

Query

account

Return only orders made from/to account

limit = 100

The number of results to fetch (default 10, max 1000)

offset

The offset to use to fetch

accountingCategory

Only return orders that match these accounting categories

hostContext

If account is a host, select whether to include ALL, INTERNAL or HOSTED accounts. When set (and hostedAccounts is not provided), this will automatically include children accounts (events/projects) of the selected accounts. If hostedAccounts is also provided, use includeChildrenAccounts to control children account inclusion.

includeChildrenAccounts

Include orders from children events/projects. Only relevant when hostedAccounts is provided. When hostContext is set without hostedAccounts , children accounts are automatically included regardless of this parameter.

pausedBy

Only return orders that were paused by these roles. status must be set to PAUSED.

paymentMethod

Only return orders that were paid with this payment method. Must be an admin of the account owning the payment method.

paymentMethodService

Only return orders that match these payment method services

paymentMethodType

Only return orders that match these payment method types

manualPaymentProvider

Only return orders that used this manual payment provider.

includeIncognito

Whether to include incognito orders. Must be admin or root. Only with filter null or OUTGOING.

filter

Account orders filter (INCOMING or OUTGOING)

frequency

Use this field to filter orders on their frequency (ONETIME, MONTHLY or YEARLY)

status

Use this field to filter orders on their statuses

orderBy = { "field": "CREATED_AT", "direction": "DESC" }

The order of results

amount

Only return expenses that match this amount range

minAmount

Only return orders where the amount is greater than or equal to this value (in cents)

maxAmount

Only return orders where the amount is lower than or equal to this value (in cents)

dateFrom

Only return orders that were created after this date

dateTo

Only return orders that were created before this date

expectedDateFrom

Only return pending orders that were expected after this date

expectedDateTo

Only return pending orders that were expected before this date

chargedDateFrom

Return orders that were charged after this date

chargedDateTo

Return orders that were charged before this date

searchTerm

The term to search

tier

onlySubscriptions

Only returns orders that have a subscription (monthly/yearly). Don't use together with frequency.

onlyActiveSubscriptions

Same as onlySubscriptions, but returns only orders with active subscriptions

expectedFundsFilter

oppositeAccount

Return only orders made from/to that opposite account (only works when orders are already filtered with a main account)

hostedAccounts

Return only orders made from/to these hosted accounts

host

Return orders only for this host

createdBy

Return only orders created by these users. Limited to 1000 users at a time.