Skip to content

Rippling: Retrieve a specific bill payment

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

← Rest API operations · Get started

Operation rippling.rest_api.get_bill_payments

Deprecated. This contract (2026-11-07) no longer has this operation. The SDK keeps restApi.getBillPayments / rest_api.get_bill_payments, deprecated, and the method calls contract 2026-10-28, which published it and which Alter still serves. Its input and response below are that contract’s.

Provider route: GET /bill-payments/{id}/. 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"]["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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentFormat: id

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaobjectOptional
__meta.redacted_fieldsarrayOptional
__meta.redacted_fields[]ModelEach itemExpand Retrieve a report run — response body — meta redacted fields item
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
attachmentsarrayOptionalURLs of other attached files.
attachments[]stringEach item
check_datestringOptionalDate the company is debited, as an ISO 8601 date. Null when not set.
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, or MANUALLY_PAID.
Known values: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, MANUALLY_PAID, PAID_IN_FULL_VIA_VENDOR_CREDIT
debit_methodstringOptionalHow the company is debited: ACH, WIRE, EXISTING_CORPORATE_CARD, or MANUALLY_PAID.
Known values: ACH, WIRE, EXISTING_CORPORATE_CARD, MANUALLY_PAID
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_arrivalstringOptionalWhen the vendor is expected to receive the payment, as an ISO 8601 date-time in UTC. 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.
global_purposestringOptionalPurpose code for an international payment. Null for domestic payments.
idstringRequired within parentIdentifier field
invoice_numberstringOptionalInvoice number. Null when the bill has no invoice number.
line_itemsarrayOptionalBill line items, including accounting, tax, quantity, and term details.
line_items[]ModelEach itemExpand Retrieve a specific bill payment — 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 `/bill-payments/{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_settingstringOptionalSCHEDULE_NOW when a debit date was chosen; SKIP_FOR_NOW when choosing one was skipped.
Known values: SCHEDULE_NOW, SKIP_FOR_NOW
payment_velocitystringOptionalHow 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
receiptstringOptionalURL of the receipt file.
scheduled_payment_datestringOptionalDate used to estimate vendor payment, as an ISO 8601 date. Null when not set.
submitter_idstringOptionalID of the bill manager who submitted the bill. Use it with `/workers/{id}/`. Can differ from `worker_id`. Null before submission.
transaction_datestringOptionalInvoice date, as an ISO 8601 date-time in UTC. Null when not set.
transaction_typestringOptionalType of transaction: `BILL_PAYMENT`.
Known values: BILL_PAYMENT
updated_atstringRequired within parentRecord update date
vendorobjectOptionalVendor the purchase was made from.
vendor.idstringOptionalID of the vendor.
vendor.namestringOptionalName of the vendor.
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.
worker_idstringOptionalID 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

Retrieve a specific bill payment — response body — line items item
FieldTypePresenceDescription and constraints
$objectRoot
amortization_statusstringOptionalAmortization state. Null when not set.
Known values: NOT_STARTED, IN_PROGRESS, COMPLETED, ERROR
amortizedbooleanOptionalWhether this line is amortized.
amountobjectOptionalAmount of this split, in the merchant currency. The `value` is a decimal string.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valueJSONOptional
amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category_idstringOptionalID of the Spend category assigned to this split. No public API is currently available to retrieve this category; its name is in `category_name`.
category_namestringOptionalName of the spend category.
dimension_choicesobjectOptionalSelected dimension values, keyed by dimension ID. Includes department and work location.
Additional keys: see wildcard field
dimension_choices.*ModelAdditional keysExpand Retrieve a specific bill — response body — line items item dimension choices value
discountstringOptionalDiscount on the item as a percentage (`10.00` means 10%), as a decimal string. Null when not set.
end_datestringOptionalAmortization end date. Null when not set.
gl_amortization_schedulestringOptionalID of the amortization schedule in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
gl_amortization_templatestringOptionalID of the amortization template in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
gl_billablestringOptionalWhether this split is billed to `gl_customer` in the accounting system. `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not set.
Known values: BILLABLE, NOT_BILLABLE
gl_customerstringOptionalID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer.
gl_tax_codestringOptionalRippling ID of the tax code synced from the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
memostringOptionalMemo entered on this split.
prepaid_accountstringOptionalID of the prepaid account in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
priceobjectOptionalUnit price, in the merchant currency. The `value` is a decimal string. Null when not set.
price.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
price.valueJSONOptional
price.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
price.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantitystringOptionalItem quantity, as a decimal string. Null when not set.
quantity_unit_of_measurestringOptionalUnit for quantity, such as tons or seats. Null when quantity is not set.
start_datestringOptionalAmortization start date. Null when not set.
tax_amountobjectOptionalTax amount entered on the line, in the merchant currency. The `value` is a decimal string. Null when not set.
tax_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
tax_amount.valueJSONOptional
tax_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
tax_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_code_display_aliasstringOptionalDisplay name of the tax code. Null when not set.
termstringOptionalTerm length, as a decimal string. Null when not set.
term_unit_of_measurestringOptionalUnit for term: YEARS, QUARTERS, MONTHS, WEEKS, or DAYS. Null when term is not set.
Known values: YEARS, QUARTERS, MONTHS, WEEKS, DAYS
total_amortized_amountobjectOptionalAmount amortized so far, in the company's headquarters currency. The `value` is a decimal string. Null when not set.
total_amortized_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
total_amortized_amount.valueJSONOptional
total_amortized_amount.value (anyOf 1)numberAlternativeThe decimal amount for the currency.
total_amortized_amount.value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a specific bill — response body — line items item dimension choices value

Retrieve a report run — response body — meta redacted fields item
FieldTypePresenceDescription and constraints
$objectRootInfo about the redacted fields.
namestringOptionalThe name for the redacted field
reasonstringOptionalThe reason for the redaction
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.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

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.