Rippling: Retrieve a specific bill payment

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.get_bill_payments

Provider route: GET /bill-payments/{id}/. Alter supplies the connection’s credentials and routing.

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"]["getBillPayments"]>[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.getBillPayments(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.get_bill_payments(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: id

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	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
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	URLs of other attached files.
attachments[]	string	Each item
check_date	string	Optional	Date the company is debited, as an ISO 8601 date. Null when not set.
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, or MANUALLY_PAID. Known values: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, MANUALLY_PAID, PAID_IN_FULL_VIA_VENDOR_CREDIT
debit_method	string	Optional	How the company is debited: ACH, WIRE, EXISTING_CORPORATE_CARD, or MANUALLY_PAID. Known values: ACH, WIRE, EXISTING_CORPORATE_CARD, MANUALLY_PAID
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	When the vendor is expected to receive the payment, as an ISO 8601 date-time in UTC. 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.
global_purpose	string	Optional	Purpose code for an international payment. Null for domestic payments.
id	string	Required within parent	Identifier field
invoice_number	string	Optional	Invoice number. Null when the bill has no invoice number.
line_items	array	Optional	Bill line items, including accounting, tax, quantity, and term details.
line_items[]	Model	Each item	Expand Retrieve a specific bill payment — 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 `/bill-payments/{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	SCHEDULE_NOW when a debit date was chosen; SKIP_FOR_NOW when choosing one was skipped. Known values: SCHEDULE_NOW, SKIP_FOR_NOW
payment_velocity	string	Optional	How fast the vendor is paid after `check_date`: `TWO_DAY` (accelerated, 2 business days) or `FOUR_DAY` (standard, 4 business days). Known values: TWO_DAY, FOUR_DAY
receipt	string	Optional	URL of the receipt file.
scheduled_payment_date	string	Optional	Date used to estimate vendor payment, as an ISO 8601 date. Null when not set.
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_date	string	Optional	Invoice date, as an ISO 8601 date-time in UTC. Null when not set.
transaction_type	string	Optional	Type of transaction: `BILL_PAYMENT`. Known values: BILL_PAYMENT
updated_at	string	Required within parent	Record update date
vendor	object	Optional	Vendor the purchase was made from.
vendor.id	string	Optional	ID of the vendor.
vendor.name	string	Optional	Name of the vendor.
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_id	string	Optional	ID of the worker who made the transaction. Use it with `/workers/{id}/`.

Referenced models: Retrieve a specific bill payment — response body — line items item, Retrieve a report run — response body — meta redacted fields item

Policy, approvals and errors

SDK function policy ID: rippling.rest_api.get_bill_payments. Catalog operation: get-bill-payments. 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: ["bill-payments.read"]

Provider entitlements: ["Internal_Testing"]

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

Official provider source