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

The Invoices API from Rillet — 4 operation(s) for invoices.

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

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

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

7 operations 4 paths 39 schemas 1 DELETE2 GET2 POST2 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 Invoices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

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

Invoices 7
GET
/invoices
Lists all invoices
list-all-invoices 7 params → 200default
POST
/invoices
Creates an invoice
create-an-invoice body → 200default
GET
/invoices/{invoice_id}
Retrieves an invoice
retrieve-an-invoice 2 params → 200default
DELETE
/invoices/{invoice_id}
Deletes an invoice
delete-an-invoice 1 param → 204default
PUT
/invoices/{invoice_id}
Updates an invoice
update-an-invoice 1 param body → 200default
POST
/invoices/{invoice_id}/taxes
Updates invoice taxes
update-taxes-for-an-invoice 1 param body → 200default
PUT
/invoices/{invoice_id}/sent-status
Updates invoice sent status
update-invoice-sent-status 1 param body → 200default

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Invoice (27 properties), InvoiceItem (11 properties), CreateFullInvoiceRequest (11 properties), CreateRevenueRecognitionOnlyInvoiceRequest (10 properties). Each schema is shown below with its type and property counts.

UpdateRevenueRecognitionOnlyInvoiceItemRequest
object
4 properties 1 required
FieldAssignments
array
ExchangeRate
object
4 properties 4 required
CreateFullInvoiceItemRequest
object
5 properties 2 required
UpdateInvoiceRequest
object
AccountCode
string
The account code found in the Chart of Accounts
InvoiceItem
object
11 properties 10 required
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
Discount
Invoice
object
27 properties 17 required
TaxRate
1 required
UpdateInvoiceSentStatusRequest
object
1 property 1 required
UpdateRevenueRecognitionOnlyInvoiceRequest
object
7 properties 2 required
Address
object
6 properties 5 required
InvoiceItemPriceRequest
object
4 properties 3 required
ItemRevenue
object
3 properties
UpdateItemTaxesRequest
object
2 properties 2 required
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
UpdateFullInvoiceRequest
object
8 properties 3 required
CreateRevenueRecognitionOnlyInvoiceItemRequest
object
8 properties 5 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
CreateRevenueRecognitionOnlyInvoiceRequest
object
10 properties 5 required
CreateInvoiceRequest
object
CountryCode
string
Two-letter country code (ISO 3166-1 alpha-2).
InvoicingBankAccount
object
7 properties 4 required
CalendarPeriod
object
2 properties 2 required
CurrencyCode
string
Currency code following ISO-4217
AmountDiscount
object
2 properties 1 required
UpdateTaxesRequest
object
2 properties 2 required
CreateArOnlyInvoiceRequest
object
9 properties 5 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
InvoiceStatus
string
PercentageDiscount
object
2 properties 1 required
Pagination
object
1 property
CreateFullInvoiceRequest
object
11 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-invoices-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