Skip to content

List payment batches

GET/payroll/payment-batches

Returns all payment batches for the tenant, including their processing status. Use to track disbursement progress across payroll runs.

Request

This endpoint takes no parameters and no request body.

Responses

200 List of payment batches

Content type application/json, array of object · PaymentBatchV1.

FieldTypeRequiredDescription
idintegerNo
run_idintegerNo
namestringNo
payment_methodstringNo

One of: "bank_transfer", "mobile_money", "cheque", "cash"

statusstringNo

One of: "draft", "submitted", "processing", "completed", "failed"

employee_countinteger, nullableNo
total_amountnumber (float), nullableNo
currencystringNo

Max length: 3

created_atstring (date-time)No

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/payroll/payment-batches" \
  -H "Accept: application/json"
Loading