Корпоративное API: Работа с черновиками в Астрал.Доверенность | Помощь Астрал
Отдел продаж:
Отдел продаж
График работы

Астрал.Доверенность: Работа с черновиками

Автор Чижова Юлия

Автор: Чижова Юлия

27.04.2024
353
Из статьи вы узнаете:

Черновики с relationshipType=B2B не поддерживаются для отображения и редактирования в UI сервиса Астрал.Доверенность, т.е. создание, просмотр и редактирование таких черновиков возможно только через API.

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

GET/corporate-api/v1/draft-poas

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

  • номер доверенности
  • формат доверенности
  • дата начала 
  • дата окончания
  • данные о доверителе
    • ИНН
    • Наименование
    • СНИЛС
    • ОГРН
  • данные о представителях
    • ИНН
    • Наименование
    • СНИЛС
    • ОГРН
  • дата последнего обновления
Наименование параметраТип параметраЗначениеДополнительно
Typestring

Формат доверенности:

B2B – вернутся черновики доверенностей, формата 1.01, 001, 002

B2G – вернутся черновики доверенностей, формата 5.01

Unified – вернутся черновики доверенностей, формата 003

Можно указать одновременно только один тип доверенности

SortOrder

string

Сортировка значений от ранней даты к поздней и наоборот

SortField

string

Сортировка по следующим значениям:

  • LastUpdateDate
если поле пустое, то вернется массив с сортировкой по 

LastUpdateDate DESC 

SearchByRepresentative

string

Поиск по наименованию представителя

SearchByPrincipal

string

Поиск по наименованию доверителя

Search

string

Поиск по любому значению

Offset

integer($int32)

Отступ

ExcludeEmpty

boolean

Необходимость включить в список пустые черновики

если указать true, то вернутся все черновики, включая пустые

если указать false, то вернутся только черновики, где заполнены еще какие-то данные
помимо номера и типа доверенности

Пустые черновики имеют только номер доверенности и тип

Count

integer($int32)

Количество черновиков
КодЗначениеДополнительно
200

Success

{
  "data": [
    {
      "poaNumber": "string",
      "type": "B2B",
      "startDate": "2024-03-29T07:46:36.214Z",
      "endDate": "2024-03-29T07:46:36.214Z",
      "principals": [
        {
          "inn": "string",
          "displayName": "string",
          "snils": "string",
          "ogrn": "string"
        }
      ],
      "representatives": [
        {
          "inn": "string",
          "displayName": "string",
          "snils": "string",
          "ogrn": "string"
        }
      ],
      "lastUpdateDate": "2024-03-29T07:46:36.214Z"
    }
  ],
  "meta": {
    "totalCount": 0
  }
}

Возвращается массив data кратких данных по каждому черновику, содержащий следующие значения:

poaNumber - номер черновика доверенности

type - формат доверенности

startDate - дата свершения

endDate - дата окончания

principals - сведения о доверителе

principals.inn - ИНН доверителя

principals.displayName - наименование доверителя

principals.snils - СНИЛС доверителя

principals.ogrn - ОГРН доверителя

representatives - сведения о представителях

representatives.inn - ИНН представителя

representatives.displayName - наименование представителя

representatives.snils - СНИЛС представителя

representatives.ogrn - ОГРН представителя

lastUpdateDate - дата последнего обновления черновика

meta - служебная информация

totalCount - общее число найденных черновиков

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/draft-poas?ExcludeEmpty=false&Type=Unified

Ответ:

{
    "data": [
        {
            "lastUpdateDate": "2024-03-29T07:55:47.389179+00:00",
            "poaNumber": "a0e90eb7-c72c-4dca-bd2c-041f0c492765",
            "type": "Unified",
            "startDate": "2024-03-29T07:55:47.359555+00:00",
            "principals": [
                {
                    "inn": "9654045503",
                    "displayName": "_тест_АО \"Ко &Овчинников\"",
                    "ogrn": "1157451843560"
                }
            ],
            "representatives": [
                {
                    "inn": "9600562311",
                    "displayName": "АО \"ВС\"",
                    "ogrn": "1273775454545"
                }
            ]
        },
        {
            "lastUpdateDate": "2024-03-27T06:42:35.576363+00:00",
            "poaNumber": "19104a9b-0f7f-4cf6-b05c-fcb19cf682bb",
            "type": "Unified",
            "startDate": "2024-03-27T06:42:35.31673+00:00",
            "principals": [
                {
                    "inn": "9654045503",
                    "displayName": "_тест_АО \"Ко &Овчинников\"",
                    "ogrn": "1157451843560"
                }
            ],
            "representatives": [
                {
                    "inn": "9600562311",
                    "displayName": "АО \"ВС\"",
                    "ogrn": "1273775454545"
                }
            ]
        }
    ],
    "meta": {
        "totalCount": 21
    }
}

