Payment Parts
A payment part shows how a single payment is split across invoices. The API exposes payment parts for reading how money has been allocated. See Payment Types and Records for the field reference.
Methods
Section titled “Methods”Retrieve Single Payment Part
Section titled “Retrieve Single Payment Part”/backend/api/v1/paymentParts/ID - fetch the payment part with the specified ID.
List Payment Parts
Section titled “List Payment Parts”/backend/api/v1/paymentParts/ - list all payment parts.
/backend/api/v1/payments/ID/paymentParts/ - list the parts of the payment with the specified ID.
/backend/api/v1/invoices/ID/paymentParts/ - list the payment parts allocated to the invoice with the specified ID.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include parts with a higher ID |
createdSince | datetime | No | Only include parts created since the given time |
updatedSince | datetime | No | Only include parts updated since the given time |
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| id | Payment Part ID | Text | The unique identifier for this payment part record |
| paymentPartAmount | Allocated Amount | Currency | The amount of the payment allocated to this invoice |