Skip to content

Rippling: List bills

Rippling restApi.listBills: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.list_bills

Provider route: GET /bills/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listBills"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.listBills(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.list_bills(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.filterstringOptional
query.expandstringOptional
query.order_bystringOptional
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
__metaModelOptionalExpand List Sites — response body — meta
next_linkstringOptionalA link to the next page of responses.
Format: uri
resultsarrayOptional
results[]ModelEach itemExpand List bills — response body — results item

Referenced models: List bills — response body — results item, List Sites — response body — meta

29 more schemas are linked from the tables above, on the schema pages.

List bills — response body — results item
FieldTypePresenceDescription and constraints
$objectRootA bill visible to the caller, including its invoice and payment details.
accounting_datestringOptionalDate the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).
approval_statusstringOptionalApproval state of the bill. `DRAFT`: not submitted. `PENDING`: awaiting required information before submission. `REQUESTED`: awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: paid. `CANCELLED`: cancelled. `FAILED`: payment failed.
Known values: DRAFT, PENDING, REQUESTED, APPROVED, REJECTED, FINALIZED, ACTIONED, CANCELLED, FAILED
attachmentsarrayOptionalOther attached files, including filenames and recorded upload metadata.
attachments[]ModelEach itemExpand Retrieve a specific bill — response body — attachments item
company_amountobjectOptionalAmount in the company's headquarters currency. The `value` is a decimal string.
company_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
company_amount.valueJSONOptional
company_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
company_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
credit_methodstringOptionalHow the vendor is paid: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, MANUALLY_PAID, or PAID_IN_FULL_VIA_VENDOR_CREDIT. GLOBAL_ORDER is an international transfer. PAID_IN_FULL_VIA_VENDOR_CREDIT means vendor credits cover the full bill, with no cash payment.
Known values: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, MANUALLY_PAID, PAID_IN_FULL_VIA_VENDOR_CREDIT
due_datestringOptionalInvoice due date, as an ISO 8601 date. A draft can omit it.
entity_idstringOptionalID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.
estimated_payment_arrivalstringOptionalDate the vendor is expected to receive the payment, as an ISO 8601 date. Null when not set.
gl_sync_statestringOptionalState of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.
Known values: NOT_FINALIZED, FOR_REVIEW, PENDING_SYNC, SYNCED, ERROR, DO_NOT_SYNC, EXPORTED, NOT_SYNCABLE, AUTO_SYNC
gl_vendorobjectOptionalVendor in the connected accounting system.
gl_vendor.gl_vendor_idstringOptionalID of the vendor in the accounting system.
gl_vendor.idstringOptionalID of the accounting vendor in Rippling.
gl_vendor.namestringOptionalName of the vendor in the accounting system.
idstringRequired within parentIdentifier field
invoiceobjectOptionalInvoice file and its filename.
invoice.file_namestringOptionalOriginal file name, when recorded.
invoice.urlstringRequired within parentURL for accessing the file.
invoice_datestringOptionalInvoice date, as an ISO 8601 date (YYYY-MM-DD). Null when not set. Filters compare UTC calendar days: `eq` includes the whole day, `gt` starts the following day, and `lt` excludes the specified day. `ge` and `le` include the specified day; `in` matches any listed day.
invoice_numberstringOptionalInvoice number. Null when the bill has no invoice number.
line_itemsarrayOptionalCategory splits of the transaction amount.
line_items[]ModelEach itemExpand Retrieve a specific bill — response body — line items item
memostringOptionalMemo entered on the transaction.
merchant_amountobjectOptionalAmount charged by the merchant, in the merchant currency. The `value` is a decimal string.
merchant_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
merchant_amount.valueJSONOptional
merchant_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
merchant_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
parent_bill_idstringOptionalID of the bill this payment was split from. Use it with `/bills/{id}/`. Null when it is not a split bill.
payment_amountobjectOptionalAmount paid to the vendor, in the payment currency. The `value` is a decimal string.
payment_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
payment_amount.valueJSONOptional
payment_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
payment_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payment_method_feeobjectOptionalPayment method fee, in the company's headquarters currency. The `value` is a decimal string. Zero when there is no fee.
payment_method_fee.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
payment_method_fee.valueJSONOptional
payment_method_fee.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
payment_method_fee.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payment_schedule_settingstringOptionalPayment scheduling choice: `SCHEDULE_NOW` to schedule payment, or `SKIP_FOR_NOW` to defer scheduling.
Known values: SCHEDULE_NOW, SKIP_FOR_NOW
payment_velocitystringOptionalPayment speed option: `TWO_DAY` (accelerated) or `FOUR_DAY` (standard). Use `estimated_payment_arrival` for the expected arrival date.
Known values: TWO_DAY, FOUR_DAY
scheduled_payment_datestringOptionalDate used to estimate vendor payment, as an ISO 8601 date. Null when not set.
submitterModelOptionalExpand Retrieve a specific bill — response body — submitter
submitter_idstringOptionalID of the bill manager who submitted the bill. Use it with `/workers/{id}/`. Can differ from `worker_id`. Null before submission.
transaction_typestringOptionalType of transaction: `BILL_PAYMENT`.
Known values: BILL_PAYMENT
updated_atstringRequired within parentRecord update date
vendorModelOptionalExpand Retrieve a specific bill — response body — vendor
vendor_idstringOptionalID of the Finance vendor. Use it with `/finance-vendors/{id}/`.
vendor_memostringOptionalMemo included on the payment to the vendor. Supported for ACH; null when not set.
vendor_paid_datestringOptionalDate the vendor is paid, as an ISO 8601 date. Null until paid.
workerModelOptionalExpand Retrieve a specific bill — response body — worker
worker_idstringOptionalID of the worker who made the transaction. Use it with `/workers/{id}/`.