Получение черновика доверенности

GET/corporate-api/v1/draft-poas/{poaNumber}

Метод позволяет получить полные данные черновика конкретной доверенности. Вернется массив данных, которые имеются в черновике на текущий момент.

Наименование параметраТип параметраЗначениеДополнительно

poaNumber

string

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

Обязательный параметр
КодЗначениеДополнительно
200

Success

{
  "poaNumber": "string",
  "creationDate": "2024-03-24T12:58:03.230Z",
  "data": "string",
  "lastDraftUpdateDate": "2024-03-24T12:58:03.230Z",
  "startDate": "2024-03-24T12:58:03.230Z",
  "endDate": "2024-03-24T12:58:03.230Z",
  "relationshipType": "B2B",
  "formatCoreVersion": "string"
}

Возвращаются данные черновика, содержащие следующие значения:

poaNumber - номер черновика доверенности

creationDate - дата создания черновика

data - данные черновика доверенности. В зависимости от формата доверенности data будет иметь разную модель данных

lastDraftUpdateDate - дата последнего сохранения черновика

startDate - дата свершения

endDate - дата окончания

relationshipType - формат доверенности. Принимает значения:

  • B2B
  • B2G
  • Unified 

formatCoreVersion - версия модели данных формата доверенности. Принимает значения:

  • B2B_coreV2
  • B2G_coreV1
  • Unified_coreV1

Соответствие relationshipType и formatCoreVersion 

B2B - B2B_coreV2

B2G - B2G_coreV1

Unified - Unified_coreV1

400BadRequestНеверный запрос
401UnauthorizedApiKey отсутствует
403ForbiddenДоступ запрещен
404NotFoundНеверный URL
500InternalServerErrorAn error has occured

Запрос:

/corporate-api/v1/draft-poas/ae0506d6-207d-41f1-a8ad-d5d79974e8ca

Ответ:

{
    "lastDraftUpdateDate": "2024-03-29T07:55:47.389179+00:00",
    "startDate": "2024-03-29T07:55:47.359555+00:00",
    "relationshipType": "Unified",
    "formatCoreVersion": "coreV1",
    "poaNumber": "a0e90eb7-c72c-4dca-bd2c-041f0c492765",
    "creationDate": "2024-03-29T07:55:47.358861+00:00",
    "data": {
        "esiaId": null,
        "notary": null,
        "endDate": null,
        "startDate": "2024-03-29T07:55:47.3595554+00:00",
        "isTransfer": false,
        "principals": [
            {
                "principalType": "RusOrganization",
                "privatePerson": null,
                "rusOrganization": {
                    "inn": "9654045503",
                    "kpp": "999999998",
                    "name": "_тест_АО \"Ко &Овчинников\"",
                    "ogrn": "1157451843560",
                    "address": {
                        "value": "Удмуртская Респ, Игринский р-н, тер ППБ Комсомолец",
                        "fiasId": null,
                        "regionCode": "47"
                    },
                    "soleExecutiveBodies": [
                        {
                            "isJointPowers": false,
                            "privatePerson": {
                                "inn": "961160209502",
                                "snils": "265-027-859 81",
                                "gender": null,
                                "address": null,
                                "fullName": {
                                    "name": "Фёина",
                                    "surname": "Нёумова",
                                    "patronymic": "Яковлёвна"
                                },
                                "position": null,
                                "birthDate": null,
                                "birthPlace": null,
                                "citizenshipType": null,
                                "identityDocument": null,
                                "citizenshipCountry": null
                            },
                            "managingOrganization": null,
                            "soleExecutiveBodyType": "PrivatePerson",
                            "individualEntrepreneur": null
                        }
                    ],
                    "hasSoleExecutivePrivatePerson": true,
                    "hasSoleExecutiveManagingOrganization": false,
                    "hasSoleExecutiveIndividualEntrepreneur": false
                },
                "foreignOrganization": null,
                "individualEntrepreneur": null
            }
        ],
        "empowerment": {
            "description": null,
            "isJointPowers": false,
            "isMachineReadable": true,
            "isLosingEmpowerment": false,
            "machineReadableEmpowermentList": [
                {
                    "code": "FKZ_00000001",
                    "name": "Утверждение Сведений об операциях с целевыми средствами (код формы по ОКУД 0501213)",
                    "mnemonics": null,
                    "limitations": []
                }
            ]
        },
        "isNotarized": false,
        "transferData": null,
        "transferType": "Never",
        "isIrrevocable": false,
        "irrevocableData": null,
        "representatives": [
            {
                "rusOrgBranch": null,
                "privatePerson": null,
                "rusOrganization": {
                    "inn": "9600562311",
                    "kpp": "999999999",
                    "name": "АО \"ВС\"",
                    "ogrn": "1273775454545",
                    "address": null
                },
                "foreignOrgBranch": null,
                "representativeType": "Organization",
                "individualEntrepreneur": null
            }
        ],
        "elementMandatory": "00000000",
        "otherInformation": null,
        "internalPoaNumber": "123",
        "transferPrincipals": [],
        "submitTaxAuthorityCode": null,
        "targetTaxAuthorityCodes": [],
        "poaInternalRegistrationDate": null
    }
}

