Skip to main content

List price lists

GET 
/api/price-lists

Required permissions:

  • pricelist.view: allows view resources of price lists.

Here the dedicated support page.

Request​

Query Parameters

    limit integer

    Possible values: <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of price lists.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    created_at date-timerequired
    updated_at date-timerequired
    name stringrequired

    The price list name

    description string

    The price list description

    available_from date

    The date from which the price list is available. This follows the YYYY-MM-DD format

    available_to date

    The date until which the price list is available. This follows the YYYY-MM-DD format

    is_default_for_client booleanrequired

    Whether this is the default price list for the client

    is_default_for_company booleanrequired

    Whether this is the default price list for the company

    uses_default_price_list_costs booleanrequired

    Whether to sync costs with company default price list

    client_id integer

    Possible values: >= 1

    ID of the client to associate with this employee

  • ]

Loading...