Resolve accounting rule

curl --request POST \
  --url https://api.hyperline.co/v1/accounting/rules/resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ledger_id": "led_abc123def456",
  "category": "accounting_software",
  "product_id": "prod_abc123def456",
  "product_type": "flat_fee",
  "currency": "EUR",
  "country": "FR",
  "tax_scheme": "reverse_charge",
  "tax_territory": "FR",
  "tax_rate_class": "standard_rate",
  "customer_id": "cus_abc123def456",
  "coupon_id": "cpn_abc123def456",
  "client_provider_id": "clp_abc123def456",
  "payment_method_type": "card",
  "bank_account_id": "bac_abc123def456",
  "invoice_type": "invoice",
  "interval_period": "months",
  "interval_count": 1,
  "custom_properties": {
    "fee_type": "service"
  }
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/rules/resolve"

payload = {
    "ledger_id": "led_abc123def456",
    "category": "accounting_software",
    "product_id": "prod_abc123def456",
    "product_type": "flat_fee",
    "currency": "EUR",
    "country": "FR",
    "tax_scheme": "reverse_charge",
    "tax_territory": "FR",
    "tax_rate_class": "standard_rate",
    "customer_id": "cus_abc123def456",
    "coupon_id": "cpn_abc123def456",
    "client_provider_id": "clp_abc123def456",
    "payment_method_type": "card",
    "bank_account_id": "bac_abc123def456",
    "invoice_type": "invoice",
    "interval_period": "months",
    "interval_count": 1,
    "custom_properties": { "fee_type": "service" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ledger_id: 'led_abc123def456',
    category: 'accounting_software',
    product_id: 'prod_abc123def456',
    product_type: 'flat_fee',
    currency: 'EUR',
    country: 'FR',
    tax_scheme: 'reverse_charge',
    tax_territory: 'FR',
    tax_rate_class: 'standard_rate',
    customer_id: 'cus_abc123def456',
    coupon_id: 'cpn_abc123def456',
    client_provider_id: 'clp_abc123def456',
    payment_method_type: 'card',
    bank_account_id: 'bac_abc123def456',
    invoice_type: 'invoice',
    interval_period: 'months',
    interval_count: 1,
    custom_properties: {fee_type: 'service'}
  })
};

