- Category: accounting
- Auth: API_KEY, DCR_OAUTH
- Composio-managed OAuth available? No
- Tools: 174
- Triggers: 0
- Slug:
RILLET - Version: 20261101_00
Tools
Adds members to a customer family
Adds members to a customer family
RILLET_ADD_CUSTOMER_FAMILY_MEMBERSAdds customers to a family and moves members already in it, in one call. Naming a member that already belongs gives it a new parent, so a branch can be restructured in a single request rather than through a sequence that would be invalid halfway through.Input Parameters
Output
Amends a contract
Amends a contract
RILLET_AMEND_A_CONTRACTApplies a contract amendment when you need to add items, retire items, or change pricing/invoicing after go-live. Unlike a full PUT update, amendments model business-time changes and preserve historical billing context. Use preview-contract-amendment to dry-run the financial impact before committing.Input Parameters
Output
Reconciles credit memo applications
Reconciles credit memo applications
Applies a vendor credit to bills
Applies a vendor credit to bills
Updates metadata for multiple accounts
Updates metadata for multiple accounts
RILLET_BULK_UPDATE_ACCOUNT_METADATAPatches metadata on up to 1,000 accounts in one atomic request. Each account may receive different values. If an account is missing or any key or value is invalid, nothing is written for any account. Per account this behaves exactly like patch-account-metadata: keys omitted for that account are left unchanged; null, empty, and whitespace-only values clear that key.Input Parameters
Output
Updates metadata for multiple bills
Updates metadata for multiple bills
RILLET_BULK_UPDATE_BILL_METADATAPatches metadata on up to 1,000 bills in one atomic request. Each bill may receive different values. If a bill is missing or any key or value is invalid, nothing is written for any bill. Per bill this behaves exactly like patch-bill-metadata: keys omitted for that bill are left unchanged; null, empty, and whitespace-only values clear that key. If any bill has a pending approval request, the entire request is rejected with a 400 and nothing is written.Input Parameters
Output
Updates metadata for multiple contracts
Updates metadata for multiple contracts
RILLET_BULK_UPDATE_CONTRACT_METADATAPatches metadata on up to 1,000 contracts in one atomic request. Each contract may receive different values. If a contract is missing or any key or value is invalid, nothing is written for any contract. Per contract this behaves exactly like patch-contract-metadata: keys omitted for that contract are left unchanged; null, empty, and whitespace-only values clear that key.Input Parameters
Output
Updates metadata for multiple customers
Updates metadata for multiple customers
RILLET_BULK_UPDATE_CUSTOMER_METADATAPatches metadata on up to 1,000 customers in one atomic request. Each customer may receive different values. If a customer is missing or any key or value is invalid, nothing is written for any customer. Per customer this behaves exactly like patch-customer-metadata: keys omitted for that customer are left unchanged; null, empty, and whitespace-only values clear that key. Metadata-only changes are recorded in the audit log but do not trigger customer.updated webhooks or customer integration syncs.Input Parameters
Output
Updates metadata for multiple invoices
Updates metadata for multiple invoices
RILLET_BULK_UPDATE_INVOICE_METADATAPatches metadata on up to 1,000 invoices in one atomic request. Each invoice may receive different values. If an invoice is missing or any key or value is invalid, nothing is written for any invoice. Per invoice this behaves exactly like patch-invoice-metadata: keys omitted for that invoice are left unchanged; null, empty, and whitespace-only values clear that key.Input Parameters
Output
Permanently cancels a pending milestone
Permanently cancels a pending milestone
RILLET_CANCEL_A_MILESTONEPermanently forfeits a pending milestone allocation on a FULL contract without redistributing it or automatically issuing a refund. A nonzero allocation creates a linked credit memo; zero allocations do not. Retrying the saved effective_date is a no-op, while a different date conflicts. Completed milestones must be reversed before cancellation. This PUT operation sends the complete documented request representation.Input Parameters
Output
Completes a close checklist task
Completes a close checklist task
RILLET_COMPLETE_A_CLOSE_CHECKLIST_TASKMarks the task as prepared, recorded as completed by the connected user at the current time. Requires an OAuth connection made by a named user; API keys are rejected with HTTP 403 because they do not act as a user. A task that is already completed is rejected with HTTP 409 so an earlier preparer’s record is never overwritten. Returns the updated task.Input Parameters
Output
Creates a bank account
Creates a bank account
RILLET_CREATE_A_BANK_ACCOUNTRegisters a treasury bank account with currency, institution identifiers, and linkage to the GL cash account used during transaction import. Accurate mapping here ensures invoice payments, bill payments, and bank feeds all post to the same cash subledger.Input Parameters
Output
Creates a bank transaction
Creates a bank transaction
RILLET_CREATE_A_BANK_TRANSACTIONInserts a single bank feed line such as a wire, ACH, or adjustment when automated imports miss a statement row. Specify the hosting bank account and value dates so cash reporting matches what treasury already booked externally.Input Parameters
Output
Creates a bill
Creates a bill
RILLET_CREATE_A_BILLAccrues a new accounts-payable bill against a vendor with subsidiary context, line items, and due dates your approval workflow consumes. Attach supporting metadata now so matching payments, amortization schedules, and document uploads stay aligned with the payable.Input Parameters
Output
Creates a bill payment
Creates a bill payment
RILLET_CREATE_A_BILL_PAYMENTBooks a cash or scheduled disbursement that settles all or part of a bill, updating the outstanding payable and linking treasury activity. Provide funding source details consistent with your configured payment rails so downstream bank reconciliation stays accurate. IMPORTANT: Notice this operation has a redundancy between the bill_id path parameter and the billId attribute in the request body, which takes precedence and is used in internal logic. When executing this operation, both IDs must match, otherwise the request will be rejected. This is a legacy redundancy and will be removed in future versions of this operation.Input Parameters
billId provided in the request body.Output
Creates a chart of accounts
Creates a chart of accounts
RILLET_CREATE_A_CHART_OF_ACCOUNTSInitializes the entire chart of accounts for a bare organization in one atomic call. The organization must have no existing chart of accounts; otherwise the request fails with 409. The complete request is validated before any accounts or groups are created; validation failures return 400 without leaving a partial chart of accounts. Structural invariants match CSV import: exactly one Accounts Receivable, Accounts Payable, Sales Tax Liability, and Retained Earnings; at least one Unbilled Revenue, Prepaid Expense, and Deferred Revenue. The same default group scaffold as CSV import is created. Each account’s optional parent_grouping reuses a scaffold group by name or creates a nested group under the account type root.Input Parameters
Output
Creates a contract
Creates a contract
RILLET_CREATE_A_CONTRACTRillet supports two contract scope types: FULL and REVENUE_RECOGNITION_ONLY. The selected scope determines how the invoices are created and what information the user needs to provide. The FULL scope is used when contract invoices are generated and sent directly from Rillet. In this case, Rillet automatically assigns the invoice numbers. The REVENUE_RECOGNITION_ONLY scope is intended for situations where contracts and invoices are issued from another system and only need to be recorded in Rillet for accounting purposes. In this workflow, users must provide the invoice numbers manually. Other fields can be populated based on the data imported from the external system. For example, if your organization issues invoices through an external billing platform but tracks financials in Rillet, you should select REVENUE_RECOGNITION_ONLY.Input Parameters
Output
Creates a credit memo
Creates a credit memo
Creates a customer
Creates a customer
RILLET_CREATE_A_CUSTOMERCreates a new customer in the Accounts Receivable catalog. Required fields: name. When providing a billing or shipping address, line1, city, zip_code, and country are required. State is required for United States addresses (use a 2-letter code such as ‘TN’ or ‘CA’) and may be omitted where it does not apply.Input Parameters
Output
Creates a customer family
Creates a customer family
RILLET_CREATE_A_CUSTOMER_FAMILYCreates a family from customers that do not already belong to one. A child may report to another child, so a multi-level hierarchy is created in one call.Input Parameters
Output
Creates a draft contract
Creates a draft contract
RILLET_CREATE_A_DRAFT_CONTRACTStages a contract in the “draft” holding state instead of creating it directly as an active contract. Draft contracts appear in the Rillet UI under “Draft” for a human to approve or reject. ## Deduplication To prevent duplicate draft contracts on retry, supply at least one external_references entry with a stable (type, id) pair. When you POST again with any matching (type, id) pair, the prior draft record is replaced with the new payload. Draft contracts created without any external_references are not deduplicated — every POST creates a new record. ## External reference types Each reference’s type must match a slug already defined under Rillet Settings → External References for the organization; unknown slugs return a 400. References attached at create time are preserved when the draft contract is promoted to an active contract.Input Parameters
POST /customers first if needed.type slug must already exist in the org’s external reference types (configurable in Rillet Settings). Required for deduplication. Re-posting with any matching (type, id) pair replaces the prior draft record. Draft contracts created without external_references are not deduplicated.Output
Creates a journal entry
Creates a journal entry
RILLET_CREATE_A_JOURNAL_ENTRYPosts a balanced manual journal entry with explicit debit and credit lines, posting date, and subsidiary scope for GL corrections. Prefer dedicated AR or AP APIs when the business event already exists; reserve this for adjustments your automation cannot model yet.Input Parameters
Output
Creates an account
Creates an account
RILLET_CREATE_AN_ACCOUNTAdds an account to the chart of accounts for the organization. The account currency is inherited from the organization, its status is ACTIVE, and its default grouping and closing behavior are derived from the selected type and subtype.Input Parameters
Accounts Receivable, Fixed Assets, Accumulated Depreciation, Other Current Asset, Bank, Allowance for Doubtful Accounts, Unbilled Revenue, Prepaid Expense, Deferred Commissions, Right of Use Asset, Other Assets, Restricted Cash. LIABILITY: Other Current Liability, Other Long Term Liability, Accounts Payable, Credit Card, Deferred Revenue, Accrued Expense, Sales Tax Liability, Debt, Lease Liability, Customer Deposits, Customer Credit. EQUITY: Equity, Equity, Compensation, Additional Paid In Capital, Accumulated Other Comprehensive Income, Retained Earnings.Output
Creates an invoice
Creates an invoice
RILLET_CREATE_AN_INVOICEA matching creation approval workflow returns HTTP 202 with invoice_id, approval_request_id, and status PENDING. This is a proposal, not a created invoice. Retrieve its contents using retrieve-an-invoice-creation-proposal. For approval proposals, pass idempotency_key on the initial call and retain it across retries. The key is optional; each call without one creates a new submission, including retries. The key does not deduplicate legacy creation when approvals are disabled or the invoice belongs to a contract. A rejected proposal remains closed; a deliberate new invoice uses a new key. Rillet supports two invoice scope types: FULL and REVENUE_RECOGNITION_ONLY. The selected scope determines how the invoice is created and what information the user needs to provide. The FULL scope is used when the invoice is generated and sent directly from Rillet.Input Parameters
Output
Creates an invoice payment
Creates an invoice payment
RILLET_CREATE_AN_INVOICE_PAYMENTRecords a manual cash receipt against an open invoice by amount, effective date, and a GL account code that maps to a funded cash account. Rillet resolves the account code to a cash account before posting, so verify chart-of-accounts mapping when automations fail validation.Input Parameters
Output
Creates a product
Creates a product
RILLET_CREATE_A_PRODUCTCreates a new product (good or service) that can be referenced on contracts and invoices. Choose pricing and revenue behavior consistent with how you bill customers (one-time, recurring, usage, etc.). Set type to BUNDLE to create a bundle.Input Parameters
Output
Create a reimbursement
Create a reimbursement
Creates a reimbursement payment
Creates a reimbursement payment
Create an auto-payment setup link
Create an auto-payment setup link
Creates a vendor
Creates a vendor
RILLET_CREATE_A_VENDORAdds a vendor master record the accounts-payable team can select on bills, vendor credits, and payments. Capture legal name, remit-to address, default currency, and payment terms so downstream bills inherit correct due dates and banking instructions.Input Parameters
Output
Creates a vendor credit
Creates a vendor credit
Creates an external reference type
Creates an external reference type
Creates a field
Creates a field
RILLET_CREATE_FIELDDefines a new custom field (text, number, pick list, etc.) that can be attached to supported Rillet entities for reporting and automation. After creation, use create-field-value to seed allowed pick-list entries or default values teams should see in the UI.Input Parameters
Output
Creates a field value
Creates a field value
RILLET_CREATE_FIELD_VALUEAdds a selectable value to a pick-list style custom field so users and APIs can tag entities with consistent taxonomy. Values inherit the field’s scope, so create them after the parent field exists and before importing records that reference the new code.Input Parameters
Output
Deletes a bank account
Deletes a bank account
Deletes a bank transaction
Deletes a bank transaction
Deletes a bill
Deletes a bill
Deletes a bill payment
Deletes a bill payment
RILLET_DELETE_A_BILL_PAYMENTReverses a previously recorded bill payment when the disbursement failed or was duplicated, restoring the bill balance accordingly. Treat this as a corrective action with the same controls you apply to voiding treasury transactions in your close process.Input Parameters
Output
Deletes a charge
Deletes a charge
Deletes a contract
Deletes a contract
Deletes a document from a contract
Deletes a document from a contract
RILLET_DELETE_A_CONTRACT_DOCUMENTRemoves one attachment from a contract. The stored file is deleted unless another contract or a milestone still uses it, or the file belongs to another part of Rillet. Works for files uploaded through the API or the Rillet application, or imported from Salesforce.Input Parameters
Output
Deletes a credit memo
Deletes a credit memo
Deletes a customer
Deletes a customer
Dissolves a customer family
Dissolves a customer family
Deletes a draft contract
Deletes a draft contract
Deletes a document from a draft contract
Deletes a document from a draft contract
RILLET_DELETE_A_DRAFT_CONTRACT_DOCUMENTRemoves one attachment from a draft contract. The stored file is deleted unless a contract, another draft contract or a milestone still uses it, or the file belongs to another part of Rillet. Works for files uploaded through the API or the Rillet application, or imported from Salesforce. A file imported from Salesforce stays removed when the draft contract is imported again, unless a newer version of it is uploaded in Salesforce.Input Parameters
Output
Deletes a journal entry
Deletes a journal entry
Deletes an invoice
Deletes an invoice
Deletes a document from an invoice
Deletes a document from an invoice
Deletes an invoice payment
Deletes an invoice payment
RILLET_DELETE_AN_INVOICE_PAYMENTReverses a previously recorded uncleared invoice payment, restoring the invoice balance accordingly. Only uncleared payments can be deleted; cleared or reconciled payments are rejected. Treat this as a corrective action with the same controls you apply to voiding treasury transactions in your close process.Input Parameters
Output
Deletes a product
Deletes a product
Deletes a reimbursement
Deletes a reimbursement
Deletes a reimbursement payment
Deletes a reimbursement payment
Deletes a usage record
Deletes a usage record
Deletes a vendor
Deletes a vendor
Deletes a vendor credit
Deletes a vendor credit
Unapplies all credit memo applications
Unapplies all credit memo applications
Deletes a field value
Deletes a field value
Ends an open-ended contract
Ends an open-ended contract
RILLET_END_AN_OPEN_ENDED_CONTRACTSets an explicit end date on a contract that previously had no close date (open-ended). Provide the final end_date in the request body; downstream invoicing and revenue recognition honor the new boundary. This PUT operation sends the complete documented request representation.Input Parameters
Output
Gets API key information
Gets API key information
RILLET_GET_API_KEY_INFORMATIONConfirms the caller’s API key is recognized and returns basic identity metadata such as organization context when authentication succeeds. Integrations should call this during bootstrap or rotation to distinguish invalid keys from broader connectivity failures.Output
Get Current Organization
Get Current Organization
Get Financial Report
Get Financial Report
RILLET_GET_FINANCIAL_REPORTReturn either a trial balance for a date range or a balance sheet as of a date, with optional subsidiary and book filters. This reads calculated accounting results and does not post or modify entries.Input Parameters
Output
Gets payment method
Gets payment method
Returns service health
Returns service health
List Accounting Reference Data
List Accounting Reference Data
RILLET_LIST_ACCOUNTING_REFERENCE_DATAReturn a Rillet reference collection selected by resource: chart accounts, subsidiaries, books, bank accounts, tax rates, or custom fields, with resource-specific filters. Use it to resolve IDs and accounting configuration before querying transactions or reports.Input Parameters
Output
Lists all approval workflows
Lists all approval workflows
RILLET_LIST_ALL_APPROVAL_WORKFLOWSReturns every approval workflow in the organization tied to the API credentials, active and inactive, grouped by the kind of record they apply to and ordered by ascending priority within each group. This endpoint is not paginated and returns the complete set.Output
Lists all charges
Lists all charges
Lists all contract item usage records
Lists all contract item usage records
Lists all credit memos
Lists all credit memos
Lists all customer families
Lists all customer families
RILLET_LIST_ALL_CUSTOMER_FAMILIESReturns customer families with pagination and optional search or update filters. The response does not include members; use list-customer-family-members to read them.Input Parameters
Output
Lists all draft contracts
Lists all draft contracts
Lists payments for a given invoice
Lists payments for a given invoice
Lists all invoice payments
Lists all invoice payments
RILLET_LIST_ALL_INVOICES_PAYMENTSPages every customer payment recorded against invoices across the organization, independent of which invoice it settled. Use updated.gt and sort_by when syncing integrations; follow the pagination cursor until no next page remains.Input Parameters
Output
Lists all metadata definitions
Lists all metadata definitions
RILLET_LIST_ALL_METADATA_DEFINITIONSReturns the organization’s metadata definitions: the custom fields that can hold values on contracts, customers, and invoices. Keys are permanent identifiers derived from the name at creation; API consumers bind to keys, which never change on rename. At most 50 active definitions can be assigned to one entity type. Definitions are managed in Settings, not through this API.Input Parameters
Output
Lists all products
Lists all products
Lists all reimbursements
Lists all reimbursements
RILLET_LIST_ALL_REIMBURSEMENTSSurfaces reimbursement requests created from approved charges or manual submissions, including subsidiary and freshness filters for payroll sync. Use pagination cursors for large populations and pair with retrieve-a-reimbursement when a row needs detailed audit context.Input Parameters
Output
Lists all vendor credits
Lists all vendor credits
List Bank Transactions
List Bank Transactions
RILLET_LIST_BANK_TRANSACTIONSReturn one page of bank transactions, optionally filtered by bank account, subsidiary, transaction-date range, or update time.Input Parameters
Output
Lists bill payments
Lists bill payments
List Bills
List Bills
Lists close checklist tasks
Lists close checklist tasks
RILLET_LIST_CLOSE_CHECKLIST_TASKSReturns the month-end close checklist for one accounting month: every task with its notes, due date, preparer, reviewer queue, completion and sign-off state. Use it to report close progress or to find the task_id needed by update, complete and sign-off. Resolve preparer and reviewer user ids to people with list-members (match on user_id). Responds with HTTP 404 when no checklist exists for the month.Input Parameters
Output
Lists documents attached to a contract
Lists documents attached to a contract
RILLET_LIST_CONTRACT_DOCUMENTSReturns all attached documents, including those uploaded through the Rillet application or imported from Salesforce. Each download URL is valid for up to 1 hour; call this endpoint again to obtain fresh URLs. Documents are listed oldest first. Returns an empty documents array when the contract has no attachments.Input Parameters
Output
List Contracts
List Contracts
RILLET_LIST_CONTRACTSReturn one page of contracts, optionally filtered by subsidiary, customer, lifecycle status, or inclusive/exclusive start and end date ranges.Input Parameters
Output
Lists the members of a customer family
Lists the members of a customer family
RILLET_LIST_CUSTOMER_FAMILY_MEMBERSReturns the members of a customer family with pagination. Each member names the member it reports to, so you can rebuild the tree. Newest first, not alphabetical.Input Parameters
Output
List Customers
List Customers
Lists documents attached to a draft contract
Lists documents attached to a draft contract
RILLET_LIST_DRAFT_CONTRACT_DOCUMENTSReturns all attached documents, including those uploaded through the Rillet application or imported from Salesforce. Each download URL is valid for up to 1 hour; call this endpoint again to obtain fresh URLs. Documents are listed oldest first. Returns an empty documents array when the draft contract has no attachments. Once the draft contract is confirmed, its documents are listed on the contract instead.Input Parameters
Output
Lists documents attached to an invoice
Lists documents attached to an invoice
RILLET_LIST_INVOICE_DOCUMENTSReturns all attached documents, including those uploaded through the Rillet application. Each download URL is valid for up to 1 hour; call this endpoint again to obtain fresh URLs. Documents are listed oldest first. Returns an empty documents array when the invoice has no attachments.Input Parameters
Output
List Invoices
List Invoices
RILLET_LIST_INVOICESReturn one page of invoices, optionally filtered by subsidiary, customer, payment status, overdue state, external reference, or update time. Results intentionally omit bank-account and full postal-address details.Input Parameters
Output
List Journal Entries
List Journal Entries
RILLET_LIST_JOURNAL_ENTRIESReturn one page of journal entries, optionally filtered by subsidiary, book, posting-date range, account IDs, or update time. Each result includes debit and credit lines with exact decimal amount strings.Input Parameters
Output
Lists documents attached to a manual journal entry
Lists documents attached to a manual journal entry
RILLET_LIST_JOURNAL_ENTRY_DOCUMENTSReturns all attached documents, including those uploaded through the Rillet application. Each download URL is valid for up to 1 hour; call this endpoint again to obtain fresh URLs. Returns an empty array when the entry has no attachments. System-generated and non-posting entries are not supported.Input Parameters
Output
Lists organization members
Lists organization members
RILLET_LIST_MEMBERSReturns the identity of each member of the organization tied to the API credentials. This endpoint carries identity only (id, user, email, name, status); it does not return role assignments. Use list-role-assignments to discover which member is assigned which role, and list-roles to resolve what each role authorizes.Input Parameters
Output
Lists reimbursement payments
Lists reimbursement payments
Lists journal entries with reporting currency amounts
Lists journal entries with reporting currency amounts
RILLET_LIST_REPORTS_JOURNAL_ENTRIESReturns journal entries with line item amounts converted to the reporting currency.Input Parameters
Output
Lists role assignments
Lists role assignments
RILLET_LIST_ROLE_ASSIGNMENTSReturns which organization member is assigned which role and the scope of that assignment. References roles and members by id only; join against list-roles and list-members to resolve names. This endpoint is not the source of truth for role or subsidiary names.Input Parameters
Output
Lists roles
Lists roles
List Vendors
List Vendors
RILLET_LIST_VENDORSReturn one page of accounts-payable vendors, optionally limited to records updated after a timestamp. Results omit tax IDs, addresses, email addresses, payment terms, custom fields, and account-code details.Input Parameters
Output
Matches two bank transactions as a transfer
Matches two bank transactions as a transfer
RILLET_MATCH_BANK_TRANSACTIONS_AS_TRANSFERMatches two bank transactions as a transfer. The source transaction may be incoming or outgoing; the transaction amounts determine the direction. Cross-subsidiary transfers require access to both subsidiaries. For a same-subsidiary transfer with a difference, provide reconciliation_adjustment.account_id; reconciliation_adjustment.fields apply to the adjustment line. If either bank transaction has a fee, provide fees_account_id to book it. A transfer with fees on both bank transactions is not supported.Input Parameters
Output
Matches bank transactions to existing records
Matches bank transactions to existing records
RILLET_MATCH_BANK_TRANSACTIONS_TO_RECORDSMatches bank transactions to existing records. You can include different record types in one request, subject to the supported match combinations. To book a difference, provide reconciliation_adjustment.account_id. Optional reconciliation_adjustment.fields are custom field and value IDs applied to the adjustment entry, not to the matched records. Rillet calculates the difference.Input Parameters
Output
Matches bank transactions with new quick entries
Matches bank transactions with new quick entries
RILLET_MATCH_BANK_TRANSACTIONS_WITH_QUICK_ENTRYCreates a separate quick entry for each bank transaction in transaction_ids, using the same requested details. The transactions are not combined into one many-to-one (N:1) match. With line_items, supply exactly one ID.Input Parameters
Output
Patches account metadata
Patches account metadata
RILLET_PATCH_ACCOUNT_METADATAPartial update. Keys omitted from the request body are left unchanged; send a key with a null, empty, or whitespace-only value to clear it. Prefer this over update-account-metadata when setting or clearing individual keys, as it cannot disturb keys you did not name. Archived keys may only be cleared, never changed. Every key must name a definition assigned to accounts: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written.Input Parameters
Output
Patches bill metadata
Patches bill metadata
RILLET_PATCH_BILL_METADATAPartial update. Keys omitted from the request body are left unchanged; send a key with a null, empty, or whitespace-only value to clear it. Prefer this over update-bill-metadata when setting or clearing individual keys, as it cannot disturb keys you did not name. Archived keys may only be cleared, never changed. Every key must name a definition assigned to bills: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written. Writes are rejected with a 400 while the bill has a pending approval request.Input Parameters
Output
Patches contract metadata
Patches contract metadata
RILLET_PATCH_CONTRACT_METADATAPartial update. Keys omitted from the request body are left unchanged; send a key with a null, empty, or whitespace-only value to clear it. Prefer this over update-contract-metadata when setting or clearing individual keys, as it cannot disturb keys you did not name. Archived keys may only be cleared, never changed. Every key must name a definition assigned to contracts: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written.Input Parameters
Output
Patches customer metadata
Patches customer metadata
RILLET_PATCH_CUSTOMER_METADATAPartial update. Keys omitted from the request body are left unchanged; send a key with a null, empty, or whitespace-only value to clear it. Prefer this over update-customer-metadata when setting or clearing individual keys, as it cannot disturb keys you did not name. Archived keys may only be cleared, never changed. Every key must name a definition assigned to customers: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written.Input Parameters
Output
Patches invoice metadata
Patches invoice metadata
RILLET_PATCH_INVOICE_METADATAPartial update. Keys omitted from the request body are left unchanged; send a key with a null, empty, or whitespace-only value to clear it. Prefer this over update-invoice-metadata when setting or clearing individual keys, as it cannot disturb keys you did not name. Archived keys may only be cleared, never changed. Every key must name a definition assigned to invoices: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written.Input Parameters
Output
Previews contract amendment
Previews contract amendment
RILLET_PREVIEW_CONTRACT_AMENDMENTPreview a contract that has been amended. This has no effect on the actual contract, only provides a preview of what a contract will look like after it is amended.Input Parameters
Output
Preview the invoice schedule for a contract
Preview the invoice schedule for a contract
Refreshes a bundle
Refreshes a bundle
Removes a member from a customer family
Removes a member from a customer family
RILLET_REMOVE_A_CUSTOMER_FAMILY_MEMBERRemoves one customer from the family; the customer itself is untouched. Anyone reporting to it moves up to its own parent. If this would leave the family with a single member it is dissolved instead. The root parent cannot be removed this way: dissolve the family instead.Input Parameters
Output
Renames a customer family
Renames a customer family
Retrieves a bank account
Retrieves a bank account
Retrieves a bank account balance
Retrieves a bank account balance
RILLET_RETRIEVE_A_BANK_ACCOUNT_BALANCEReturns the latest stored bank balance on or before the requested date in the bank account’s native currency. The response includes the stored balance date so consumers can identify when the latest available balance predates the requested date.Input Parameters
Output
Retrieves a bank transaction
Retrieves a bank transaction
Retrieves a bill
Retrieves a bill
Retrieves account metadata
Retrieves account metadata
Retrieves a charge
Retrieves a charge
Retrieves a contract
Retrieves a contract
Retrieves a credit memo
Retrieves a credit memo
Retrieves a customer
Retrieves a customer
Retrieves a customer family
Retrieves a customer family
Retrieves a draft contract
Retrieves a draft contract
Retrieves a journal entry
Retrieves a journal entry
RILLET_RETRIEVE_A_JOURNAL_ENTRYRetrieves a journal entry with every line, account reference, and reconciliation flag needed for close review or downstream edits. Call before update-a-journal-entry so you can merge new edits with existing lines without accidentally dropping balances.Input Parameters
Output
Retrieves an approval workflow
Retrieves an approval workflow
RILLET_RETRIEVE_AN_APPROVAL_WORKFLOWReturns one approval workflow: the conditions that decide which entries it applies to, and the ordered layers of approvers that must sign off. This is the control definition, not a record of approvals given. Approval workflows are not versioned — the response describes the workflow as it stands now, and an update overwrites it in place.Input Parameters
Output
Retrieves an invoice
Retrieves an invoice
Retrieves a pending invoice creation proposal
Retrieves a pending invoice creation proposal
RILLET_RETRIEVE_AN_INVOICE_CREATION_PROPOSALRetrieve the captured contents of an invoice awaiting creation approval. No effective invoice exists yet. After approval, retrieve the invoice through the normal invoice endpoint. Pending proposals are excluded from invoice lists.Input Parameters
Output
Retrieves a product
Retrieves a product
Retrieves a reimbursement
Retrieves a reimbursement
Retrieves a subsidiary
Retrieves a subsidiary
Retrieves a vendor
Retrieves a vendor
Retrieves a vendor credit
Retrieves a vendor credit
Retrieves bill metadata
Retrieves bill metadata
Retrieves cash flow statement report
Retrieves cash flow statement report
RILLET_RETRIEVE_CASH_FLOW_STATEMENT_REPORTReturns a cash flow statement report for the specified date range.Input Parameters
Output
Retrieves contract metadata
Retrieves contract metadata
RILLET_RETRIEVE_CONTRACT_METADATAReturns this contract’s metadata values keyed by definition key. Keys with no value are omitted, including values held by archived definitions, which stay readable here. Definition names, types and status come from list-all-metadata-definitions.Input Parameters
Output
Retrieves customer metadata
Retrieves customer metadata
RILLET_RETRIEVE_CUSTOMER_METADATAReturns this customer’s metadata values keyed by definition key. Keys with no value are omitted, including values held by archived definitions, which stay readable here. Definition names, types and status come from list-all-metadata-definitions.Input Parameters
Output
Retrieves executive P&L report
Retrieves executive P&L report
RILLET_RETRIEVE_EXECUTIVE_PL_REPORTReturns an executive profit and loss report with margins for the specified date range.Input Parameters
Output
Retrieves income statement report
Retrieves income statement report
RILLET_RETRIEVE_INCOME_STATEMENT_REPORTReturns an income statement (profit and loss) report for the specified date range.Input Parameters
Output
Retrieves invoice metadata
Retrieves invoice metadata
RILLET_RETRIEVE_INVOICE_METADATAReturns this invoice’s metadata values keyed by definition key. Keys with no value are omitted, including values held by archived definitions, which stay readable here. Definition names, types and status come from list-all-metadata-definitions.Input Parameters
Output
Retrieves last book closed period
Retrieves last book closed period
RILLET_RETRIEVE_LAST_BOOK_CLOSED_PERIODReturns the most recently closed accounting period for book-close workflows, including closed-on timestamps your automation can cache. When no period has ever been closed the API responds with HTTP 404, so treat a missing resource as “not yet closed” rather than an outage.Output
Retrieves ARR waterfall report
Retrieves ARR waterfall report
RILLET_RETRIEVE_WATERFALL_REPORTReturns the ARR waterfall dataset for the requested month with optional breakdown dimensions, subsidiary filters, and pagination cursors for large tenants. Finance teams use this to explain beginning ARR, new business, expansion, contraction, and churn between periods.Input Parameters
Output
Reverses a milestone completion
Reverses a milestone completion
RILLET_REVERSE_A_MILESTONE_COMPLETIONRemoves the current completion and its recognition effect without cancelling the milestone, issuing a credit, or changing its allocation. The milestone must currently be completed. The milestone change and required revenue journal regeneration commit atomically.Input Parameters
Output
Signs off a close checklist task as reviewer
Signs off a close checklist task as reviewer
RILLET_SIGN_OFF_A_CLOSE_CHECKLIST_TASKRecords the connected user’s review sign-off on a completed task. Requires an OAuth connection made by a named user; API keys are rejected with HTTP 403. The task must be completed first (HTTP 409 otherwise). Only a reviewer on the task who has not signed off yet may sign off (HTTP 403 otherwise); when the organization enforces an ordered reviewer queue, it must also be their turn. A fully signed-off task is rejected with HTTP 409. Returns the updated task.Input Parameters
Output
Reports API or MCP bugs and missing features
Reports API or MCP bugs and missing features
RILLET_SUBMIT_AGENT_FEEDBACKFound something surprising, confusing, or missing while using the API or MCP tools? Tell us, even if you found a workaround. Report unclear tool schemas, confusing results, missing filters, excessive pagination, or missing bulk operations. Send one observation per request. Describe what you were trying to do and what you expected; for bugs, also include what actually happened. For MCP feedback, set endpoint to /mcp and include the affected tool name in description, for example list_all_journal_entries. You do not need to know the tool’s underlying REST path. For API feedback, set endpoint to the affected API path. A writable API key or OAuth token with write scope is required. The organization and submitting credential are recorded from authentication, so you do not need to provide them.Input Parameters
Output
Updates a bank transaction
Updates a bank transaction
RILLET_UPDATE_A_BANK_TRANSACTIONAdjusts memo, categorization, or reconciliation metadata on an existing bank transaction without re-importing the entire feed batch. Supply the full body expected by the schema so optional fields you intend to keep are not unintentionally cleared. This PUT operation sends the complete documented request representation.Input Parameters
Output
Updates a bill
Updates a bill
RILLET_UPDATE_A_BILLIMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-bill first to fetch the current record, then include ALL existing fields in your update request along with your changes. Bills with line allocations return 422 BillHasSubsidiaryAllocations, even for a no-op update. These allocations cannot be sent through this API; edit the bill in Rillet instead.Input Parameters
Output
Updates account metadata
Updates account metadata
RILLET_UPDATE_ACCOUNT_METADATAIMPORTANT: This is a full-replace operation (PUT semantics). Every active metadata key omitted from the request body is cleared. To set or clear individual keys without disturbing the rest, use patch-account-metadata instead. Null, empty, and whitespace-only values clear a single key. Archived keys may only be cleared, never changed. Every key must name a definition assigned to accounts: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written.Input Parameters
Output
Updates a close checklist task
Updates a close checklist task
RILLET_UPDATE_A_CLOSE_CHECKLIST_TASKPartial update of one task’s details and assignments. Fields omitted from the body are left unchanged. Completion and reviewer sign-offs cannot be set or cleared here; use complete-a-close-checklist-task and sign-off-a-close-checklist-task. A reviewer who has already signed off keeps their place in the queue: a reviewer_ids list that drops or moves them is rejected with HTTP 409. Every preparer and reviewer must be an active member of the organization (see list-members). Returns the updated task.Input Parameters
Output
Updates a credit memo
Updates a credit memo
RILLET_UPDATE_A_CREDIT_MEMOIMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-credit-memo first to fetch the current record, then include ALL existing fields in your update request along with your changes.Input Parameters
Output
Updates a customer
Updates a customer
RILLET_UPDATE_A_CUSTOMERUpdates a single customer record in the catalog. IMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-customer first to fetch the current record, then include ALL existing fields in your update request along with your changes. Exceptions that keep stored data when the field is omitted: - metadata: omit it to keep all existing metadata, or send only the keys you want to set or clear. - addresses: omit address and billing_addresses to keep the stored billing addresses, and likewise shipping_address and shipping_addresses. This is for backward compatibility: integrations built before customers could have several addresses won’t wipe the ones they don’t send.Input Parameters
Output
Updates a draft contract
Updates a draft contract
RILLET_UPDATE_A_DRAFT_CONTRACTReplaces the draft contract identified by draft_contract_id with the supplied payload. The body shape matches POST /draft-contracts — items and external_references on the existing record are fully replaced. Returns 404 if the id is not a draft contract in the organization. Exceptions that keep stored data when the field is omitted: - shipping_customer_id, billing_address_id, shipping_address_id: omit them to keep the draft’s current ship-to customer and addresses, or send null to clear them. - email_selection: omit it to keep the draft’s current recipients. This is for backward compatibility: integrations built before these fields existed won’t clear them on every update.Input Parameters
POST /customers first if needed.type slug must already exist in the org’s external reference types (configurable in Rillet Settings). Required for deduplication. Re-posting with any matching (type, id) pair replaces the prior draft record. Draft contracts created without external_references are not deduplicated.Output
Updates a journal entry
Updates a journal entry
RILLET_UPDATE_A_JOURNAL_ENTRYReplaces the lines and header metadata on an existing manual journal entry, subject to the same balancing rules as creation. Always include the complete line list retrieved beforehand because partial payloads can clear fields the API treats as optional.Input Parameters
Output
Records or corrects a milestone completion
Records or corrects a milestone completion
RILLET_UPDATE_A_MILESTONE_COMPLETIONCreates or fully replaces the current completion on a milestone in a FULL contract. The reference may be the milestone UUID or its case-insensitive key. The completion date must fall within the owning line term. Omitted or null memo and external_references values clear those fields. An identical request is a no-op. The milestone change and required revenue journal regeneration commit atomically.Input Parameters
Output
Updates an approval workflow
Updates an approval workflow
RILLET_UPDATE_AN_APPROVAL_WORKFLOWReplaces an approval workflow’s definition. The whole definition is required — a partial body is rejected, not merged, and fields this contract does not define are ignored. Send type and active back as read; changing either here is rejected, and combinations the Rillet app cannot configure are rejected too (see the individual fields). Entries already awaiting approval are unaffected, because an entry copies the layers it needs when approval starts; only entries registered after this call use the new definition. Deadlines and layer escalation rules are not part of this contract and are cleared, exactly as saving a workflow in Rillet clears them.Input Parameters
["IN_APP"] is accepted today: EMAIL and SLACK deliver nothing, so they are rejected rather than stored.groups must be empty for now: nested combinations are not evaluated yet and are rejected, so a workflow currently has exactly one group.PROVIDER_IMPORT, SCHEDULED_SYNC, and REIMPORT.Output
Updates an invoice
Updates an invoice
RILLET_UPDATE_AN_INVOICEIMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-an-invoice first to fetch the current record, then include ALL existing fields in your update request along with your changes. Exceptions that keep stored data when the field is omitted: - metadata: omit it to keep all existing metadata, or send only the keys you want to set or clear. - shipping_customer_id, billing_address_id, shipping_address_id: omit them to keep the invoice’s current ship-to customer and addresses, or send null to clear them. This is for backward compatibility: integrations built before these fields existed won’t clear them on every update. - email_selection: omit it to keep the invoice’s current recipients.Input Parameters
Output
Updates an invoice payment
Updates an invoice payment
RILLET_UPDATE_AN_INVOICE_PAYMENTReplaces the amount, date, and cash account on an existing uncleared invoice payment. Only uncleared payments can be updated; cleared or reconciled payments are rejected. This is a full-replace operation (PUT semantics) — include all fields in the request body.Input Parameters
Output
Updates a product
Updates a product
RILLET_UPDATE_A_PRODUCTUpdates a single product or bundle definition in the catalog. IMPORTANT: This is a full-replace operation (PUT semantics). Include every field expected by ProductRequest; omitted fields may be cleared. Call retrieve-a-product first, merge your changes, then submit the full body.Input Parameters
Output
Updates a vendor
Updates a vendor
RILLET_UPDATE_A_VENDORIMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-vendor first to fetch the current record, then include ALL existing fields in your update request along with your changes.Input Parameters
Output
Updates a vendor credit
Updates a vendor credit
RILLET_UPDATE_A_VENDOR_CREDITIMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-vendor-credit first to fetch the current record, then include ALL existing fields in your update request along with your changes.Input Parameters
Output
Updates bill metadata
Updates bill metadata
RILLET_UPDATE_BILL_METADATAIMPORTANT: This is a full-replace operation (PUT semantics). Every active metadata key omitted from the request body is cleared. To set or clear individual keys without disturbing the rest, use patch-bill-metadata instead. Null, empty, and whitespace-only values clear a single key. Archived keys may only be cleared, never changed. Every key must name a definition assigned to bills: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written. Writes are rejected with a 400 while the bill has a pending approval request.Input Parameters
Output
Updates contract metadata
Updates contract metadata
RILLET_UPDATE_CONTRACT_METADATAIMPORTANT: This is a full-replace operation (PUT semantics). Every active metadata key omitted from the request body is cleared. To set or clear individual keys without disturbing the rest, use patch-contract-metadata instead. Null, empty, and whitespace-only values clear a single key. Archived keys may only be cleared, never changed. Every key must name a definition assigned to contracts: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written.Input Parameters
Output
Updates customer metadata
Updates customer metadata
RILLET_UPDATE_CUSTOMER_METADATAFull replacement: every active key omitted from the request is cleared. To set or clear individual keys without disturbing the rest, use patch-customer-metadata instead. Null, empty, and whitespace-only values clear one key. Unknown keys, archived keys, and definitions not assigned to customers fail the entire request with a 400. Metadata-only changes are recorded in the audit log but do not trigger customer.updated webhooks or customer integration syncs.Input Parameters
Output
Updates a field
Updates a field
RILLET_UPDATE_FIELDChanges labels, validation rules, or visibility metadata on an existing custom field without recreating historical values. Coordinate with stakeholders before renaming because downstream integrations often key off the human-readable label. This PUT operation sends the complete documented request representation.Input Parameters
Output
Updates a field value
Updates a field value
RILLET_UPDATE_FIELD_VALUERenames or reorders a pick-list entry while preserving its underlying id so historical records stay linked to the same option. Prefer this over delete-and-recreate when auditing requires stable references across reporting periods. This PUT operation sends the complete documented request representation.Input Parameters
Output
Updates invoice metadata
Updates invoice metadata
RILLET_UPDATE_INVOICE_METADATAIMPORTANT: This is a full-replace operation (PUT semantics). Every active metadata key omitted from the request body is cleared. To set or clear individual keys without disturbing the rest, use patch-invoice-metadata instead. Null, empty, and whitespace-only values clear a single key. Archived keys may only be cleared, never changed. Every key must name a definition assigned to invoices: an unknown key, or one assigned only to another entity type, fails the request with a 400. Keys are never silently ignored. The write is atomic: if any key fails validation, nothing is written.Input Parameters
Output
Updates invoice sent status
Updates invoice sent status
RILLET_UPDATE_INVOICE_SENT_STATUSMarks whether an invoice has been delivered to the customer, which downstream workflows use for collections cadence and compliance reporting. Set the sent flag true after your billing system or email provider confirms delivery, or false while the document is still internal-only. This PUT operation sends the complete documented request representation.Input Parameters
Output
Updates credit memo taxes
Updates credit memo taxes
RILLET_UPDATE_TAXES_FOR_A_CREDIT_MEMORefreshes tax quotes on an existing credit memo using the same structured payload as invoice tax updates, stamped with taxesCalculatedAt for auditability. Use after line items change or when your tax engine recomputes jurisdiction-specific amounts before issuing the credit to the customer.Input Parameters
Output
Updates invoice taxes
Updates invoice taxes
RILLET_UPDATE_TAXES_FOR_AN_INVOICERecalculates or replaces tax lines on an existing invoice using the supplied tax payload. Use after changing taxable addresses or when integrating an external tax engine result. Returns 400 when the supplied taxes would turn an invoice total that is zero or positive into a negative total. Invoices whose total is already negative can still be updated.Input Parameters
Output
Uploads a document to a charge
Uploads a document to a charge
RILLET_UPLOAD_CHARGE_DOCUMENTAttaches a receipt (PDF, TXT, JPG/JPEG, PNG, GIF, XLSX/XLS, DOCX/DOC, CSV, RTF, TIFF/TIF, BMP, Pages, Numbers, PPTX, or PPT) to an existing charge using multipart form data with a single file part. PDF, JPEG, and PNG keep content-signature validation and do not require a matching filename extension. Every other format requires an allowed filename extension and either a matching content type or application/octet-stream. Files detected as HTML are rejected regardless of their filename or declared content type.Input Parameters
Output
Uploads a document to a contract
Uploads a document to a contract
RILLET_UPLOAD_CONTRACT_DOCUMENTAttaches one PDF, JPEG, PNG, or XLSX file to an existing contract. Existing attachments are preserved, including files uploaded through the Rillet application or imported from Salesforce. Repeating an upload creates another attachment. A file may be at most 9 MiB. The upload is refused when the contract already has 20 attachments, or when it would take the contract’s attachments past 100 MiB in total; files uploaded through the Rillet application or imported from Salesforce count toward both limits. A file name may have at most 255 characters and must not contain a path.Input Parameters
Output
Uploads a document
Uploads a document
RILLET_UPLOAD_DOCUMENTAttaches a document (PDF, TXT, JPG/JPEG, PNG, GIF, XLSX/XLS, DOCX/DOC, CSV, RTF, TIFF/TIF, BMP, Pages, Numbers, PPTX, or PPT) such as an invoice, contract, or receipt to an existing bill using multipart form data with a single file part. Call after the bill exists so approvers and auditors can open the evidence directly from the payable record. PDF, JPEG, and PNG keep content-signature validation and do not require a matching filename extension. Every other format requires an allowed filename extension and either a matching content type or application/octet-stream. Files detected as HTML are rejected regardless of their filename or declared content type.Input Parameters
Output
Uploads a document to a draft contract
Uploads a document to a draft contract
RILLET_UPLOAD_DRAFT_CONTRACT_DOCUMENTAttaches one PDF, JPEG, PNG, or XLSX file to an existing draft contract. Existing attachments are preserved, including files uploaded through the Rillet application or imported from Salesforce. Repeating an upload creates another attachment. A file may be at most 9 MiB. The upload is refused when the draft contract already has 20 attachments, or when it would take the draft contract’s attachments past 100 MiB in total; files uploaded through the Rillet application or imported from Salesforce count toward both limits. A file name may have at most 255 characters and must not contain a path. When the draft contract is confirmed, its attachments move to the contract. Re-creating the draft contract with POST /draft-contracts and the same external reference discards its attachments; use PUT to change a draft contract.Input Parameters
Output
Uploads a document to an invoice
Uploads a document to an invoice
RILLET_UPLOAD_INVOICE_DOCUMENTAttaches one PDF, JPEG, PNG, or XLSX file to an existing invoice. Existing attachments are preserved, including files uploaded through the Rillet application. Repeating an upload creates another attachment. An invoice can have at most 10 attachments totalling at most 7 MiB, including files uploaded through the Rillet application, so the invoice email stays within delivery limits. A file name may have at most 255 characters and must not contain a path. Attachments are included when Rillet emails the invoice. Attach before the invoice is sent: adding a file to an invoice that was already sent does not send it again.Input Parameters
Output
Uploads a document to a manual journal entry
Uploads a document to a manual journal entry
RILLET_UPLOAD_JOURNAL_ENTRY_DOCUMENTAppends one PDF, JPEG, PNG, or XLSX of at most 20 MiB to an existing manual journal entry. Create the journal entry first; for asynchronous imports, wait until the entry is available. Existing attachments are preserved. Repeating an upload creates another attachment. A journal entry can have at most 10 attachments, including files uploaded through the Rillet application. Attachments may be added to approved entries and entries in closed periods without changing accounting data or approval status. System-generated and non-posting entries are not supported.Input Parameters
Output
Uploads a document to a reimbursement
Uploads a document to a reimbursement
RILLET_UPLOAD_REIMBURSEMENT_DOCUMENTAttaches a receipt (PDF, TXT, JPG/JPEG, PNG, GIF, XLSX/XLS, DOCX/DOC, CSV, RTF, TIFF/TIF, BMP, Pages, Numbers, PPTX, or PPT) to an existing reimbursement using multipart form data with a single file part. PDF, JPEG, and PNG keep content-signature validation and do not require a matching filename extension. Every other format requires an allowed filename extension and either a matching content type or application/octet-stream. Files detected as HTML are rejected regardless of their filename or declared content type.