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 Credit Memos API

The Credit Memos API from Rillet — 4 operation(s) for credit memos.

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

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

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

8 operations 4 paths 29 schemas 2 DELETE2 GET3 POST1 PUT

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

Paths & Operations 8

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

Credit Memos 8
GET
/credit-memos
Lists all credit memos
list-all-credit-memos 4 params → 200default
POST
/credit-memos
Creates a credit memo
create-a-credit-memo body → 200default
GET
/credit-memos/{credit_memo_id}
Retrieves a credit memo
retrieve-a-credit-memo 1 param → 200default
DELETE
/credit-memos/{credit_memo_id}
Deletes a credit memo
delete-a-credit-memo 1 param → 204default
PUT
/credit-memos/{credit_memo_id}
Updates a credit memo
update-a-credit-memo 1 param body → 200default
POST
/credit-memos/{credit_memo_id}/taxes
Updates credit memo taxes
update-taxes-for-a-credit-memo 1 param body → 200default
DELETE
/credit-memos/{credit_memo_id}/applications
Unapplies all credit memo applications
delete-credit-memo-applications 1 param → 204default
POST
/credit-memos/{credit_memo_id}/applications
Reconciles credit memo applications
apply-credit-memo 1 param body → 200default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are CreditMemo (17 properties), CreditMemoItem (9 properties), CreateCreditMemoRequest (7 properties), CreditMemoApplication (6 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
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
ApplyCreditMemoRequest
object
1 property 1 required
CreditMemo
object
17 properties 15 required
CreditMemoItem
object
9 properties 7 required
TaxRate
1 required
CreditMemoItemPriceRequest
object
3 properties 3 required
Address
object
6 properties 5 required
UpdateItemTaxesRequest
object
2 properties 2 required
ItemRevenue
object
3 properties
MonetaryAmount
object
2 properties 2 required
Error
object
4 properties 2 required
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
CreditMemoApplicationRequest
object
3 properties 3 required
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
CreditMemoApplication
object
6 properties 5 required
CreateCreditMemoItemRequest
object
5 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
UpdateTaxesRequest
object
2 properties 2 required
RevenuePattern
string
DAILY means that the revenue is divided equally per day in the revenue period. EVENPERIOD means that the revenue is divided equally for each calendar month in…
TaxRateWithOptionalAmount
object
5 properties 4 required
UpdateCreditMemoRequest
object
3 properties 2 required
CreateCreditMemoRequest
object
7 properties 3 required
Pagination
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-credit-memos-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 Contract Items API
Rillet Contracts API
Rillet Customer Payments API
Rillet Customers API