fetch('https://api.hyperline.co/v1/accounting/rules/resolve', 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/resolve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ledger_id' => 'led_abc123def456',
    'category' => 'accounting_software',
    'product_id' => 'prod_abc123def456',
    'product_type' => 'flat_fee',
    'currency' => 'EUR',
    'country' => 'FR',
    'tax_scheme' => 'reverse_charge',
    'tax_territory' => 'FR',
    'tax_rate_class' => 'standard_rate',
    'customer_id' => 'cus_abc123def456',
    'coupon_id' => 'cpn_abc123def456',
    'client_provider_id' => 'clp_abc123def456',
    'payment_method_type' => 'card',
    'bank_account_id' => 'bac_abc123def456',
    'invoice_type' => 'invoice',
    'interval_period' => 'months',
    'interval_count' => 1,
    'custom_properties' => [
        'fee_type' => 'service'
    ]
  ]),
  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/resolve"

	payload := strings.NewReader("{\n  \"ledger_id\": \"led_abc123def456\",\n  \"category\": \"accounting_software\",\n  \"product_id\": \"prod_abc123def456\",\n  \"product_type\": \"flat_fee\",\n  \"currency\": \"EUR\",\n  \"country\": \"FR\",\n  \"tax_scheme\": \"reverse_charge\",\n  \"tax_territory\": \"FR\",\n  \"tax_rate_class\": \"standard_rate\",\n  \"customer_id\": \"cus_abc123def456\",\n  \"coupon_id\": \"cpn_abc123def456\",\n  \"client_provider_id\": \"clp_abc123def456\",\n  \"payment_method_type\": \"card\",\n  \"bank_account_id\": \"bac_abc123def456\",\n  \"invoice_type\": \"invoice\",\n  \"interval_period\": \"months\",\n  \"interval_count\": 1,\n  \"custom_properties\": {\n    \"fee_type\": \"service\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.hyperline.co/v1/accounting/rules/resolve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ledger_id\": \"led_abc123def456\",\n  \"category\": \"accounting_software\",\n  \"product_id\": \"prod_abc123def456\",\n  \"product_type\": \"flat_fee\",\n  \"currency\": \"EUR\",\n  \"country\": \"FR\",\n  \"tax_scheme\": \"reverse_charge\",\n  \"tax_territory\": \"FR\",\n  \"tax_rate_class\": \"standard_rate\",\n  \"customer_id\": \"cus_abc123def456\",\n  \"coupon_id\": \"cpn_abc123def456\",\n  \"client_provider_id\": \"clp_abc123def456\",\n  \"payment_method_type\": \"card\",\n  \"bank_account_id\": \"bac_abc123def456\",\n  \"invoice_type\": \"invoice\",\n  \"interval_period\": \"months\",\n  \"interval_count\": 1,\n  \"custom_properties\": {\n    \"fee_type\": \"service\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ledger_id\": \"led_abc123def456\",\n  \"category\": \"accounting_software\",\n  \"product_id\": \"prod_abc123def456\",\n  \"product_type\": \"flat_fee\",\n  \"currency\": \"EUR\",\n  \"country\": \"FR\",\n  \"tax_scheme\": \"reverse_charge\",\n  \"tax_territory\": \"FR\",\n  \"tax_rate_class\": \"standard_rate\",\n  \"customer_id\": \"cus_abc123def456\",\n  \"coupon_id\": \"cpn_abc123def456\",\n  \"client_provider_id\": \"clp_abc123def456\",\n  \"payment_method_type\": \"card\",\n  \"bank_account_id\": \"bac_abc123def456\",\n  \"invoice_type\": \"invoice\",\n  \"interval_period\": \"months\",\n  \"interval_count\": 1,\n  \"custom_properties\": {\n    \"fee_type\": \"service\"\n  }\n}"

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

{
  "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",
  "uncollectible_debit_ledger_account_id": "lac_abc123def456",
  "allowance_for_doubtful_accounts_id": "lac_abc123def456",
  "provider_fees_expense_ledger_account_id": "lac_abc123def456",
  "payment_processing_fees_expense_ledger_account_id": "lac_abc123def456",
  "payment_processing_fees_revenue_ledger_account_id": "lac_abc123def456",
  "customer_credits_ledger_account_id": "lac_abc123def456",
  "rev_rec_method": "over_time",
  "rev_rec_granularity": "month",
  "rev_rec_point_in_time_basis": "service_end_date",
  "discount_recognition_method": "deferred",
  "journal_id": "jou_abc123def456",
  "trace": [
    {
      "rule_id": "arl_abc123def456",
      "applied_fields": [
        "revenueLedgerAccountId"
      ]
    }
  ]
}

POST

accounting

rules

resolve

Resolve accounting rule

curl --request POST \
  --url https://api.hyperline.co/v1/accounting/rules/resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ledger_id": "led_abc123def456",
  "category": "accounting_software",
  "product_id": "prod_abc123def456",
  "product_type": "flat_fee",
  "currency": "EUR",
  "country": "FR",
  "tax_scheme": "reverse_charge",
  "tax_territory": "FR",
  "tax_rate_class": "standard_rate",
  "customer_id": "cus_abc123def456",
  "coupon_id": "cpn_abc123def456",
  "client_provider_id": "clp_abc123def456",
  "payment_method_type": "card",
  "bank_account_id": "bac_abc123def456",
  "invoice_type": "invoice",
  "interval_period": "months",
  "interval_count": 1,
  "custom_properties": {
    "fee_type": "service"
  }
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/rules/resolve"

payload = {
    "ledger_id": "led_abc123def456",
    "category": "accounting_software",
    "product_id": "prod_abc123def456",
    "product_type": "flat_fee",
    "currency": "EUR",
    "country": "FR",
    "tax_scheme": "reverse_charge",
    "tax_territory": "FR",
    "tax_rate_class": "standard_rate",
    "customer_id": "cus_abc123def456",
    "coupon_id": "cpn_abc123def456",
    "client_provider_id": "clp_abc123def456",
    "payment_method_type": "card",
    "bank_account_id": "bac_abc123def456",
    "invoice_type": "invoice",
    "interval_period": "months",
    "interval_count": 1,
    "custom_properties": { "fee_type": "service" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ledger_id: 'led_abc123def456',
    category: 'accounting_software',
    product_id: 'prod_abc123def456',
    product_type: 'flat_fee',
    currency: 'EUR',
    country: 'FR',
    tax_scheme: 'reverse_charge',
    tax_territory: 'FR',
    tax_rate_class: 'standard_rate',
    customer_id: 'cus_abc123def456',
    coupon_id: 'cpn_abc123def456',
    client_provider_id: 'clp_abc123def456',
    payment_method_type: 'card',
    bank_account_id: 'bac_abc123def456',
    invoice_type: 'invoice',
    interval_period: 'months',
    interval_count: 1,
    custom_properties: {fee_type: 'service'}
  })
};

