Companies

In the Retail Ops environment, the Company (aka Master Franchise) is the level of settings generally corresponding with a Brand in the context of a given Country. A Company can be assigned many settings.

---

Company methods

Currency list

Returns a list of all available currencies for the company.

Method

GET	/api/externals/v1/companies/currencies

Arguments

• winLangID (long): Windows Language Identifier of the resulting data

Body

(none)

Response

{
  "currencies": [
    {
      "id": long,
      "rate": long,
      "precision": long,
      "symbol": string,
      "accountancyCode": string,
      "isoCode": string,
      "hasDecimals": boolean,
      "isRateCompanySpecific": boolean
    }
  ],
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Currencies

Name	Comment
id	ID of the currency
rate	Exchange rate relative to Euro
precision	Number of decimal places. If 0 then "123", if 1 then "123.4", if 2 then "123.45", ...
symbol	Symbol of the currency (€, $, £, ...)
accountancyCode	Accountancy code of the currency (E for €, D for $, BP for £, ...)
isoCode	Three-letter ISO code for the currency (EUR for €, USD for $, GBP for £, ...)
hasDecimals	If the currency has decimals then true
isRateCompanySpecific	If the currency rate is defined for your company then true

---

Tax list

Returns a list of all available taxes for the company.

Method

GET	/api/externals/v1/companies/taxes

Arguments

• winLangID (long): Windows Language Identifier of the resulting data

Body

(none)

Response

{
  "tax1": [
    { 
      "code": string, 
      "description": string,
      "rate": long,
    }
  ],
  "tax2": [
    { 
      "isReduceRate": boolean,
      "code": string, 
      "description": string,
      "rate": long,
    }
  ],
  "tax3": [
    {
      "code": string, 
      "description": string,
      "rate": long,
    }
  ],
  "taxSettings": {
    "useTax1": boolean,
    "useTax2": boolean,
    "useTax3": boolean,
    "useElectronicWasteTax": boolean,
    "useEcoParticipationTax": boolean,
    "isTax3BasedOnPriceBeforeTaxes": boolean
  },
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Taxes

Name	Comment
tax1	Parafiscal tax
tax2	VAT
tax3	Additional tax that can be computed on the result of the previous taxes or directly on the base price
taxX.code	Code of the taxX
taxX.description	Description of the taxX. Ex: "VAT 20%" for the tax2
taxX.rate	Percentage rate of the taxX. Ex: 20 corresponds to 20%
tax2.isReduceRate	true if the tax2 has a reduced rate. Ex: 10% instead of 20%
taxSettings.useTaxX	true if the company uses the taxX
taxSettings.useElectronicWasteTax	true if the company uses the Electronic Waste tax
taxSettings.useEcoParticipationTax	true if the company uses the Eco Participation tax
taxSettings.isTax3BasedOnPriceBeforeTaxes	Tax3 Computation rule. true if the tax3 is computed directly from the base price.