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

The Charges API from Rillet — 2 operation(s) for charges.

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

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

This API exposes 4 operations across 2 paths, and defines 20 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.

4 operations 2 paths 20 schemas 1 DELETE2 GET1 POST

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 Charges API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Charges 4
GET
/charges
Lists all charges
list-all-charges 4 params → 200default
POST
/charges
Create a charge
create-a-charge body → 200default
GET
/charges/{charge_id}
Retrieves a charge
retrieve-a-charge 1 param → 200default
DELETE
/charges/{charge_id}
Deletes a charge
delete-a-charge 1 param → 204default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ChargeRequest (8 properties), ChargeItemRequest (6 properties), TaxRateWithOptionalAmount (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

FieldAssignments
array
ExchangeRate
object
4 properties 4 required
AccountCode
string
The account code found in the Chart of Accounts
ChargeItem
ExternalReference
object
For requests, only pre-defined custom IDs are accepted. In responses, an object imported through an integration (e.g. Stripe) would return the provider's objec…
3 properties 2 required
TaxRate
1 required
Error
object
4 properties 2 required
ChargeItemRequest
object
6 properties 2 required
ChargeStatus
string
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
Charge
RoundedMonetaryAmount
object
A monetary amount that must be rounded to the currency's default decimal places (e.g., 2 decimal places for USD).
2 properties 2 required
CountryCode
string
Two-letter country code (ISO 3166-1 alpha-2).
CalendarPeriod
object
2 properties 2 required
CurrencyCode
string
Currency code following ISO-4217
ExpenseTaxRate
ChargeRequest
object
8 properties 4 required
TaxRateWithOptionalAmount
object
5 properties 4 required
Pagination
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-charges-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 Chart of Accounts API
Rillet Contract Items API
Rillet Contracts API
Rillet Credit Memos API
Rillet Customer Payments API
Rillet Customers API