HomeCareBilling API

Read and write an agency's billing records. Authenticate with an agency API key as a bearer token. Every POST made with an API key needs an Idempotency-Key header.

Version 1 · Base URL https://www.homecarebilling.co · openapi.json

Documentation

GET /api/v1/openapi.json

The OpenAPI document

This document. No credential is needed.

200 The OpenAPI 3 document object
default An error, in the shared envelope. Error

Schemas

Error

Every error on the API. The details field appears on a 422 and maps each invalid field to its messages.

error object, required
error.code string, required: Stable, machine-readable, for example not_found or idempotency_key_reused.
error.details object: On a 422: each invalid field to a list of its messages. A nested record's field maps to an object of the same shape, and a list of nested records to a list of such objects.
error.message string, required: For a person to read.

Field	Type	Required	Description
error	object	yes
error.code	string	yes	Stable, machine-readable, for example not_found or idempotency_key_reused.
error.details	object	no	On a 422: each invalid field to a list of its messages. A nested record's field maps to an object of the same shape, and a list of nested records to a list of such objects.
error.message	string	yes	For a person to read.

Page

One page of a list. The total counts every matching record under the same filters, so a client can tell the whole list from the first page.

data array of object, required
limit integer, required: Rows asked for (default 100); a larger request is served 200.
offset integer, required: Rows skipped.
total integer, required: Every matching row.

Field	Type	Required	Description
data	array of object	yes
limit	integer	yes	Rows asked for (default 100); a larger request is served 200.
offset	integer	yes	Rows skipped.
total	integer	yes	Every matching row.