Skip to main content
POST
/
v1
/
payrolls
Create
curl --request POST \
  --url https://api.cadanapay.com/v1/payrolls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workerType": "EMPLOYEE",
  "type": "ONE_OFF",
  "tags": {}
}
'
{
  "payrollId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e"
}

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.

Body

application/json
​
workerType
enum<string>
required

worker type

Available options:
EMPLOYEE,
CONTRACTOR
Example:

"EMPLOYEE"

​
type
enum<string>
required

payroll type

Available options:
ONE_OFF,
REGULAR
Example:

"ONE_OFF"

​
tags
object

Any custom data you want to store

Response

create payroll response

​
payrollId
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"