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

Песочница

GET https://sandbox.alfabank.ru/api/jp/v1/salary-project/payroll/applications/{applicationId}

Пром

GET https://baas.alfabank.ru/api/jp/v1/salary-project/payroll/applications/{applicationId}

Scope

salary-project

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow H2H

stringrequired

application/json

PATH

Атрибут

Описание

applicationId

stringrequired

Внешний ID запроса

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

Язык

1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/salary-project/payroll/applications/{applicationId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

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

Пример ответа 200 (OK)

1{
2  "applicationId": "7421w6f13a01983593e8dffb71fa6d15",
3  "applicationCreatedAt": "2000-01-23T04:56:07.000+00:00",
4  "originalMessage": {
5    "id": "7421w6f13a01983593e8dffb71fa6d15",
6    "createdAt": "2000-01-23T04:56:07.000+00:00",
7    "status": "ACSP",
8    "reason": "Приостановлен"
9  },
10  "payroll": {
11    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
12    "status": "ACSP",
13    "reason": "Приостановлен",
14    "accrual": {
15      "id": "7421a6f13a01983593e8dffb71fa6d15",
16      "updatedAt": "2000-01-23T04:56:07.000+00:00",
17      "status": "ACSP",
18      "reason": "Приостановлен"
19    }
20  }
21}

BODY

атрибут

описание

applicationId

stringrequired

Внешний ID запроса

applicationCreatedAt

stringrequired

Дата создания запроса

objectoptional

Информация об исходном сообщении

stringrequired

Уникальный id исходного сообщения с ведомостью

createdAt

stringrequired

Дата и время формирования исходного сообщения с ведомостью

status

stringrequired

Статус исходного сообщения

reason

stringoptional

Описание причины присвоения статуса сообщения

objectoptional

Информация о ведомости

stringrequired

Идентификатор исходного пакета с ведомостью

status

stringrequired

Статус исходного пакета с ведомостью

reason

stringoptional

Описание причины присвоения статуса пакета с ведомостью

objectoptional

Информация о начислении

stringrequired

Номер начисления в ведомости

updatedAt

stringoptional

Дата и время присвоения статуса

status

stringrequired

Статус начисления

reason

stringoptional

Описание кода причины присвоения статуса начисления

Пример ответа 200 (OK)

1{
2  "applicationId": "7421w6f13a01983593e8dffb71fa6d15",
3  "applicationCreatedAt": "2000-01-23T04:56:07.000+00:00",
4  "originalMessage": {
5    "id": "7421w6f13a01983593e8dffb71fa6d15",
6    "createdAt": "2000-01-23T04:56:07.000+00:00",
7    "status": "ACSP",
8    "reason": "Приостановлен"
9  },
10  "payroll": {
11    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
12    "status": "ACSP",
13    "reason": "Приостановлен",
14    "accrual": {
15      "id": "7421a6f13a01983593e8dffb71fa6d15",
16      "updatedAt": "2000-01-23T04:56:07.000+00:00",
17      "status": "ACSP",
18      "reason": "Приостановлен"
19    }
20  }
21}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

invalid_request - неверные входные параметры запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)

1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

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

error_description

stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)

1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent

error_description

stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)

1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

unknown_endpoint - эндпоинт не найден или неактивен

error_description

stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)

1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}

Нет тела ответа

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

internal_error - внутренняя ошибка сервиса при выполнении обработки запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа