Payment type

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

POST /payment-type/create

This method allows adding payment-type into the account.

Тело запроса

Поле	Тип	Обязательно	Описание
name	string	Да
parent_id	string	Нет
transaction_type	string	Нет	Допустимые значения: income, expense, transfer, exchange, nothing, exchange_method. По умолчанию: "income"
user_type	string	Нет	Допустимые значения: supplier, employee, customer, person, other. По умолчанию: "supplier"
can_be_canceled	boolean	Нет	По умолчанию: false

{
  "name": "string",
  "parent_id": "67b486d242ed76693cd2cc59",
  "transaction_type": "income",
  "user_type": "supplier",
  "can_be_canceled": false
}

Ответ

Поле	Тип	Описание
_id	string
name	string
short_cut	string
type	string	Допустимые значения: cash, card, debt, gift, transfer, terminal, by_balance, by_cashback
is_enabled	boolean	По умолчанию: true
is_default	boolean	По умолчанию: false
is_visible	boolean	По умолчанию: false
created_at	string (date-time)
updated_at	string (date-time)

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "name": "string",
    "short_cut": "string",
    "type": "cash",
    "is_enabled": true,
    "is_default": false,
    "is_visible": false,
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": "2025-05-01T12:00:00Z"
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /payment-type/update

This method allows updating payment-type in the account.

Тело запроса

Поле	Тип	Обязательно	Описание
_id	string	Да
name	string	Да
parent_id	string	Нет
transaction_type	string	Нет	Допустимые значения: income, expense, transfer, exchange, nothing, exchange_method. По умолчанию: "income"
user_type	string	Нет	Допустимые значения: supplier, employee, customer, person, other. По умолчанию: "supplier"
can_be_canceled	boolean	Нет	По умолчанию: false

{
  "_id": "67b486d242ed76693cd2cc59",
  "name": "string",
  "parent_id": "67b486d242ed76693cd2cc59",
  "transaction_type": "income",
  "user_type": "supplier",
  "can_be_canceled": false
}

Ответ

Структура ответа совпадает с POST /payment-type/create.

DELETE /payment-type/delete/{id}

Delete a payment-type

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

POST /payment-type/get-all

Get all payment-types

Тело запроса

Поле	Тип	Обязательно	Описание
transaction_type	string	Нет	Допустимые значения: income, expense, transfer, exchange, nothing, exchange_method
user_type	string	Нет	Допустимые значения: supplier, employee, customer, person, other
is_visible	boolean	Нет	По умолчанию: false
is_active	boolean	Нет	По умолчанию: true
search	string	Нет

{
  "transaction_type": "income",
  "user_type": "supplier",
  "is_visible": false,
  "is_active": true,
  "search": "string"
}

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    {
      "_id": "string",
      "name": "string",
      "short_cut": "string",
      "type": "cash",
      "is_enabled": true,
      "is_default": false,
      "is_visible": false,
      "created_at": "2025-05-01T12:00:00Z",
      "updated_at": "2025-05-01T12:00:00Z"
    }
  ],
  "time": "2025-05-01T12:00:00Z"
}

GET /payment-type/get-by-id/{id}

Get payment-type using its _id

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /payment-type/create.

GET /payment-type/get-deleted

Get deleted payment-type ids

Параметры запроса

Параметр	Тип	Обязательно	Описание
deleted_at	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

PUT /payment-type/set-state

This method allows setActive payment-type in the account.

Тело запроса

Поле	Тип	Обязательно	Описание
is_active	boolean	Да	По умолчанию: true
_id	string	Да

{
  "is_active": true,
  "_id": "67b486d242ed76693cd2cc59"
}

Ответ

Структура ответа совпадает с POST /payment-type/create.

---

Эта страница сгенерирована из спецификации OpenAPI.