Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Accounting

Resolve accounting rule

Preview which account codes would be resolved for a given context.

post/v1/accounting/rules/resolve

Request body

ledger_idstring required

Identifier of the ledger this rule belongs to.

category'invoice_posted' | 'invoice_settled' | 'revenue_recognition' | 'credit_note_created' | 'accounting_software' required

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

product_idstring

Product ID to resolve against.

product_typestring

Product type to resolve against.

currencystring

Currency code to resolve against.

countrystring

Country code to resolve against.

customer_idstring

Customer ID to resolve against.

interval_periodstring

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

interval_countnumber

Billing interval count filter.

Example request

{
  "ledger_id": "led_abc123def456",
  "category": "accounting_software",
  "product_id": "prod_abc123def456",
  "product_type": "flat_fee",
  "currency": "EUR",
  "country": "FR",
  "customer_id": "cus_abc123def456",
  "interval_period": "month",
  "interval_count": 1
}

Response

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.

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.

bad_debt_expense_ledger_account_idstring nullable required

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

Example response

{
  "revenue_ledger_account_id": "lac_abc123def456",
  "deferred_revenue_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",
  "bad_debt_expense_ledger_account_id": "lac_abc123def456",
  "trace": [
    {
      "rule_id": "arl_abc123def456",
      "applied_fields": [
        "revenueLedgerAccountId"
      ]
    }
  ]
}