Teachworks Payment Allocations API
Allocations of payments to invoices.
Teachworks Payment Allocations API is one of 23 APIs that Teachworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payment Allocations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, https://api.teachworks.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Teachworks Payment Allocations API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (tokenAuth).
By default, every request must be authenticated.
tokenAuth— Account API token passed in the Authorization header using the scheme "Authorization: Token token=APITOKEN". Generate a token on the Integrations and Add-ons p…
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Allocations of payments to invoices.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Teachworks 12
Other APIs Teachworks publishes across the network.