Skip to main content
GET
Get accounting rule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

id
string
required

Unique identifier of the accounting rule.

Example:

"arl_abc123def456"

code
string
required

Auto-generated rule code (e.g. R-001).

Example:

"R-001"

name
string | null
required

Optional user-defined name for the rule.

Example:

"Recurring subscriptions"

ledger_id
string
required

Identifier of the ledger this rule belongs to.

Example:

"led_abc123def456"

category
string | null
required

Rule category (e.g. accounting_software, invoice_posted).

Example:

"accounting_software"

priority
number
required

Override order. Higher priority wins when multiple rules match.

Example:

100

product_ids
string[]
required

Product IDs to match. Empty means match all.

Example:
product_types
string[]
required

Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.

Example:
customer_ids
string[]
required

Customer IDs for customer-specific overrides.

Example:
currencies
string[]
required

Currency codes to match (e.g. EUR, USD).

Example:
countries
string[]
required

Country codes for jurisdiction-based overrides.

Example:
coupon_ids
string[]
required

Coupon IDs to match. Empty means match all.

Example:
client_provider_ids
string[]
required

Client provider IDs to match. Empty means match all.

Example:
payment_method_types
string[]
required

Payment method types to match. Empty means match all.

Example:
interval_period
string | null
required

Billing interval period filter (month, year, etc.).

Example:

"month"

interval_count
number | null
required

Billing interval count filter.

Example:

1

revenue_ledger_account_id
string | null
required

Revenue ledger account ID used for invoice line revenue routing.

Example:

"lac_abc123def456"

deferred_revenue_ledger_account_id
string | null
required

Deferred revenue ledger account ID used before revenue is recognized.

Example:

"lac_abc123def456"

deferred_discount_ledger_account_id
string | null
required

Deferred discount ledger account ID used before discounts are recognized.

Example:

"lac_abc123def456"

contra_revenue_ledger_account_id
string | null
required

Contra revenue ledger account ID used for amounts that reduce revenue.

Example:

"lac_abc123def456"

discount_ledger_account_id
string | null
required

Discount ledger account ID used for recognized discounts.

Example:

"lac_abc123def456"

ar_ledger_account_id
string | null
required

Accounts receivable ledger account ID used for invoice posting.

Example:

"lac_abc123def456"

cash_ledger_account_id
string | null
required

Cash ledger account ID used for payment settlement.

Example:

"lac_abc123def456"

payments_clearing_ledger_account_id
string | null
required

Payments clearing ledger account ID used while payments settle.

Example:

"lac_abc123def456"

output_tax_ledger_account_id
string | null
required

Output tax ledger account ID used for tax liability.

Example:

"lac_abc123def456"

bad_debt_expense_ledger_account_id
string | null
required

Bad debt expense ledger account ID used for provider-side write-off routing.

Example:

"lac_abc123def456"

customer_credits_ledger_account_id
string | null
required

Customer credits ledger account ID used for credit balances.

Example:

"lac_abc123def456"

journal_id
string | null
required

Journal ID used to route entries in the accounting provider.

Example:

"jou_abc123def456"

entity_type
string | null
required

Entity type the rule applies to.

Example:

"invoice"

created_at
string<date>
required

Timestamp when the rule was created.

updated_at
string<date>
required

Timestamp when the rule was last updated.

revenue_ledger_account
object | null

Expanded revenue ledger account reference when available.