# Протокол

## Оглавление

- [keyapis/invoice/v1/keyapis_invoice_invoice_v1.proto](#keyapis_invoice_v1_keyapis_invoice_invoice_v1-proto)
    - [InvoiceService](#keyapis-invoice-v1-InvoiceService)
  
    - [CreateInvoiceRequest](#keyapis-invoice-v1-CreateInvoiceRequest)
    - [CreateInvoiceResponse](#keyapis-invoice-v1-CreateInvoiceResponse)
    - [CreateInvoiceResponse.Error](#keyapis-invoice-v1-CreateInvoiceResponse-Error)
    - [CreateInvoiceResponse.Error.MissingUserContacts](#keyapis-invoice-v1-CreateInvoiceResponse-Error-MissingUserContacts)
    - [GetInvoiceCountRequest](#keyapis-invoice-v1-GetInvoiceCountRequest)
    - [GetInvoiceCountResponse](#keyapis-invoice-v1-GetInvoiceCountResponse)
    - [GetInvoiceListRequest](#keyapis-invoice-v1-GetInvoiceListRequest)
    - [GetInvoiceListResponse](#keyapis-invoice-v1-GetInvoiceListResponse)
    - [GetInvoiceListResponse.Error](#keyapis-invoice-v1-GetInvoiceListResponse-Error)
    - [GetInvoiceRequest](#keyapis-invoice-v1-GetInvoiceRequest)
    - [GetInvoiceResponse](#keyapis-invoice-v1-GetInvoiceResponse)
    - [GetInvoiceResponse.Error](#keyapis-invoice-v1-GetInvoiceResponse-Error)
    - [Invoice](#keyapis-invoice-v1-Invoice)
    - [Invoice.ExternalError](#keyapis-invoice-v1-Invoice-ExternalError)
    - [Invoice.ExternalError.ExternalSystemError](#keyapis-invoice-v1-Invoice-ExternalError-ExternalSystemError)
    - [Invoice.Position](#keyapis-invoice-v1-Invoice-Position)
    - [Invoice.SavingError](#keyapis-invoice-v1-Invoice-SavingError)
    - [Invoice.SavingError.InvoiceAlreadyExists](#keyapis-invoice-v1-Invoice-SavingError-InvoiceAlreadyExists)
    - [InvoiceFilter](#keyapis-invoice-v1-InvoiceFilter)
    - [InvoicePaging](#keyapis-invoice-v1-InvoicePaging)
    - [PostInvoiceConfirmRequest](#keyapis-invoice-v1-PostInvoiceConfirmRequest)
    - [PostInvoiceConfirmRequest.Card](#keyapis-invoice-v1-PostInvoiceConfirmRequest-Card)
    - [PostInvoiceConfirmResponse](#keyapis-invoice-v1-PostInvoiceConfirmResponse)
  
    - [Invoice.CardType](#keyapis-invoice-v1-Invoice-CardType)
    - [Invoice.InvoiceStatusType](#keyapis-invoice-v1-Invoice-InvoiceStatusType)
    - [Invoice.PayInterfaceType](#keyapis-invoice-v1-Invoice-PayInterfaceType)
    - [Invoice.PaywayType](#keyapis-invoice-v1-Invoice-PaywayType)
    - [InvoicePaging.DirectionType](#keyapis-invoice-v1-InvoicePaging-DirectionType)
    - [InvoicePaging.OrderByType](#keyapis-invoice-v1-InvoicePaging-OrderByType)
  


## [Схема классов](/svg/protos/key/keyapis/invoice/v1/keyapis_invoice_invoice_v1.proto.svg)
<a href="/svg/protos/key/keyapis/invoice/v1/keyapis_invoice_invoice_v1.proto.svg"><img src="/svg/protos/key/keyapis/invoice/v1/keyapis_invoice_invoice_v1.proto.svg" alt="/svg/protos/key/keyapis/invoice/v1/keyapis_invoice_invoice_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_invoice_v1_keyapis_invoice_invoice_v1-proto"></a>

## [keyapis/invoice/v1/keyapis_invoice_invoice_v1.proto](/protos/key/keyapis/invoice/v1/keyapis_invoice_invoice_v1.proto)
Сервис реализует функционал управления выставленными счётами


<a name="keyapis-invoice-v1-InvoiceService"></a>

### InvoiceService
 Сервис invoices

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-invoice-v1-CreateInvoice"></a> [CreateInvoice](#keyapis-invoice-v1-CreateInvoice) | Метод создания платежа. Создание платежа в своей и внешней платежной системе. Метод доступен для: service | [keyapis.invoice.v1.CreateInvoiceRequest](#keyapis-invoice-v1-CreateInvoiceRequest) | [keyapis.invoice.v1.CreateInvoiceResponse](#keyapis-invoice-v1-CreateInvoiceResponse) |
| <a id="keyapis-invoice-v1-GetInvoice"></a> [GetInvoice](#keyapis-invoice-v1-GetInvoice) | Метод получения платежа. Для master доступно получение платежа только с user_id из токена. Метод доступен для: admin, service, master | [keyapis.invoice.v1.GetInvoiceRequest](#keyapis-invoice-v1-GetInvoiceRequest) | [keyapis.invoice.v1.GetInvoiceResponse](#keyapis-invoice-v1-GetInvoiceResponse) |
| <a id="keyapis-invoice-v1-PostInvoiceConfirm"></a> [PostInvoiceConfirm](#keyapis-invoice-v1-PostInvoiceConfirm) | Метод подтверждения платежа (вызывается со стороны внешней системы). Не требует авторизации | [keyapis.invoice.v1.PostInvoiceConfirmRequest](#keyapis-invoice-v1-PostInvoiceConfirmRequest) | [keyapis.invoice.v1.PostInvoiceConfirmResponse](#keyapis-invoice-v1-PostInvoiceConfirmResponse) |
| <a id="keyapis-invoice-v1-GetInvoiceList"></a> [GetInvoiceList](#keyapis-invoice-v1-GetInvoiceList) | Метод получения списка платежей. Для master доступно получение только собственных платежей, если параметр filter.user_id передан и не совпадает с user_id из токена, возвращается ошибка доступа. Метод доступен для: admin, service, master, ltp_first | [keyapis.invoice.v1.GetInvoiceListRequest](#keyapis-invoice-v1-GetInvoiceListRequest) | [keyapis.invoice.v1.GetInvoiceListResponse](#keyapis-invoice-v1-GetInvoiceListResponse) |
| <a id="keyapis-invoice-v1-GetInvoiceCount"></a> [GetInvoiceCount](#keyapis-invoice-v1-GetInvoiceCount) | Метод получения количества платежей. Для master в параметр filter.user_id подставляется user_id из токена. Метод доступен для: admin, service, master, ltp_first | [keyapis.invoice.v1.GetInvoiceCountRequest](#keyapis-invoice-v1-GetInvoiceCountRequest) | [keyapis.invoice.v1.GetInvoiceCountResponse](#keyapis-invoice-v1-GetInvoiceCountResponse) |

 <!-- end services -->


<a name="keyapis-invoice-v1-CreateInvoiceRequest"></a>


### [CreateInvoiceRequest](#keyapis-invoice-v1-CreateInvoiceRequest)
 Запрос на создание платежа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-user_id"></a> [user_id](#keyapis-invoice-v1-CreateInvoiceRequest-user_id) | Идентификатор пользователя |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-positions"></a> [positions](#keyapis-invoice-v1-CreateInvoiceRequest-positions) | Позиция счета |  repeated  [keyapis.invoice.v1.Invoice.Position](#keyapis-invoice-v1-Invoice-Position) | REQUIRED|
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-pay_interface_type"></a> [pay_interface_type](#keyapis-invoice-v1-CreateInvoiceRequest-pay_interface_type) | Метод платежа |    [keyapis.invoice.v1.Invoice.PayInterfaceType](#keyapis-invoice-v1-Invoice-PayInterfaceType) | REQUIRED|
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-payway_type"></a> [payway_type](#keyapis-invoice-v1-CreateInvoiceRequest-payway_type) | Способ оплаты. По умолчанию: BANK_CARD |    [keyapis.invoice.v1.Invoice.PaywayType](#keyapis-invoice-v1-Invoice-PaywayType) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-return_url"></a> [return_url](#keyapis-invoice-v1-CreateInvoiceRequest-return_url) | Ссылка для перехода после оплаты. Если не передан подставится значение по умолчанию |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-phone_number"></a> [phone_number](#keyapis-invoice-v1-CreateInvoiceRequest-phone_number) | Номер телефона. Должно быть означено поле phone_number, либо поле email |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-email"></a> [email](#keyapis-invoice-v1-CreateInvoiceRequest-email) | Электронная почта. Должно быть означено поле phone_number, либо поле email |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceRequest-title"></a> [title](#keyapis-invoice-v1-CreateInvoiceRequest-title) | Описание платежа. По умолчанию подставляется "Счёт от {DD.MM.YYYY}г." |    [string](#scalar-types) | <nil>|






<a name="keyapis-invoice-v1-CreateInvoiceResponse"></a>


### [CreateInvoiceResponse](#keyapis-invoice-v1-CreateInvoiceResponse)
 Ответ на запрос создание платежа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-CreateInvoiceResponse-error"></a> [error](#keyapis-invoice-v1-CreateInvoiceResponse-error) | Ошибка валидации |  optional  [keyapis.invoice.v1.CreateInvoiceResponse.Error](#keyapis-invoice-v1-CreateInvoiceResponse-Error) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceResponse-data"></a> [data](#keyapis-invoice-v1-CreateInvoiceResponse-data) | Платеж |  optional  [keyapis.invoice.v1.Invoice](#keyapis-invoice-v1-Invoice) | <nil>|






<a name="keyapis-invoice-v1-CreateInvoiceResponse-Error"></a>


### [CreateInvoiceResponse.Error](#keyapis-invoice-v1-CreateInvoiceResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-CreateInvoiceResponse-Error-validation"></a> [validation](#keyapis-invoice-v1-CreateInvoiceResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.invoice.v1.ValidationError](#keyapis-invoice-v1-ValidationError) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceResponse-Error-missing_user_contacts"></a> [missing_user_contacts](#keyapis-invoice-v1-CreateInvoiceResponse-Error-missing_user_contacts) | Должно быть означено поле phone_number, либо поле email |  optional  [keyapis.invoice.v1.CreateInvoiceResponse.Error.MissingUserContacts](#keyapis-invoice-v1-CreateInvoiceResponse-Error-MissingUserContacts) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceResponse-Error-external"></a> [external](#keyapis-invoice-v1-CreateInvoiceResponse-Error-external) | Ошибки внешней системы |  optional  [keyapis.invoice.v1.Invoice.ExternalError](#keyapis-invoice-v1-Invoice-ExternalError) | <nil>|
| <a id="keyapis-invoice-v1-CreateInvoiceResponse-Error-saving"></a> [saving](#keyapis-invoice-v1-CreateInvoiceResponse-Error-saving) | Ошибка сохранения |  optional  [keyapis.invoice.v1.Invoice.SavingError](#keyapis-invoice-v1-Invoice-SavingError) | <nil>|






<a name="keyapis-invoice-v1-CreateInvoiceResponse-Error-MissingUserContacts"></a>


### [CreateInvoiceResponse.Error.MissingUserContacts](#keyapis-invoice-v1-CreateInvoiceResponse-Error-MissingUserContacts)
 Должно быть означено поле phone_number, либо поле email






<a name="keyapis-invoice-v1-GetInvoiceCountRequest"></a>


### [GetInvoiceCountRequest](#keyapis-invoice-v1-GetInvoiceCountRequest)
 Запрос на получение количества платежей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceCountRequest-filter"></a> [filter](#keyapis-invoice-v1-GetInvoiceCountRequest-filter) | Фильтр |    [keyapis.invoice.v1.InvoiceFilter](#keyapis-invoice-v1-InvoiceFilter) | REQUIRED|






<a name="keyapis-invoice-v1-GetInvoiceCountResponse"></a>


### [GetInvoiceCountResponse](#keyapis-invoice-v1-GetInvoiceCountResponse)
 Ответ на запрос получения количества платежей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceCountResponse-data"></a> [data](#keyapis-invoice-v1-GetInvoiceCountResponse-data) | Количество |  optional  [int32](#scalar-types) | <nil>|






<a name="keyapis-invoice-v1-GetInvoiceListRequest"></a>


### [GetInvoiceListRequest](#keyapis-invoice-v1-GetInvoiceListRequest)
 Запрос на получение списка платежей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceListRequest-filter"></a> [filter](#keyapis-invoice-v1-GetInvoiceListRequest-filter) | Фильтр |    [keyapis.invoice.v1.InvoiceFilter](#keyapis-invoice-v1-InvoiceFilter) | <nil>|
| <a id="keyapis-invoice-v1-GetInvoiceListRequest-paging"></a> [paging](#keyapis-invoice-v1-GetInvoiceListRequest-paging) | Пагинация |  optional  [keyapis.invoice.v1.InvoicePaging](#keyapis-invoice-v1-InvoicePaging) | <nil>|






<a name="keyapis-invoice-v1-GetInvoiceListResponse"></a>


### [GetInvoiceListResponse](#keyapis-invoice-v1-GetInvoiceListResponse)
 Ответ на запрос получения списка платежей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceListResponse-data"></a> [data](#keyapis-invoice-v1-GetInvoiceListResponse-data) | Платежи |  repeated  [keyapis.invoice.v1.Invoice](#keyapis-invoice-v1-Invoice) | <nil>|
| <a id="keyapis-invoice-v1-GetInvoiceListResponse-error"></a> [error](#keyapis-invoice-v1-GetInvoiceListResponse-error) | Ошибка |    [keyapis.invoice.v1.GetInvoiceListResponse.Error](#keyapis-invoice-v1-GetInvoiceListResponse-Error) | <nil>|






<a name="keyapis-invoice-v1-GetInvoiceListResponse-Error"></a>


### [GetInvoiceListResponse.Error](#keyapis-invoice-v1-GetInvoiceListResponse-Error)
 Ошибка запроса на получение списка платежей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceListResponse-Error-validation"></a> [validation](#keyapis-invoice-v1-GetInvoiceListResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.invoice.v1.ValidationError](#keyapis-invoice-v1-ValidationError) | <nil>|






<a name="keyapis-invoice-v1-GetInvoiceRequest"></a>


### [GetInvoiceRequest](#keyapis-invoice-v1-GetInvoiceRequest)
 Запрос на получение статуса платежа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceRequest-invoice_id"></a> [invoice_id](#keyapis-invoice-v1-GetInvoiceRequest-invoice_id) | Идентификатор платежа в Ключе. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-invoice-v1-GetInvoiceResponse"></a>


### [GetInvoiceResponse](#keyapis-invoice-v1-GetInvoiceResponse)
 Ответ на запрос получения платежа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceResponse-error"></a> [error](#keyapis-invoice-v1-GetInvoiceResponse-error) | Ошибка |  optional  [keyapis.invoice.v1.GetInvoiceResponse.Error](#keyapis-invoice-v1-GetInvoiceResponse-Error) | <nil>|
| <a id="keyapis-invoice-v1-GetInvoiceResponse-data"></a> [data](#keyapis-invoice-v1-GetInvoiceResponse-data) | Платеж |  optional  [keyapis.invoice.v1.Invoice](#keyapis-invoice-v1-Invoice) | <nil>|






<a name="keyapis-invoice-v1-GetInvoiceResponse-Error"></a>


### [GetInvoiceResponse.Error](#keyapis-invoice-v1-GetInvoiceResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-GetInvoiceResponse-Error-validation"></a> [validation](#keyapis-invoice-v1-GetInvoiceResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.invoice.v1.ValidationError](#keyapis-invoice-v1-ValidationError) | <nil>|






<a name="keyapis-invoice-v1-Invoice"></a>


### [Invoice](#keyapis-invoice-v1-Invoice)
 Выставленный счёт


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-Invoice-id"></a> [id](#keyapis-invoice-v1-Invoice-id) | Идентификатор платежа. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-title"></a> [title](#keyapis-invoice-v1-Invoice-title) | Описание платежа |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-user_id"></a> [user_id](#keyapis-invoice-v1-Invoice-user_id) | Идентификатор пользователя |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-invoice_status_type"></a> [invoice_status_type](#keyapis-invoice-v1-Invoice-invoice_status_type) | Статус платежа |    [keyapis.invoice.v1.Invoice.InvoiceStatusType](#keyapis-invoice-v1-Invoice-InvoiceStatusType) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-created_at"></a> [created_at](#keyapis-invoice-v1-Invoice-created_at) | Дата создания платежа. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-updated_at"></a> [updated_at](#keyapis-invoice-v1-Invoice-updated_at) | Дата обновления платежа. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-positions"></a> [positions](#keyapis-invoice-v1-Invoice-positions) | Позиция счета |  repeated  [keyapis.invoice.v1.Invoice.Position](#keyapis-invoice-v1-Invoice-Position) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-pay_interface_type"></a> [pay_interface_type](#keyapis-invoice-v1-Invoice-pay_interface_type) | Метод платежа |    [keyapis.invoice.v1.Invoice.PayInterfaceType](#keyapis-invoice-v1-Invoice-PayInterfaceType) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-payway_type"></a> [payway_type](#keyapis-invoice-v1-Invoice-payway_type) | Способ оплаты |    [keyapis.invoice.v1.Invoice.PaywayType](#keyapis-invoice-v1-Invoice-PaywayType) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-status_changed_at"></a> [status_changed_at](#keyapis-invoice-v1-Invoice-status_changed_at) | Дата изменения статуса платежа. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-paid_at"></a> [paid_at](#keyapis-invoice-v1-Invoice-paid_at) | Дата платежа. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-pay_url"></a> [pay_url](#keyapis-invoice-v1-Invoice-pay_url) | Платежная ссылка |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-paid_by_card_masked"></a> [paid_by_card_masked](#keyapis-invoice-v1-Invoice-paid_by_card_masked) | Маскированный номер карты при платеже |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-paid_by_card_espp_id"></a> [paid_by_card_espp_id](#keyapis-invoice-v1-Invoice-paid_by_card_espp_id) | Идентификатор платежного средства в внешней системы |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-card_type"></a> [card_type](#keyapis-invoice-v1-Invoice-card_type) | Тип банковской карты |    [keyapis.invoice.v1.Invoice.CardType](#keyapis-invoice-v1-Invoice-CardType) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-espp_req_status"></a> [espp_req_status](#keyapis-invoice-v1-Invoice-espp_req_status) | Код ошибки внешней системы |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-espp_req_user_msg"></a> [espp_req_user_msg](#keyapis-invoice-v1-Invoice-espp_req_user_msg) | Комментарий к статусу платежа из внешней системы |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-espp_invoice_id"></a> [espp_invoice_id](#keyapis-invoice-v1-Invoice-espp_invoice_id) | Уникальный номер транзакции в внешней системы |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-phone_number"></a> [phone_number](#keyapis-invoice-v1-Invoice-phone_number) | Номер телефона |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-email"></a> [email](#keyapis-invoice-v1-Invoice-email) | Электронная почта |    [string](#scalar-types) | <nil>|






<a name="keyapis-invoice-v1-Invoice-ExternalError"></a>


### [Invoice.ExternalError](#keyapis-invoice-v1-Invoice-ExternalError)
 Ошибки внешней системы


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-Invoice-ExternalError-external_system_error"></a> [external_system_error](#keyapis-invoice-v1-Invoice-ExternalError-external_system_error) | Запрос к внешней системе вернул ошибку или прекращен по таймауту |  optional  [keyapis.invoice.v1.Invoice.ExternalError.ExternalSystemError](#keyapis-invoice-v1-Invoice-ExternalError-ExternalSystemError) | <nil>|






<a name="keyapis-invoice-v1-Invoice-ExternalError-ExternalSystemError"></a>


### [Invoice.ExternalError.ExternalSystemError](#keyapis-invoice-v1-Invoice-ExternalError-ExternalSystemError)
 Запрос к внешней системе вернул ошибку или прекращен по таймауту






<a name="keyapis-invoice-v1-Invoice-Position"></a>


### [Invoice.Position](#keyapis-invoice-v1-Invoice-Position)
 Позиция счета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-Invoice-Position-id"></a> [id](#keyapis-invoice-v1-Invoice-Position-id) | Идентификатор позиции. # Тип: Guid |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-Position-invoice_id"></a> [invoice_id](#keyapis-invoice-v1-Invoice-Position-invoice_id) | Идентификатор платежа. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-title"></a> [title](#keyapis-invoice-v1-Invoice-Position-title) | Название позиции |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-category"></a> [category](#keyapis-invoice-v1-Invoice-Position-category) | Категория позиции (='subscription') |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-amount"></a> [amount](#keyapis-invoice-v1-Invoice-Position-amount) | Цена в рублях. Число должно быть больше 0 |    [float](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-created_at"></a> [created_at](#keyapis-invoice-v1-Invoice-Position-created_at) | Дата создания позиции платежа. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-invoice-v1-Invoice-Position-updated_at"></a> [updated_at](#keyapis-invoice-v1-Invoice-Position-updated_at) | Дата обновления позиции платежа. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-invoice-v1-Invoice-Position-mrf_id"></a> [mrf_id](#keyapis-invoice-v1-Invoice-Position-mrf_id) | Идентификатор МРФ |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-rf_id"></a> [rf_id](#keyapis-invoice-v1-Invoice-Position-rf_id) | Идентификатор РФ |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-instance_id"></a> [instance_id](#keyapis-invoice-v1-Invoice-Position-instance_id) | Идентификатор экземпляра оплачиваемой подписки. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-offering_id"></a> [offering_id](#keyapis-invoice-v1-Invoice-Position-offering_id) | Идентификатор предложения оплачиваемой подписки |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-Invoice-Position-due_date_at"></a> [due_date_at](#keyapis-invoice-v1-Invoice-Position-due_date_at) | Срок окончания оплачиваемого периода |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-Position-svc_type_id"></a> [svc_type_id](#keyapis-invoice-v1-Invoice-Position-svc_type_id) | Идентификатор получателя платежа |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-Invoice-Position-is_discount"></a> [is_discount](#keyapis-invoice-v1-Invoice-Position-is_discount) | Признак скидки |    [bool](#scalar-types) | <nil>|






<a name="keyapis-invoice-v1-Invoice-SavingError"></a>


### [Invoice.SavingError](#keyapis-invoice-v1-Invoice-SavingError)
 Ошибка сохранения.
Эти проверки выполняются при работе с базой данных и сторонними сервисами


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-Invoice-SavingError-invoice_already_exists"></a> [invoice_already_exists](#keyapis-invoice-v1-Invoice-SavingError-invoice_already_exists) | У пользователя уже есть платеж со статусом PENDING |  optional  [keyapis.invoice.v1.Invoice.SavingError.InvoiceAlreadyExists](#keyapis-invoice-v1-Invoice-SavingError-InvoiceAlreadyExists) | <nil>|






<a name="keyapis-invoice-v1-Invoice-SavingError-InvoiceAlreadyExists"></a>


### [Invoice.SavingError.InvoiceAlreadyExists](#keyapis-invoice-v1-Invoice-SavingError-InvoiceAlreadyExists)
 У пользователя уже есть платеж со статусом PENDING






<a name="keyapis-invoice-v1-InvoiceFilter"></a>


### [InvoiceFilter](#keyapis-invoice-v1-InvoiceFilter)
 Фильтр инвойсов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-InvoiceFilter-user_id"></a> [user_id](#keyapis-invoice-v1-InvoiceFilter-user_id) | Идентификатор пользователя |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-InvoiceFilter-invoice_status_type"></a> [invoice_status_type](#keyapis-invoice-v1-InvoiceFilter-invoice_status_type) | Статус платежа |    [keyapis.invoice.v1.Invoice.InvoiceStatusType](#keyapis-invoice-v1-Invoice-InvoiceStatusType) | <nil>|






<a name="keyapis-invoice-v1-InvoicePaging"></a>


### [InvoicePaging](#keyapis-invoice-v1-InvoicePaging)
 Постраничный вывод


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-InvoicePaging-order_by_type"></a> [order_by_type](#keyapis-invoice-v1-InvoicePaging-order_by_type) | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: PAID_AT |    [keyapis.invoice.v1.InvoicePaging.OrderByType](#keyapis-invoice-v1-InvoicePaging-OrderByType) | <nil>|
| <a id="keyapis-invoice-v1-InvoicePaging-direction_type"></a> [direction_type](#keyapis-invoice-v1-InvoicePaging-direction_type) | Тип направления сортировки. # По умолчанию: DESC |    [keyapis.invoice.v1.InvoicePaging.DirectionType](#keyapis-invoice-v1-InvoicePaging-DirectionType) | <nil>|
| <a id="keyapis-invoice-v1-InvoicePaging-limit"></a> [limit](#keyapis-invoice-v1-InvoicePaging-limit) | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-InvoicePaging-offset"></a> [offset](#keyapis-invoice-v1-InvoicePaging-offset) | Сдвиг. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-invoice-v1-PostInvoiceConfirmRequest"></a>


### [PostInvoiceConfirmRequest](#keyapis-invoice-v1-PostInvoiceConfirmRequest)
 Запрос на подтверждение платежа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-src_pay_id"></a> [src_pay_id](#keyapis-invoice-v1-PostInvoiceConfirmRequest-src_pay_id) | Идентификатор платежа в Ключе |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-espp_pay_id"></a> [espp_pay_id](#keyapis-invoice-v1-PostInvoiceConfirmRequest-espp_pay_id) | Идентификатор платежа во внешней системе |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-pay_status"></a> [pay_status](#keyapis-invoice-v1-PostInvoiceConfirmRequest-pay_status) | Статус платежа из внешней системы |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-req_type"></a> [req_type](#keyapis-invoice-v1-PostInvoiceConfirmRequest-req_type) | Тип запроса. Должно иметь значение "confirmPayment" |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-amount"></a> [amount](#keyapis-invoice-v1-PostInvoiceConfirmRequest-amount) | Сумма платежа в минимальных единицах валюты |    [float](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-currency"></a> [currency](#keyapis-invoice-v1-PostInvoiceConfirmRequest-currency) | Код валюты платежа |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-pay_method"></a> [pay_method](#keyapis-invoice-v1-PostInvoiceConfirmRequest-pay_method) | Код способа оплаты |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-create_time_at"></a> [create_time_at](#keyapis-invoice-v1-PostInvoiceConfirmRequest-create_time_at) | Дата регистрации платежа. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-req_note"></a> [req_note](#keyapis-invoice-v1-PostInvoiceConfirmRequest-req_note) | Комментарий или сообщение об ошибке |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-req_user_msg"></a> [req_user_msg](#keyapis-invoice-v1-PostInvoiceConfirmRequest-req_user_msg) | Сообщение, отображаемое пользователю |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-pay_time_at"></a> [pay_time_at](#keyapis-invoice-v1-PostInvoiceConfirmRequest-pay_time_at) | Время фактической оплаты. Время фактической оплаты на стороне Процессинга. Возвращается, если оплата состоялась |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-abandon_time_at"></a> [abandon_time_at](#keyapis-invoice-v1-PostInvoiceConfirmRequest-abandon_time_at) | Время фактической отмены оплаты. Время фактической отмены оплаты на стороне Процессинга. Возвращается, если отмена оплаты состоялась |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-card"></a> [card](#keyapis-invoice-v1-PostInvoiceConfirmRequest-card) | Структура с информацией о карте плательщика. Передаётся только при успешном платеже и если указаны способы оплаты payMethod = StoredBankCard либо BankCard |    [keyapis.invoice.v1.PostInvoiceConfirmRequest.Card](#keyapis-invoice-v1-PostInvoiceConfirmRequest-Card) | <nil>|






<a name="keyapis-invoice-v1-PostInvoiceConfirmRequest-Card"></a>


### [PostInvoiceConfirmRequest.Card](#keyapis-invoice-v1-PostInvoiceConfirmRequest-Card)
 Структура с информацией о карте плательщика


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-espp_card_id"></a> [espp_card_id](#keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-espp_card_id) | Идентификатор платежного средства во внешней системы. Возвращается в случае успешной привязки БК к УЗ |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-card_num"></a> [card_num](#keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-card_num) | Номер платежного средства. Маскированный номер карты. Например: 123456******7890 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-card_kind"></a> [card_kind](#keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-card_kind) | Тип банковской карты |    [string](#scalar-types) | <nil>|
| <a id="keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-bank_name"></a> [bank_name](#keyapis-invoice-v1-PostInvoiceConfirmRequest-Card-bank_name) | Банк-эмитент. Наименование банка-эмитента. Процессинг может вернуть значение "НЕ ЗАДАВАЛСЯ". В этом случае рекомендуется не отображать эту информацию для пользователя |    [string](#scalar-types) | <nil>|






<a name="keyapis-invoice-v1-PostInvoiceConfirmResponse"></a>


### [PostInvoiceConfirmResponse](#keyapis-invoice-v1-PostInvoiceConfirmResponse)
 Ответ на запрос подтверждения платежа





 <!-- end messages -->



<a name="keyapis-invoice-v1-Invoice-CardType"></a>

### [Invoice.CardType](#keyapis-invoice-v1-Invoice-CardType)
 Справочник банковских карт

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-invoice-v1-Invoice-CardType-CARD_TYPE_UNKNOWN"></a> [CARD_TYPE_UNKNOWN](#keyapis-invoice-v1-Invoice-CardType-CARD_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-invoice-v1-Invoice-CardType-VISA"></a> [VISA](#keyapis-invoice-v1-Invoice-CardType-VISA) | Карта VISA |
| 2 | <a id="keyapis-invoice-v1-Invoice-CardType-EC_MC"></a> [EC_MC](#keyapis-invoice-v1-Invoice-CardType-EC_MC) | Карта EuroCard/MasterCard |
| 3 | <a id="keyapis-invoice-v1-Invoice-CardType-DCL"></a> [DCL](#keyapis-invoice-v1-Invoice-CardType-DCL) | Карта DinersClub |
| 4 | <a id="keyapis-invoice-v1-Invoice-CardType-JCB"></a> [JCB](#keyapis-invoice-v1-Invoice-CardType-JCB) | Карта JCB |
| 5 | <a id="keyapis-invoice-v1-Invoice-CardType-AMEX"></a> [AMEX](#keyapis-invoice-v1-Invoice-CardType-AMEX) | Карта American Express |
| 6 | <a id="keyapis-invoice-v1-Invoice-CardType-MIR"></a> [MIR](#keyapis-invoice-v1-Invoice-CardType-MIR) | Платежная система "Мир" |




<a name="keyapis-invoice-v1-Invoice-InvoiceStatusType"></a>

### [Invoice.InvoiceStatusType](#keyapis-invoice-v1-Invoice-InvoiceStatusType)
 Справочник типов статусов оплаты счёта

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-invoice-v1-Invoice-InvoiceStatusType-INVOICE_STATUS_TYPE_UNKNOWN"></a> [INVOICE_STATUS_TYPE_UNKNOWN](#keyapis-invoice-v1-Invoice-InvoiceStatusType-INVOICE_STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-invoice-v1-Invoice-InvoiceStatusType-PLANNED"></a> [PLANNED](#keyapis-invoice-v1-Invoice-InvoiceStatusType-PLANNED) | Создан, ожидает подтверждения |
| 2 | <a id="keyapis-invoice-v1-Invoice-InvoiceStatusType-PENDING"></a> [PENDING](#keyapis-invoice-v1-Invoice-InvoiceStatusType-PENDING) | Ожидает оплаты |
| 3 | <a id="keyapis-invoice-v1-Invoice-InvoiceStatusType-ERROR"></a> [ERROR](#keyapis-invoice-v1-Invoice-InvoiceStatusType-ERROR) | Ошибка оплаты |
| 4 | <a id="keyapis-invoice-v1-Invoice-InvoiceStatusType-PAID"></a> [PAID](#keyapis-invoice-v1-Invoice-InvoiceStatusType-PAID) | Оплачен |
| 5 | <a id="keyapis-invoice-v1-Invoice-InvoiceStatusType-CANCELLED"></a> [CANCELLED](#keyapis-invoice-v1-Invoice-InvoiceStatusType-CANCELLED) | Отменен |




<a name="keyapis-invoice-v1-Invoice-PayInterfaceType"></a>

### [Invoice.PayInterfaceType](#keyapis-invoice-v1-Invoice-PayInterfaceType)
 Справочник методов платежа

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-invoice-v1-Invoice-PayInterfaceType-PAY_INTERFACE_TYPE_UNKNOWN"></a> [PAY_INTERFACE_TYPE_UNKNOWN](#keyapis-invoice-v1-Invoice-PayInterfaceType-PAY_INTERFACE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-invoice-v1-Invoice-PayInterfaceType-GUI"></a> [GUI](#keyapis-invoice-v1-Invoice-PayInterfaceType-GUI) | Оплата через интерфейс предпроцессинга |
| 2 | <a id="keyapis-invoice-v1-Invoice-PayInterfaceType-M2M"></a> [M2M](#keyapis-invoice-v1-Invoice-PayInterfaceType-M2M) | Оплата с использованием ранее созданного способа платежа, настроенного по умолчанию |




<a name="keyapis-invoice-v1-Invoice-PaywayType"></a>

### [Invoice.PaywayType](#keyapis-invoice-v1-Invoice-PaywayType)
 Справочник типов платежных средств

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-invoice-v1-Invoice-PaywayType-PAYWAY_TYPE_UNKNOWN"></a> [PAYWAY_TYPE_UNKNOWN](#keyapis-invoice-v1-Invoice-PaywayType-PAYWAY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-invoice-v1-Invoice-PaywayType-BANK_CARD"></a> [BANK_CARD](#keyapis-invoice-v1-Invoice-PaywayType-BANK_CARD) | Банковская карта |
| 2 | <a id="keyapis-invoice-v1-Invoice-PaywayType-SBP"></a> [SBP](#keyapis-invoice-v1-Invoice-PaywayType-SBP) | Сервис быстрых платежей |
| 3 | <a id="keyapis-invoice-v1-Invoice-PaywayType-SBER_PAY"></a> [SBER_PAY](#keyapis-invoice-v1-Invoice-PaywayType-SBER_PAY) | Связка Сбербанка |




<a name="keyapis-invoice-v1-InvoicePaging-DirectionType"></a>

### [InvoicePaging.DirectionType](#keyapis-invoice-v1-InvoicePaging-DirectionType)
 Справочник типов направлений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-invoice-v1-InvoicePaging-DirectionType-DIRECTION_TYPE_UNKNOWN"></a> [DIRECTION_TYPE_UNKNOWN](#keyapis-invoice-v1-InvoicePaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-invoice-v1-InvoicePaging-DirectionType-DESC"></a> [DESC](#keyapis-invoice-v1-InvoicePaging-DirectionType-DESC) | От большего к меньшему |
| 2 | <a id="keyapis-invoice-v1-InvoicePaging-DirectionType-ASC"></a> [ASC](#keyapis-invoice-v1-InvoicePaging-DirectionType-ASC) | От меньшего к большему |




<a name="keyapis-invoice-v1-InvoicePaging-OrderByType"></a>

### [InvoicePaging.OrderByType](#keyapis-invoice-v1-InvoicePaging-OrderByType)
 Справочник типов значений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-invoice-v1-InvoicePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-invoice-v1-InvoicePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-invoice-v1-InvoicePaging-OrderByType-ID"></a> [ID](#keyapis-invoice-v1-InvoicePaging-OrderByType-ID) | По идентификатору |
| 2 | <a id="keyapis-invoice-v1-InvoicePaging-OrderByType-PAID_AT"></a> [PAID_AT](#keyapis-invoice-v1-InvoicePaging-OrderByType-PAID_AT) | По дате оплаты |
| 3 | <a id="keyapis-invoice-v1-InvoicePaging-OrderByType-CREATED_AT"></a> [CREATED_AT](#keyapis-invoice-v1-InvoicePaging-OrderByType-CREATED_AT) | По дате создания |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |