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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workerType": "EMPLOYEE",
  "status": "completed",
  "numPeople": 50,
  "type": "ONE-OFF",
  "payrollDate": "2023-12-25",
  "debit": {
    "amount": 10000,
    "currency": "USD"
  },
  "gross": {
    "amount": 10000,
    "currency": "USD"
  },
  "net": {
    "amount": 10000,
    "currency": "USD"
  },
  "tax": {
    "amount": 10000,
    "currency": "USD"
  },
  "pension": {
    "amount": 10000,
    "currency": "USD"
  },
  "payPeriod": {
    "fromDate": "2023-12-25",
    "toDate": "2023-12-25"
  },
  "entries": [
    {
      "personId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
      "salary": {
        "amount": 10000,
        "currency": "USD"
      },
      "net": {
        "amount": 10000,
        "currency": "USD"
      }
    }
  ]
}

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

get payroll response

​
payrollId
string<uuid>

created payroll id

​
workerType
enum<string>

worker type

Available options:
EMPLOYEE,
CONTRACTOR
Example:

"EMPLOYEE"

​
status
enum<string>

payroll status

Available options:
created,
pending approval,
approved,
rejected,
awaiting funds,
scheduled,
processing,
completed,
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
​
pension
object
​
payPeriod
object
​
entries
object[]