Skip to main content

​
List payables

GET /api/businesses/{businessId}/payables Returns a paginated list of payables for a business. Use query filters to narrow results.

​
Path parameters

​
businessId
string
required
The ID of the business.

​
Query parameters

​
status
string
Filter by status. Accepted values: DRAFT, SUBMITTED, APPROVED, DECLINED, CANCELLED, PAID, SCHEDULED.
​
connectionId
string
Filter by connection ID to see payables for a specific payer-payee relationship.
​
limit
number
default:"20"
Maximum number of payables to return.
​
offset
number
default:"0"
Number of payables to skip for pagination.
curl --request GET \
  --url "https://api.cleo-pay.com/api/businesses/biz_abc123/payables?status=SUBMITTED&limit=50&offset=0" \
  --header "Authorization: Bearer <token>"

​
Get a payable

GET /api/businesses/{businessId}/payables/{payableId} Returns the full details of a single payable.

​
Path parameters

​
businessId
string
required
The ID of the business.
​
payableId
string
required
The ID of the payable.
curl --request GET \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_ghi789 \
  --header "Authorization: Bearer <token>"

​
Update a payable

PUT /api/businesses/{businessId}/payables/{payableId} Updates the details of a payable. Only payables in DRAFT status can be fully updated. Submitted payables have limited editable fields.

​
Path parameters

​
businessId
string
required
The ID of the business.
​
payableId
string
required
The ID of the payable to update.

​
Approve a payable

POST /api/businesses/{businessId}/payables/{payableId}/approve Approves a payable for payment. This action is taken by the payer and moves the payable from SUBMITTED to APPROVED status.

​
Path parameters

​
businessId
string
required
The ID of the payer’s business.
​
payableId
string
required
The ID of the payable to approve.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_payer456/payables/pay_ghi789/approve \
  --header "Authorization: Bearer <token>"

​
Decline a payable

POST /api/businesses/{businessId}/payables/{payableId}/decline Declines a payable. This action is taken by the payer and moves the payable to DECLINED status. Include a reason to help the sender understand why it was declined.

​
Path parameters

​
businessId
string
required
The ID of the payer’s business.
​
payableId
string
required
The ID of the payable to decline.

​
Request body

​
reason
string
Optional explanation for declining the payable.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_payer456/payables/pay_ghi789/decline \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{ "reason": "Amount does not match the purchase order." }'

​
Cancel a payable

POST /api/businesses/{businessId}/payables/{payableId}/cancel Cancels a payable. This action is taken by the sender (payee) and moves the payable to CANCELLED status.

​
Path parameters

​
businessId
string
required
The ID of the sender’s business.
​
payableId
string
required
The ID of the payable to cancel.

​
Send a payment reminder

POST /api/businesses/{businessId}/payables/{payableId}/send-reminder Sends an email reminder to the payer about an outstanding payable.

​
Path parameters

​
businessId
string
required
The ID of the sender’s business.
​
payableId
string
required
The ID of the payable.

​
Get activity log

GET /api/businesses/{businessId}/payables/{payableId}/activity-log Returns a chronological audit trail of all actions taken on the payable, including status changes, approvals, and comments.

​
Path parameters

​
businessId
string
required
The ID of the business.
​
payableId
string
required
The ID of the payable.
curl --request GET \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_ghi789/activity-log \
  --header "Authorization: Bearer <token>"

​
Export payables as CSV

POST /api/businesses/{businessId}/payables/export Exports payables matching the specified filters as a CSV file.

​
Path parameters

​
businessId
string
required
The ID of the business.

​
Request body

​
status
string
Filter by payable status.
​
connectionId
string
Filter by connection.
​
startDate
string
Export payables created on or after this ISO 8601 date.
​
endDate
string
Export payables created on or before this ISO 8601 date.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/payables/export \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "status": "PAID",
    "startDate": "2026-01-01",
    "endDate": "2026-03-31"
  }'