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 Invoices API

APIs for interacting with invoices

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

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

This API exposes 5 operations across 5 paths, and defines 10 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.

5 operations 5 paths 10 schemas 3 GET2 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 Invoices 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 5

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

Invoices 5

APIs for interacting with invoices

GET
/v1/invoices
List Invoices
listInvoices 10 params → 2005XX
GET
/v1/invoices/{invoiceId}
Get Invoice
getInvoice 2 params → 2004045XX
GET
/v1/invoices/{invoiceId}/url
Get Invoice URL
getInvoiceUrl 2 params → 2004045XX
POST
/v1/invoices/{invoiceId}/review
Review Invoice
reviewInvoice 2 params body → 2044004045XX
POST
/v1/invoices/{invoiceId}/cancel
Cancel Invoice
cancelInvoice 2 params → 2044004045XX

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are invoice (17 properties), invoiceLineItem (8 properties), invoiceParty (4 properties), phoneNumber (2 properties). Each schema is shown below with its type and property counts.

phoneNumber
object
Person's phone number
2 properties
uuid
string
NotFoundError
Not Found
InternalError
Internal server error
BadRequestError
Bad input provided by client
amount
object
2 properties 2 required
invoiceParty
object
Details of a party on an invoice (issuer or recipient)
4 properties
invoiceLineItem
object
A line item on an invoice
8 properties
invoice
object
An invoice document
17 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-invoices-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 Jurisdictions API