Skip to main content

List taxes

GET 
/v2/taxes

List taxes

Request​

Query Parameters

    page any

    Pagination page number

    Example: 1
    offset any

    Pagination offset number

    Example: 12
    shopId integer

    Shop identifier for the tax to apply to

    Example: 1
    code string

    Possible values: [H, L, N]

    Tax code

    zone string

    Tax zone

    Example: NL
    createdAtGreaterThan date-time

    Search by date created greater than

    Example: 2314-03-14T03:14:15.926Z
    createdAtLessThan date-time

    Search by date created less than

    Example: 2314-03-14T03:14:15.926Z
    lastModifiedAtGreaterThan date-time

    Search by date updated greater than

    Example: 2314-03-14T03:14:15.926Z
    lastModifiedAtLessThan date-time

    Search by date updated less than

    Example: 2314-03-14T03:14:15.926Z
    sortField string

    Possible values: [id, shopId, code, zone, percentage, exportCode, createdAt, lastModifiedAt]

    Default value: id

    Field to sort by

    sortOrder string

    Possible values: [asc, desc, asc, desc]

    Default value: asc

    Order option to sort by

Responses​

List taxes

Schema

  • Array [

    • id uuidrequired

    Possible values: >= 36 characters and <= 36 characters

    Tax primary identifier

    shopId integerrequired

    Shop identifier for the tax to apply to

    code stringnullable

    Possible values: [H, L, N]

    Tax code

    zone stringrequired

    Possible values: <= 2 characters

    Tax zone

    percentage decimalnullable

    Default value: 0

    Tax percentage

    exportCode stringnullable

    Possible values: <= 10 characters

    Tax export code

    createdAt date-timerequired

    Default value: CURRENT_TIMESTAMP

    Tax initial creation timestamp

    createdBy integernullable

    Reference to the user that created the tax initially

    lastModifiedAt date-timerequired

    Default value: CURRENT_TIMESTAMP

    Tax last update timestamp

    lastModifiedBy integernullable

    Reference to the user that last modified the tax

  • ]

Loading...