Skip to main content
The Get Payable endpoint retrieves the complete detail record for a single payable, identified by its internal id. The response includes every field available on a payable — lifecycle and payment statuses, amount breakdowns, dates, your custom reference number, the associated contact, and the full structured line-item array. Use this endpoint to display invoice detail pages, poll for status changes, or reconcile payment progress in your own systems.

​
Request

GET https://api.cleo-pay.com/v1/payables/{payableId} Include your bearer token in every request:

​
Path Parameters

​
payableId
string
required
The internal opaque id of the payable to retrieve (e.g. pay_01hx9k2mq3fvb8n7cptd6ewrja). This is the id field returned when you create a payable or list payables — not the publicId.

​
Example Request

​
Response

A successful request returns HTTP 200 with the full PayableDetail object.
​
id
string
Internal opaque identifier for the payable.
​
publicId
string
Stable public identifier shown in the Cleo Pay dashboard. Safe to display to end users or reference in support conversations.
​
status
string
Current lifecycle status of the payable. One of: draft, pending_approval, approved, declined, blocked, void.
​
paymentStatus
string
Current payment processing status. One of: none, scheduled, processing, settled, failed, clawback.
​
totalAmountCents
number
Total invoice amount in cents (e.g. 250000 = $2,500.00).
​
amountPaidCents
number
Amount already paid against this payable, in cents.
​
remainingAmountCents
number
Outstanding balance remaining, in cents. Equals totalAmountCents - amountPaidCents.
​
dueDate
string | null
Payment due date in YYYY-MM-DD format, or null if not set.
​
issueDate
string | null
Invoice issue date in YYYY-MM-DD format, or null if not set.
​
customNumber
string | null
Your custom invoice or purchase-order reference number, or null if not provided.
​
description
string | null
Free-text memo or description, or null if not provided.
​
contact
object
The counterparty associated with this payable.
​
items
array
Structured line items attached to this payable. Returns an empty array if no items were provided at creation.

​
Example Response

Every payable carries two distinct identifiers. The id (e.g. pay_01hx9k2mq3fvb8n7cptd6ewrja) is the internal opaque ID used in all API calls — pass it as the payableId path parameter here, or wherever an API endpoint requires a payable reference. The publicId (e.g. PAY-2024-00042) is the stable, human-readable identifier displayed in the Cleo Pay dashboard and safe to surface to your customers or in support communications. Never use publicId as the path parameter for API requests.