Import default tax codes
https://api.light.inc/v1/tax-codes/import-default-taxes
Imports the country's default tax codes and their tax tags, and assigns the codes to the requested company entities. A new code takes the status of its default code; activate a disabled one with updateTaxCode. A code the company already has is never changed: it is only assigned to the requested company entities it lacks, so running the import again creates nothing. Requires the company admin role.
Authorization
Send one of these on every request. See Authentication for how to get credentials.
- API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
- Bearer token
Request body
application/json;charset=UTF-8
-
countrystringrequiredCountry whose default tax codes are imported
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZW -
companyEntityIdsarray of string · uuidrequiredCompany entities the imported tax codes are assigned to
-
salesTaxAccountIdstring · uuidrequiredLedger account sales tax codes post their tax to. Must be assigned to every requested company entity
-
euSalesGoodsTaxAccountIdstring · uuidLedger account for tax on EU sales of goods. Defaults to
salesTaxAccountId. Must be assigned to every requested company entity -
euSalesServicesTaxAccountIdstring · uuidLedger account for tax on EU sales of services. Defaults to
salesTaxAccountId. Must be assigned to every requested company entity -
euSalesContraTaxAccountIdstring · uuidContra ledger account for EU sales. Defaults to
salesTaxAccountId. Must be assigned to every requested company entity -
purchaseTaxAccountIdstring · uuidrequiredLedger account purchase tax codes post their tax to. Must be assigned to every requested company entity
-
euPurchaseGoodsTaxAccountIdstring · uuidLedger account for tax on EU purchases of goods. Defaults to
purchaseTaxAccountId. Must be assigned to every requested company entity -
euPurchaseServicesTaxAccountIdstring · uuidLedger account for tax on EU purchases of services. Defaults to
purchaseTaxAccountId. Must be assigned to every requested company entity -
euPurchaseContraTaxAccountIdstring · uuidContra ledger account for EU purchases. Defaults to
purchaseTaxAccountId. Must be assigned to every requested company entity
Response
The country's tax codes assigned to the requested company entities, the new ones and the ones that already existed
-
idstring · uuidUnique identifier for the tax code. Documents reference it as
taxCodeId -
companyIdstring · uuidID of the company
-
codestringShort code of the tax code, unique within the company
-
namestringDisplay name of the tax code
-
ratenumberTax rate as a fraction:
0.25is 25%. Null for an exempt tax code -
typestringWhether the tax code applies to purchases (bills) or to sales (sales invoices)
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
PURCHASESALES -
statusstringStatus of the tax code.
DISABLED_EXTERNALLYis set by an ERP sync when the code was disabled in the ERP⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACTIVEDISABLEDDISABLED_EXTERNALLY -
sourceTypestringWhere the tax code is maintained.
SYNCED_EXTERNALLYmeans the code mirrors one in the company's ERP;INTERNALmeans it was created in Light⚠️ This enum is not exhaustive; new values may be added in the future.
One of
INTERNALSYNCED_EXTERNALLY -
countrystringCountry whose tax rules the tax code follows
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZW -
taxCategorystringWhether the tax code is for goods or for services. Null when not set
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
GOODSSERVICES -
edifactCodestringDuty or tax category code from the UNCL5305 code list, used on electronic invoices (https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/)
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
AEEGKLMOSZ -
contextstringFree-text guidance describing when the tax code applies
-
baseTaxTagobjectTax tag a tax code reports its taxable base or a posted share under on the tax report
-
idstring · uuidUnique identifier for the tax tag
-
labelstringLabel of the tax tag, as it appears on the tax report
-
countrystringCountry whose tax report the tax tag belongs to
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZW
-
-
postingRulesarray of object-
percentagenumberShare of the tax this rule posts, as a fraction:
1is all of it and-1reverses all of it -
accountIdstring · uuidLedger account the share is posted to. Null when the share is posted to the account of the line the tax code is used on
-
taxTagobjectTax tag a tax code reports its taxable base or a posted share under on the tax report
-
idstring · uuidUnique identifier for the tax tag
-
labelstringLabel of the tax tag, as it appears on the tax report
-
countrystringCountry whose tax report the tax tag belongs to
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZW
-
-
-
companyEntityIdsarray of string · uuidCompany entities the code may be used in
-
createdAtstring · date-timeTimestamp when the tax code was created
-
updatedAtstring · date-timeTimestamp when the tax code was last updated