Обновление черновика доверенности

PUT/corporate-api/v1/draft-poas/{poaNumber}

Метод позволяет отредактировать данные черновика конкретной доверенности.

Наименование параметраТип параметраЗначениеДополнительно

poaNumber

string

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

Обязательный параметр

{
"relationshipType": "B2B",
"
poaXXX": {<структура в зависимости от типа формата>
}

  "poaB2B": {
    "startDate": "2024-03-24T15:15:14.353Z",
    "endDate": "2024-03-24T15:15:14.353Z",
    "transferType": "OneTime",
    "isLosingEmpowerment": true,
    "isJointPowers": true,
    "isTransfer": true,
    "transferData": {
      "basePoaNumber": "string",
      "previousPoaNumber": "string",
      "basePoaPrincipals": [
        {
          "principalType": "RusOrganization",
          "rusOrganization": {
            "name": "string",
            "inn": "string",
            "kpp": "string",
            "ogrn": "string",
            "address": "string"
          },
          "foreignOrganization": {
            "name": "string",
            "inn": "string",
            "kpp": "string",
            "registrationCountryCode": "string",
            "regNumber": "string",
            "address": "string"
          },
          "individualEntrepreneur": {
            "name": "string",
            "inn": "string",
            "ogrnip": "string",
            "snils": "string",
            "individualInfo": {
              "birthDate": "2024-03-24T15:15:14.353Z",
              "birthPlace": "string",
              "gender": "Male",
              "citizenshipType": "Russian",
              "citizenshipCountryCode": "string"
            },
            "fullName": {
              "name": "string",
              "surname": "string",
              "patronymic": "string"
            }
          },
          "privatePerson": {
            "inn": "string",
            "snils": "string",
            "fullName": {
              "name": "string",
              "surname": "string",
"patronymic": "string"
            },
            "individualInfo": {
              "birthDate": "2024-03-24T15:15:14.353Z",
              "birthPlace": "string",
              "gender": "Male",
              "citizenshipType": "Russian",
              "citizenshipCountryCode": "string"
            }
          }
        }
      ]
    },
    "principals": [
      {
        "principalType": "RusOrganization",
        "rusOrganization": {
          "name": "string",
          "inn": "string",
          "kpp": "string",
          "ogrn": "string",
          "address": "string",
          "individual": {
            "inn": "string",
            "snils": "string",
            "position": "string",
            "authorityDocumentName": "string",
            "individualInfo": {
              "birthDate": "2024-03-24T15:15:14.354Z",
              "birthPlace": "string",
              "gender": "Male",
              "citizenshipType": "Russian",
              "citizenshipCountryCode": "string"
            }
          },
          "isPresentManagingOrg": true,
          "managingOrganization": {
            "name": "string",
            "inn": "string",
            "kpp": "string",
            "ogrn": "string"
          }
        },
        "foreignOrganization": {
          "name": "string",
          "inn": "string",
          "kpp": "string",
          "registrationCountryCode": "string",
          "regNumber": "string",
          "address": "string",
          "supervisor": {
            "inn": "string",
            "authorityDocumentName": "string",
            "individualInfo": {
              "birthDate": "2024-03-24T15:15:14.354Z",
              "birthPlace": "string",
              "gender": "Male",
              "citizenshipType": "Russian",
              "citizenshipCountryCode": "string"
            }
          }
        },
        "individualEntrepreneur": {
          "name": "string",
          "inn": "string",
          "ogrnip": "string",
          "snils": "string",
          "individualInfo": {
            "birthDate": "2024-03-24T15:15:14.354Z",
            "birthPlace": "string",
            "gender": "Male",
            "citizenshipType": "Russian",
            "citizenshipCountryCode": "string"
          }
        },
        "privatePerson": {
          "inn": "string",
          "snils": "string",
          "fullName": {
            "name": "string",
            "surname": "string",
            "patronymic": "string"
          },
          "individualInfo": {
            "birthDate": "2024-03-24T15:15:14.354Z",
            "birthPlace": "string",
            "gender": "Male",
            "citizenshipType": "Russian",
            "citizenshipCountryCode": "string"
          }
        },
        "signatory": {
          "name": "string",
          "surname": "string",
          "patronymic": "string"
        }
      }
    ],
    "representatives": [
      {
        "representativeType": "Organization",
        "organization": {
          "name": "string",
          "inn": "string",
          "kpp": "string",
          "ogrn": "string",
          "individuals": [
            {
              "inn": "string",
              "snils": "string",
              "fullName": {
                "name": "string",
                "surname": "string",
                "patronymic": "string"
              },
              "individualInfo": {
                "birthDate": "2024-03-24T15:15:14.354Z",
                "birthPlace": "string",
                "gender": "Male",
                "citizenshipType": "Russian",
                "citizenshipCountryCode": "string"
              }
            }
          ]
        },
        "individualEntrepreneur": {
          "name": "string",
          "inn": "string",
          "ogrnip": "string",
          "snils": "string",
          "individualInfo": {
            "birthDate": "2024-03-24T15:15:14.354Z",
            "birthPlace": "string",
            "gender": "Male",
            "citizenshipType": "Russian",
            "citizenshipCountryCode": "string"
          },
          "fullName": {
            "name": "string",
            "surname": "string",
            "patronymic": "string"
          }
        },
        "privatePerson": {
          "inn": "string",
          "snils": "string",
          "fullName": {
            "name": "string",
            "surname": "string",
            "patronymic": "string"
          },
          "individualInfo": {
            "birthDate": "2024-03-24T15:15:14.354Z",
            "birthPlace": "string",
            "gender": "Male",
            "citizenshipType": "Russian",
            "citizenshipCountryCode": "string"
          }
        }
      }
    ],
    "empowermentList": [
      {
        "code": "string",
        "description": "string",
        "contents": "string"
      }
    ]
  }
