Skip to main content
GET
/
v1
/
payrolls
/
{payrollId}
Get
curl --request GET \
  --url https://api.cadanapay.com/v1/payrolls/{payrollId} \
  --header 'Authorization: Bearer <token>'
{ "payrollId": "7c4f1d36-2b9a-4bca-91e7-2b1f1e6e7c11", "workerType": "EMPLOYEE", "type": "REGULAR", "status": "Saved", "payrollDate": "2021-06-26", "debit": { "amount": 31947900, "currency": "PHP" }, "gross": { "amount": 31947900, "currency": "PHP" }, "net": { "amount": 31947900, "currency": "PHP" }, "tax": { "amount": 0, "currency": "PHP" }, "pension": { "amount": 0, "currency": "PHP" }, "statutoryDeductions": { "amount": 0, "currency": "PHP" }, "employerContributions": { "amount": 0, "currency": "PHP" }, "payPeriod": { "fromDate": "2021-06-01", "toDate": "2021-06-30" }, "entries": [ { "personId": "04a8977d-5d99-4b28-8de4-8161401ca3fa", "salary": { "amount": 75000, "currency": "PHP" }, "bonus": { "amount": 10000, "currency": "PHP" }, "gross": { "amount": 85000, "currency": "PHP" }, "net": { "amount": 75704, "currency": "PHP" }, "allowances": [ { "name": "Transport", "isTaxable": true, "amount": { "amount": 5000, "currency": "PHP" } }, { "name": "Housing", "isTaxable": true, "amount": { "amount": 10000, "currency": "PHP" } } ], "deductions": [ { "name": "SSS", "isStatutory": true, "amount": { "amount": 4125, "currency": "PHP" } }, { "name": "Bonus Tax", "isStatutory": false, "amount": { "amount": 500, "currency": "PHP" } }, { "name": "Withholding Tax", "isStatutory": true, "amount": { "amount": 4671, "currency": "PHP" } } ], "employerContributions": [ { "name": "SSS", "isStatutory": false, "amount": { "amount": 9750, "currency": "PHP" } } ] } ] }

Documentation Index

Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
payrollId
string<uuid>
required

The unique identifier for the payroll

Response

Payroll details. Employee payrolls include tax, pension, statutory deduction, and employer contribution aggregates plus per-entry allowance, deduction, and employer-contribution line items. Contractor payrolls omit those fields entirely and return only the salary-based shape.

​
payrollId
string<uuid>

created payroll id

​
workerType
enum<string>

worker type

Available options:
EMPLOYEE,
CONTRACTOR
Example:

"EMPLOYEE"

​
status
enum<string>

Current payroll status. See Payroll Lifecycle for the meaning of each value and the allowed transitions.

Available options:
Created,
Saved,
Pending Approval,
Awaiting Funds,
Scheduled,
Processing,
Completed,
Rejected,
Deleted
Example:

"Completed"

​
numPeople
integer

number of people in payroll run

Example:

50

​
type
enum<string>

payroll type

Available options:
ONE-OFF,
REGULAR
Example:

"ONE-OFF"

​
payrollDate
string<date>

payroll date

​
debit
object
​
gross
object
​
net
object
​
tax
object

Total tax withheld across all entries. Returned for EMPLOYEE payrolls only; omitted for contractor payrolls.

​
pension
object

Total pension contribution across all entries. Returned for EMPLOYEE payrolls only; omitted for contractor payrolls.

​
statutoryDeductions
object

Total of all statutory deductions (legally-mandated items such as income tax and social security) across all entries. Returned for EMPLOYEE payrolls only; omitted for contractor payrolls.

​
employerContributions
object

Total employer contributions across all entries (e.g., employer-side social security). Returned for EMPLOYEE payrolls only; omitted for contractor payrolls.

​
payPeriod
object
​
entries
object[]