Get a price list

GET 
/api/price-lists/:id

Required permissions:

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

Here the dedicated support page.

Request

Path Parameters

id integerrequired

The ID of the price list to view

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested price list.

application/json

Schema

Schema

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

Example (from schema)

{
  "id": 1,
  "created_at": "2025-04-22T10:10:03.010Z",
  "updated_at": "2025-04-22T10:10:03.010Z",
  "name": "string",
  "description": "string",
  "available_from": "2025-04-22",
  "available_to": "2025-04-22",
  "is_default_for_client": true,
  "is_default_for_company": true,
  "uses_default_price_list_costs": true,
  "client_id": 1
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "message": "string"
}

Loading...