Получение статуса зарплатной ведомости

Обновлено 20 февраля 2025

GET

/v1/payrolls/{externalId}/state

Запрос для получения статуса ранее отправленной зарплатной ведомости. Должен содержать токено доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

Для доступа к этому методу в параметре scope ссылки авторизации должно быть указано значение PAYROLL.

Request {#request}

Path Parameters

externalId
string
required
Внешний UUID зарплатной ведомости
Example: 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6

Header Parameters

Authorization
string
required
Access token организации-клиента, полученный через SSO
Example: f8ad3141-b7e8-4924-92de-3de4fd0a464e-1

Ответы

• 200
• 400
• 401
• 403
• 404
• 429
• 500
• 503

Успешный код возврата

• application/json

• Схема
• Пример из схемы

Schema

bankComment

string

Банковский комментарий к статусу документа

bankStatus

string

Статус документа

receiptStatus

string

Статус процесса обработки регистрации самозанятых в ФНС

{
  "bankComment": "Документ в обработке",
  "bankStatus": "PROCESSING",
  "receiptStatus": "FINISHED"
}

Ошибка в запросе или его жизненном цикле

• application/json

• Схема
• Пример из схемы

Schema

referenceId

string

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks object[]
Список проверок, приведших к ошибке
Array [
level
string
Уровень результата
message
string
Сообщение
]

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string"
    }
  ]
}

Не авторизован

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Запрещено

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Не найдено

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Превышен лимит запросов

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Внутренняя ошибка сервера

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Сервис временно недоступен

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Loading...

Loading...