Skip to main content
GET
List accruals

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

journal_sequence_number
string

Journal sequence number. Returns the accruals of that journal.

Required string length: 1 - 100
accrual_ids
string[]

IDs to return, separated by commas. The other filters also apply.

Required array length: 1 - 100 elements
Minimum string length: 1
vendor_id
string

Filter to a single vendor (vnd_<id> or a bare id).

period
string

Accrual period, Month, in YYYY-MM format.

Pattern: ^\d{4}-\d{2}$
limit
integer
default:25

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

status
enum<string>
default:posted

Accrual status. Defaults to posted; all removes the status filter.

Available options:
pending,
posted,
reversed,
matched,
all

Legal entity ID (le_…).

Example:

"le_507f1f77bcf86cd799439011"

Response

List of accruals.

data
object[]
required

The records.

count
integer
required

Number of accruals on this page.

has_more
boolean

Whether another page is available.

next_cursor
string | null

Cursor for the next page, or null on the last page.