GET
List purchase payments
Company space For: Buyer, Accountant · Permission: purchase_payments.list, purchases.retrieve Conditions
  • Payments are listed most recent first.
Part of Pay suppliers and adjust debt.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

purchase
string
required

Identifier of the purchase (27-character KSUID).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, purchase_id, vendor_id, vendor_credit_payment_id, payment_method, cash_register_id, money_account_id, amount, discount_received, paid_at, currency_code, currency_exponent, reference, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: purchase, purchase.items, purchase.debtAdjustments, purchase.returns, purchase.pickups, purchase.deliveries, purchase.vendor.

Response

200 - application/json

Resource.

data
PurchasePaymentResource · object[]
required

Items of this page.

meta
object
required

Pagination details.