Referenced models: Retrieve a specific bill — response body — line items item, Retrieve a specific bill — response body — attachments item, Retrieve a specific bill — response body — submitter, Retrieve a specific bill — response body — vendor, Retrieve a specific bill — response body — worker

List Sites — response body — meta
FieldTypePresenceDescription and constraints
$objectRootA list of redacted fields.
redacted_fieldsarrayOptional
redacted_fields[]objectEach item
redacted_fields[].namestringOptionalThe name for the redacted field
redacted_fields[].reasonstringOptionalThe reason for the redaction
Retrieve a specific bill — response body — attachments item
FieldTypePresenceDescription and constraints
$objectRootA Finance transaction attachment with recorded upload details.
file_namestringOptionalOriginal file name, when recorded.
uploaded_atstringOptionalWhen the attachment was uploaded, as an ISO 8601 date-time in UTC, when recorded.
uploaded_by_idstringOptionalID of the worker who uploaded the attachment. Use it with `/workers/{id}/`.
urlstringRequired within parentURL for accessing the file.
Retrieve a specific bill — response body — vendor
FieldTypePresenceDescription and constraints
$objectRootVendor details. Expand with `bills.read` and `finance-vendors.read`.

Expandable field
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
is_archivedbooleanOptionalWhether the vendor is archived. Archived vendors remain available for historical references.
logostringOptionalURL of the vendor's logo. Null when no logo is available.
namestringOptionalCanonical name of the Finance vendor. Name eq, ne, and in filters also match alternate names.
updated_atstringRequired within parentRecord update date
Retrieve a specific bill — response body — line items item dimension choices value
FieldTypePresenceDescription and constraints
$objectRoot
dimension_namestringOptionalName of the dimension, such as Department.
labelstringOptionalDisplay name of the selected dimension value.
valuestringOptionalID of the selected dimension value.

SDK function policy ID: rippling.rest_api.list_bills. Catalog operation: list-bills. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["bills.read"]

Provider entitlements: ["Spend_Management_Platform_API"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.