Outbound Payments

GET /accounting/outbound-payments

Group: Accounting › Outbound Payments · Operation ID: outboundPayments

Returns a list of outbound payments. Each entry is the payment header. Read one payment with its lines and payee details from GET accounting/outbound-payments/:id or POST accounting/outbound-payments/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
outboundPaymentNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentCurrency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
approvalStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
applicationStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
origin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
singlePayment — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, outboundPaymentNumber, paymentDate, paymentCurrency, paymentType, status, approvalStatus, applicationStatus, lastModifiedDate
Selectable: id, outboundPaymentNumber, description, paymentDate, paymentCurrency, paymentType, status, approvalStatus, applicationStatus, paymentId, externalId, origin, singlePayment, paymentAccountName, entityName, lastModifiedDate

Response

200 Success

Under data, an array of outboundPaymentsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the outbound payment.
`outboundPaymentNumber`	string or null	no	The outbound payment number. Absent until a number has been assigned.
`description`	string or null	no	A description of the payment.
`paymentDate`	string (date) or null	no	The date the payment was made. Format YYYY-MM-DD.
`paymentCurrency`	string or null	no	The currency the payment is denominated in. Format ISO 4217, for example 'USD'.
`paymentType`	string or null	no	How the money was sent, for example 'ach', 'wire' or 'check'.
`status`	string or null	no	The processing status of the payment.
`approvalStatus`	string or null	no	Where the payment sits in the approval workflow.
`applicationStatus`	string or null	no	How much of the payment has been applied to bills. Values include 'unapplied', 'partiallyApplied' and 'applied'.
`paymentId`	string or null	no	The payment reference assigned by the bank or payment provider. It is not filterable. Match on it through POST accounting/outbound-payments/search.
`externalId`	string or null	no	The identifier this payment has in the upstream system that produced it. It is not unique.
`origin`	string or null	no	The source system this payment came from. Recorded when an integration created the payment.
`singlePayment`	boolean or null	no	Whether the payment covers a single bill rather than a batch.
`paymentAccountName`	string or null	no	The name of the bank GL account the money left. It is not filterable. To scope by account, use paymentAccountId on POST accounting/outbound-payments/search.
`entityName`	string or null	no	The name of the legal entity that made the payment. It is not filterable. To scope by entity, use entityId on POST accounting/outbound-payments/search.
`lastModifiedDate`	string (date-time) or null	no	The date and time the payment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error