Payments
Payments received against invoices.
List payments
GET/v1/payments
Newest first, a page at a time. See Pagination and syncing.
curl "https://harlo-api-dev.pages.dev/v1/payments?limit=10" \
-H "Authorization: Bearer $HARLO_API_KEY"Filters
| Parameter | What it does |
|---|---|
invoice_id | Payments on one invoice. |
load_id | Payments for one load. |
Paging, order and format
| Parameter | What it does |
|---|---|
limit | How many to return, 1 to 100.Default: 25 |
cursor | `next_cursor` from the previous page. |
sort | Order: newest first by default.Values: -created_at, created_at, -updated_at, updated_atDefault: -created_at |
updated_since | Only records changed at or after this ISO 8601 time. |
created_since | Only records created at or after this ISO 8601 time. |
format | `csv` returns the page as a spreadsheet: nested fields become columns like `customer.name`.Values: json, csvDefault: json |
Retrieve a payment
GET/v1/payments/{id}
curl "https://harlo-api-dev.pages.dev/v1/payments/e5f1ab2f-1431-4a23-a9c2-32c384ceb7f0" \
-H "Authorization: Bearer $HARLO_API_KEY"Example response
{
"id": "e5f1ab2f-1431-4a23-a9c2-32c384ceb7f0",
"object": "payment",
"invoice": {
"id": "a3b858d0-046b-4ded-8f6f-a5a4a5837114",
"number": "INV-L-00001"
},
"load": {
"id": "d614de50-90e6-4ea5-ae14-c3c5f804a121",
"number": "L-00001"
},
"customer": {
"id": "f96a1a46-3469-450a-8a70-4e16e433b248",
"name": "Blue Lake Logistics LLC"
},
"amount": 2760,
"received_date": "2026-11-14",
"method": "ACH",
"reference": "ACH 88123",
"notes": null,
"created_at": "2026-11-14T07:42:56.089893+00:00",
"updated_at": "2026-11-14T07:42:56.089893+00:00"
}The payment object
| Field | Type | What it is |
|---|---|---|
id | id | Unique id of the payment. |
object | string | Always "payment". |
invoice | object | |
id | string, nullable | |
number | string, nullable | |
load | object | |
id | string, nullable | |
number | string, nullable | |
customer | object | |
id | string, nullable | |
name | string, nullable | |
amount | number | |
received_date | date, nullable | |
method | string | ACH, Check, Wire, Factoring, or Other. |
reference | string, nullable | Check number or transfer reference. |
notes | string, nullable | |
created_at | timestamp, nullable | When it was created. |
updated_at | timestamp, nullable | When it last changed. Use with `updated_since` to sync. |