API Reference
  1. Payroll Cost API

List fundings for the payroll journal

get
https://api.everee.com/integration/v1/payroll-costs/journal/fundings

This endpoint lists your fundings for a range of funding dates, so you can retrieve the payroll journal of each one.

Only fundings that have been submitted or funded are listed by default, because those are the ones with journal data. Pass status to list fundings in other statuses.

Results are paginated with a cursor. Pass the nextCursor from each response as the after parameter of your next request until hasNextPage is false. See the Guide to the payroll journal for all the details about how this API works.

Query Params
date
required

The start of the funding date range, inclusive, in the format YYYY-MM-DD.

date
required

The end of the funding date range, inclusive, in the format YYYY-MM-DD.

status
array of strings

The funding statuses to list. Provide multiple status parameters to list more than one. Defaults to SUBMITTED and FUNDED, the fundings that have journal data.

status
Allowed:
integer
1 to 100
Defaults to 25

The maximum number of fundings to return on a page. Defaults to 25 and must not exceed 100.

string

The nextCursor from the previous page, to retrieve the page after it. Omit to retrieve the first page.

Responses

400

A date is missing or invalid, the end date is before the start date, the limit is out of range, or the cursor is invalid

Updated 2 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 days ago

Did this page help you?