Перейти до головного контенту

Отримати статус документа​

URI: /external/documents/:id?api_token={{api_token}}

Використовується для отримання статусу документа.

Запит виконується методом GET у json форматі з даними.

Параметри URI​

Метод дозволяє передати наступні параметри:

/external/documents/:id?api_token={{api_token}}, де:

  • api_token — токен авторизації компанії;
  • id — ідентифікатор документа.

Приклад запиту​

⚠️ Запит повинен містити заголовок Accept: application/json

json title="Запит: /external/documents/:3?api_token=12ejh124gvhjv12h41jh241d1df

Параметри відповіді​

Ім'яТипОпис
statusobjectПоточний статус документа (STATUS_PENDING, STATUS_COMPLETED, STATUS_REJECTED)

Приклад успішної відповіді​

200 OK

У відповідь ви отримаєте поточний статус документа:

  • STATUS_PENDING - очікує підпису однією зі сторін;
  • STATUS_COMPLETED - повністю підписаний;
  • STATUS_REJECTED - відхилений контрагентом.
Відповідь: /external/documents/:3?api_token=12ejh124gvhjv12h41jh241d1df
{
    "status": "STATUS_COMPLETED"
}

Приклад неуспішної відповіді​

404 Not Found

Документ не знайдено​

Відповідь: /external/documents/:3?api_token=12ejh124gvhjv12h41jh241d1df
{
    "message": "Document not found!"
}