v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Accounting

Get accounting rule

Retrieve a single accounting rule by its identifier.

get/v1/accounting/rules/{id}

Path parameters

idstring required

Response

idstring required

Unique identifier of the accounting rule.

codestring required

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

namestring nullable required

Optional user-defined name for the rule.

ledger_idstring required

Identifier of the ledger this rule belongs to.

categorystring nullable required

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

prioritynumber required

Override order. Higher priority wins when multiple rules match.

product_idsstring[] required

Product IDs to match. Empty means match all.

product_typesstring[] required

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

customer_idsstring[] required

Customer IDs for customer-specific overrides.

currenciesstring[] required

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

countriesstring[] required

Country codes for jurisdiction-based overrides.

coupon_idsstring[] required

Coupon IDs to match. Empty means match all.

client_provider_idsstring[] required

Client provider IDs to match. Empty means match all.

payment_method_typesstring[] required

Payment method types to match. Empty means match all.

interval_periodstring nullable required

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

interval_countnumber nullable required

Billing interval count filter.

revenue_ledger_account_idstring nullable required

Revenue ledger account ID used for invoice line revenue routing.

deferred_revenue_ledger_account_idstring nullable required

Deferred revenue ledger account ID used before revenue is recognized.

deferred_discount_ledger_account_idstring nullable required

Deferred discount ledger account ID used before discounts are recognized.

contra_revenue_ledger_account_idstring nullable required

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

discount_ledger_account_idstring nullable required

Discount ledger account ID used for recognized discounts.

ar_ledger_account_idstring nullable required

Accounts receivable ledger account ID used for invoice posting.

cash_ledger_account_idstring nullable required

Cash ledger account ID used for payment settlement.

payments_clearing_ledger_account_idstring nullable required

Payments clearing ledger account ID used while payments settle.

output_tax_ledger_account_idstring nullable required

Output tax ledger account ID used for tax liability.

bad_debt_expense_ledger_account_idstring nullable required

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

customer_credits_ledger_account_idstring nullable required

Customer credits ledger account ID used for credit balances.

journal_idstring nullable required

Journal ID used to route entries in the accounting provider.

entity_typestring nullable required

Entity type the rule applies to.

created_atstring date required

Timestamp when the rule was created.

updated_atstring date required

Timestamp when the rule was last updated.

Example response

{
  "id": "arl_abc123def456",
  "code": "R-001",
  "name": "Recurring subscriptions",
  "ledger_id": "led_abc123def456",
  "category": "accounting_software",
  "priority": 100,
  "product_ids": [
    "prod_abc123def456"
  ],
  "product_types": [
    "flat_fee"
  ],
  "customer_ids": [
    "cus_abc123def456"
  ],
  "currencies": [
    "EUR"
  ],
  "countries": [
    "FR"
  ],
  "coupon_ids": [
    "cpn_abc123def456"
  ],
  "client_provider_ids": [
    "clp_abc123def456"
  ],
  "payment_method_types": [
    "card"
  ],
  "interval_period": "month",
  "interval_count": 1,
  "revenue_ledger_account_id": "lac_abc123def456",
  "revenue_ledger_account": {
    "id": "lac_abc123def456",
    "code": "706100",
    "name": "Revenue",
    "integration": {
      "entity_id": "123456789",
      "provider_name": "stripe",
      "provider_account_id": "acc_1234567890"
    }
  },
  "deferred_revenue_ledger_account_id": "lac_abc123def456",
  "deferred_discount_ledger_account_id": "lac_abc123def456",
  "contra_revenue_ledger_account_id": "lac_abc123def456",
  "discount_ledger_account_id": "lac_abc123def456",
  "ar_ledger_account_id": "lac_abc123def456",
  "cash_ledger_account_id": "lac_abc123def456",
  "payments_clearing_ledger_account_id": "lac_abc123def456",
  "output_tax_ledger_account_id": "lac_abc123def456",
  "bad_debt_expense_ledger_account_id": "lac_abc123def456",
  "customer_credits_ledger_account_id": "lac_abc123def456",
  "journal_id": "jou_abc123def456",
  "entity_type": "invoice"
}