List payables for the authenticated user

get

http://api.wingspan.app/v2/payments/payables

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page[mode]

string

enum

Pagination mode.

Allowed:

page[size]

integer

1 to 200

Maximum number of results per page

page[token]

string

Opaque continuation token (cursor or materialized mode); server-issued

page[resultSetId]

string

Resume an existing saved result set (materialized mode only)

sort[createdAt]

string

enum

Allowed:

sort[updatedAt]

string

enum

Allowed:

sort[events.paidAt]

string

enum

Allowed:

sort[internal.events.paymentDueAt]

string

enum

Allowed:

filter[status][=]

string

enum

Filter by exact status

Allowed:

filter[status][!=]

string

enum

Exclude status

Allowed:

filter[status][in]

array of strings

Filter by multiple statuses

filter[status][in]

Allowed:

filter[status][notIn]

array of strings

Exclude multiple statuses

filter[status][notIn]

Allowed:

filter[payeeId][=]

string

Filter by payee ID

filter[payeeId][in]

array of strings

Filter by multiple payee IDs

filter[payeeId][in]

filter[payerPayeeEngagementId][=]

string

Filter by payer-payee engagement ID

filter[payerPayeeEngagementId][in]

array of strings

Filter by multiple engagement IDs

filter[payerPayeeEngagementId][in]

filter[payer.workflowStatus][=]

string

enum

Filter by exact payer workflow status

Allowed:

filter[payer.workflowStatus][!=]

string

enum

Exclude payer workflow status

Allowed:

filter[payer.workflowStatus][in]

array of strings

Filter by multiple payer workflow statuses

filter[payer.workflowStatus][in]

Allowed:

filter[payer.workflowStatus][notIn]

array of strings

Exclude multiple payer workflow statuses

filter[payer.workflowStatus][notIn]

Allowed:

filter[payer.workflowStatus][exists]

boolean

Filter by whether payer workflow status is set

filter[payee.workflowStatus][=]

string

enum

Filter by exact payee workflow status

Allowed:

filter[payee.workflowStatus][!=]

string

enum

Exclude payee workflow status

Allowed:

filter[payee.workflowStatus][in]

array of strings

Filter by multiple payee workflow statuses

filter[payee.workflowStatus][in]

Allowed:

filter[payee.workflowStatus][notIn]

array of strings

Exclude multiple payee workflow statuses

filter[payee.workflowStatus][notIn]

Allowed:

filter[payee.workflowStatus][exists]

boolean

Filter by whether payee workflow status is set

filter[dueDate][>=]

date-time

Filter by due date (greater than or equal)

filter[dueDate][<=]

date-time

Filter by due date (less than or equal)

filter[events.openedAt][>]

date-time

Filter by opened date (greater than)

filter[events.openedAt][<]

date-time

Filter by opened date (less than)

filter[events.paidAt][>]

date-time

Filter by paid date (greater than)

filter[events.paidAt][<]

date-time

Filter by paid date (less than)

filter[lineItems.labels.bulkBatchId][=]

string

Filter by bulk batch ID

filter[internal.payroll.payrollId][=]

string

Filter by payroll ID

excludeDeclined

string

enum

Exclude declined payables that have not been resubmitted

Allowed:

Headers

X-WS-Get-List-Summary

string

enum

When 'true', the response includes X-WS-List-Size and X-WS-Custom-Payable-Amount-Total headers computed across the full filtered set.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of payables

400Bad Request

401Unauthorized

403Forbidden