fetch('https://api.hyperline.co/v1/accounting/rules/resolve', 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/resolve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ledger_id' => 'led_abc123def456',
    'category' => 'accounting_software',
    'product_id' => 'prod_abc123def456',
    'product_type' => 'flat_fee',
    'currency' => 'EUR',
    'country' => 'FR',
    'tax_scheme' => 'reverse_charge',
    'tax_territory' => 'FR',
    'tax_rate_class' => 'standard_rate',
    'customer_id' => 'cus_abc123def456',
    'coupon_id' => 'cpn_abc123def456',
    'client_provider_id' => 'clp_abc123def456',
    'payment_method_type' => 'card',
    'bank_account_id' => 'bac_abc123def456',
    'invoice_type' => 'invoice',
    'interval_period' => 'months',
    'interval_count' => 1,
    'custom_properties' => [
        'fee_type' => 'service'
    ]
  ]),
  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/resolve"

	payload := strings.NewReader("{\n  \"ledger_id\": \"led_abc123def456\",\n  \"category\": \"accounting_software\",\n  \"product_id\": \"prod_abc123def456\",\n  \"product_type\": \"flat_fee\",\n  \"currency\": \"EUR\",\n  \"country\": \"FR\",\n  \"tax_scheme\": \"reverse_charge\",\n  \"tax_territory\": \"FR\",\n  \"tax_rate_class\": \"standard_rate\",\n  \"customer_id\": \"cus_abc123def456\",\n  \"coupon_id\": \"cpn_abc123def456\",\n  \"client_provider_id\": \"clp_abc123def456\",\n  \"payment_method_type\": \"card\",\n  \"bank_account_id\": \"bac_abc123def456\",\n  \"invoice_type\": \"invoice\",\n  \"interval_period\": \"months\",\n  \"interval_count\": 1,\n  \"custom_properties\": {\n    \"fee_type\": \"service\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.hyperline.co/v1/accounting/rules/resolve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ledger_id\": \"led_abc123def456\",\n  \"category\": \"accounting_software\",\n  \"product_id\": \"prod_abc123def456\",\n  \"product_type\": \"flat_fee\",\n  \"currency\": \"EUR\",\n  \"country\": \"FR\",\n  \"tax_scheme\": \"reverse_charge\",\n  \"tax_territory\": \"FR\",\n  \"tax_rate_class\": \"standard_rate\",\n  \"customer_id\": \"cus_abc123def456\",\n  \"coupon_id\": \"cpn_abc123def456\",\n  \"client_provider_id\": \"clp_abc123def456\",\n  \"payment_method_type\": \"card\",\n  \"bank_account_id\": \"bac_abc123def456\",\n  \"invoice_type\": \"invoice\",\n  \"interval_period\": \"months\",\n  \"interval_count\": 1,\n  \"custom_properties\": {\n    \"fee_type\": \"service\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ledger_id\": \"led_abc123def456\",\n  \"category\": \"accounting_software\",\n  \"product_id\": \"prod_abc123def456\",\n  \"product_type\": \"flat_fee\",\n  \"currency\": \"EUR\",\n  \"country\": \"FR\",\n  \"tax_scheme\": \"reverse_charge\",\n  \"tax_territory\": \"FR\",\n  \"tax_rate_class\": \"standard_rate\",\n  \"customer_id\": \"cus_abc123def456\",\n  \"coupon_id\": \"cpn_abc123def456\",\n  \"client_provider_id\": \"clp_abc123def456\",\n  \"payment_method_type\": \"card\",\n  \"bank_account_id\": \"bac_abc123def456\",\n  \"invoice_type\": \"invoice\",\n  \"interval_period\": \"months\",\n  \"interval_count\": 1,\n  \"custom_properties\": {\n    \"fee_type\": \"service\"\n  }\n}"

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

{
  "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",
  "uncollectible_debit_ledger_account_id": "lac_abc123def456",
  "allowance_for_doubtful_accounts_id": "lac_abc123def456",
  "provider_fees_expense_ledger_account_id": "lac_abc123def456",
  "payment_processing_fees_expense_ledger_account_id": "lac_abc123def456",
  "payment_processing_fees_revenue_ledger_account_id": "lac_abc123def456",
  "customer_credits_ledger_account_id": "lac_abc123def456",
  "rev_rec_method": "over_time",
  "rev_rec_granularity": "month",
  "rev_rec_point_in_time_basis": "service_end_date",
  "discount_recognition_method": "deferred",
  "journal_id": "jou_abc123def456",
  "trace": [
    {
      "rule_id": "arl_abc123def456",
      "applied_fields": [
        "revenueLedgerAccountId"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

ledger_id

string

required

Identifier of the ledger this rule belongs to.

Example:

"led_abc123def456"

category

enum<string>

required

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

Available options:

invoice_posted,

invoice_settled,

revenue_recognition,

credit_note_created,

accounting_software

Example:

"accounting_software"

product_id

string

Product ID to resolve against.

Example:

"prod_abc123def456"

product_type

enum<string>

Product type to resolve against.

Available options:

flat_fee,

dynamic,

addon,

seat,

one_off,

credit,

bundle

Example:

"flat_fee"

currency

enum<string>

Currency code to resolve against.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

XOF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

country

enum<string>

Country code to resolve against.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BF,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ES-CE,

ES-ML,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

IC,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PT-20,

PT-30,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"FR"

tax_scheme

enum<string>

Tax scheme to resolve against.

Available options:

standard,

reverse_charge,

exempt,

not_eligible,

manual

Example:

"reverse_charge"

tax_territory

enum<string>

Tax territory country code to resolve against.

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BF,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ES-CE,

ES-ML,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

IC,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PT-20,

PT-30,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"FR"

tax_rate_class

enum<string>

Tax rate class to resolve against.

Available options:

standard_rate,

reduced_rate,

reduced_rate_alt,

super_reduced_rate,

parking_rate,

exempt,

reverse_charge

Example:

"standard_rate"

customer_id

string

Customer ID to resolve against.

Example:

"cus_abc123def456"

coupon_id

string

Coupon ID to resolve against.

Example:

"cpn_abc123def456"

client_provider_id

string

Client provider ID to resolve against.

Example:

"clp_abc123def456"

payment_method_type

enum<string>

Payment method type to resolve against.

Available options:

card,

transfer,

transfer_automated,

direct_debit,

direct_debit_ach,

direct_debit_bacs,

apple_pay,

google_pay,

paypal,

stripe_link,

external

Example:

"card"

bank_account_id

string

Bank account ID to resolve against.

Example:

"bac_abc123def456"

invoice_type

enum<string>

Invoice kind to resolve against. Accepts invoice or document; any other invoice kind is matched as invoice.

Available options:

invoice,

document

Example:

"invoice"

interval_period

enum<string>

Billing interval period filter (months, years, etc.).

Available options:

days,

weeks,

quarters,

months,

years,

once,

all

Example:

"months"

interval_count

number

Billing interval count filter.

Example:

1

custom_properties

object

Invoice custom property values to resolve against, keyed by custom property slug. Unknown slugs and null values are ignored. Rules with custom property filters never match without them.

Show child attributes

Example:

{ "fee_type": "service" }

Response

200 - application/json

revenue_ledger_account_id

string | null

required

Revenue ledger account ID used for invoice line revenue routing.

Example:

"lac_abc123def456"

deferred_revenue_ledger_account_id

string | null

required

Deferred revenue ledger account ID used before revenue is recognized.

Example:

"lac_abc123def456"

deferred_discount_ledger_account_id

string | null

required

Deferred discount ledger account ID used before discounts are recognized.

Example:

"lac_abc123def456"

contra_revenue_ledger_account_id

string | null

required

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

Example:

"lac_abc123def456"

discount_ledger_account_id

string | null

required

Discount ledger account ID used for recognized discounts.

Example:

"lac_abc123def456"

ar_ledger_account_id

string | null

required

Accounts receivable ledger account ID used for invoice posting.

Example:

"lac_abc123def456"

cash_ledger_account_id

string | null

required

Cash ledger account ID used for payment settlement.

Example:

"lac_abc123def456"

payments_clearing_ledger_account_id

string | null

required

Payments clearing ledger account ID used while payments settle.

Example:

"lac_abc123def456"

output_tax_ledger_account_id

string | null

required

Output tax ledger account ID used for tax liability.

Example:

"lac_abc123def456"

uncollectible_debit_ledger_account_id

string | null

required

Ledger account ID debited when an invoice becomes uncollectible. Use an asset account for doubtful-receivable reclassification or an expense account for direct write-off.

Example:

"lac_abc123def456"

allowance_for_doubtful_accounts_id

string | null

required

Allowance for doubtful accounts ledger account ID, set on credit_note_created rules.

Example:

"lac_abc123def456"

provider_fees_expense_ledger_account_id

string | null

required

Expense ledger account ID debited for payment provider fees when a payment settles.

Example:

"lac_abc123def456"

payment_processing_fees_expense_ledger_account_id

string | null

required

Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over provider_fees_expense_ledger_account_id when set by the same or a higher priority rule.

Example:

"lac_abc123def456"

payment_processing_fees_revenue_ledger_account_id

string | null

required

Payment processing fees revenue ledger account ID, set on invoice_settled rules.

Example:

"lac_abc123def456"

customer_credits_ledger_account_id

string | null

required

Customer credits ledger account ID used for credit balances.

Example:

"lac_abc123def456"

rev_rec_method

enum<string> | null

required

Revenue recognition method.

Available options:

none,

point_in_time,

over_time,

usage_based,

milestone,

manual

Example:

"over_time"

rev_rec_granularity

enum<string> | null

required

Recognition period granularity. Used when rev_rec_method is over_time.

Available options:

day,

month,

quarter,

year

Example:

"month"

rev_rec_point_in_time_basis

enum<string> | null

required

Date revenue is recognized on. Used when rev_rec_method is point_in_time.

Available options:

invoice_date,

service_start_date,

service_end_date,

custom_date

Example:

"service_end_date"

discount_recognition_method

enum<string> | null

required

Method used to recognize discounts.

Available options:

immediate,

deferred,

use_net_amount

Example:

"deferred"

journal_id

string | null

required

Journal ID used to route entries in the accounting provider.

Example:

"jou_abc123def456"

trace

object[]

required

Trace of which rules contributed which resolved fields.

Show child attributes

⌘I