v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Accounting

List accounting rules

Retrieve existing accounting rules with optional filtering.

get/v1/accounting/rules

Query parameters

takenumber nullable
skipnumber nullable
ledger_idstring
ledger_id__notstring
ledger_id__isNullstring
ledger_id__isNotNullstring
ledger_id__equalsstring
ledger_id__containsstring
ledger_id__startsWithstring
ledger_id__endWithstring
categorystring
category__notstring
category__isNullstring
category__isNotNullstring
category__equalsstring
category__containsstring
category__startsWithstring
category__endWithstring

Response

Example response

{
  "meta": {
    "total": 1,
    "taken": 1
  },
  "data": [
    {
      "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"
    }
  ]
}
All 239 operations