Обновление информации о закрывающем документе

Метод Update closing document используется для обновления информации о закрывающем документе клиента текущего реселлера или любого из его нижестоящих реселлеров.

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

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

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

PATCH {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices/{external_invoice_id}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathnumberОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
account_idpathnumberОбязательныйID клиента

external_invoice_id

pathnumberОбязательныйID закрывающего документа в платформе
keyformstringОбязательныйGUID закрывающего документа во внешней системе
typeformstringОбязательный

Тип отправляемого документа. Возможные значения:

  • invoice — счет.
  • invoice_vat — счет-фактура.
  • act — акт.
nameformstringОбязательныйНазвание закрывающего документа
amountformobjectОбязательныйИнформация о сумме и валюте закрывающего документа во внешней системе

totalformstringОбязательныйСумма закрывающего документа во внешней системе в денежном формате. Может быть отрицательной или равной 0. Пример: 123.45

currencyformstringОбязательныйISO-код валюты закрывающего документа во внешней системе. Можно указать код любой валюты в платформе (см. Получение списка курсов валют)
start_dateformstringОбязательныйДата начала финансового периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД
end_dateformstringОбязательныйДата окончания финансового периода, за который выставлен закрывающий документ, в формате ГГГГ-ММ-ДД
fileformstringОбязательный

Закрывающий документ в кодировке base64 с указанием MIME-типа данных (см. Список MIME-типов). Поддерживаются следующие форматы файлов:

  • DOC.
  • PDF.
  • XLSX.

Максимальный размер отправляемого файла закрывающего документа зависит от настроек конкретной инсталляции и может быть изменен по обращению в службу технической поддержки.

Формат данных:

data:<MIME-тип данных>;base64,'содержимое в кодировке base64'

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

В случае отсутствия ошибок метод возвращает информацию о закрывающем документе (см. модель ответа в Получение информации о закрывающем документе).

Ошибки

СтатусТекст ошибкиКомментарий
400Параметр "total" содержит неподдерживаемый форматЗначение в аргументе total должно быть в денежном формате. Пример: 123.45
Параметр "currency" содержит валюту, не поддерживаемую реселлеромУказанный код валюты currency не найден для реселлера. Доступные коды валют см. в Получение списка курсов валют
500Internal Server Error

В запросе неверно указан аргумент file:

  • Отсутствует запятая перед содержимым файла.
  • Не удается установить MIME-тип ни по содержимому файла, ни указанному типу.

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

PATCH /api/v3/resellers/1/accounts/505/external_invoices/11
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
    "key": "0493e78a-e8ef-11e9-81b4-2a2ae2dbcce4",
    "type": "invoice",
    "name": "New invoice",
    "amount": {
        "total": "123.45",
        "currency": "EUR"
    },
    "start_date": "2019-09-01",
    "end_date": "2019-10-01",
    "file": "data:application/pdf;base64,'SSBob2xkIHRoZSBwb3NpdGlvbiBvZiBhIHFhIGVuZ2luZWVyLiBRQSBlbmdpbmVlciByZXNwb25zaWJpbGl0aWVzIGluY2x1ZGUgZGVzaWduaW5nIGFuZCBpbXBsZW1lbnRpbmcgdGVzdHMsIGRlYnVnZ2luZyBhbmQgZGVmaW5pbmcgY29ycmVjdGl2ZSBhY3Rpb25zLiBJIGFsc28gcmV2aWV3IHN5c3RlbSByZXF1aXJlbWVudHMgYW5kIHRyYWNrIHF1YWxpdHkgYXNzdXJhbmNlIG1ldHJpY3MgKGUuZy4gZGVmZWN0IGRlbnNpdGllcyBhbmQgb3BlbiBkZWZlY3QgY291bnRzLikgVGhlIFFBIHRlY2huaWNpYW4gcm9sZSBwbGF5cyBhbiBpbXBvcnRhbnQgcGFydCBpbiBvdXIgY29tcGFueeKAmXMgcHJvZHVjdCBkZXZlbG9wbWVudCBwcm9jZXNzLg=='"
}

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

{
    "data": {
        "id": "11",
        "type": "external_invoices",
        "attributes": {
            "created_at": "2019-10-18T13:45:38.333297+0300",
            "updated_at": "2019-10-18T13:45:38.333297+0300",
            "key": "0493e78a-e8ef-11e9-81b4-2a2ae2dbcce4",
            "name": "New invoice",
            "amount": {
                "total": "123.45",
                "currency": "EUR"
            },
            "start_date": "2019-09-01",
            "end_date": "2019-10-01",
            "file": "data:application/pdf;base64,SSBob2xkIHRoZSBwb3NpdGlvbiBvZiBhIHFhIGVuZ2luZWVyLiBRQSBlbmdp\nbmVlciByZXNwb25zaWJpbGl0aWVzIGluY2x1ZGUgZGVzaWduaW5nIGFuZCBp\nbXBsZW1lbnRpbmcgdGVzdHMsIGRlYnVnZ2luZyBhbmQgZGVmaW5pbmcgY29y\ncmVjdGl2ZSBhY3Rpb25zLiBJIGFsc28gcmV2aWV3IHN5c3RlbSByZXF1aXJl\nbWVudHMgYW5kIHRyYWNrIHF1YWxpdHkgYXNzdXJhbmNlIG1ldHJpY3MgKGUu\nZy4gZGVmZWN0IGRlbnNpdGllcyBhbmQgb3BlbiBkZWZlY3QgY291bnRzLikg\nVGhlIFFBIHRlY2huaWNpYW4gcm9sZSBwbGF5cyBhbiBpbXBvcnRhbnQgcGFy\ndCBpbiBvdXIgY29tcGFueeKAmXMgcHJvZHVjdCBkZXZlbG9wbWVudCBwcm9j\nZXNzLg==\n",
            "type": "invoice"
        }
    }
}