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

Rillet Contract Items API

The Contract Items API from Rillet — 1 operation(s) for contract items.

Rillet Contract Items API is one of 28 APIs that Rillet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contract Items. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 1 path, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version v4.0.

Requests are made against 2 base URLs: https://api.rillet.com, https://sandbox.api.rillet.com.

3 operations 1 paths 6 schemas 1 DELETE1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v4.0
Base URL
https://api.rillet.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Rillet Contract Items API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

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

Contract Items 3
PATCH
/contract-items/{contract_item_id}/usage
Upserts a usage record
upsert-a-usage-record 1 param body → 200default
GET
/contract-items/{contract_item_id}/usage
Lists all contract item usage records
list-all-contract-item-usage-records 3 params → 200default
DELETE
/contract-items/{contract_item_id}/usage
Deletes a usage record
delete-a-usage-record 2 params → 204default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), Usage (2 properties), Pagination (1 property), UsageRecords (1 property). Each schema is shown below with its type and property counts.

Usage
object
2 properties 2 required
Error
object
4 properties 2 required
UsageRecords
object
Allows you to update multiple dates at once.
1 property 1 required
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
Pagination
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-contract-items-api-openapi.yml Raw ↑

Other APIs Rillet publishes across the network.

Rillet API Key API
Rillet Bank accounts API
Rillet Bank Transactions API
Rillet Bill Payments API
Rillet Bills API
Rillet Books periods API
Rillet Charges API
Rillet Chart of Accounts API
Rillet Contracts API
Rillet Credit Memos API
Rillet Customer Payments API
Rillet Customers API