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 Invoice payments API

The Invoice payments API from Rillet — 3 operation(s) for invoice payments.

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

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

This API exposes 5 operations across 3 paths, and defines 9 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.

5 operations 3 paths 9 schemas 1 DELETE2 GET1 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 Invoice payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Invoice payments 5
GET
/invoice-payments
Lists all invoice payments
list-all-invoices-payments 4 params → 200default
GET
/invoices/{invoice_id}/payments
Lists payments for a given invoice
list-all-invoice-payments 1 param → 200default
POST
/invoices/{invoice_id}/payments
Creates an invoice payment
create-an-invoice-payment 1 param body → 200default
DELETE
/invoices/{invoice_id}/payments/{payment_id}
Deletes an invoice payment
delete-an-invoice-payment 2 params → 204default
PUT
/invoices/{invoice_id}/payments/{payment_id}
Updates an invoice payment
update-an-invoice-payment 2 params body → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are InvoicePayment (7 properties), Error (4 properties), InvoicePaymentRequest (3 properties), RoundedMonetaryAmount (2 properties). Each schema is shown below with its type and property counts.

InvoicePayment
object
7 properties 5 required
InvoicePaymentRequest
object
3 properties 3 required
Error
object
4 properties 2 required
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
AccountCode
string
The account code found in the Chart of Accounts
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
Pagination
object
1 property
CurrencyCode
string
Currency code following ISO-4217

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-invoice-payments-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 Credit Memos API
Rillet Customer Payments API