Податки

Список податків

Отримати список податків

GET /api/taxes{?active,order,offset,limit,unprotect_keys}

Отримання всіх записів

Параметри
Параметр	Тип	Обов’язковий	Опис
`active`	string	ні	Якщо параметр дорівнює “true”, то повертаються лише активні записи.
`order`	string	ні	Список полів сортування через кому без пробілів
`offset`	integer	ні	Повертати дані, починаючи з указаного номера запису
`limit`	integer	ні	Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_tax": 1,
    "rate_tax": 0,
    "name_tax": "Без НДС",
    "id_group_tax": 1,
    "active": true
  }
]

Додати податок

POST /api/taxes{?active,order,offset,limit,unprotect_keys}

Додавання нового податку. Атрибут id_tax у JSON запиту стандартно ігнорується.

Параметри
Параметр	Тип	Обов’язковий	Опис
`unprotect_keys`	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

Content-Type: application/json

Тіло запиту:

{
  "id_tax": 1,
  "rate_tax": 0,
  "name_tax": "Без НДС",
  "id_group_tax": 1,
  "active": true
}

Відповідь 200 (application/json)

{
  "id_tax": 1,
  "rate_tax": 0,
  "name_tax": "Без НДС",
  "id_group_tax": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_tax": {
      "type": "number"
    },
    "rate_tax": {
      "type": "number"
    },
    "name_tax": {
      "type": "string"
    },
    "id_group_tax": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_tax",
    "rate_tax",
    "name_tax",
    "id_group_tax",
    "active"
  ]
}

Кількість податків

Отримати кількість податків

GET /api/taxes/count{?active}

Повертає кількість записів

Параметри
Параметр	Тип	Обов’язковий	Опис
`active`	string	ні	Якщо параметр дорівнює “true”, то враховуються лише активні записи.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}

Податок

Отримати дані про податок

GET /api/taxes/{id_tax}{?unprotect_keys}

Отримання запису за кодом

Параметри
Параметр	Тип	Обов’язковий	Опис
`id_tax`	integer	так	Код податку
`unprotect_keys`	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Відповідь 200 (application/json)

{
  "id_tax": 1,
  "rate_tax": 0,
  "name_tax": "Без НДС",
  "id_group_tax": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_tax": {
      "type": "number"
    },
    "rate_tax": {
      "type": "number"
    },
    "name_tax": {
      "type": "string"
    },
    "id_group_tax": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_tax",
    "rate_tax",
    "name_tax",
    "id_group_tax",
    "active"
  ]
}

Змінити дані про податок

PUT /api/taxes/{id_tax}{?unprotect_keys}

Зміна даних про податок. Атрибут id_tax у JSON запиту ігнорується.

Параметри
Параметр	Тип	Обов’язковий	Опис
`id_tax`	integer	так	Код податку
`unprotect_keys`	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

Content-Type: application/json

Тіло запиту:

{
  "id_tax": 1,
  "rate_tax": 0,
  "name_tax": "Без НДС",
  "id_group_tax": 1,
  "active": true
}

Відповідь 200 (application/json)

{
  "id_tax": 1,
  "rate_tax": 0,
  "name_tax": "Без НДС",
  "id_group_tax": 1,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_tax": {
      "type": "number"
    },
    "rate_tax": {
      "type": "number"
    },
    "name_tax": {
      "type": "string"
    },
    "id_group_tax": {
      "type": "number"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_tax",
    "rate_tax",
    "name_tax",
    "id_group_tax",
    "active"
  ]
}

Деактивувати дані про податок

DELETE /api/taxes/{id_tax}{?unprotect_keys}

Параметри
Параметр	Тип	Обов’язковий	Опис
`id_tax`	integer	так	Код податку
`unprotect_keys`	string	ні	Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Відповідь 204

Список груп податкових ставок

Отримати список груп податкових ставок

GET /api/groupsTaxes{?active,order,offset,limit}

Отримати список усіх груп податкових ставок

Параметри
Параметр	Тип	Обов’язковий	Опис
`active`	string	ні	Якщо параметр дорівнює “true”, то повертаються лише активні записи.
`order`	string	ні	Список полів сортування через кому без пробілів
`offset`	integer	ні	Повертати дані, починаючи з указаного номера запису
`limit`	integer	ні	Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_group_tax": 1,
    "name_group_tax": "A"
  }
]

Додати групу податкових ставок

POST /api/groupsTaxes{?active,order,offset,limit}

Додавання нової групи податкових ставок.

Атрибут id_group_tax у JSON запиту ігнорується (значення буде встановлено автоматично), якщо не вказано параметр unprotect_keys=true

Заголовки запиту:

Content-Type: application/json

Тіло запиту:

{
  "id_group_tax": 1,
  "name_group_tax": "A"
}

Відповідь 200 (application/json)

{
  "id_group_tax": 1,
  "name_group_tax": "A"
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group_tax": {
      "type": "number"
    },
    "name_group_tax": {
      "type": "string"
    }
  },
  "required": [
    "id_group_tax",
    "name_group_tax"
  ]
}

Кількість груп податкових ставок

Отримати кількість податків

GET /api/groupsTaxes/count{?active}

Повертає кількість записів

Параметри
Параметр	Тип	Обов’язковий	Опис
`active`	string	ні	Якщо параметр дорівнює “true”, то враховуються лише активні записи.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}

Група податкових ставок

Отримати дані про групу податкових ставок

GET /api/groupsTaxes/{id_group_tax}

Отримання запису за кодом

Параметри
Параметр	Тип	Обов’язковий	Опис
`id_group_tax`	integer	так	Код групи податкових ставок

Відповідь 200 (application/json)

{
  "id_group_tax": 1,
  "name_group_tax": "A"
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group_tax": {
      "type": "number"
    },
    "name_group_tax": {
      "type": "string"
    }
  },
  "required": [
    "id_group_tax",
    "name_group_tax"
  ]
}

Змінити дані про групу податкових ставок

PUT /api/groupsTaxes/{id_group_tax}

Зміна групи податкових ставок.

Атрибут id_group_tax у JSON запиту ігнорується, якщо не вказано параметр unprotect_keys=true

Параметри
Параметр	Тип	Обов’язковий	Опис
`id_group_tax`	integer	так	Код групи податкових ставок

Заголовки запиту:

Content-Type: application/json

Тіло запиту:

{
  "id_group_tax": 1,
  "name_group_tax": "A"
}

Відповідь 200 (application/json)

{
  "id_group_tax": 1,
  "name_group_tax": "A"
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_group_tax": {
      "type": "number"
    },
    "name_group_tax": {
      "type": "string"
    }
  },
  "required": [
    "id_group_tax",
    "name_group_tax"
  ]
}

Деактивувати дані про групу податкових ставок

DELETE /api/groupsTaxes/{id_group_tax}

Параметри
Параметр	Тип	Обов’язковий	Опис
`id_group_tax`	integer	так	Код групи податкових ставок