"poaB2G": {
    "startDate": "2024-03-24T15:15:14.354Z",
    "endDate": "2024-03-24T15:15:14.354Z",
    "submitTaxAuthorityCode": "string",
    "targetTaxAuthorityCodes": [
      "string"
    ],
    "principal": {
      "principalType": "RusOrganization",
      "rusOrganization": {
        "name": "string",
        "inn": "string",
        "kpp": "string",
        "ogrn": "string",
        "address": "string",
        "isPresentManagingOrg": true,
        "managingOrganization": {
          "name": "string",
          "inn": "string",
          "kpp": "string",
          "ogrn": "string"
        },
        "individual": {
          "inn": "string",
          "snils": "string",
          "nationality": "string",
          "birthDate": "2024-03-24T15:15:14.354Z",
          "position": "string"
        }
      },
      "foreignOrganization": {
        "name": "string",
        "inn": "string",
        "kpp": "string",
        "country": "string",
        "registrationNumber": "string",
        "registeredName": "string",
        "address": "string",
        "taxpayerCode": "string",
        "supervisor": {
          "inn": "string",
          "genderType": "Male",
          "birthDate": "2024-03-24T15:15:14.354Z",
          "placeOfBirth": "string",
          "citizenship": "Russian",
          "nationality": "string"
        }
      },
      "privatePerson": {
        "inn": "string",
        "ogrnIp": "string",
        "snils": "string",
        "nationality": "string",
        "birthDate": "2024-03-24T15:15:14.354Z",
        "identityDocument": {
          "documentType": "string",
          "numberSeries": "string",
          "dateOfIssue": "2024-03-24T15:15:14.354Z",
          "issuerName": "string",
          "issuerCode": "string"
        }
      }
    },
    "representative": {
      "empowermentCodes": [
        "string"
      ],
      "representativeIsOrganization": true,
      "individual": {
        "inn": "string",
        "ogrnip": "string",
        "snils": "string",
        "nationalityCountryCode": "string",
        "birthDate": "2024-03-24T15:15:14.354Z",
        "representativeCredentials": {
          "name": "string",
          "surname": "string",
          "patronymic": "string"
        },
        "identityDocument": {
          "documentType": "string",
          "numberSeries": "string",
          "dateOfIssue": "2024-03-24T15:15:14.354Z",
          "issuerName": "string",
          "issuerCode": "string"
        }
      },
      "representativeOrganization": {
        "name": "string",
        "inn": "string",
        "kpp": "string",
        "ogrn": "string"
      }
    },
    "signatoryCredentials": {
      "name": "string",
      "surname": "string",
      "patronymic": "string"
    }
  },
