Skip to content
DevelopersGet an API key

Payments

Payments received against invoices.

List payments

GET/v1/payments

Newest first, a page at a time. See Pagination and syncing.

curl "https://api.goharlo.com/v1/payments?limit=10" \
  -H "Authorization: Bearer $HARLO_API_KEY"

Filters

ParameterWhat it does
invoice_idPayments on one invoice.
load_idPayments for one load.

Paging, order and format

ParameterWhat it does
limitHow many to return, 1 to 100.Default: 25
cursor`next_cursor` from the previous page.
sortOrder: newest first by default.Values: -created_at, created_at, -updated_at, updated_atDefault: -created_at
updated_sinceOnly records changed at or after this ISO 8601 time.
created_sinceOnly 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://api.goharlo.com/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"
}

Record a payment

POST/v1/payments

Records a customer payment against an invoice, with the same rules as Harlo itself: no more than the balance, not on a void invoice. The invoice becomes partial or paid. Needs a key that can record payments. Send an Idempotency-Key so a retry never pays twice.

curl -X POST "https://api.goharlo.com/v1/payments" \
  -H "Authorization: Bearer $HARLO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: qbo-payment-1042" \
  -d '{"invoice_id":"a3b858d0-046b-4ded-8f6f-a5a4a5837114","amount":2760,"received_date":"2026-11-14","method":"ACH","reference":"ACH 88123"}'

Body

FieldWhat it is
invoice_idThe Harlo invoice being paid.
amountDollars and cents, no more than the invoice's balance.
received_dateWhen the money arrived.
methodOne of ACH, Check, Wire, Factoring, Other.
referenceoptionalCheck number or transfer reference, up to 120 characters.

Answers 201 Created with the payment. The invoice becomes partial or paid, and payment.created (and invoice.paid) webhooks fire. Paying more than the balance or a void invoice answers 409 conflict with the reason.

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

FieldTypeWhat it is
ididUnique id of the payment.
objectstringAlways "payment".
invoiceobject
idstring, nullable
numberstring, nullable
loadobject
idstring, nullable
numberstring, nullable
customerobject
idstring, nullable
namestring, nullable
amountnumber
received_datedate, nullable
methodstringACH, Check, Wire, Factoring, or Other.
referencestring, nullableCheck number or transfer reference.
notesstring, nullable
created_attimestamp, nullableWhen it was created.
updated_attimestamp, nullableWhen it last changed. Use with `updated_since` to sync.
NextCustomers