Skip to main content
GET
/
v1
/
payrolls
List
curl --request GET \
  --url https://api.cadanapay.com/v1/payrolls \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
      },
      "statutoryDeductions": {
        "amount": 10000,
        "currency": "USD"
      },
      "employerContributions": {
        "amount": 10000,
        "currency": "USD"
      },
      "payPeriod": {
        "fromDate": "2023-12-25",
        "toDate": "2023-12-25"
      }
    }
  ]
}

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.

Response

get payrolls response

​
data
object[]