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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.filter | string | Optional | |
query.expand | string | Optional | |
query.order_by | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
__meta | Model | Optional | Expand List Sites — response body — meta |
next_link | string | Optional | A link to the next page of responses. Format: uri |
results | array | Optional | |
results[] | Model | Each item | Expand List bills — response body — results item |
Referenced models: List bills — response body — results item, List Sites — response body — meta
Schemas
Section titled “Schemas”29 more schemas are linked from the tables above, on the schema pages.
List bills — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A bill visible to the caller, including its invoice and payment details. |
accounting_date | string | Optional | Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD). |
approval_status | string | Optional | Approval 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 |
attachments | array | Optional | Other attached files, including filenames and recorded upload metadata. |
attachments[] | Model | Each item | Expand Retrieve a specific bill — response body — attachments item |
company_amount | object | Optional | Amount in the company's headquarters currency. The `value` is a decimal string. |
company_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
company_amount.value | JSON | Optional | |
company_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
company_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Required within parent | Record creation date |
credit_method | string | Optional | How 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_date | string | Optional | Invoice due date, as an ISO 8601 date. A draft can omit it. |
entity_id | string | Optional | ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`. |
estimated_payment_arrival | string | Optional | Date the vendor is expected to receive the payment, as an ISO 8601 date. Null when not set. |
gl_sync_state | string | Optional | State 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_vendor | object | Optional | Vendor in the connected accounting system. |
gl_vendor.gl_vendor_id | string | Optional | ID of the vendor in the accounting system. |
gl_vendor.id | string | Optional | ID of the accounting vendor in Rippling. |
gl_vendor.name | string | Optional | Name of the vendor in the accounting system. |
id | string | Required within parent | Identifier field |
invoice | object | Optional | Invoice file and its filename. |
invoice.file_name | string | Optional | Original file name, when recorded. |
invoice.url | string | Required within parent | URL for accessing the file. |
invoice_date | string | Optional | Invoice 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_number | string | Optional | Invoice number. Null when the bill has no invoice number. |
line_items | array | Optional | Category splits of the transaction amount. |
line_items[] | Model | Each item | Expand Retrieve a specific bill — response body — line items item |
memo | string | Optional | Memo entered on the transaction. |
merchant_amount | object | Optional | Amount charged by the merchant, in the merchant currency. The `value` is a decimal string. |
merchant_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
merchant_amount.value | JSON | Optional | |
merchant_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
merchant_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
parent_bill_id | string | Optional | ID of the bill this payment was split from. Use it with `/bills/{id}/`. Null when it is not a split bill. |
payment_amount | object | Optional | Amount paid to the vendor, in the payment currency. The `value` is a decimal string. |
payment_amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payment_amount.value | JSON | Optional | |
payment_amount.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payment_amount.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_method_fee | object | Optional | Payment method fee, in the company's headquarters currency. The `value` is a decimal string. Zero when there is no fee. |
payment_method_fee.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
payment_method_fee.value | JSON | Optional | |
payment_method_fee.value (anyOf 1) | number | Alternative | The decimal amount for the currency. |
payment_method_fee.value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payment_schedule_setting | string | Optional | Payment scheduling choice: `SCHEDULE_NOW` to schedule payment, or `SKIP_FOR_NOW` to defer scheduling. Known values: SCHEDULE_NOW, SKIP_FOR_NOW |
payment_velocity | string | Optional | Payment 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_date | string | Optional | Date used to estimate vendor payment, as an ISO 8601 date. Null when not set. |
submitter | Model | Optional | Expand Retrieve a specific bill — response body — submitter |
submitter_id | string | Optional | ID of the bill manager who submitted the bill. Use it with `/workers/{id}/`. Can differ from `worker_id`. Null before submission. |
transaction_type | string | Optional | Type of transaction: `BILL_PAYMENT`. Known values: BILL_PAYMENT |
updated_at | string | Required within parent | Record update date |
vendor | Model | Optional | Expand Retrieve a specific bill — response body — vendor |
vendor_id | string | Optional | ID of the Finance vendor. Use it with `/finance-vendors/{id}/`. |
vendor_memo | string | Optional | Memo included on the payment to the vendor. Supported for ACH; null when not set. |
vendor_paid_date | string | Optional | Date the vendor is paid, as an ISO 8601 date. Null until paid. |
worker | Model | Optional | Expand Retrieve a specific bill — response body — worker |
worker_id | string | Optional | ID 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of redacted fields. |
redacted_fields | array | Optional | |
redacted_fields[] | object | Each item | |
redacted_fields[].name | string | Optional | The name for the redacted field |
redacted_fields[].reason | string | Optional | The reason for the redaction |
Retrieve a specific bill — response body — attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Finance transaction attachment with recorded upload details. |
file_name | string | Optional | Original file name, when recorded. |
uploaded_at | string | Optional | When the attachment was uploaded, as an ISO 8601 date-time in UTC, when recorded. |
uploaded_by_id | string | Optional | ID of the worker who uploaded the attachment. Use it with `/workers/{id}/`. |
url | string | Required within parent | URL for accessing the file. |
Retrieve a specific bill — response body — vendor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Vendor details. Expand with `bills.read` and `finance-vendors.read`. Expandable field |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
is_archived | boolean | Optional | Whether the vendor is archived. Archived vendors remain available for historical references. |
logo | string | Optional | URL of the vendor's logo. Null when no logo is available. |
name | string | Optional | Canonical name of the Finance vendor. Name eq, ne, and in filters also match alternate names. |
updated_at | string | Required within parent | Record update date |
Retrieve a specific bill — response body — line items item dimension choices value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dimension_name | string | Optional | Name of the dimension, such as Department. |
label | string | Optional | Display name of the selected dimension value. |
value | string | Optional | ID of the selected dimension value. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}