Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cadana Payrolls API

APIs for interacting with Payroll

Cadana Payrolls API is one of 30 APIs that Cadana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payrolls. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 5 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.cadanapay.com, https://dev-api.cadanapay.com.

7 operations 5 paths 16 schemas 1 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.cadanapay.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Cadana Payrolls API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API_SECRET_KEY) (Authorization). By default, every request must be authenticated.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Payrolls 7

APIs for interacting with Payroll

POST
/v1/payrolls
Create
createPayroll 1 param body → 2004005XX
GET
/v1/payrolls
List
retrievePayrolls 1 param → 200400
POST
/v1/payrolls/{payrollId}/save
Save
savePayroll 3 params body → 200204400
GET
/v1/payrolls/{payrollId}
Get
getPayroll 2 params → 200400
DELETE
/v1/payrolls/{payrollId}
Delete
deletePayroll 2 params → 204400
POST
/v1/payrolls/{payrollId}/approve
Approve
approvePayroll 2 params → 204400
GET
/v1/payrolls/{payrollId}/payslip-links
Get Payslip Links
getPayrollPayslipLinks 3 params → 200400404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are payrollSummary (14 properties), payrollEntry (11 properties), payrollEntryInput (11 properties), SavePayroll (6 properties). Each schema is shown below with its type and property counts.

CreatePayrollRequest
object
3 properties 2 required
deduction
object
3 properties 3 required
allowance
object
3 properties 3 required
payrollEntry
object
11 properties 2 required
uuid
string
NotFoundError
Not Found
InternalError
Internal server error
payrollEntryInput
object
11 properties 2 required
BadRequestError
Bad input provided by client
SavePayroll
object
6 properties 3 required
payrollStatus
string
Current payroll status. See [Payroll Lifecycle](/workforce/payroll-lifecycle) for the meaning of each value and the allowed transitions.
amount
object
2 properties 2 required
payPeriod
object
2 properties
payrollSummary
object
14 properties
tags
object
Any custom data you want to store
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-payrolls-api-openapi.yml Raw ↑

Other APIs Cadana publishes across the network.

Cadana Balances API
Cadana Beneficiaries API
Cadana Businesses API
Cadana Contracts API
Cadana Custom Auth API
Cadana Entities API
Cadana Events API
Cadana Files API
Cadana Filings API
Cadana FX API
Cadana Instant Pay API
Cadana Invoices API