amend_a_contract
ChatGPTAmends a contract. Applies 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.
apply_vendor_credit
ChatGPTApplies a vendor credit to bills. Allocates an existing vendor credit balance against specific open bills, reducing net amounts payable similar to a targeted vendor payment. Use after reviewing retrieve-a-vendor-credit so you apply only the remaining unapplied balance.
bulk_update_contract_metadata
ChatGPTUpdates metadata for multiple contracts. Patches 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.
bulk_update_customer_metadata
ChatGPTUpdates metadata for multiple customers. Patches 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.
bulk_update_invoice_metadata
ChatGPTUpdates metadata for multiple invoices. Patches 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.
create_a_bank_account
ChatGPTCreates a bank account. Registers 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.
create_a_bank_transaction
ChatGPTCreates a bank transaction. Inserts 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.
create_a_bill
ChatGPTCreates a bill. Accrues 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.
create_a_bill_payment
ChatGPTCreates a bill payment. Books 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.
create_a_charge
ChatGPTCreate a charge
create_a_chart_of_accounts
ChatGPTCreates a chart of accounts. Initializes 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. When the request contains exactly one Prepaid Expense account, expense accounts may omit prepaid_account_code to default to it; when it contains multiple Prepaid Expense accounts, each expense account must reference one by code. Cash in Transit is auto-created and must not appear in the request.
create_a_contract
ChatGPTCreates a contract. Rillet 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. If Rillet handles the entire invoicing and sending process, choose the FULL scope.
create_a_credit_memo
ChatGPTCreates a credit memo. Opens a customer credit memo that reduces receivable exposure before you allocate it to specific invoices. Capture subsidiary, customer, line-level reasons, and tax treatment so finance can audit why the balance changed.
create_a_customer
ChatGPTCreates a customer. Creates 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.
create_a_customer_family
ChatGPTCreates a customer family. Creates 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.
create_a_draft_contract
ChatGPTCreates a draft contract. Stages 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. Promotion Promotion to an active contract happens through the Rillet UI. The public API does not currently expose a programmatic promotion endpoint.
create_a_journal_entry
ChatGPTCreates a journal entry. Posts 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.
create_a_product
ChatGPTCreates a product. Creates 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.).
create_a_reimbursement
ChatGPTCreate a reimbursement
create_a_reimbursement_payment
ChatGPTCreates a reimbursement payment. Records a cash payment that settles all or part of a reimbursement.
create_a_vendor
ChatGPTCreates a vendor. Adds 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.
create_a_vendor_credit
ChatGPTCreates a vendor credit. Records a new vendor credit memo amount that reduces future payables without yet touching specific bills. After creation, use apply-vendor-credit to allocate the balance across one or more open bills.
create_an_account
ChatGPTCreates an account. Adds 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.
create_an_invoice
ChatGPTCreates an invoice. 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. In this case, Rillet automatically assigns the invoice number. The REVENUE_RECOGNITION_ONLY scope is intended for situations where the invoice is issued from another system and only needs to be recorded in Rillet for accounting purposes. In this workflow, users must provide the invoice number 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. If Rillet handles the entire invoicing and sending process, choose the FULL scope.
create_an_invoice_payment
ChatGPTCreates an invoice payment. Records 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.
create_field
ChatGPTCreates a field. Defines 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.
create_field_value
ChatGPTCreates a field value. Adds 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.
delete_a_bank_account
ChatGPTDeletes a bank account. Removes a bank account definition when the entity closed the account or you mistakenly created a duplicate connector mapping. Ensure no scheduled payments or open reconciliation batches still target this bank account before deletion.
delete_a_bank_transaction
ChatGPTDeletes a bank transaction. Removes a bank transaction row that was imported twice or created in error before it affects reconciled cash balances. Confirm treasury agrees the underlying bank activity will not return on the next feed pull before deleting.
delete_a_bill
ChatGPTDeletes a bill. Removes a bill that should no longer drive AP balances, typically while it remains in draft or was created in error. Verify no posted payments, accrual journals, or vendor credit applications still reference the bill before deleting.
delete_a_bill_payment
ChatGPTDeletes a bill payment. Reverses 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.
delete_a_charge
ChatGPTDeletes a charge. Drops a charge that should not influence spend reporting, for example duplicate imports from a card processor feed. Ensure finance agrees the underlying bank activity will not be re-imported before removing the charge permanently.
delete_a_contract
ChatGPTDeletes a contract. Permanently removes a contract when your business rules allow deletion. Confirm downstream invoices, revenue schedules, and integrations no longer depend on this contract before deleting it.
delete_a_credit_memo
ChatGPTDeletes a credit memo. Removes a credit memo that should no longer affect AR balances, typically while it is still draft or unused. Confirm no invoice applications or downstream revenue adjustments depend on this memo before calling delete.
delete_a_customer
ChatGPTDeletes a customer. Permanently deletes a customer. Verify no active contracts or open invoices reference this customer first.
delete_a_draft_contract
ChatGPTDeletes a draft contract. Permanently removes a draft contract along with its line items and external references. Use this to programmatically reject a draft contract instead of doing it from the Rillet UI.
delete_a_journal_entry
ChatGPTDeletes a journal entry. Deletes a manual journal entry that should be excluded from the ledger, typically prior to period lock while corrections remain allowed. Verify dependent reconciliations or downstream consolidations no longer rely on the entry before removal.
delete_a_product
ChatGPTDeletes a product. Permanently removes a product. Ensure no in-flight contracts or invoices require this product before deleting.
delete_a_reimbursement
ChatGPTDeletes a reimbursement. Removes a reimbursement that was created prematurely or duplicated during intake so it no longer blocks payroll totals. Confirm no outbound payments or GL accruals were posted against the reimbursement before deleting it.
delete_a_reimbursement_payment
ChatGPTDeletes a reimbursement payment. Reverses an uncleared reimbursement payment that was recorded in error.
delete_a_usage_record
ChatGPTDeletes a usage record. Removes the usage entry for a single contract item on a specific calendar date. This is narrower than upsert-a-usage-record and is ideal when you need to wipe a mistaken day without resending the entire usage payload.
delete_a_vendor
ChatGPTDeletes a vendor. Removes a vendor you no longer expect to pay. Confirm no open bills, credits, or scheduled payments still reference this vendor to avoid orphaned payables.
delete_a_vendor_credit
ChatGPTDeletes a vendor credit. Permanently removes a vendor credit that should not remain in the subledger. Ensure no applications or downstream reconciliations still rely on this credit before deleting.
delete_an_invoice
ChatGPTDeletes an invoice. Permanently removes an invoice when your policy allows it (for example draft or voided states). Confirm no downstream payments or revenue postings still depend on this invoice.
delete_an_invoice_payment
ChatGPTDeletes an invoice payment. Reverses 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.
delete_field_value
ChatGPTDeletes a field value. Retires a pick-list option that should no longer be selectable while keeping older records intact for read-only history. Confirm no automation or validation rules still require the value before removal to avoid breaking bulk imports.
end_an_open_ended_contract
ChatGPTEnds an open-ended contract. Sets 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.
get_api_key_information
ChatGPTGets API key information. Confirms 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.
get_fields
ChatGPTGets custom fields. Retrieves custom field definitions and their pick-list values for the organization. Use the returned field ids with create-field-value and update-field-value when enriching core entities.
get_payment_method
ChatGPTGets payment method. Returns the payment method configured for auto-payment for the given customer.
list_all_accounts
ChatGPTLists all accounts. Returns the chart of accounts for the organization tied to the API credentials. Use optional filters (for example updated.gt) to sync only accounts changed since a prior run. Account ids are stable identifiers used when creating journal entries, bills, and other postings.
list_all_approval_workflows
ChatGPTLists all approval workflows. Returns 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.
list_all_bank_accounts
ChatGPTLists all bank accounts. Returns cash bank accounts configured for the organization, optionally filtered by subsidiary. Bank account ids anchor transaction import, reconciliation, and treasury automations.
list_all_bank_transactions
ChatGPTLists all bank transactions. Streams imported or manually entered cash activity for reconciliation, optionally scoped by bank account, subsidiary, or updated-since filters. Pair results with retrieve-a-bank-transaction when you need memo-level detail before marking items cleared.
list_all_bills
ChatGPTLists all bills. Returns AP bills with pagination plus filters for vendor, subsidiary, approval state, and balances due. Use bill ids with retrieve-a-bill before performing full updates or attaching documents.
list_all_books
ChatGPTLists all books. Returns all accounting books available to the authenticated organization. Successful responses always contain at least one book and list the primary book first. Only primary and adjustment-overlay book IDs can be used with report and journal-entry endpoints that accept a book_id.
list_all_charges
ChatGPTLists all charges. Pages card or out-of-pocket employee charges awaiting policy review, subsidiary allocation, or conversion into reimbursable payables. Filter by subsidiary_id or updated.gt when syncing corporate card feeds into downstream expense automation.
list_all_contract_item_usage_records
ChatGPTLists all contract item usage records. Returns historical usage quantities for a contract item, newest first, with optional pagination cursors. Use before upsert-a-usage-record or delete-a-usage-record to understand existing coverage for each date.
list_all_contracts
ChatGPTLists all contracts. Returns contracts with pagination and rich filters (subsidiary, customer, status, date ranges). Use this to discover contract ids, check lifecycle state, or drive reporting extracts.
list_all_credit_memos
ChatGPTLists all credit memos. Returns customer credit memos with pagination and filters for application state, customer, and subsidiaries. Use credit memo ids with retrieve-a-credit-memo before updates or when applying credits to invoices.
list_all_customers
ChatGPTLists all customers. Returns customers for accounts receivable with pagination and optional search or external-reference filters.
list_all_draft_contracts
ChatGPTLists all draft contracts. Returns draft contracts with cursor pagination. Draft contracts are staged records that appear in the Rillet UI under \"Draft\" for a human to approve or reject before they become active contracts.
list_all_invoice_payments
ChatGPTLists payments for a given invoice. Returns every payment attempt tied to a single invoice, including successful, uncleared, and failed rows with their public status. Pair with retrieve-an-invoice when reconciling an account statement against what Rillet already applied.
list_all_invoices
ChatGPTLists all invoices. Returns AR invoices with pagination plus filters for subsidiary, customer, overdue state, and audit timestamps. Use invoice ids from this feed with retrieve-an-invoice before performing full updates.
list_all_invoices_payments
ChatGPTLists all invoice payments. Pages 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.
list_all_journal_entries
ChatGPTLists all journal entries. Returns GL journal entries with rich filtering (subsidiary, account, date range, reconciliation state). Use entry ids with retrieve-a-journal-entry before attempting updates or deletes.
list_all_metadata_definitions
ChatGPTLists all metadata definitions. Returns 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.
list_all_products
ChatGPTLists all products. Returns sellable products and services for accounts receivable (contracts, invoices). Supports pagination and optional filters such as status and currency.
list_all_reimbursements
ChatGPTLists all reimbursements. Surfaces 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.
list_all_subsidiaries
ChatGPTLists all subsidiaries. Returns legal-entity subsidiaries for the authenticated organization. Use this to discover subsidiary UUIDs before calling endpoints that accept subsidiary_id (contracts, invoices, reports). Each subsidiary carries currency and timezone used for localized accounting and reporting.
list_all_tax_rates
ChatGPTLists all tax rates. Returns all available tax rates. Use the returned IDs when creating bills with specific tax codes.
list_all_vendor_credits
ChatGPTLists all vendor credits. Returns vendor credits with pagination and filters for vendor, subsidiary, and freshness. Credits represent vendor-issued balance reductions you can later apply to bills using apply-vendor-credit.
list_all_vendors
ChatGPTLists all vendors. Returns vendors with pagination and optional status or currency filters. Vendor ids feed bill creation, vendor credits, and payment workflows.
list_bill_payments
ChatGPTLists bill payments. Enumerates disbursements recorded against a specific bill, useful when reconciling vendor statements to internal cash movements. Combine with retrieve-a-bill to understand remaining balance after each payment posts.
list_journal_entry_documents
ChatGPTLists documents attached to a manual journal entry. Returns 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.
list_members
ChatGPTLists organization members. Returns 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.
list_reimbursement_payments
ChatGPTLists reimbursement payments. Lists payments recorded against a reimbursement so external systems can reconcile its paid balance.
list_reports_journal_entries
ChatGPTLists journal entries with reporting currency amounts. Returns journal entries with line item amounts converted to the reporting currency.
list_role_assignments
ChatGPTLists role assignments. Returns 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.
list_roles
ChatGPTLists roles. Returns every role defined in the organization along with the flat set of permission keys it grants. Each permission is an opaque, colon-delimited string; treat it as an opaque identifier and do not rely on its internal structure.
patch_contract_metadata
ChatGPTPatches contract metadata. Partial 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.
patch_customer_metadata
ChatGPTPatches customer metadata. Partial 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.
patch_invoice_metadata
ChatGPTPatches invoice metadata. Partial 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.
preview_contract_amendment
ChatGPTPreviews contract amendment. Preview 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.
preview_invoice_schedule
ChatGPTPreview the invoice schedule for a contract. Computes and returns the invoice schedule the given contract would produce, without creating the contract or persisting anything.
rename_a_customer_family
ChatGPTRenames a customer family. Changes the family's name. Membership is untouched: anything else in the body is ignored, so use the members endpoints to change who belongs.
retrieve_a_bank_account
ChatGPTRetrieves a bank account. Returns configuration and status for a single bank account, including identifiers downstream connectors need when refreshing balances. Use before deleting or updating metadata so you preserve institution codes and default subsidiary routing.
retrieve_a_bank_transaction
ChatGPTRetrieves a bank transaction. Fetches one bank transaction with counterparty text, amounts, and reconciliation flags used by cash teams during month-end. Use before update-a-bank-transaction to preserve memos or matched invoice references embedded in the payload.
retrieve_a_bill
ChatGPTRetrieves a bill. Returns the authoritative bill record including vendor linkage, approval state, open balance, and document references. Fetch before update-a-bill because PUT semantics require you to resubmit every field to avoid nulling omitted values.
retrieve_a_charge
ChatGPTRetrieves a charge. Fetches a single charge with merchant metadata, amounts, and workflow state so reviewers can decide coding before reimbursement. Use this after list-all-charges surfaces an id that needs manual inspection or attachment to a bill.
retrieve_a_contract
ChatGPTRetrieves a contract. Returns the expanded contract including items, schedules, and metadata required before updates or amendments. Always retrieve before issuing a full PUT update so you preserve fields you do not intend to clear.
retrieve_a_credit_memo
ChatGPTRetrieves a credit memo. Loads the full credit memo payload, including remaining balance, applications, and tax metadata you must echo on PUT updates. Always retrieve before editing because update-a-credit-memo replaces the entire resource when fields are omitted.
retrieve_a_customer
ChatGPTRetrieves a customer. Returns a single customer record including billing profile details, which are needed for updates.
retrieve_a_draft_contract
ChatGPTRetrieves a draft contract. Returns a draft contract by id, including its line items and any attached external references.
retrieve_a_journal_entry
ChatGPTRetrieves a journal entry. Retrieves 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.
retrieve_a_product
ChatGPTRetrieves a product. Returns a single product definition including pricing configuration used on contracts and invoices.
retrieve_a_reimbursement
ChatGPTRetrieves a reimbursement. Returns the full reimbursement packet with employee linkage, funding instructions, and approval history for a single id. Helpful when validating totals before releasing ACH batches or answering employee support tickets.
retrieve_a_subsidiary
ChatGPTRetrieves a subsidiary. Returns one subsidiary by id for the authenticated organization. Call list-all-subsidiaries first if you need to resolve which subsidiary id to use.
retrieve_a_vendor
ChatGPTRetrieves a vendor. Fetches the full vendor profile including identifiers you must echo back on PUT updates. Use before editing to avoid wiping optional fields, and when validating tax or payment metadata during bill entry.
retrieve_a_vendor_credit
ChatGPTRetrieves a vendor credit. Loads a single vendor credit including remaining balance and application history. Retrieve before updating or applying so you know how much capacity is left to allocate to bills.
retrieve_an_approval_workflow
ChatGPTRetrieves an approval workflow. Returns 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.
retrieve_an_organization
ChatGPTRetrieves an organization. Returns the organization profile for the API credentials in use (the “current” org). Use this to confirm organization id, display name, and other org-level settings in integrations.
retrieve_balance_sheet_report
ChatGPTRetrieves balance sheet report. Returns a balance sheet report as of the specified date. Required parameter: as_of_date (ISO-8601 format YYYY-MM-DD). Must be provided or the call will fail. Example: as_of_date=2024-12-31.
retrieve_cash_flow_statement_report
ChatGPTRetrieves cash flow statement report. Returns a cash flow statement report for the specified date range.
retrieve_contract_metadata
ChatGPTRetrieves contract metadata. Returns 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.
retrieve_customer_metadata
ChatGPTRetrieves customer metadata. Returns 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.
retrieve_executive_pl_report
ChatGPTRetrieves executive P&L report. Returns an executive profit and loss report with margins for the specified date range.
retrieve_income_statement_report
ChatGPTRetrieves income statement report. Returns an income statement (profit and loss) report for the specified date range.
retrieve_invoice_metadata
ChatGPTRetrieves invoice metadata. Returns 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.
retrieve_last_book_closed_period
ChatGPTRetrieves last book closed period. Returns 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.
retrieve_trial_balance_report
ChatGPTRetrieves trial balance report. Returns a trial balance report for the specified date range. Required parameters: from_date and to_date (ISO-8601 format YYYY-MM-DD). Both must be provided or the call will fail. Example: from_date=2024-01-01, to_date=2024-12-31.
retrieve_waterfall_report
ChatGPTRetrieves ARR waterfall report. Returns 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.
update_a_bank_transaction
ChatGPTUpdates a bank transaction. Adjusts 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.
update_a_bill
ChatGPTUpdates a bill. 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-bill first to fetch the current record, then include ALL existing fields in your update request along with your changes.
update_a_credit_memo
ChatGPTUpdates a credit memo. 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-credit-memo first to fetch the current record, then include ALL existing fields in your update request along with your changes.
update_a_customer
ChatGPTUpdates a customer. Updates 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. Metadata is the exception: omit metadata to preserve all existing metadata, or supply only the metadata keys you want to set or clear.
update_a_draft_contract
ChatGPTUpdates a draft contract. Replaces 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.
update_a_journal_entry
ChatGPTUpdates a journal entry. Replaces 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.
update_a_product
ChatGPTUpdates a product. Updates a single product 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.
update_a_vendor
ChatGPTUpdates a vendor. 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-vendor first to fetch the current record, then include ALL existing fields in your update request along with your changes.
update_a_vendor_credit
ChatGPTUpdates a vendor credit. 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-vendor-credit first to fetch the current record, then include ALL existing fields in your update request along with your changes.
update_an_approval_workflow
ChatGPTUpdates an approval workflow. Replaces 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.
update_an_invoice
ChatGPTUpdates an invoice. 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-an-invoice first to fetch the current record, then include ALL existing fields in your update request along with your changes. Metadata is the exception: omit metadata to preserve all existing metadata, or supply only the metadata keys you want to set or clear.
update_an_invoice_payment
ChatGPTUpdates an invoice payment. Replaces 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.
update_contract_metadata
ChatGPTUpdates contract metadata. IMPORTANT: 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.
update_customer_metadata
ChatGPTUpdates customer metadata. Full 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.
update_field
ChatGPTUpdates a field. Changes 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.
update_field_value
ChatGPTUpdates a field value. Renames 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.
update_invoice_metadata
ChatGPTUpdates invoice metadata. IMPORTANT: 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.
update_invoice_sent_status
ChatGPTUpdates invoice sent status. Marks 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.
update_taxes_for_a_credit_memo
ChatGPTUpdates credit memo taxes. Refreshes 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.
update_taxes_for_an_invoice
ChatGPTUpdates invoice taxes. Recalculates 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.
upsert_a_usage_record
ChatGPTUpserts a usage record. Creates usage records on dates where previously no usage was recorded. Overwrites usage records on dates where usage was previously recorded already.
amend_a_contract
Claudeapply_vendor_credit
Claudecreate_a_bill
Claudecreate_a_bill_payment
Claudecreate_a_contract
Claudecreate_a_credit_memo
Claudecreate_a_customer
Claudecreate_a_product
Claudecreate_a_vendor
Claudecreate_a_vendor_credit
Claudecreate_an_invoice
Claudecreate_an_invoice_payment
Claudecreate_field
Claudecreate_field_value
Claudedelete_a_bill
Claudedelete_a_bill_payment
Claudedelete_a_charge
Claudedelete_a_contract
Claudedelete_a_credit_memo
Claudedelete_a_customer
Claudedelete_a_product
Claudedelete_a_reimbursement
Claudedelete_a_usage_record
Claudedelete_a_vendor
Claudedelete_a_vendor_credit
Claudedelete_an_invoice
Claudedelete_field_value
Claudeend_an_open_ended_contract
Claudeget_api_key_information
Claudeget_fields
Claudeget_payment_method
Claudelist_all_accounts
Claudelist_all_bills
Claudelist_all_charges
Claudelist_all_contract_item_usage_records
Claudelist_all_contracts
Claudelist_all_credit_memos
Claudelist_all_customers
Claudelist_all_invoice_payments
Claudelist_all_invoices
Claudelist_all_invoices_payments
Claudelist_all_journal_entries
Claudelist_all_products
Claudelist_all_reimbursements
Claudelist_all_subsidiaries
Claudelist_all_vendor_credits
Claudelist_all_vendors
Claudelist_bill_payments
Claudepreview_contract_amendment
Clauderetrieve_a_bill
Clauderetrieve_a_charge
Clauderetrieve_a_contract
Clauderetrieve_a_credit_memo
Clauderetrieve_a_customer
Clauderetrieve_a_product
Clauderetrieve_a_reimbursement
Clauderetrieve_a_subsidiary
Clauderetrieve_a_vendor
Clauderetrieve_a_vendor_credit
Clauderetrieve_an_organization
Clauderetrieve_balance_sheet_report
Clauderetrieve_cash_flow_statement_report
Clauderetrieve_executive_pl_report
Clauderetrieve_income_statement_report
Clauderetrieve_trial_balance_report
Clauderetrieve_waterfall_report
Claudesetup_auto_payment
Claudeupdate_a_bill
Claudeupdate_a_contract
Claudeupdate_a_credit_memo
Claudeupdate_a_customer
Claudeupdate_a_product
Claudeupdate_a_vendor
Claudeupdate_a_vendor_credit
Claudeupdate_an_invoice
Claudeupdate_field
Claudeupdate_field_value
Claudeupdate_invoice_sent_status
Claudeupdate_taxes_for_a_credit_memo
Claudeupdate_taxes_for_an_invoice
Claudeupsert_a_usage_record
Claude
