Создание корректировки

Метод Create correction используется для создания корректировки для указанного клиента с возможностью включить ее в акт. Этот метод может использоваться для автоматизации учета в 1С оплат по платежам, отмененным или оплаченным с баланса клиента (вместе с Подтверждение или отклонение корректировки). Корректировка может быть создана для клиента текущего реселлера и любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

POST {base_url}/api/v3/resellers/{reseller_id}/corrections

{
    "data": {
        "attributes": {
            "account_id" : {account_id},
            "included_invoice" : {included_invoice},
            "subscription_id" : {subscription_id},
            "period_from" : "{period_from}",
            "period_to" : "{period_to}",
            "total" : "{total}",
            "comment" : "{comment}"
        }
    }
}

Аргументы

Название			Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token			header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type			header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept			header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url			path	string	Обязательный	URL ActivePlatform
reseller_id			path	integer	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
data			form	object	Обязательный	Информация об атрибутах операции
	attributes		form	object	Обязательный	Атрибуты операции
		account_id	form	integer	Обязательный	ID клиента, для которого производится корректировка
		included_invoice	form	bool	Обязательный	Необходимость включения корректировки в акт: true — корректировку необходимо включить в акт. false — корректировку не нужно включать в акт.
		subscription_id	form	integer	Опциональный	ID подписки, по которой производится корректировка. Обязательный, если `included_invoice = true`
		period_from	form	string	Опциональный	Дата начала периода, за который производится корректировка (ГГГГ-ММ-ДД). Обязательный, если `included_invoice = true` Этот период используется только для информирования клиента и не влияет на то, в акт за какой период попадет корректировка. корректировка всегда включается в акт за тот финансовый период, в котором она была подтверждена.
		period_to	form	string	Опциональный	Дата окончания периода, за который производится корректировка (ГГГГ-ММ-ДД). Обязательный, если `included_invoice = true`
		total	form	string	Обязательный	Сумма корректировки: Если корректировка связана с подпиской по модели Постоплата, положительная сумма увеличивает текущую задолженность по подписке, а отрицательная — уменьшает ее (см. Подтверждение корректировки). В остальных случаях положительная сумма увеличивает баланс клиента, а отрицательная — уменьшает его.
		comment	form	string	Опциональный	Комментарий сотрудника к корректировке

Модель ответа

В случае отсутствия ошибок метод возвращает данные о созданной корректировке. Статус ответа: 201 Created.

Название			Тип данных	Описание
data			object	Данные ответа
	id		string	ID корректировки
	type		string	Тип данных
	attributes		object	Информация о корректировке
		created_at	string	Дата и время создания корректировки
		updated_at	string	Дата и время последнего обновления корректировки
		account_id	integer	ID клиента, для которого производится корректировка
		manager_id	integer	ID сотрудника, который создал корректировку
		status	string	Текущий статус корректировки: approval_required — корректировка создана, но не подтверждена. approved — корректировка подтверждена. declined — корректировка отклонена.
		total	string	Сумма корректировки
		included_invoice	bool	Признак включения корректировки в акт: true — корректировка включается в акт. false — корректировка не включается в акт.
		subscription_id	integer	ID подписки, по которой произведена корректировка, если `included_invoice = true`
		period_from	string	Дата начала периода, за который производится корректировка (ГГГГ-ММ-ДД), если `included_invoice = true`
		period_to	string	Дата окончания периода, за который производится корректировка (ГГГГ-ММ-ДД), если `included_invoice = true`
		сomment	string	Комментарий сотрудника к корректировке
		approved_at	string	Дата подтверждения корректировки (ГГГГ-ММ-ДД)

Пример запроса

POST /api/v3/resellers/1/corrections
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "data": {
        "attributes": {
            "account_id" : 710,
            "included_invoice" : true,
            "subscription_id" : 3008954,
            "period_from" : "2021-12-01",
            "period_to" : "2021-12-31",
            "total" : "100.25",
            "comment" : "top-up payment"
        }
    }
}

Пример ответа

{
    "data": {
        "id": "738",
        "type": "corrections",
        "attributes": {
            "created_at": "2021-08-10T12:18:42.721974+0300",
            "updated_at": "2021-08-10T12:18:42.721974+0300",
            "account_id": 710,
            "manager_id": 225,
            "status": "approval_required",
            "total": "100.25",
            "included_invoice": true,
            "subscription_id": 3008954,
            "period_from": "2021-12-01",
            "period_to": "2021-12-31",
            "comment": "top-up payment",
            "approved_at": null
        }
    }
}