Get Payment

GET /accounting/payments/{id}

Group: Accounting › Payments · Operation ID: getPayment

Returns the payment with the given identifier. Use the payment's id, not its paymentNumber.

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.
id path string yes The unique identifier for the payment to return.

Response

200 Success

Under data (getPaymentOutput):

Field Type Required Description
id string yes The unique identifier for the payment.
paymentNumber string no The payment number, unique within the tenant. A human-readable reference used for reconciliation.
paymentDate string (date) yes The date the payment was made. Format YYYY-MM-DD.
paymentType string yes The payment method. Possible values: 'check', 'ach', 'wire', 'creditCard', 'directDebit', 'sepaCreditTransfer'.
currency string yes The currency the customer paid in. Every amount on the payment is in this currency. Format ISO 4217, for example 'USD'.
paymentAccountCurrency string no The currency of the bank account the payment was received into. Present only when it differs from the payment currency. Format ISO 4217, for example 'USD'.
amount string (decimal) no The amount paid, in the payment currency.
appliedAmount string (decimal) no The portion already applied to invoices, in the payment currency. The sum of the payment's applications.
unappliedAmount string (decimal) no The portion not yet applied to any invoice, in the payment currency. unappliedAmount = amount - appliedAmount - refundAmount.
refundAmount string (decimal) no The portion refunded through approved refunds, in the payment currency.
bankFeeAmount string (decimal) no The bank fee deducted from the payment, in the payment currency.
smallBalanceWriteOffAmount string (decimal) no The total written off as a small residual balance across the payment's applications, in the payment currency.
totalEarlyPaymentDiscount string (decimal) no The total early-payment discount granted across the payment's applications, in the payment currency.
exchangeRate string (decimal) no The rate used to convert the payment currency to the entity's functional currency. A ratio, not an amount, with no currency of its own.
customerPaymentStatus string no The derived lifecycle status of the payment. Possible values: 'unapplied', 'partiallyApplied', 'appliedInFull', 'partiallyRefunded', 'refunded', 'disputed', 'chargedBack'.
disputeStatus string no The dispute state of the payment. Possible values: 'disputed', 'chargedBack'. Absent on an undisputed payment.
paymentReference string no The reference the payer supplied with the payment, for example a remittance or wire reference. Absent when none was supplied.
paymentNote string no A free-form note recorded on the payment. Absent when none was set.
customerId string no The customer the payment came from. See id on GET accounting/customers/:id.
customerName string no The name of the customer the payment came from.
thirdPartyPayerId string no The customer who actually paid, when a third party paid on the invoiced customer's behalf. Absent when the invoiced customer paid. See id on GET accounting/customers/:id.
entityId string no The legal entity that received the payment. See id on GET base/entities.
accountId string no The ledger account the payment was posted to. See id on GET accounting/accounts/:id.
accountName string no The name of the ledger account the payment was posted to.
lastModifiedDate string (date-time) yes The date and time the payment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses