The organization's control settings, with the defaults

GET

/organizations/current/control-settings

const url = 'https://api.invogi.com/v1/organizations/current/control-settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.invogi.com/v1/organizations/current/control-settings \
  --header 'Authorization: Bearer <token>'

Thresholds and per-finding actions that apply everywhere (common) plus a section per supported country (uk, uae). Every field has a default that reproduces the built-in behaviour. version names the policy decisions are made under: default-v1 for untouched settings, otherwise custom-; the settings behind each version are kept per organization so a decision can be reproduced.

Authorizations

bearerAuth

Responses

200

Effective settings, defaults and version

application/json

object

settings

required

Settings for the deterministic controls. Percent-like values are fractions (0.05 = 5%) except VAT rates, which are percent.

object

common

object

duplicates

object

invoiceNumberSimilarityMin

number

>= 0.5 <= 1

amountNearMatchPct

number

<= 0.2

dateDistanceDaysMax

integer

<= 90

crossCurrencyAmountTolerancePct

number

<= 0.5

anomalies

object

minHistoryCount

integer

>= 2 <= 50

madMultiplier

number

>= 1 <= 10

purchaseOrders

object

unitPriceTolerancePct

number

<= 0.5

quantityTolerancePct

number

<= 0.5

fxTolerancePct

number

<= 0.2

actions

Finding type to OFF, INFORM, REVIEW or BLOCK. Absent keeps the built-in behaviour.

object

key

additional properties

string

Allowed values: OFF INFORM REVIEW BLOCK

object

enabled

boolean

vatNumberCheck

boolean

vatRateCheck

boolean

allowedVatRates

Array<number>

>= 1 items <= 8 items

missingVatNumberCheck

boolean

companyRegister

object

unchecked

string

Allowed values: NEW_SUPPLIERS ALWAYS INFORM_ONLY

requireCompanyNumber

boolean

uae

object

enabled

boolean

trnCheck

boolean

vatRateCheck

boolean

allowedVatRates

Array<number>

>= 1 items <= 8 items

missingTrnCheck

boolean

defaults

required

Settings for the deterministic controls. Percent-like values are fractions (0.05 = 5%) except VAT rates, which are percent.

object

common

object

duplicates

object

invoiceNumberSimilarityMin

number

>= 0.5 <= 1

amountNearMatchPct

number

<= 0.2

dateDistanceDaysMax

integer

<= 90

crossCurrencyAmountTolerancePct

number

<= 0.5

anomalies

object

minHistoryCount

integer

>= 2 <= 50

madMultiplier

number

>= 1 <= 10

purchaseOrders

object

unitPriceTolerancePct

number

<= 0.5

quantityTolerancePct

number

<= 0.5

fxTolerancePct

number

<= 0.2

actions

Finding type to OFF, INFORM, REVIEW or BLOCK. Absent keeps the built-in behaviour.

object

key

additional properties

string

Allowed values: OFF INFORM REVIEW BLOCK

object

enabled

boolean

vatNumberCheck

boolean

vatRateCheck

boolean

allowedVatRates

Array<number>

>= 1 items <= 8 items

missingVatNumberCheck

boolean

companyRegister

object

unchecked

string

Allowed values: NEW_SUPPLIERS ALWAYS INFORM_ONLY

requireCompanyNumber

boolean

uae

object

enabled

boolean

trnCheck

boolean

vatRateCheck

boolean

allowedVatRates

Array<number>

>= 1 items <= 8 items

missingTrnCheck

boolean

version

required

string

Example

{
  "settings": {
    "common": {
      "actions": {
        "additionalProperty": "OFF"
      }
    },
    "uk": {
      "companyRegister": {
        "unchecked": "NEW_SUPPLIERS"
      }
    }
  },
  "defaults": {
    "common": {
      "actions": {
        "additionalProperty": "OFF"
      }
    },
    "uk": {
      "companyRegister": {
        "unchecked": "NEW_SUPPLIERS"
      }
    }
  }
}