Update accounting rule

curl --request PUT \
  --url https://api.hyperline.co/v1/accounting/rules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "priority": 123,
  "product_ids": [
    "<string>"
  ],
  "product_types": [],
  "customer_ids": [
    "<string>"
  ],
  "currencies": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "coupon_ids": [
    "<string>"
  ],
  "client_provider_ids": [
    "<string>"
  ],
  "payment_method_types": [
    "<string>"
  ],
  "interval_period": "<string>",
  "interval_count": 123,
  "revenue_ledger_account_id": "<string>",
  "deferred_revenue_ledger_account_id": "<string>",
  "deferred_discount_ledger_account_id": "<string>",
  "contra_revenue_ledger_account_id": "<string>",
  "discount_ledger_account_id": "<string>",
  "ar_ledger_account_id": "<string>",
  "cash_ledger_account_id": "<string>",
  "payments_clearing_ledger_account_id": "<string>",
  "output_tax_ledger_account_id": "<string>",
  "bad_debt_expense_ledger_account_id": "<string>",
  "customer_credits_ledger_account_id": "<string>",
  "journal_id": "<string>"
}
'

{
  "id": "arl_abc123def456",
  "code": "R-001",
  "name": "Recurring subscriptions",
  "ledger_id": "led_abc123def456",
  "category": "accounting_software",
  "priority": 100,
  "product_ids": [
    "<string>"
  ],
  "product_types": [
    "<string>"
  ],
  "customer_ids": [
    "<string>"
  ],
  "currencies": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "coupon_ids": [
    "<string>"
  ],
  "client_provider_ids": [
    "<string>"
  ],
  "payment_method_types": [
    "<string>"
  ],
  "interval_period": "<string>",
  "interval_count": 123,
  "revenue_ledger_account_id": "<string>",
  "deferred_revenue_ledger_account_id": "<string>",
  "deferred_discount_ledger_account_id": "<string>",
  "contra_revenue_ledger_account_id": "<string>",
  "discount_ledger_account_id": "<string>",
  "ar_ledger_account_id": "<string>",
  "cash_ledger_account_id": "<string>",
  "payments_clearing_ledger_account_id": "<string>",
  "output_tax_ledger_account_id": "<string>",
  "bad_debt_expense_ledger_account_id": "<string>",
  "customer_credits_ledger_account_id": "<string>",
  "journal_id": "<string>",
  "entity_type": "<string>",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "revenue_ledger_account": {
    "id": "<string>",
    "code": "<string>",
    "name": "<string>",
    "client_provider_id": "<string>",
    "provider": {
      "name": "<string>"
    }
  }
}

PUT

accounting

rules

{id}

Update accounting rule

curl --request PUT \
  --url https://api.hyperline.co/v1/accounting/rules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "priority": 123,
  "product_ids": [
    "<string>"
  ],
  "product_types": [],
  "customer_ids": [
    "<string>"
  ],
  "currencies": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "coupon_ids": [
    "<string>"
  ],
  "client_provider_ids": [
    "<string>"
  ],
  "payment_method_types": [
    "<string>"
  ],
  "interval_period": "<string>",
  "interval_count": 123,
  "revenue_ledger_account_id": "<string>",
  "deferred_revenue_ledger_account_id": "<string>",
  "deferred_discount_ledger_account_id": "<string>",
  "contra_revenue_ledger_account_id": "<string>",
  "discount_ledger_account_id": "<string>",
  "ar_ledger_account_id": "<string>",
  "cash_ledger_account_id": "<string>",
  "payments_clearing_ledger_account_id": "<string>",
  "output_tax_ledger_account_id": "<string>",
  "bad_debt_expense_ledger_account_id": "<string>",
  "customer_credits_ledger_account_id": "<string>",
  "journal_id": "<string>"
}
'

{
  "id": "arl_abc123def456",
  "code": "R-001",
  "name": "Recurring subscriptions",
  "ledger_id": "led_abc123def456",
  "category": "accounting_software",
  "priority": 100,
  "product_ids": [
    "<string>"
  ],
  "product_types": [
    "<string>"
  ],
  "customer_ids": [
    "<string>"
  ],
  "currencies": [
    "<string>"
  ],
  "countries": [
    "<string>"
  ],
  "coupon_ids": [
    "<string>"
  ],
  "client_provider_ids": [
    "<string>"
  ],
  "payment_method_types": [
    "<string>"
  ],
  "interval_period": "<string>",
  "interval_count": 123,
  "revenue_ledger_account_id": "<string>",
  "deferred_revenue_ledger_account_id": "<string>",
  "deferred_discount_ledger_account_id": "<string>",
  "contra_revenue_ledger_account_id": "<string>",
  "discount_ledger_account_id": "<string>",
  "ar_ledger_account_id": "<string>",
  "cash_ledger_account_id": "<string>",
  "payments_clearing_ledger_account_id": "<string>",
  "output_tax_ledger_account_id": "<string>",
  "bad_debt_expense_ledger_account_id": "<string>",
  "customer_credits_ledger_account_id": "<string>",
  "journal_id": "<string>",
  "entity_type": "<string>",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "revenue_ledger_account": {
    "id": "<string>",
    "code": "<string>",
    "name": "<string>",
    "client_provider_id": "<string>",
    "provider": {
      "name": "<string>"
    }
  }
}

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

string

requis

Corps

application/json

name

string | null

Réponse

200 - application/json

string

requis

Unique identifier of the accounting rule.

Exemple:

"arl_abc123def456"

code

string

requis

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

Exemple:

"R-001"

name

string | null

requis

Optional user-defined name for the rule.

Exemple:

"Recurring subscriptions"

ledger_id

string

requis

Identifier of the ledger this rule belongs to.

Exemple:

"led_abc123def456"