List tax codes

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

Query parameters

• sort string

  Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

  Available directions: asc, desc.

  Available fields: code, context, type, rate, country, status, createdAt.

• filter string

  Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

  Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

  Available fields: id, companyEntityId, code, sourceType, status, type, createdAt.

• searchTerm string

  Matches against the tax code's code or name

• limit integer · int32

  Maximum number of items to return. Default is 50, maximum is 200.

• cursor string

  The cursor position to start returning results from. Omit it, or provide 0, for the initial request. For subsequent requests, use nextCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually. This endpoint paginates by cursor only and has no offset parameter.

Response

• records array of object

  List of records for the current page

  • id string · uuid

    Unique identifier for the tax code. Documents reference it as taxCodeId

  • companyId string · uuid

    ID of the company

  • code string

    Short code of the tax code, unique within the company

  • name string

    Display name of the tax code

  • rate number

    Tax rate as a fraction: 0.25 is 25%. Null for an exempt tax code

  • type string

    Whether 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 PURCHASE SALES

  • status string

    Status of the tax code. DISABLED_EXTERNALLY is 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 ACTIVE DISABLED DISABLED_EXTERNALLY

  • sourceType string

    Where the tax code is maintained. SYNCED_EXTERNALLY means the code mirrors one in the company's ERP; INTERNAL means it was created in Light

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of INTERNAL SYNCED_EXTERNALLY

  • country string

    Country whose tax rules the tax code follows

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX 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 NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

  • taxCategory string

    Whether 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 GOODS SERVICES

  • edifactCode string

    Duty 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 AE E G K L M O S Z

  • context string

    Free-text guidance describing when the tax code applies

  • baseTaxTag object

    Tax tag the taxable base of a line with this tax code is reported under on the tax report

    • id string · uuid

      Unique identifier for the tax tag

    • label string

      Label of the tax tag, as it appears on the tax report

    • country string

      Country whose tax report the tax tag belongs to

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX 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 NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XI XU XK YE YT YU ZA ZM ZR ZW

  • companyEntityIds array of string · uuid

    Company entities the code may be used in

  • createdAt string · date-time

    Timestamp when the tax code was created

  • updatedAt string · date-time

    Timestamp when the tax code was last updated

• hasMore boolean

  Boolean flag indicating if there are more records available

• nextCursor string

  Cursor for fetching the next page

• prevCursor string

  Cursor for fetching the previous page