Перейти к содержанию

price-lists

GET /api/price-lists

List Price Lists

Авторизация: Bearer Token

Query параметры:

Параметр Тип По умолчанию Описание
status Status
skip Skip 0
limit Limit 50

Response 200: Successful Response

Поле Тип Обязательное Описание
items array[object] нет
total Total нет

Ошибки:

Код Описание
422 Validation Error

POST /api/price-lists

Create Price List

Авторизация: Bearer Token

Request Body:

Поле Тип Обязательное Описание
name Name да
effective_date Effective Date да
description Description нет

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
name Name нет
description Description нет
status Status нет
effective_date Effective Date нет
created_by Created By нет
creator_name Creator Name нет
items_count Items Count нет
created_at Created At нет
updated_at Updated At нет
items array[object] нет

Ошибки:

Код Описание
422 Validation Error

GET /api/price-lists/current

Get Current Price List

Авторизация: Bearer Token

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
name Name нет
description Description нет
status Status нет
effective_date Effective Date нет
created_by Created By нет
creator_name Creator Name нет
items_count Items Count нет
created_at Created At нет
updated_at Updated At нет
items array[object] нет

GET /api/price-lists/{price_list_id}

Get Price List

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
price_list_id Price List Id

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
name Name нет
description Description нет
status Status нет
effective_date Effective Date нет
created_by Created By нет
creator_name Creator Name нет
items_count Items Count нет
created_at Created At нет
updated_at Updated At нет
items array[object] нет

Ошибки:

Код Описание
422 Validation Error

PUT /api/price-lists/{price_list_id}

Update Price List

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
price_list_id Price List Id

Request Body:

Поле Тип Обязательное Описание
name Name нет
effective_date Effective Date нет
description Description нет
items Items нет

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
name Name нет
description Description нет
status Status нет
effective_date Effective Date нет
created_by Created By нет
creator_name Creator Name нет
items_count Items Count нет
created_at Created At нет
updated_at Updated At нет
items array[object] нет

Ошибки:

Код Описание
422 Validation Error

DELETE /api/price-lists/{price_list_id}

Delete Price List

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
price_list_id Price List Id

Response 200: Successful Response

Нет данных

Ошибки:

Код Описание
422 Validation Error

POST /api/price-lists/{price_list_id}/activate

Activate Price List

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
price_list_id Price List Id

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
name Name нет
description Description нет
status Status нет
effective_date Effective Date нет
created_by Created By нет
creator_name Creator Name нет
items_count Items Count нет
created_at Created At нет
updated_at Updated At нет
items array[object] нет

Ошибки:

Код Описание
422 Validation Error

POST /api/price-lists/billing/report/excel

Export Billing Report Excel

Авторизация: Bearer Token

Request Body:

Поле Тип Обязательное Описание
date_from Date From да
date_to Date To да

Response 200: Successful Response

Нет данных

Ошибки:

Код Описание
422 Validation Error