Skip to main content
GET
/
v1
/
payrolls
/
{payrollId}
Get
curl --request GET \
  --url https://api.cadanapay.com/v1/payrolls/{payrollId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.cadanapay.com/v1/payrolls/{payrollId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cadanapay.com/v1/payrolls/{payrollId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadanapay.com/v1/payrolls/{payrollId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cadanapay.com/v1/payrolls/{payrollId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.cadanapay.com/v1/payrolls/{payrollId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/payrolls/{payrollId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "payrollId": "7c4f1d36-2b9a-4bca-91e7-2b1f1e6e7c11",
  "workerType": "EMPLOYEE",
  "type": "REGULAR",
  "status": "Pending Submission",
  "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"
          }
        }
      ]
    }
  ]
}

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. Values are title-cased (e.g. Pending Submission, Scheduled, Completed).

Available options:
Created,
Pending Submission,
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

Total amount deducted from the business balance for this payroll. For direct employment this is net pay plus fees; for EOR workers (compInfo.employmentModel: "eor") it is gross pay plus employer contributions, so statutory amounts are collected.

​
gross
object

Total gross pay across all entries, before deductions.

​
net
object

Total net (take-home) pay across all entries.

​
tax
object

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

​
pension
object

Combined employee and employer retirement contributions across all entries; the employee and employer portions are also included in statutoryDeductions and employerContributions respectively. Returned for EMPLOYEE payrolls only; omitted for contractor payrolls.

​
statutoryDeductions
object

Total of all employee-side statutory deductions, including 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

The pay period this payroll covers.

​
entries
object[]