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

The Fields API from Rillet — 4 operation(s) for fields.

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

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

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

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

Paths & Operations 6

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

Fields 6
GET
/fields
Gets custom fields
get-fields 1 param → 200default
POST
/fields
Creates a field
create-field body → 200default
PUT
/fields/{id}
Updates a field
update-field 1 param body → 200default
POST
/fields/{id}/values
Creates a field value
create-field-value 1 param body → 200default
PUT
/fields/{fieldId}/values/{fieldValueId}
Updates a field value
update-field-value 2 params body → 200default
DELETE
/fields/{fieldId}/values/{fieldValueId}
Deletes a field value
delete-field-value 2 params → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Field (5 properties), Error (4 properties), FieldValue (3 properties), UpdateFieldRequest (2 properties). Each schema is shown below with its type and property counts.

FieldSettingsMap
object
The settings of the field. EXPENSES: Applies to Bills, Credit Card Transactions and Manual Entries. REVENUE: Applies to Customers, Contracts, Invoices and Cred…
2 properties
CreateFieldRequestValue
object
1 property 1 required
FieldSettings
object
2 properties 2 required
Error
object
4 properties 2 required
FieldsResponse
object
1 property 1 required
FieldValue
object
3 properties 3 required
CreateFieldValueRequest
object
1 property 1 required
Field
object
5 properties 4 required
UpdateFieldValueRequest
object
1 property 1 required
CreateFieldRequest
object
2 properties 2 required
UpdateFieldRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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