Cadana Filings 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 9
Across 8 paths, the API surfaces 9 operations — 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Filings 9
Create, submit, and track statutory returns — from upcoming obligations through acceptance
GET
/v1/statutory/filings
List filings
listFilings4 params→ 200
POST
/v1/statutory/filings
Create a filing
createFiling1 parambody→ 201400422
POST
/v1/statutory/filings/batch
Create all filings for a period
createFilingsBatch1 parambody→ 201400
GET
/v1/statutory/filings/{filing_id}
Get a filing
getFiling2 params→ 200404
POST
/v1/statutory/filings/{filing_id}/approve
Approve a filing for submission
approveFiling2 params→ 204409
POST
/v1/statutory/filings/{filing_id}/cancel
Cancel a filing
cancelFiling2 paramsbody→ 204409
POST
/v1/statutory/filings/{filing_id}/amend
Amend a previously accepted filing
amendFiling2 paramsbody→ 201409
GET
/v1/statutory/filings/{filing_id}/document
Download filing document
getFilingDocument2 params→ 200404
GET
/v1/statutory/compliance/summary
Get compliance health summary
getComplianceSummary3 params→ 200
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Filing (20 properties), FilingListItem (13 properties), CreateFilingRequest (10 properties), FilingSummary (9 properties). Each schema is shown below with its type and property counts.
IDResponse
object
Response containing the ID of a newly created resource.
1 property
StatusHistoryEntry
object
Records a single status transition on a filing or remittance.
3 properties
FilingListItem
object
Reduced filing entry returned in list responses. Use GET /v1/statutory/filings/{id} for full details.
13 properties
AmendFilingRequest
object
2 properties1 required
ComplianceSummary
object
Single-call compliance health overview
7 properties
CreateFilingRequest
object
Create a filing. Every filing is described by a breakdown array of contribution lines that sum to the filing total — the breakdown is the canonical input. The…
10 properties6 required
Filing
object
Full filing detail returned by GET /v1/statutory/filings/{id}. Includes amounts, status history, and linked payroll runs.
20 properties
FilingBreakdownEntry
object
One contribution line that rolls up into a filing's total. The breakdown array as a whole is the canonical description of the filing — its sum is the filing to…
4 properties1 required
FilingAmounts
object
Derived totals for the filing. Read-only on responses — Cadana computes these values from the breakdown lines. You do not pass amounts when creating a filing;…
2 properties
FilingSummary
object
Status counts for the filtered set of filings. Use this to power compliance health dashboards.
9 properties
CreateFilingsBatchRequest
object
Batch create filings for a business and period in one call. Pick one input shape: - payrollRunIds — Cadana derives the filing types and breakdowns from the lin…
7 properties3 required
Error
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
