Get a payment
Get a single payment by its ID.
The response carries the same shape as a list entry, plus quickbooks_deposit_account_name (the human-readable name of the QuickBooks Online deposit account, resolved only here — the list endpoint omits it). Like the list endpoint, at most one of invoice / purchase is populated depending on payment_type, and status is POSTED or VOIDED.
Returns 404 if no payment with that ID exists within your company; soft-deleted payments return 404 too. Voided payments are returned normally with status VOIDED. A payment on an invoice or purchase the authenticated user cannot view under their team restrictions is still returned; the records they cannot view are null or left out, as in the list.
Required permission: payments_permissions_view.
Request
- Base URLhttps://app.distru.com
- AuthHTTP bearer
Path parameters
The payment's Distru ID, as returned in the id field of the list endpoint. An ID that doesn't exist for your company returns 404.
Response
A single payment
Example response
{
"data": {
"company": {
"id": "3f128a34-cc59-4b49-8883-23bf10e59c6c",
"name": "Retailer 1"
}
}
}Changes
No recorded changes to this operation across all 17 revisions of this API.