"poaUnified": {
    "startDate": "2024-03-24T15:15:14.354Z",
    "endDate": "2024-03-24T15:15:14.354Z",
    "esiaId": "string",
    "otherInformation": "string",
    "transferType": "OneTime",
    "internalPoaNumber": "string",
    "poaInternalRegistrationDate": "2024-03-24T15:15:14.354Z",
    "submitTaxAuthorityCode": "string",
    "targetTaxAuthorityCodes": [
      "string"
    ],
    "isTransfer": true,
    "principals": [
      {
        "principalType": "RusOrganization",
        "rusOrganization": {
          "name": "string",
          "inn": "string",
          "kpp": "string",
          "ogrn": "string",
          "address": {
            "regionCode": "string",
            "fiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "value": "string"
          },
          "soleExecutiveBodies": [
            {
              "soleExecutiveBodyType": "ManagingOrganization",
              "managingOrganization": {
                "name": "string",
                "inn": "string",
                "kpp": "string",
                "ogrn": "string",
                "address": {
                  "regionCode": "string",
                  "fiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "value": "string"
                },
                "individuals": [
                  {
                    "birthDate": "2024-03-24T15:15:14.354Z",
                    "birthPlace": "string",
                    "gender": "Male",
                    "citizenshipType": "Russian",
                    "citizenshipCountryCode": "string",
                    "fullName": {
                      "name": "string",
                      "surname": "string",
                      "patronymic": "string"
                    },
                    "address": {
                      "regionCode": "string",
                      "fiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "value": "string"
                    },
                    "identityDocument": {
                      "documentType": "string",
                      "numberSeries": "string",
                      "dateOfIssue": "2024-03-24T15:15:14.354Z",
                      "issuerCode": "string",
                      "expDate": "2024-03-24T15:15:14.354Z",
                      "issuerName": "string"
                    },
                    "inn": "string",
                    "snils": "string",
                    "position": "string"
                  }
                ]
              },
              "privatePerson": {
                "birthDate": "2024-03-24T15:15:14.354Z",
                "birthPlace": "string",
                "gender": "Male",
                "citizenshipType": "Russian",
                "citizenshipCountryCode": "string",
                "fullName": {
                  "name": "string",
                  "surname": "string",
                  "patronymic": "string"
                },
                "address": {
                  "regionCode": "string",
                  "fiasId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "value": "string"
                },
                "identityDocument": {
                  "documentType": "string",
                  "numberSeries": "string",
                  "dateOfIssue": "2024-03-24T15:15:14.354Z",
                  "issuerCode": "string",
                  "expDate": "2024-03-24T15:15:14.354Z",
                  "issuerName": "string"
                },
                "inn": "string",
                "snils": "string",
                "position": "string"
              },
              "individualEntrepreneur": {
                "birthDate": "2024-03-24T15:15:14.354Z",
                "birthPlace": "string",
                "gender": "Male",
                "citizenshipType": "Russian",
                "citizenshipCountryCode": "string",
                "fullName": {
                  "name": "string",
                  "surname": "string",
                  "patronymic": "string"
                },
                "address": {
                  "regionCode": "string",
                  "fi