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 Vendor Credits API

The Vendor Credits API from Rillet — 2 operation(s) for vendor credits.

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

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

This API exposes 5 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.

5 operations 2 paths 20 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 Vendor Credits 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 2 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.

Vendor Credits 5
GET
/vendor-credits
Lists all vendor credits
list-all-vendor-credits 5 params → 200default
POST
/vendor-credits
Creates a vendor credit
create-a-vendor-credit body → 200default
GET
/vendor-credits/{vendor_credit_id}
Retrieves a vendor credit
retrieve-a-vendor-credit 1 param → 200default
PUT
/vendor-credits/{vendor_credit_id}
Updates a vendor credit
update-a-vendor-credit 1 param body → 200default
DELETE
/vendor-credits/{vendor_credit_id}
Deletes a vendor credit
delete-a-vendor-credit 1 param → 204default

Schemas 20

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

BaseVendorCreditRequest
object
5 properties 4 required
FieldAssignments
array
AccountCode
string
The account code found in the Chart of Accounts
TaxRate
1 required
CreateVendorCreditRequest
VendorCreditStatus
string
VendorCreditLineItem
Error
object
4 properties 2 required
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
VendorCreditApplication
object
6 properties 5 required
VendorCredit
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).
CurrencyCode
string
Currency code following ISO-4217
ExpenseTaxRate
TaxRateWithOptionalAmount
object
5 properties 4 required
UpdateVendorCreditRequest
Pagination
object
1 property
VendorCreditLineItemRequest
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-vendor-credits-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