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": "Recurring subscriptions",
  "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",
  "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"
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/rules/{id}"

payload = {
    "name": "Recurring subscriptions",
    "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",
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Recurring subscriptions',
    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',
    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'
  })
};

fetch('https://api.hyperline.co/v1/accounting/rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/accounting/rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Recurring subscriptions',
    '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',
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/rules/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Recurring subscriptions\",\n  \"category\": \"accounting_software\",\n  \"priority\": 100,\n  \"product_ids\": [\n    \"prod_abc123def456\"\n  ],\n  \"product_types\": [\n    \"flat_fee\"\n  ],\n  \"customer_ids\": [\n    \"cus_abc123def456\"\n  ],\n  \"currencies\": [\n    \"EUR\"\n  ],\n  \"countries\": [\n    \"FR\"\n  ],\n  \"coupon_ids\": [\n    \"cpn_abc123def456\"\n  ],\n  \"client_provider_ids\": [\n    \"clp_abc123def456\"\n  ],\n  \"payment_method_types\": [\n    \"card\"\n  ],\n  \"interval_period\": \"month\",\n  \"interval_count\": 1,\n  \"revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_discount_ledger_account_id\": \"lac_abc123def456\",\n  \"contra_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"discount_ledger_account_id\": \"lac_abc123def456\",\n  \"ar_ledger_account_id\": \"lac_abc123def456\",\n  \"cash_ledger_account_id\": \"lac_abc123def456\",\n  \"payments_clearing_ledger_account_id\": \"lac_abc123def456\",\n  \"output_tax_ledger_account_id\": \"lac_abc123def456\",\n  \"bad_debt_expense_ledger_account_id\": \"lac_abc123def456\",\n  \"customer_credits_ledger_account_id\": \"lac_abc123def456\",\n  \"journal_id\": \"jou_abc123def456\",\n  \"entity_type\": \"invoice\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.hyperline.co/v1/accounting/rules/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Recurring subscriptions\",\n  \"category\": \"accounting_software\",\n  \"priority\": 100,\n  \"product_ids\": [\n    \"prod_abc123def456\"\n  ],\n  \"product_types\": [\n    \"flat_fee\"\n  ],\n  \"customer_ids\": [\n    \"cus_abc123def456\"\n  ],\n  \"currencies\": [\n    \"EUR\"\n  ],\n  \"countries\": [\n    \"FR\"\n  ],\n  \"coupon_ids\": [\n    \"cpn_abc123def456\"\n  ],\n  \"client_provider_ids\": [\n    \"clp_abc123def456\"\n  ],\n  \"payment_method_types\": [\n    \"card\"\n  ],\n  \"interval_period\": \"month\",\n  \"interval_count\": 1,\n  \"revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_discount_ledger_account_id\": \"lac_abc123def456\",\n  \"contra_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"discount_ledger_account_id\": \"lac_abc123def456\",\n  \"ar_ledger_account_id\": \"lac_abc123def456\",\n  \"cash_ledger_account_id\": \"lac_abc123def456\",\n  \"payments_clearing_ledger_account_id\": \"lac_abc123def456\",\n  \"output_tax_ledger_account_id\": \"lac_abc123def456\",\n  \"bad_debt_expense_ledger_account_id\": \"lac_abc123def456\",\n  \"customer_credits_ledger_account_id\": \"lac_abc123def456\",\n  \"journal_id\": \"jou_abc123def456\",\n  \"entity_type\": \"invoice\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Recurring subscriptions\",\n  \"category\": \"accounting_software\",\n  \"priority\": 100,\n  \"product_ids\": [\n    \"prod_abc123def456\"\n  ],\n  \"product_types\": [\n    \"flat_fee\"\n  ],\n  \"customer_ids\": [\n    \"cus_abc123def456\"\n  ],\n  \"currencies\": [\n    \"EUR\"\n  ],\n  \"countries\": [\n    \"FR\"\n  ],\n  \"coupon_ids\": [\n    \"cpn_abc123def456\"\n  ],\n  \"client_provider_ids\": [\n    \"clp_abc123def456\"\n  ],\n  \"payment_method_types\": [\n    \"card\"\n  ],\n  \"interval_period\": \"month\",\n  \"interval_count\": 1,\n  \"revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_discount_ledger_account_id\": \"lac_abc123def456\",\n  \"contra_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"discount_ledger_account_id\": \"lac_abc123def456\",\n  \"ar_ledger_account_id\": \"lac_abc123def456\",\n  \"cash_ledger_account_id\": \"lac_abc123def456\",\n  \"payments_clearing_ledger_account_id\": \"lac_abc123def456\",\n  \"output_tax_ledger_account_id\": \"lac_abc123def456\",\n  \"bad_debt_expense_ledger_account_id\": \"lac_abc123def456\",\n  \"customer_credits_ledger_account_id\": \"lac_abc123def456\",\n  \"journal_id\": \"jou_abc123def456\",\n  \"entity_type\": \"invoice\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "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",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "revenue_ledger_account": {
    "id": "lac_abc123def456",
    "code": "706100",
    "name": "Revenue",
    "integration": {
      "entity_id": "123456789",
      "provider_name": "stripe",
      "provider_account_id": "acc_1234567890"
    }
  }
}

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": "Recurring subscriptions",
  "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",
  "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"
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/rules/{id}"

payload = {
    "name": "Recurring subscriptions",
    "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",
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Recurring subscriptions',
    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',
    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'
  })
};

fetch('https://api.hyperline.co/v1/accounting/rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/accounting/rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Recurring subscriptions',
    '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',
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/rules/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Recurring subscriptions\",\n  \"category\": \"accounting_software\",\n  \"priority\": 100,\n  \"product_ids\": [\n    \"prod_abc123def456\"\n  ],\n  \"product_types\": [\n    \"flat_fee\"\n  ],\n  \"customer_ids\": [\n    \"cus_abc123def456\"\n  ],\n  \"currencies\": [\n    \"EUR\"\n  ],\n  \"countries\": [\n    \"FR\"\n  ],\n  \"coupon_ids\": [\n    \"cpn_abc123def456\"\n  ],\n  \"client_provider_ids\": [\n    \"clp_abc123def456\"\n  ],\n  \"payment_method_types\": [\n    \"card\"\n  ],\n  \"interval_period\": \"month\",\n  \"interval_count\": 1,\n  \"revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_discount_ledger_account_id\": \"lac_abc123def456\",\n  \"contra_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"discount_ledger_account_id\": \"lac_abc123def456\",\n  \"ar_ledger_account_id\": \"lac_abc123def456\",\n  \"cash_ledger_account_id\": \"lac_abc123def456\",\n  \"payments_clearing_ledger_account_id\": \"lac_abc123def456\",\n  \"output_tax_ledger_account_id\": \"lac_abc123def456\",\n  \"bad_debt_expense_ledger_account_id\": \"lac_abc123def456\",\n  \"customer_credits_ledger_account_id\": \"lac_abc123def456\",\n  \"journal_id\": \"jou_abc123def456\",\n  \"entity_type\": \"invoice\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.hyperline.co/v1/accounting/rules/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Recurring subscriptions\",\n  \"category\": \"accounting_software\",\n  \"priority\": 100,\n  \"product_ids\": [\n    \"prod_abc123def456\"\n  ],\n  \"product_types\": [\n    \"flat_fee\"\n  ],\n  \"customer_ids\": [\n    \"cus_abc123def456\"\n  ],\n  \"currencies\": [\n    \"EUR\"\n  ],\n  \"countries\": [\n    \"FR\"\n  ],\n  \"coupon_ids\": [\n    \"cpn_abc123def456\"\n  ],\n  \"client_provider_ids\": [\n    \"clp_abc123def456\"\n  ],\n  \"payment_method_types\": [\n    \"card\"\n  ],\n  \"interval_period\": \"month\",\n  \"interval_count\": 1,\n  \"revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_discount_ledger_account_id\": \"lac_abc123def456\",\n  \"contra_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"discount_ledger_account_id\": \"lac_abc123def456\",\n  \"ar_ledger_account_id\": \"lac_abc123def456\",\n  \"cash_ledger_account_id\": \"lac_abc123def456\",\n  \"payments_clearing_ledger_account_id\": \"lac_abc123def456\",\n  \"output_tax_ledger_account_id\": \"lac_abc123def456\",\n  \"bad_debt_expense_ledger_account_id\": \"lac_abc123def456\",\n  \"customer_credits_ledger_account_id\": \"lac_abc123def456\",\n  \"journal_id\": \"jou_abc123def456\",\n  \"entity_type\": \"invoice\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Recurring subscriptions\",\n  \"category\": \"accounting_software\",\n  \"priority\": 100,\n  \"product_ids\": [\n    \"prod_abc123def456\"\n  ],\n  \"product_types\": [\n    \"flat_fee\"\n  ],\n  \"customer_ids\": [\n    \"cus_abc123def456\"\n  ],\n  \"currencies\": [\n    \"EUR\"\n  ],\n  \"countries\": [\n    \"FR\"\n  ],\n  \"coupon_ids\": [\n    \"cpn_abc123def456\"\n  ],\n  \"client_provider_ids\": [\n    \"clp_abc123def456\"\n  ],\n  \"payment_method_types\": [\n    \"card\"\n  ],\n  \"interval_period\": \"month\",\n  \"interval_count\": 1,\n  \"revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"deferred_discount_ledger_account_id\": \"lac_abc123def456\",\n  \"contra_revenue_ledger_account_id\": \"lac_abc123def456\",\n  \"discount_ledger_account_id\": \"lac_abc123def456\",\n  \"ar_ledger_account_id\": \"lac_abc123def456\",\n  \"cash_ledger_account_id\": \"lac_abc123def456\",\n  \"payments_clearing_ledger_account_id\": \"lac_abc123def456\",\n  \"output_tax_ledger_account_id\": \"lac_abc123def456\",\n  \"bad_debt_expense_ledger_account_id\": \"lac_abc123def456\",\n  \"customer_credits_ledger_account_id\": \"lac_abc123def456\",\n  \"journal_id\": \"jou_abc123def456\",\n  \"entity_type\": \"invoice\"\n}"

response = http.request(request)
puts response.read_body

{
  "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",
  "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",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "revenue_ledger_account": {
    "id": "lac_abc123def456",
    "code": "706100",
    "name": "Revenue",
    "integration": {
      "entity_id": "123456789",
      "provider_name": "stripe",
      "provider_account_id": "acc_1234567890"
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

name

string | null

Optional user-defined name for the rule.

Example:

"Recurring subscriptions"

Response

200 - application/json

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"