API-Документация
MONO - автономная и единая точка доступа к кооперативной экономике. MONO предоставляет методы для извлечения (QUERIES), изменения (MUTATIONS) и подписок (SUBSCRIPTIONS) на информацию в локальной базе данных кооператива и распределенной базе данных кооперативной экономики, используя технологию GRAPHQL.
Contact
Terms of Service
API Endpoints
http://localhost:2998/v1/graphql
Queries
getAccount
Description
Получить сводную информацию о аккаунте
Требуемые роли: chairman, member.
Response
Returns an Account!
Arguments
Name | Description |
---|---|
data - GetAccountInput!
|
Example
Query
query getAccount($data: GetAccountInput!) {
getAccount(data: $data) {
blockchain_account {
...BlockchainAccountFragment
}
participant_account {
...ParticipantAccountFragment
}
provider_account {
...MonoAccountFragment
}
user_account {
...UserAccountFragment
}
username
}
}
Variables
{"data": GetAccountInput}
Response
{
"data": {
"getAccount": {
"blockchain_account": BlockchainAccount,
"participant_account": ParticipantAccount,
"provider_account": MonoAccount,
"user_account": UserAccount,
"username": "abc123"
}
}
}
getAccounts
Description
Получить сводную информацию о аккаунтах системы
Response
Returns an AccountsPaginationResult!
Arguments
Name | Description |
---|---|
data - GetAccountsInput
|
|
options - PaginationInput
|
Example
Query
query getAccounts(
$data: GetAccountsInput,
$options: PaginationInput
) {
getAccounts(
data: $data,
options: $options
) {
currentPage
items {
...AccountFragment
}
totalCount
totalPages
}
}
Variables
{
"data": GetAccountsInput,
"options": PaginationInput
}
Response
{
"data": {
"getAccounts": {
"currentPage": 123,
"items": [Account],
"totalCount": 987,
"totalPages": 123
}
}
}
getAgenda
Description
Получить список вопросов совета кооператива для голосования
Требуемые роли: chairman, member.
Response
Returns [AgendaWithDocuments!]!
Example
Query
query getAgenda {
getAgenda {
action {
...BlockchainActionFragment
}
documents {
...DocumentPackageFragment
}
table {
...BlockchainDecisionFragment
}
}
}
Response
{
"data": {
"getAgenda": [
{
"action": BlockchainAction,
"documents": DocumentPackage,
"table": BlockchainDecision
}
]
}
}
getBranches
Description
Получить список кооперативных участков
Response
Returns [Branch!]!
Arguments
Name | Description |
---|---|
data - GetBranchesInput!
|
Example
Query
query getBranches($data: GetBranchesInput!) {
getBranches(data: $data) {
bank_account {
...BankPaymentMethodFragment
}
braname
city
coopname
country
details {
...OrganizationDetailsFragment
}
email
fact_address
full_address
full_name
phone
represented_by {
...RepresentedByFragment
}
short_name
trusted {
...IndividualFragment
}
trustee {
...IndividualFragment
}
type
}
}
Variables
{"data": GetBranchesInput}
Response
{
"data": {
"getBranches": [
{
"bank_account": BankPaymentMethod,
"braname": "abc123",
"city": "abc123",
"coopname": "xyz789",
"country": "abc123",
"details": OrganizationDetails,
"email": "abc123",
"fact_address": "abc123",
"full_address": "xyz789",
"full_name": "abc123",
"phone": "xyz789",
"represented_by": RepresentedBy,
"short_name": "abc123",
"trusted": [Individual],
"trustee": Individual,
"type": "abc123"
}
]
}
}
getDocuments
Response
Returns a DocumentsPaginationResult!
Arguments
Name | Description |
---|---|
data - GetDocumentsInput!
|
Example
Query
query getDocuments($data: GetDocumentsInput!) {
getDocuments(data: $data) {
currentPage
items {
...DocumentPackageFragment
}
totalCount
totalPages
}
}
Variables
{"data": GetDocumentsInput}
Response
{
"data": {
"getDocuments": {
"currentPage": 987,
"items": [DocumentPackage],
"totalCount": 123,
"totalPages": 123
}
}
}
getExtensions
Description
Получить список расширений
Требуемые роли: chairman.
Response
Returns [Extension!]!
Arguments
Name | Description |
---|---|
data - GetExtensionsInput
|
Example
Query
query getExtensions($data: GetExtensionsInput) {
getExtensions(data: $data) {
available
config
created_at
description
enabled
image
installed
instructions
name
readme
schema
tags
title
updated_at
}
}
Variables
{"data": GetExtensionsInput}
Response
{
"data": {
"getExtensions": [
{
"available": true,
"config": {},
"created_at": "2007-12-03T10:15:30Z",
"description": "xyz789",
"enabled": true,
"image": "xyz789",
"installed": false,
"instructions": "xyz789",
"name": "abc123",
"readme": "abc123",
"schema": {},
"tags": ["abc123"],
"title": "abc123",
"updated_at": "2007-12-03T10:15:30Z"
}
]
}
}
getPaymentMethods
Description
Получить список методов оплаты
Требуемые роли: chairman. Исключение: доступ разрешен, если data.username
совпадает с username
текущего пользователя.
Response
Returns a PaymentMethodPaginationResult!
Arguments
Name | Description |
---|---|
data - GetPaymentMethodsInput
|
Example
Query
query getPaymentMethods($data: GetPaymentMethodsInput) {
getPaymentMethods(data: $data) {
currentPage
items {
...PaymentMethodFragment
}
totalCount
totalPages
}
}
Variables
{"data": GetPaymentMethodsInput}
Response
{
"data": {
"getPaymentMethods": {
"currentPage": 987,
"items": [PaymentMethod],
"totalCount": 123,
"totalPages": 123
}
}
}
getPayments
Description
Получить список платежей
Требуемые роли: chairman, member. Исключение: доступ разрешен, если data.username
совпадает с username
текущего пользователя.
Response
Returns a PaymentPaginationResult!
Arguments
Name | Description |
---|---|
data - GetPaymentsInput
|
|
options - PaginationInput
|
Example
Query
query getPayments(
$data: GetPaymentsInput,
$options: PaginationInput
) {
getPayments(
data: $data,
options: $options
) {
currentPage
items {
...PaymentFragment
}
totalCount
totalPages
}
}
Variables
{
"data": GetPaymentsInput,
"options": PaginationInput
}
Response
{
"data": {
"getPayments": {
"currentPage": 123,
"items": [Payment],
"totalCount": 123,
"totalPages": 987
}
}
}
getSystemInfo
Description
Получить сводную публичную информацию о системе
Response
Returns a SystemInfo!
Example
Query
query getSystemInfo {
getSystemInfo {
blockchain_account {
...BlockchainAccountFragment
}
blockchain_info {
...BlockchainInfoDTOFragment
}
contacts {
...ContactsDTOFragment
}
cooperator_account {
...CooperativeOperatorAccountFragment
}
coopname
system_status
vars {
...VarsFragment
}
}
}
Response
{
"data": {
"getSystemInfo": {
"blockchain_account": BlockchainAccount,
"blockchain_info": BlockchainInfoDTO,
"contacts": ContactsDTO,
"cooperator_account": CooperativeOperatorAccount,
"coopname": "xyz789",
"system_status": "active",
"vars": Vars
}
}
}
Mutations
addParticipant
Description
Добавить активного пайщика, который вступил в кооператив, не используя платформу (заполнив заявление собственноручно, оплатив вступительный и минимальный паевый взносы, и получив протокол решения совета)
Требуемые роли: chairman, member.
Response
Returns an Account!
Arguments
Name | Description |
---|---|
data - AddParticipantInput!
|
Example
Query
mutation addParticipant($data: AddParticipantInput!) {
addParticipant(data: $data) {
blockchain_account {
...BlockchainAccountFragment
}
participant_account {
...ParticipantAccountFragment
}
provider_account {
...MonoAccountFragment
}
user_account {
...UserAccountFragment
}
username
}
}
Variables
{"data": AddParticipantInput}
Response
{
"data": {
"addParticipant": {
"blockchain_account": BlockchainAccount,
"participant_account": ParticipantAccount,
"provider_account": MonoAccount,
"user_account": UserAccount,
"username": "xyz789"
}
}
}
addTrustedAccount
Description
Добавить доверенное лицо кооперативного участка
Требуемые роли: chairman.
Response
Returns a Branch!
Arguments
Name | Description |
---|---|
data - AddTrustedAccountInput!
|
Example
Query
mutation addTrustedAccount($data: AddTrustedAccountInput!) {
addTrustedAccount(data: $data) {
bank_account {
...BankPaymentMethodFragment
}
braname
city
coopname
country
details {
...OrganizationDetailsFragment
}
email
fact_address
full_address
full_name
phone
represented_by {
...RepresentedByFragment
}
short_name
trusted {
...IndividualFragment
}
trustee {
...IndividualFragment
}
type
}
}
Variables
{"data": AddTrustedAccountInput}
Response
{
"data": {
"addTrustedAccount": {
"bank_account": BankPaymentMethod,
"braname": "xyz789",
"city": "xyz789",
"coopname": "abc123",
"country": "abc123",
"details": OrganizationDetails,
"email": "abc123",
"fact_address": "abc123",
"full_address": "abc123",
"full_name": "abc123",
"phone": "abc123",
"represented_by": RepresentedBy,
"short_name": "xyz789",
"trusted": [Individual],
"trustee": Individual,
"type": "xyz789"
}
}
}
createBankAccount
Description
Добавить метод оплаты
Response
Returns a PaymentMethod!
Arguments
Name | Description |
---|---|
data - CreateBankAccountInput!
|
Example
Query
mutation createBankAccount($data: CreateBankAccountInput!) {
createBankAccount(data: $data) {
created_at
data {
... on BankAccount {
...BankAccountFragment
}
... on SbpAccount {
...SbpAccountFragment
}
}
is_default
method_id
method_type
updated_at
username
}
}
Variables
{"data": CreateBankAccountInput}
Response
{
"data": {
"createBankAccount": {
"created_at": "2007-12-03T10:15:30Z",
"data": BankAccount,
"is_default": true,
"method_id": "abc123",
"method_type": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"username": "abc123"
}
}
}
createBranch
Description
Создать кооперативный участок
Требуемые роли: chairman.
Response
Returns a Branch!
Arguments
Name | Description |
---|---|
data - CreateBranchInput!
|
Example
Query
mutation createBranch($data: CreateBranchInput!) {
createBranch(data: $data) {
bank_account {
...BankPaymentMethodFragment
}
braname
city
coopname
country
details {
...OrganizationDetailsFragment
}
email
fact_address
full_address
full_name
phone
represented_by {
...RepresentedByFragment
}
short_name
trusted {
...IndividualFragment
}
trustee {
...IndividualFragment
}
type
}
}
Variables
{"data": CreateBranchInput}
Response
{
"data": {
"createBranch": {
"bank_account": BankPaymentMethod,
"braname": "xyz789",
"city": "xyz789",
"coopname": "abc123",
"country": "xyz789",
"details": OrganizationDetails,
"email": "xyz789",
"fact_address": "xyz789",
"full_address": "abc123",
"full_name": "xyz789",
"phone": "abc123",
"represented_by": RepresentedBy,
"short_name": "abc123",
"trusted": [Individual],
"trustee": Individual,
"type": "xyz789"
}
}
}
createDeposit
Description
Создать объект платежа вступительного взноса
Требуемые роли: chairman, member, user.
Response
Returns a Payment!
Arguments
Name | Description |
---|---|
data - CreateDepositPaymentInput!
|
Example
Query
mutation createDeposit($data: CreateDepositPaymentInput!) {
createDeposit(data: $data) {
amount
blockchain_id
created_at
details {
...PaymentDetailsFragment
}
expired_at
id
message
provider
status
symbol
updated_at
username
}
}
Variables
{"data": CreateDepositPaymentInput}
Response
{
"data": {
"createDeposit": {
"amount": 123.45,
"blockchain_id": 123.45,
"created_at": "2007-12-03T10:15:30Z",
"details": PaymentDetails,
"expired_at": "2007-12-03T10:15:30Z",
"id": "abc123",
"message": "abc123",
"provider": "xyz789",
"status": "COMPLETED",
"symbol": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"username": "abc123"
}
}
}
createInitialPayment
Description
Создать объект платежа вступительного взноса
Требуемые роли: chairman, member, user.
Response
Returns a Payment!
Arguments
Name | Description |
---|---|
data - CreateInitialPaymentInput!
|
Example
Query
mutation createInitialPayment($data: CreateInitialPaymentInput!) {
createInitialPayment(data: $data) {
amount
blockchain_id
created_at
details {
...PaymentDetailsFragment
}
expired_at
id
message
provider
status
symbol
updated_at
username
}
}
Variables
{"data": CreateInitialPaymentInput}
Response
{
"data": {
"createInitialPayment": {
"amount": 123.45,
"blockchain_id": 987.65,
"created_at": "2007-12-03T10:15:30Z",
"details": PaymentDetails,
"expired_at": "2007-12-03T10:15:30Z",
"id": "abc123",
"message": "abc123",
"provider": "xyz789",
"status": "COMPLETED",
"symbol": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"username": "abc123"
}
}
}
createProjectOfFreeDecision
Description
Создать повестку дня и проект решения, и сохранить в хранилище для дальнейшей генерации документа и его публикации
Требуемые роли: chairman, member.
Response
Returns a CreatedProjectFreeDecision!
Arguments
Name | Description |
---|---|
data - CreateProjectFreeDecisionInput!
|
Example
Query
mutation createProjectOfFreeDecision($data: CreateProjectFreeDecisionInput!) {
createProjectOfFreeDecision(data: $data) {
decision
id
question
}
}
Variables
{"data": CreateProjectFreeDecisionInput}
Response
{
"data": {
"createProjectOfFreeDecision": {
"decision": "abc123",
"id": "abc123",
"question": "abc123"
}
}
}
deleteAccount
Description
Удалить аккаунт из системы учёта провайдера
Требуемые роли: chairman, member.
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - DeleteAccountInput!
|
Example
Query
mutation deleteAccount($data: DeleteAccountInput!) {
deleteAccount(data: $data)
}
Variables
{"data": DeleteAccountInput}
Response
{"data": {"deleteAccount": true}}
deleteBranch
Description
Удалить кооперативный участок
Требуемые роли: chairman.
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - DeleteBranchInput!
|
Example
Query
mutation deleteBranch($data: DeleteBranchInput!) {
deleteBranch(data: $data)
}
Variables
{"data": DeleteBranchInput}
Response
{"data": {"deleteBranch": false}}
deletePaymentMethod
Description
Удалить метод оплаты
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - DeletePaymentMethodInput!
|
Example
Query
mutation deletePaymentMethod($data: DeletePaymentMethodInput!) {
deletePaymentMethod(data: $data)
}
Variables
{"data": DeletePaymentMethodInput}
Response
{"data": {"deletePaymentMethod": false}}
deleteTrustedAccount
Description
Удалить доверенное лицо кооперативного участка
Требуемые роли: chairman.
Response
Returns a Branch!
Arguments
Name | Description |
---|---|
data - DeleteTrustedAccountInput!
|
Example
Query
mutation deleteTrustedAccount($data: DeleteTrustedAccountInput!) {
deleteTrustedAccount(data: $data) {
bank_account {
...BankPaymentMethodFragment
}
braname
city
coopname
country
details {
...OrganizationDetailsFragment
}
email
fact_address
full_address
full_name
phone
represented_by {
...RepresentedByFragment
}
short_name
trusted {
...IndividualFragment
}
trustee {
...IndividualFragment
}
type
}
}
Variables
{"data": DeleteTrustedAccountInput}
Response
{
"data": {
"deleteTrustedAccount": {
"bank_account": BankPaymentMethod,
"braname": "xyz789",
"city": "xyz789",
"coopname": "xyz789",
"country": "xyz789",
"details": OrganizationDetails,
"email": "xyz789",
"fact_address": "xyz789",
"full_address": "xyz789",
"full_name": "abc123",
"phone": "abc123",
"represented_by": RepresentedBy,
"short_name": "xyz789",
"trusted": [Individual],
"trustee": Individual,
"type": "xyz789"
}
}
}
editBranch
Description
Изменить кооперативный участок
Требуемые роли: chairman.
Response
Returns a Branch!
Arguments
Name | Description |
---|---|
data - EditBranchInput!
|
Example
Query
mutation editBranch($data: EditBranchInput!) {
editBranch(data: $data) {
bank_account {
...BankPaymentMethodFragment
}
braname
city
coopname
country
details {
...OrganizationDetailsFragment
}
email
fact_address
full_address
full_name
phone
represented_by {
...RepresentedByFragment
}
short_name
trusted {
...IndividualFragment
}
trustee {
...IndividualFragment
}
type
}
}
Variables
{"data": EditBranchInput}
Response
{
"data": {
"editBranch": {
"bank_account": BankPaymentMethod,
"braname": "xyz789",
"city": "xyz789",
"coopname": "abc123",
"country": "xyz789",
"details": OrganizationDetails,
"email": "xyz789",
"fact_address": "abc123",
"full_address": "xyz789",
"full_name": "abc123",
"phone": "xyz789",
"represented_by": RepresentedBy,
"short_name": "abc123",
"trusted": [Individual],
"trustee": Individual,
"type": "xyz789"
}
}
}
generateFreeDecision
Description
Сгенерировать протокол решения по предложенной повестке
Требуемые роли: chairman, member.
Response
Returns a ProjectFreeDecisionDocument!
Arguments
Name | Description |
---|---|
data - FreeDecisionGenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateFreeDecision(
$data: FreeDecisionGenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateFreeDecision(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...ProjectFreeDecisionMetaDocumentOutputFragment
}
}
}
Variables
{
"data": FreeDecisionGenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateFreeDecision": {
"binary": "abc123",
"full_title": "xyz789",
"hash": "abc123",
"html": "abc123",
"meta": ProjectFreeDecisionMetaDocumentOutput
}
}
}
generateParticipantApplication
Description
Сгенерировать документ соглашения о целевой потребительской программе "Цифровой Кошелёк"
Требуемые роли: chairman, member.
Response
Returns a ParticipantApplicationDocument!
Arguments
Name | Description |
---|---|
data - ParticipantApplicationGenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateParticipantApplication(
$data: ParticipantApplicationGenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateParticipantApplication(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...ParticipantApplicationMetaDocumentOutputFragment
}
}
}
Variables
{
"data": ParticipantApplicationGenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateParticipantApplication": {
"binary": "abc123",
"full_title": "abc123",
"hash": "xyz789",
"html": "xyz789",
"meta": ParticipantApplicationMetaDocumentOutput
}
}
}
generateParticipantApplicationDecision
Description
Сгенерировать документ соглашения с политикой конфиденциальности
Требуемые роли: chairman, member.
Response
Returns a ParticipantApplicationDecisionDocument!
Arguments
Name | Description |
---|---|
data - ParticipantApplicationDecisionGenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateParticipantApplicationDecision(
$data: ParticipantApplicationDecisionGenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateParticipantApplicationDecision(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...ParticipantApplicationDecisionMetaDocumentOutputFragment
}
}
}
Variables
{
"data": ParticipantApplicationDecisionGenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateParticipantApplicationDecision": {
"binary": "xyz789",
"full_title": "abc123",
"hash": "xyz789",
"html": "abc123",
"meta": ParticipantApplicationDecisionMetaDocumentOutput
}
}
}
generatePrivacyAgreement
Description
Сгенерировать документ соглашения с политикой конфиденциальности
Требуемые роли: chairman, member.
Response
Returns a GeneratedDocument!
Arguments
Name | Description |
---|---|
data - GenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generatePrivacyAgreement(
$data: GenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generatePrivacyAgreement(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...MetaDocumentFragment
}
}
}
Variables
{
"data": GenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generatePrivacyAgreement": {
"binary": "xyz789",
"full_title": "abc123",
"hash": "abc123",
"html": "xyz789",
"meta": MetaDocument
}
}
}
generateProjectOfFreeDecision
Description
Сгенерировать документ проекта свободного решения
Требуемые роли: chairman, member.
Response
Returns a ProjectFreeDecisionDocument!
Arguments
Name | Description |
---|---|
data - ProjectFreeDecisionGenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateProjectOfFreeDecision(
$data: ProjectFreeDecisionGenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateProjectOfFreeDecision(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...ProjectFreeDecisionMetaDocumentOutputFragment
}
}
}
Variables
{
"data": ProjectFreeDecisionGenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateProjectOfFreeDecision": {
"binary": "abc123",
"full_title": "abc123",
"hash": "abc123",
"html": "abc123",
"meta": ProjectFreeDecisionMetaDocumentOutput
}
}
}
generateSelectBranchDocument
Description
Сгенерировать документ, подтверждающий выбор кооперативного участка
Требуемые роли: chairman, member, user.
Response
Returns a SelectBranchDocument!
Arguments
Name | Description |
---|---|
data - SelectBranchGenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateSelectBranchDocument(
$data: SelectBranchGenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateSelectBranchDocument(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...SelectBranchMetaDocumentOutputFragment
}
}
}
Variables
{
"data": SelectBranchGenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateSelectBranchDocument": {
"binary": "xyz789",
"full_title": "xyz789",
"hash": "xyz789",
"html": "abc123",
"meta": SelectBranchMetaDocumentOutput
}
}
}
generateSignatureAgreement
Description
Сгенерировать документ соглашения о целевой потребительской программе "Цифровой Кошелёк"
Требуемые роли: chairman, member.
Response
Returns a GeneratedDocument!
Arguments
Name | Description |
---|---|
data - GenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateSignatureAgreement(
$data: GenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateSignatureAgreement(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...MetaDocumentFragment
}
}
}
Variables
{
"data": GenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateSignatureAgreement": {
"binary": "xyz789",
"full_title": "xyz789",
"hash": "abc123",
"html": "xyz789",
"meta": MetaDocument
}
}
}
generateUserAgreement
Description
Сгенерировать документ пользовательского соглашения
Требуемые роли: chairman, member.
Response
Returns a GeneratedDocument!
Arguments
Name | Description |
---|---|
data - GenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateUserAgreement(
$data: GenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateUserAgreement(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...MetaDocumentFragment
}
}
}
Variables
{
"data": GenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateUserAgreement": {
"binary": "xyz789",
"full_title": "abc123",
"hash": "xyz789",
"html": "xyz789",
"meta": MetaDocument
}
}
}
generateWalletAgreement
Description
Сгенерировать документ соглашения о целевой потребительской программе "Цифровой Кошелёк"
Требуемые роли: chairman, member.
Response
Returns a GeneratedDocument!
Arguments
Name | Description |
---|---|
data - GenerateDocumentInput!
|
|
options - GenerateDocumentOptionsInput
|
Example
Query
mutation generateWalletAgreement(
$data: GenerateDocumentInput!,
$options: GenerateDocumentOptionsInput
) {
generateWalletAgreement(
data: $data,
options: $options
) {
binary
full_title
hash
html
meta {
...MetaDocumentFragment
}
}
}
Variables
{
"data": GenerateDocumentInput,
"options": GenerateDocumentOptionsInput
}
Response
{
"data": {
"generateWalletAgreement": {
"binary": "xyz789",
"full_title": "abc123",
"hash": "abc123",
"html": "abc123",
"meta": MetaDocument
}
}
}
initSystem
Description
Произвести инициализацию программного обеспечения перед установкой совета методом install
Response
Returns a SystemInfo!
Arguments
Name | Description |
---|---|
data - Init!
|
Example
Query
mutation initSystem($data: Init!) {
initSystem(data: $data) {
blockchain_account {
...BlockchainAccountFragment
}
blockchain_info {
...BlockchainInfoDTOFragment
}
contacts {
...ContactsDTOFragment
}
cooperator_account {
...CooperativeOperatorAccountFragment
}
coopname
system_status
vars {
...VarsFragment
}
}
}
Variables
{"data": Init}
Response
{
"data": {
"initSystem": {
"blockchain_account": BlockchainAccount,
"blockchain_info": BlockchainInfoDTO,
"contacts": ContactsDTO,
"cooperator_account": CooperativeOperatorAccount,
"coopname": "abc123",
"system_status": "active",
"vars": Vars
}
}
}
installExtension
Description
Установить расширение
Требуемые роли: chairman.
Response
Returns an Extension!
Arguments
Name | Description |
---|---|
data - ExtensionInput!
|
Example
Query
mutation installExtension($data: ExtensionInput!) {
installExtension(data: $data) {
available
config
created_at
description
enabled
image
installed
instructions
name
readme
schema
tags
title
updated_at
}
}
Variables
{"data": ExtensionInput}
Response
{
"data": {
"installExtension": {
"available": false,
"config": {},
"created_at": "2007-12-03T10:15:30Z",
"description": "xyz789",
"enabled": false,
"image": "abc123",
"installed": true,
"instructions": "xyz789",
"name": "abc123",
"readme": "abc123",
"schema": {},
"tags": ["abc123"],
"title": "abc123",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
installSystem
Description
Произвести установку членов совета перед началом работы
Response
Returns a SystemInfo!
Arguments
Name | Description |
---|---|
data - Install!
|
Example
Query
mutation installSystem($data: Install!) {
installSystem(data: $data) {
blockchain_account {
...BlockchainAccountFragment
}
blockchain_info {
...BlockchainInfoDTOFragment
}
contacts {
...ContactsDTOFragment
}
cooperator_account {
...CooperativeOperatorAccountFragment
}
coopname
system_status
vars {
...VarsFragment
}
}
}
Variables
{"data": Install}
Response
{
"data": {
"installSystem": {
"blockchain_account": BlockchainAccount,
"blockchain_info": BlockchainInfoDTO,
"contacts": ContactsDTO,
"cooperator_account": CooperativeOperatorAccount,
"coopname": "abc123",
"system_status": "active",
"vars": Vars
}
}
}
login
Description
Войти в систему с помощью цифровой подписи и получить JWT-токены доступа
Response
Returns a RegisteredAccount!
Arguments
Name | Description |
---|---|
data - LoginInput!
|
Example
Query
mutation login($data: LoginInput!) {
login(data: $data) {
account {
...AccountFragment
}
tokens {
...TokensFragment
}
}
}
Variables
{"data": LoginInput}
Response
{
"data": {
"login": {
"account": Account,
"tokens": Tokens
}
}
}
logout
Description
Выйти из системы и заблокировать JWT-токены
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - LogoutInput!
|
Example
Query
mutation logout($data: LogoutInput!) {
logout(data: $data)
}
Variables
{"data": LogoutInput}
Response
{"data": {"logout": true}}
publishProjectOfFreeDecision
Description
Опубликовать предложенную повестку и проект решения для дальнейшего голосования совета по нему
Требуемые роли: chairman, member.
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - PublishProjectFreeDecisionInput!
|
Example
Query
mutation publishProjectOfFreeDecision($data: PublishProjectFreeDecisionInput!) {
publishProjectOfFreeDecision(data: $data)
}
Variables
{"data": PublishProjectFreeDecisionInput}
Response
{"data": {"publishProjectOfFreeDecision": true}}
refresh
Description
Обновить токен доступа аккаунта
Response
Returns a RegisteredAccount!
Arguments
Name | Description |
---|---|
data - RefreshInput!
|
Example
Query
mutation refresh($data: RefreshInput!) {
refresh(data: $data) {
account {
...AccountFragment
}
tokens {
...TokensFragment
}
}
}
Variables
{"data": RefreshInput}
Response
{
"data": {
"refresh": {
"account": Account,
"tokens": Tokens
}
}
}
registerAccount
Description
Зарегистрировать аккаунт пользователя в системе
Response
Returns a RegisteredAccount!
Arguments
Name | Description |
---|---|
data - RegisterAccountInput!
|
Example
Query
mutation registerAccount($data: RegisterAccountInput!) {
registerAccount(data: $data) {
account {
...AccountFragment
}
tokens {
...TokensFragment
}
}
}
Variables
{"data": RegisterAccountInput}
Response
{
"data": {
"registerAccount": {
"account": Account,
"tokens": Tokens
}
}
}
registerParticipant
Description
Зарегистрировать заявление и подписанные положения, подготовив пакет документов к отправке в совет на голосование после поступления оплаты.
Требуемые роли: chairman, member, user.
Response
Returns an Account!
Arguments
Name | Description |
---|---|
data - RegisterParticipantInput!
|
Example
Query
mutation registerParticipant($data: RegisterParticipantInput!) {
registerParticipant(data: $data) {
blockchain_account {
...BlockchainAccountFragment
}
participant_account {
...ParticipantAccountFragment
}
provider_account {
...MonoAccountFragment
}
user_account {
...UserAccountFragment
}
username
}
}
Variables
{"data": RegisterParticipantInput}
Response
{
"data": {
"registerParticipant": {
"blockchain_account": BlockchainAccount,
"participant_account": ParticipantAccount,
"provider_account": MonoAccount,
"user_account": UserAccount,
"username": "abc123"
}
}
}
resetKey
Description
Заменить приватный ключ аккаунта
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - ResetKeyInput!
|
Example
Query
mutation resetKey($data: ResetKeyInput!) {
resetKey(data: $data)
}
Variables
{"data": ResetKeyInput}
Response
{"data": {"resetKey": false}}
selectBranch
Description
Выбрать кооперативный участок
Требуемые роли: chairman, member, user.
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - SelectBranchInput!
|
Example
Query
mutation selectBranch($data: SelectBranchInput!) {
selectBranch(data: $data)
}
Variables
{"data": SelectBranchInput}
Response
{"data": {"selectBranch": true}}
setPaymentStatus
Description
Создать объект платежа вступительного взноса
Требуемые роли: chairman, member.
Response
Returns a Payment!
Arguments
Name | Description |
---|---|
data - SetPaymentStatusInput!
|
Example
Query
mutation setPaymentStatus($data: SetPaymentStatusInput!) {
setPaymentStatus(data: $data) {
amount
blockchain_id
created_at
details {
...PaymentDetailsFragment
}
expired_at
id
message
provider
status
symbol
updated_at
username
}
}
Variables
{"data": SetPaymentStatusInput}
Response
{
"data": {
"setPaymentStatus": {
"amount": 987.65,
"blockchain_id": 123.45,
"created_at": "2007-12-03T10:15:30Z",
"details": PaymentDetails,
"expired_at": "2007-12-03T10:15:30Z",
"id": "xyz789",
"message": "abc123",
"provider": "xyz789",
"status": "COMPLETED",
"symbol": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"username": "abc123"
}
}
}
setWif
Description
Сохранить приватный ключ в зашифрованном серверном хранилище
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - SetWifInput!
|
Example
Query
mutation setWif($data: SetWifInput!) {
setWif(data: $data)
}
Variables
{"data": SetWifInput}
Response
{"data": {"setWif": true}}
startResetKey
Description
Выслать токен для замены приватного ключа аккаунта на электронную почту
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - StartResetKeyInput!
|
Example
Query
mutation startResetKey($data: StartResetKeyInput!) {
startResetKey(data: $data)
}
Variables
{"data": StartResetKeyInput}
Response
{"data": {"startResetKey": true}}
uninstallExtension
Description
Удалить расширение
Требуемые роли: chairman.
Response
Returns a Boolean!
Arguments
Name | Description |
---|---|
data - UninstallExtensionInput!
|
Example
Query
mutation uninstallExtension($data: UninstallExtensionInput!) {
uninstallExtension(data: $data)
}
Variables
{"data": UninstallExtensionInput}
Response
{"data": {"uninstallExtension": false}}
updateAccount
Description
Обновить аккаунт в системе провайдера
Response
Returns an Account!
Arguments
Name | Description |
---|---|
data - UpdateAccountInput!
|
Example
Query
mutation updateAccount($data: UpdateAccountInput!) {
updateAccount(data: $data) {
blockchain_account {
...BlockchainAccountFragment
}
participant_account {
...ParticipantAccountFragment
}
provider_account {
...MonoAccountFragment
}
user_account {
...UserAccountFragment
}
username
}
}
Variables
{"data": UpdateAccountInput}
Response
{
"data": {
"updateAccount": {
"blockchain_account": BlockchainAccount,
"participant_account": ParticipantAccount,
"provider_account": MonoAccount,
"user_account": UserAccount,
"username": "abc123"
}
}
}
updateBankAccount
Description
Обновить банковский счёт
Response
Returns a PaymentMethod!
Arguments
Name | Description |
---|---|
data - UpdateBankAccountInput!
|
Example
Query
mutation updateBankAccount($data: UpdateBankAccountInput!) {
updateBankAccount(data: $data) {
created_at
data {
... on BankAccount {
...BankAccountFragment
}
... on SbpAccount {
...SbpAccountFragment
}
}
is_default
method_id
method_type
updated_at
username
}
}
Variables
{"data": UpdateBankAccountInput}
Response
{
"data": {
"updateBankAccount": {
"created_at": "2007-12-03T10:15:30Z",
"data": BankAccount,
"is_default": false,
"method_id": "abc123",
"method_type": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"username": "abc123"
}
}
}
updateExtension
Description
Обновить расширение
Требуемые роли: chairman.
Response
Returns an Extension!
Arguments
Name | Description |
---|---|
data - ExtensionInput!
|
Example
Query
mutation updateExtension($data: ExtensionInput!) {
updateExtension(data: $data) {
available
config
created_at
description
enabled
image
installed
instructions
name
readme
schema
tags
title
updated_at
}
}
Variables
{"data": ExtensionInput}
Response
{
"data": {
"updateExtension": {
"available": false,
"config": {},
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"enabled": false,
"image": "xyz789",
"installed": true,
"instructions": "xyz789",
"name": "abc123",
"readme": "abc123",
"schema": {},
"tags": ["xyz789"],
"title": "abc123",
"updated_at": "2007-12-03T10:15:30Z"
}
}
}
updateSystem
Description
Обновить параметры системы
Response
Returns a SystemInfo!
Arguments
Name | Description |
---|---|
data - Update!
|
Example
Query
mutation updateSystem($data: Update!) {
updateSystem(data: $data) {
blockchain_account {
...BlockchainAccountFragment
}
blockchain_info {
...BlockchainInfoDTOFragment
}
contacts {
...ContactsDTOFragment
}
cooperator_account {
...CooperativeOperatorAccountFragment
}
coopname
system_status
vars {
...VarsFragment
}
}
}
Variables
{"data": Update}
Response
{
"data": {
"updateSystem": {
"blockchain_account": BlockchainAccount,
"blockchain_info": BlockchainInfoDTO,
"contacts": ContactsDTO,
"cooperator_account": CooperativeOperatorAccount,
"coopname": "xyz789",
"system_status": "active",
"vars": Vars
}
}
}
Types
Account
Fields
Field Name | Description |
---|---|
blockchain_account - BlockchainAccount
|
Объект системного аккаунта кооператива в блокчейне |
participant_account - ParticipantAccount
|
Объект пайщика кооператива |
provider_account - MonoAccount
|
Объект аккаунта в системе учёта провайдера |
user_account - UserAccount
|
Объект пользовательского аккаунта кооперативной экономики |
username - String!
|
Имя аккаунта кооператива |
Example
{
"blockchain_account": BlockchainAccount,
"participant_account": ParticipantAccount,
"provider_account": MonoAccount,
"user_account": UserAccount,
"username": "xyz789"
}
AccountRamDelta
AccountResourceInfo
Example
{
"available": "xyz789",
"current_used": "xyz789",
"last_usage_update_time": "abc123",
"max": "abc123",
"used": "abc123"
}
AccountType
Description
Тип аккаунта пользователя в системе
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"Entrepreneur"
AccountsPaginationResult
Fields
Field Name | Description |
---|---|
currentPage - Int!
|
Текущая страница |
items - [Account!]!
|
Элементы текущей страницы |
totalCount - Int!
|
Общее количество элементов |
totalPages - Int!
|
Общее количество страниц |
Example
{
"currentPage": 987,
"items": [Account],
"totalCount": 987,
"totalPages": 123
}
ActDetail
Fields
Field Name | Description |
---|---|
action - ExtendedBlockchainAction
|
|
document - GeneratedDocument
|
Example
{
"action": ExtendedBlockchainAction,
"document": GeneratedDocument
}
ActionAuthorization
ActionReceipt
Example
{
"abi_sequence": 123,
"act_digest": "xyz789",
"auth_sequence": [AuthSequence],
"code_sequence": 987,
"global_sequence": "abc123",
"receiver": "abc123",
"recv_sequence": "xyz789"
}
AddParticipantInput
Fields
Input Field | Description |
---|---|
created_at - String!
|
Дата создания аккаунта в строковом формате даты EOSIO по UTC (2024-12-28T06:58:52.500) |
email - String!
|
Электронная почта |
entrepreneur_data - CreateEntrepreneurDataInput
|
Данные индивидуального предпринимателя |
individual_data - CreateIndividualDataInput
|
Данные физического лица |
initial - String!
|
Вступительный взнос, который был внесён пайщиком |
minimum - String!
|
Минимальный паевый взнос, который был внесён пайщиком |
organization_data - CreateOrganizationDataInput
|
Данные организации |
referer - String
|
Имя аккаунта реферера |
spread_initial - Boolean!
|
Флаг распределения вступительного взноса в невозвратный фонд вступительных взносов кооператива |
type - AccountType!
|
Тип аккаунта |
Example
{
"created_at": "xyz789",
"email": "abc123",
"entrepreneur_data": CreateEntrepreneurDataInput,
"individual_data": CreateIndividualDataInput,
"initial": "abc123",
"minimum": "xyz789",
"organization_data": CreateOrganizationDataInput,
"referer": "abc123",
"spread_initial": false,
"type": "Entrepreneur"
}
AddTrustedAccountInput
Example
{
"braname": "abc123",
"coopname": "xyz789",
"trusted": "xyz789"
}
AgendaWithDocuments
Fields
Field Name | Description |
---|---|
action - BlockchainAction!
|
Действие, которое привело к появлению вопроса на голосовании |
documents - DocumentPackage!
|
Пакет документов, включающий разные подсекции |
table - BlockchainDecision!
|
Запись в таблице блокчейна о вопросе на голосовании |
Example
{
"action": BlockchainAction,
"documents": DocumentPackage,
"table": BlockchainDecision
}
AgreementInput
AgreementVar
AuthSequence
Authority
Fields
Field Name | Description |
---|---|
accounts - [PermissionLevelWeight!]!
|
Уровни разрешений |
keys - [KeyWeight!]!
|
Ключи |
threshold - Int!
|
Порог |
waits - [WaitWeight!]!
|
Вес ожидания |
Example
{
"accounts": [PermissionLevelWeight],
"keys": [KeyWeight],
"threshold": 123,
"waits": [WaitWeight]
}
BankAccount
Fields
Field Name | Description |
---|---|
account_number - String!
|
Номер банковского счета |
bank_name - String!
|
Название банка |
card_number - String
|
Номер карты |
currency - String!
|
Валюта счета |
details - BankAccountDetails!
|
Детали счета |
Example
{
"account_number": "xyz789",
"bank_name": "xyz789",
"card_number": "xyz789",
"currency": "abc123",
"details": BankAccountDetails
}
BankAccountDetails
BankAccountDetailsInput
BankAccountInput
Fields
Input Field | Description |
---|---|
account_number - String!
|
Номер банковского счета |
bank_name - String!
|
Название банка |
card_number - String
|
Номер карты |
currency - String!
|
Валюта счета |
details - BankAccountDetailsInput!
|
Детали счета |
Example
{
"account_number": "abc123",
"bank_name": "xyz789",
"card_number": "xyz789",
"currency": "xyz789",
"details": BankAccountDetailsInput
}
BankPaymentMethod
Fields
Field Name | Description |
---|---|
created_at - DateTime!
|
Дата создания |
data - BankAccount!
|
Данные метода оплаты |
is_default - Boolean!
|
Флаг основного метода платежа, который отображается в документах |
method_id - String!
|
Идентификатор метода оплаты |
method_type - String!
|
Тип метода оплаты |
updated_at - DateTime!
|
Дата обновления |
username - String!
|
Имя пользователя, к которому привязан метод оплаты |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"data": BankAccount,
"is_default": false,
"method_id": "xyz789",
"method_type": "abc123",
"updated_at": "2007-12-03T10:15:30Z",
"username": "xyz789"
}
BlockchainAccount
Fields
Field Name | Description |
---|---|
account_name - String!
|
Имя аккаунта |
core_liquid_balance - String
|
Баланс |
cpu_limit - AccountResourceInfo!
|
Ограничения CPU |
cpu_weight - String!
|
Вес CPU |
created - String!
|
Дата создания |
head_block_num - Int!
|
Номер последнего блока |
head_block_time - String!
|
Время последнего блока |
last_code_update - String!
|
Время последнего обновления кода |
net_limit - AccountResourceInfo!
|
Ограничения сети |
net_weight - String!
|
Вес сети |
permissions - [Permission!]!
|
Разрешения |
privileged - Boolean!
|
Флаг привилегий |
ram_quota - Int!
|
Квота RAM |
ram_usage - Int!
|
Использование RAM |
refund_request - RefundRequest
|
Запрос на возврат |
rex_info - String
|
Информация о REX |
self_delegated_bandwidth - ResourceDelegationDTO
|
Делегированные ресурсы |
total_resources - ResourceOverview
|
Общий обзор ресурсов |
voter_info - String
|
Информация о голосовании |
Example
{
"account_name": "abc123",
"core_liquid_balance": "xyz789",
"cpu_limit": AccountResourceInfo,
"cpu_weight": "xyz789",
"created": "abc123",
"head_block_num": 987,
"head_block_time": "abc123",
"last_code_update": "abc123",
"net_limit": AccountResourceInfo,
"net_weight": "xyz789",
"permissions": [Permission],
"privileged": true,
"ram_quota": 123,
"ram_usage": 123,
"refund_request": RefundRequest,
"rex_info": "xyz789",
"self_delegated_bandwidth": ResourceDelegationDTO,
"total_resources": ResourceOverview,
"voter_info": "xyz789"
}
BlockchainAction
Description
Объект действия в блокчейне
Fields
Field Name | Description |
---|---|
account - String!
|
|
account_ram_deltas - [AccountRamDelta!]!
|
|
action_ordinal - Int!
|
|
authorization - [ActionAuthorization!]!
|
|
block_id - String!
|
|
block_num - Int!
|
|
chain_id - String!
|
|
console - String!
|
|
context_free - Boolean!
|
|
creator_action_ordinal - Int!
|
|
data - JSON!
|
Данные действия в формате JSON |
elapsed - Int!
|
|
global_sequence - String!
|
|
name - String!
|
|
receipt - ActionReceipt!
|
|
receiver - String!
|
|
transaction_id - String!
|
Example
{
"account": "abc123",
"account_ram_deltas": [AccountRamDelta],
"action_ordinal": 987,
"authorization": [ActionAuthorization],
"block_id": "abc123",
"block_num": 987,
"chain_id": "abc123",
"console": "abc123",
"context_free": false,
"creator_action_ordinal": 123,
"data": {},
"elapsed": 123,
"global_sequence": "xyz789",
"name": "abc123",
"receipt": ActionReceipt,
"receiver": "abc123",
"transaction_id": "xyz789"
}
BlockchainDecision
Description
Запись в таблице блокчейна о процессе принятия решения советом кооператива
Fields
Field Name | Description |
---|---|
approved - Boolean!
|
|
authorization - SignedBlockchainDocument!
|
|
authorized - Boolean!
|
|
authorized_by - String!
|
|
batch_id - Float!
|
|
coopname - String!
|
|
created_at - String!
|
|
expired_at - String!
|
|
id - Float!
|
|
meta - String!
|
|
statement - SignedBlockchainDocument!
|
|
type - String!
|
|
username - String!
|
|
validated - Boolean!
|
|
votes_against - [String!]!
|
|
votes_for - [String!]!
|
Example
{
"approved": true,
"authorization": SignedBlockchainDocument,
"authorized": false,
"authorized_by": "xyz789",
"batch_id": 987.65,
"coopname": "abc123",
"created_at": "abc123",
"expired_at": "abc123",
"id": 987.65,
"meta": "xyz789",
"statement": SignedBlockchainDocument,
"type": "xyz789",
"username": "abc123",
"validated": true,
"votes_against": ["xyz789"],
"votes_for": ["abc123"]
}
BlockchainInfoDTO
Description
Информация о состоянии блокчейна
Fields
Field Name | Description |
---|---|
block_cpu_limit - Int!
|
Лимит CPU для блока |
block_net_limit - Int!
|
Лимит сети для блока |
chain_id - String!
|
Идентификатор цепочки (chain ID) |
fork_db_head_block_id - String
|
Идентификатор головного блока в форк базе данных |
fork_db_head_block_num - Int
|
Номер головного блока в форк базе данных |
head_block_id - String!
|
Идентификатор головного блока |
head_block_num - Int!
|
Номер головного блока |
head_block_producer - String!
|
Прозводитель головного блока |
head_block_time - String!
|
Время головного блока |
last_irreversible_block_id - String!
|
Идентификатор последнего необратимого блока |
last_irreversible_block_num - Int!
|
Номер последнего необратимого блока |
last_irreversible_block_time - String
|
Время последнего необратимого блока |
server_version - String!
|
Версия сервера |
server_version_string - String
|
Строковое представление версии сервера |
virtual_block_cpu_limit - Int!
|
Виртуальный лимит CPU для блока |
virtual_block_net_limit - Int!
|
Виртуальный лимит сети для блока |
Example
{
"block_cpu_limit": 987,
"block_net_limit": 123,
"chain_id": "abc123",
"fork_db_head_block_id": "xyz789",
"fork_db_head_block_num": 123,
"head_block_id": "xyz789",
"head_block_num": 123,
"head_block_producer": "xyz789",
"head_block_time": "abc123",
"last_irreversible_block_id": "xyz789",
"last_irreversible_block_num": 987,
"last_irreversible_block_time": "xyz789",
"server_version": "xyz789",
"server_version_string": "abc123",
"virtual_block_cpu_limit": 987,
"virtual_block_net_limit": 987
}
Boolean
Description
The Boolean
scalar type represents true
or false
.
Branch
Fields
Field Name | Description |
---|---|
bank_account - BankPaymentMethod!
|
Банковский счёт |
braname - String!
|
Уникальное имя кооперативного участка |
city - String!
|
Город |
coopname - String!
|
Имя аккаунта кооператива |
country - String!
|
Страна |
details - OrganizationDetails!
|
Детали организации |
email - String!
|
|
fact_address - String!
|
Фактический адрес |
full_address - String!
|
Полный адрес |
full_name - String!
|
Полное название организации |
phone - String!
|
Телефон |
represented_by - RepresentedBy!
|
Представитель организации |
short_name - String!
|
Краткое название организации |
trusted - [Individual!]!
|
Доверенные аккаунты Требуемые роли: chairman, member. |
trustee - Individual!
|
Председатель кооперативного участка Требуемые роли: chairman, member. |
type - String!
|
Тип организации |
Example
{
"bank_account": BankPaymentMethod,
"braname": "abc123",
"city": "xyz789",
"coopname": "abc123",
"country": "xyz789",
"details": OrganizationDetails,
"email": "abc123",
"fact_address": "xyz789",
"full_address": "xyz789",
"full_name": "xyz789",
"phone": "xyz789",
"represented_by": RepresentedBy,
"short_name": "xyz789",
"trusted": [Individual],
"trustee": Individual,
"type": "xyz789"
}
ContactsDTO
Fields
Field Name | Description |
---|---|
chairman - PublicChairman!
|
|
details - OrganizationDetails!
|
|
email - String!
|
|
full_address - String!
|
|
full_name - String!
|
|
phone - String!
|
Example
{
"chairman": PublicChairman,
"details": OrganizationDetails,
"email": "abc123",
"full_address": "abc123",
"full_name": "xyz789",
"phone": "abc123"
}
CooperativeOperatorAccount
Fields
Field Name | Description |
---|---|
announce - String!
|
Объявление кооператива |
coop_type - String!
|
Тип кооператива |
created_at - String!
|
Дата создания |
description - String!
|
Описание кооператива |
document - SignedBlockchainDocument!
|
Документ кооператива |
initial - String!
|
Начальный взнос |
is_branched - Boolean!
|
Разветвленный ли кооператив |
is_cooperative - Boolean!
|
Является ли это кооперативом |
is_enrolled - Boolean!
|
Включен ли кооператив |
meta - String!
|
Метаинформация |
minimum - String!
|
Минимальный взнос |
org_initial - String!
|
Начальный взнос организации |
org_minimum - String!
|
Минимальный взнос организации |
org_registration - String!
|
Регистрационный взнос организации |
parent_username - String!
|
Родительское имя аккаунта кооператива |
referer - String!
|
Реферал кооператива |
registered_at - String!
|
Дата регистрации |
registration - String!
|
Регистрационный взнос |
registrator - String!
|
Регистратор кооператива |
status - String!
|
Статус кооператива |
storages - [String!]!
|
Список хранилищ |
type - String!
|
Тип учетной записи |
username - String!
|
Имя аккаунта кооператива |
verifications - [Verification!]!
|
Дата регистрации |
Example
{
"announce": "xyz789",
"coop_type": "abc123",
"created_at": "abc123",
"description": "xyz789",
"document": SignedBlockchainDocument,
"initial": "xyz789",
"is_branched": false,
"is_cooperative": false,
"is_enrolled": false,
"meta": "abc123",
"minimum": "xyz789",
"org_initial": "xyz789",
"org_minimum": "abc123",
"org_registration": "abc123",
"parent_username": "abc123",
"referer": "abc123",
"registered_at": "abc123",
"registration": "abc123",
"registrator": "xyz789",
"status": "abc123",
"storages": ["xyz789"],
"type": "xyz789",
"username": "abc123",
"verifications": [Verification]
}
Country
Description
Страна регистрации пользователя
Values
Enum Value | Description |
---|---|
|
Example
"Russia"
CreateBankAccountInput
Fields
Input Field | Description |
---|---|
data - BankAccountInput!
|
Данные для банковского перевода |
is_default - Boolean!
|
Флаг основного метода платежа, который отображается в документах |
username - String!
|
Имя аккаунта пользователя |
Example
{
"data": BankAccountInput,
"is_default": true,
"username": "xyz789"
}
CreateBranchInput
Fields
Input Field | Description |
---|---|
based_on - String!
|
Документ, на основании которого действует Уполномоченный (решение совета №СС-.. от ..) |
braname - String!
|
Имя аккаунта кооперативного участка |
coopname - String!
|
Имя аккаунта кооператива |
email - String!
|
Электронная почта |
fact_address - String!
|
Фактический адрес |
full_name - String!
|
Полное имя организации кооперативного участка |
phone - String!
|
Телефон |
short_name - String!
|
Краткое имя организации кооперативного участка |
trustee - String!
|
Имя аккаунта уполномоченного (председателя) кооперативного участка |
Example
{
"based_on": "xyz789",
"braname": "abc123",
"coopname": "xyz789",
"email": "abc123",
"fact_address": "xyz789",
"full_name": "xyz789",
"phone": "xyz789",
"short_name": "xyz789",
"trustee": "xyz789"
}
CreateDepositPaymentInput
CreateEntrepreneurDataInput
Fields
Input Field | Description |
---|---|
bank_account - BankAccountInput!
|
Банковский счет |
birthdate - String!
|
Дата рождения |
city - String!
|
Город |
country - Country!
|
Страна |
details - EntrepreneurDetailsInput!
|
Детали индивидуального предпринимателя |
first_name - String!
|
Имя |
full_address - String!
|
Полный адрес |
last_name - String!
|
Фамилия |
middle_name - String!
|
Отчество |
phone - String!
|
Телефон |
Example
{
"bank_account": BankAccountInput,
"birthdate": "xyz789",
"city": "abc123",
"country": "Russia",
"details": EntrepreneurDetailsInput,
"first_name": "abc123",
"full_address": "xyz789",
"last_name": "abc123",
"middle_name": "abc123",
"phone": "abc123"
}
CreateIndividualDataInput
Example
{
"birthdate": "xyz789",
"first_name": "xyz789",
"full_address": "xyz789",
"last_name": "xyz789",
"middle_name": "abc123",
"passport": PassportInput,
"phone": "xyz789"
}
CreateInitialPaymentInput
Fields
Input Field | Description |
---|---|
username - String!
|
Имя аккаунта пользователя |
Example
{"username": "xyz789"}
CreateOrganizationDataInput
Fields
Input Field | Description |
---|---|
bank_account - BankAccountInput!
|
Банковский счет организации |
city - String!
|
Город |
country - String!
|
Страна |
details - OrganizationDetailsInput!
|
Детали организации |
fact_address - String!
|
Фактический адрес |
full_address - String!
|
Полный адрес |
full_name - String!
|
Полное наименование организации |
phone - String!
|
Телефон |
represented_by - RepresentedByInput!
|
Представитель организации |
short_name - String!
|
Краткое наименование организации |
type - OrganizationType!
|
Тип организации |
Example
{
"bank_account": BankAccountInput,
"city": "abc123",
"country": "xyz789",
"details": OrganizationDetailsInput,
"fact_address": "abc123",
"full_address": "xyz789",
"full_name": "xyz789",
"phone": "abc123",
"represented_by": RepresentedByInput,
"short_name": "abc123",
"type": "AO"
}
CreateProjectFreeDecisionInput
CreatedProjectFreeDecision
DateTime
Description
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
Example
"2007-12-03T10:15:30Z"
DecisionDetail
Description
Комплексный объект решения совета, включающий в себя информацию о голосовавших членах совета, расширенное действие, которое привело к появлению решения, и документ самого решения.
Fields
Field Name | Description |
---|---|
action - ExtendedBlockchainAction!
|
|
document - DecisionDocumentUnion!
|
|
votes_against - [ExtendedBlockchainAction!]!
|
|
votes_for - [ExtendedBlockchainAction!]!
|
Example
{
"action": ExtendedBlockchainAction,
"document": FreeDecisionDocument,
"votes_against": [ExtendedBlockchainAction],
"votes_for": [ExtendedBlockchainAction]
}
DecisionDocumentUnion
Description
Объединение типов документов протоколов решения совета
Types
Union Types |
---|
Example
FreeDecisionDocument
DeleteAccountInput
Fields
Input Field | Description |
---|---|
username_for_delete - String!
|
Имя аккаунта пользователя |
Example
{"username_for_delete": "abc123"}
DeleteBranchInput
DeletePaymentMethodInput
DeleteTrustedAccountInput
Example
{
"braname": "xyz789",
"coopname": "xyz789",
"trusted": "abc123"
}
DocumentPackage
Description
Комплексный объект папки цифрового документа, который включает в себя заявление, решение, акты и связанные документы
Fields
Field Name | Description |
---|---|
acts - [ActDetail!]!
|
Массив объект(ов) актов, относящихся к заявлению |
decision - DecisionDetail!
|
Объект цифрового документа решения |
links - [GeneratedDocument!]!
|
Массив связанных документов, извлечённых из мета-данных |
statement - StatementDetail!
|
Объект цифрового документа заявления |
Example
{
"acts": [ActDetail],
"decision": DecisionDetail,
"links": [GeneratedDocument],
"statement": StatementDetail
}
DocumentsPaginationResult
Fields
Field Name | Description |
---|---|
currentPage - Int!
|
Текущая страница |
items - [DocumentPackage!]!
|
Элементы текущей страницы |
totalCount - Int!
|
Общее количество элементов |
totalPages - Int!
|
Общее количество страниц |
Example
{
"currentPage": 123,
"items": [DocumentPackage],
"totalCount": 987,
"totalPages": 987
}
EditBranchInput
Fields
Input Field | Description |
---|---|
based_on - String!
|
Документ, на основании которого действует Уполномоченный (решение совета №СС-.. от ..) |
braname - String!
|
Имя аккаунта кооперативного участка |
coopname - String!
|
Имя аккаунта кооператива |
email - String!
|
Электронная почта |
fact_address - String!
|
Фактический адрес |
full_name - String!
|
Полное имя организации кооперативного участка |
phone - String!
|
Телефон |
short_name - String!
|
Краткое имя организации кооперативного участка |
trustee - String!
|
Имя аккаунта уполномоченного (председателя) кооперативного участка |
Example
{
"based_on": "xyz789",
"braname": "xyz789",
"coopname": "abc123",
"email": "xyz789",
"fact_address": "xyz789",
"full_name": "abc123",
"phone": "abc123",
"short_name": "xyz789",
"trustee": "xyz789"
}
Entrepreneur
Fields
Field Name | Description |
---|---|
birthdate - String!
|
Дата рождения |
city - String!
|
Город |
country - String!
|
Страна |
details - EntrepreneurDetails!
|
Детали ИП (ИНН, ОГРН) |
email - String!
|
|
first_name - String!
|
Имя |
full_address - String!
|
Юридический адрес |
last_name - String!
|
Фамилия |
middle_name - String!
|
Отчество |
phone - String!
|
Телефон |
username - String!
|
Имя аккаунта |
Example
{
"birthdate": "xyz789",
"city": "abc123",
"country": "xyz789",
"details": EntrepreneurDetails,
"email": "abc123",
"first_name": "xyz789",
"full_address": "abc123",
"last_name": "abc123",
"middle_name": "abc123",
"phone": "xyz789",
"username": "xyz789"
}
EntrepreneurDetails
EntrepreneurDetailsInput
ExtendedBlockchainAction
Description
Расширенное действие блокчейна с персональными данными пользователя, совершившего его.
Fields
Field Name | Description |
---|---|
account - String!
|
|
account_ram_deltas - [AccountRamDelta!]!
|
|
action_ordinal - Int!
|
|
authorization - [ActionAuthorization!]!
|
|
block_id - String!
|
|
block_num - Int!
|
|
chain_id - String!
|
|
console - String!
|
|
context_free - Boolean!
|
|
creator_action_ordinal - Int!
|
|
data - JSON!
|
Данные действия в формате JSON |
elapsed - Int!
|
|
global_sequence - String!
|
|
name - String!
|
|
receipt - ActionReceipt!
|
|
receiver - String!
|
|
transaction_id - String!
|
|
user - UserDataUnion
|
Доп. данные о пользователе (физ/ИП/организация) |
Example
{
"account": "xyz789",
"account_ram_deltas": [AccountRamDelta],
"action_ordinal": 123,
"authorization": [ActionAuthorization],
"block_id": "abc123",
"block_num": 123,
"chain_id": "xyz789",
"console": "abc123",
"context_free": true,
"creator_action_ordinal": 987,
"data": {},
"elapsed": 987,
"global_sequence": "xyz789",
"name": "xyz789",
"receipt": ActionReceipt,
"receiver": "abc123",
"transaction_id": "xyz789",
"user": Entrepreneur
}
Extension
Fields
Field Name | Description |
---|---|
available - Boolean!
|
Показывает, доступно ли расширение |
config - JSON
|
Настройки конфигурации для расширения |
created_at - DateTime!
|
Дата создания расширения |
description - String
|
Описание расширения |
enabled - Boolean!
|
Показывает, включено ли расширение |
image - String
|
Изображение для расширения |
installed - Boolean!
|
Показывает, установлено ли расширение |
instructions - String!
|
Поле инструкция для установки |
name - String!
|
Уникальное имя расширения |
readme - String!
|
Поле подробного текстового описания |
schema - JSON
|
Схема настроек конфигурации для расширения |
tags - [String!]!
|
Массив тегов для расширения |
title - String
|
Заголовок расширения |
updated_at - DateTime!
|
Дата последнего обновления расширения |
Example
{
"available": false,
"config": {},
"created_at": "2007-12-03T10:15:30Z",
"description": "abc123",
"enabled": true,
"image": "abc123",
"installed": true,
"instructions": "xyz789",
"name": "xyz789",
"readme": "abc123",
"schema": {},
"tags": ["abc123"],
"title": "xyz789",
"updated_at": "2007-12-03T10:15:30Z"
}
ExtensionInput
Fields
Input Field | Description |
---|---|
config - JSON!
|
Configuration settings for the extension |
created_at - DateTime
|
Timestamp of when the extension was created |
enabled - Boolean!
|
Indicates whether the extension is enabled |
name - String!
|
Unique name of the extension |
updated_at - DateTime
|
Timestamp of the last update to the extension |
Example
{
"config": {},
"created_at": "2007-12-03T10:15:30Z",
"enabled": true,
"name": "xyz789",
"updated_at": "2007-12-03T10:15:30Z"
}
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FreeDecisionDocument
Fields
Field Name | Description |
---|---|
binary - String!
|
Бинарное содержимое документа (base64) |
full_title - String!
|
Полное название документа |
hash - String!
|
Хэш документа |
html - String!
|
HTML содержимое документа |
meta - FreeDecisionMetaDocumentOutput!
|
Метаинформация для создания проекта свободного решения |
Example
{
"binary": "abc123",
"full_title": "xyz789",
"hash": "xyz789",
"html": "abc123",
"meta": FreeDecisionMetaDocumentOutput
}
FreeDecisionGenerateDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String
|
Дата и время создания документа |
decision_id - Float!
|
Идентификатор протокола решения собрания совета |
generator - String
|
Имя генератора, использованного для создания документа |
lang - String
|
Язык документа |
links - [String!]
|
Ссылки, связанные с документом |
project_id - String!
|
Идентификатор проекта решения |
timezone - String
|
Часовой пояс, в котором был создан документ |
title - String
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "xyz789",
"created_at": "xyz789",
"decision_id": 123.45,
"generator": "abc123",
"lang": "abc123",
"links": ["abc123"],
"project_id": "xyz789",
"timezone": "xyz789",
"title": "xyz789",
"username": "xyz789",
"version": "xyz789"
}
FreeDecisionMetaDocumentOutput
Fields
Field Name | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
decision_id - Float!
|
Идентификатор повестки дня |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - LangType!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
project_id - String!
|
Идентификатор протокола решения собрания совета |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 123,
"coopname": "xyz789",
"created_at": "abc123",
"decision_id": 123.45,
"generator": "xyz789",
"lang": "ru",
"links": ["abc123"],
"project_id": "xyz789",
"registry_id": 123,
"timezone": "xyz789",
"title": "xyz789",
"username": "xyz789",
"version": "xyz789"
}
GenerateDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String
|
Дата и время создания документа |
generator - String
|
Имя генератора, использованного для создания документа |
lang - String
|
Язык документа |
links - [String!]
|
Ссылки, связанные с документом |
timezone - String
|
Часовой пояс, в котором был создан документ |
title - String
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 123,
"coopname": "xyz789",
"created_at": "xyz789",
"generator": "xyz789",
"lang": "abc123",
"links": ["xyz789"],
"timezone": "xyz789",
"title": "xyz789",
"username": "abc123",
"version": "xyz789"
}
GenerateDocumentOptionsInput
Fields
Input Field | Description |
---|---|
skip_save - Boolean
|
Пропустить сохранение |
Example
{"skip_save": true}
GeneratedDocument
Fields
Field Name | Description |
---|---|
binary - String!
|
Бинарное содержимое документа (base64) |
full_title - String!
|
Полное название документа |
hash - String!
|
Хэш документа |
html - String!
|
HTML содержимое документа |
meta - MetaDocument!
|
Метаданные документа |
Example
{
"binary": "abc123",
"full_title": "xyz789",
"hash": "abc123",
"html": "xyz789",
"meta": MetaDocument
}
GetAccountInput
Fields
Input Field | Description |
---|---|
username - String!
|
Имя аккаунта пользователя |
Example
{"username": "xyz789"}
GetAccountsInput
GetBranchesInput
GetDocumentsFilterInput
GetDocumentsInput
Fields
Input Field | Description |
---|---|
filter - GetDocumentsFilterInput!
|
|
limit - Int
|
|
page - Int
|
|
type - String
|
Example
{
"filter": GetDocumentsFilterInput,
"limit": 987,
"page": 987,
"type": "xyz789"
}
GetExtensionsInput
GetPaymentMethodsInput
Fields
Input Field | Description |
---|---|
limit - Int!
|
Количество элементов на странице. Default = 10 |
page - Int!
|
Номер страницы. Default = 1 |
sortBy - String
|
Ключ сортировки (например, "name") |
sortOrder - String!
|
Направление сортировки ("ASC" или "DESC"). Default = "ASC" |
username - String
|
Имя пользователя для фильтрации методов оплаты |
Example
{
"limit": 123,
"page": 987,
"sortBy": "abc123",
"sortOrder": "abc123",
"username": "xyz789"
}
GetPaymentsInput
Fields
Input Field | Description |
---|---|
blockchain_id - String
|
Идентификатор платежа в блокчейне |
id - String
|
Идентификатор платежа во внутренней системе |
status - PaymentStatus
|
Статус платежа |
username - String
|
Имя пользователя для фильтрации платежей |
Example
{
"blockchain_id": "abc123",
"id": "abc123",
"status": "COMPLETED",
"username": "xyz789"
}
Individual
Example
{
"birthdate": "xyz789",
"email": "abc123",
"first_name": "abc123",
"full_address": "abc123",
"last_name": "xyz789",
"middle_name": "abc123",
"passport": Passport,
"phone": "abc123",
"username": "abc123"
}
Init
Fields
Input Field | Description |
---|---|
organization_data - CreateOrganizationDataInput!
|
Объект организации кооператива, которая обслуживает данный экземпляр программного обеспечения MONO |
vars - VarsInput!
|
Переменные кооператива, используемые для заполнения шаблонов документов |
Example
{
"organization_data": CreateOrganizationDataInput,
"vars": VarsInput
}
Install
Fields
Input Field | Description |
---|---|
soviet - [SovietMemberInput!]!
|
|
wif - String!
|
Example
{
"soviet": [SovietMemberInput],
"wif": "xyz789"
}
Int
Description
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
JSON
Description
The JSON
scalar type represents JSON values as specified by ECMA-404.
Example
{}
KeyWeight
LangType
Description
Язык документа
Values
Enum Value | Description |
---|---|
|
Example
"ru"
LoginInput
LogoutInput
MetaDocument
Fields
Field Name | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - LangType!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 123,
"coopname": "xyz789",
"created_at": "xyz789",
"generator": "xyz789",
"lang": "ru",
"links": ["xyz789"],
"registry_id": 987,
"timezone": "xyz789",
"title": "abc123",
"username": "abc123",
"version": "abc123"
}
MetaDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - String!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "xyz789",
"created_at": "xyz789",
"generator": "abc123",
"lang": "abc123",
"links": ["abc123"],
"registry_id": 123,
"timezone": "xyz789",
"title": "xyz789",
"username": "xyz789",
"version": "abc123"
}
MonoAccount
Fields
Field Name | Description |
---|---|
email - String!
|
Электронная почта пользователя |
has_account - Boolean!
|
Есть ли у пользователя аккаунт |
initial_order - String
|
ID начального заказа |
is_email_verified - Boolean!
|
Подтверждена ли электронная почта |
is_registered - Boolean!
|
Зарегистрирован ли пользователь |
message - String
|
Сообщение |
public_key - String!
|
Публичный ключ пользователя |
referer - String!
|
Реферер пользователя |
role - String!
|
Роль пользователя |
status - UserStatus!
|
Статус пользователя |
type - String!
|
Тип пользователя |
username - String!
|
Имя пользователя |
Example
{
"email": "xyz789",
"has_account": false,
"initial_order": "xyz789",
"is_email_verified": false,
"is_registered": true,
"message": "xyz789",
"public_key": "xyz789",
"referer": "xyz789",
"role": "xyz789",
"status": "Active",
"type": "abc123",
"username": "xyz789"
}
Organization
Fields
Field Name | Description |
---|---|
city - String!
|
Город |
country - String!
|
Страна |
details - OrganizationDetails!
|
Детали организации |
email - String!
|
|
fact_address - String!
|
Фактический адрес |
full_address - String!
|
Юридический адрес |
full_name - String!
|
Полное название |
phone - String!
|
Телефон |
represented_by - RepresentedBy!
|
Представитель организации |
short_name - String!
|
Краткое название |
type - String!
|
Тип организации |
username - String!
|
Имя аккаунта организации |
Example
{
"city": "xyz789",
"country": "abc123",
"details": OrganizationDetails,
"email": "xyz789",
"fact_address": "xyz789",
"full_address": "abc123",
"full_name": "abc123",
"phone": "xyz789",
"represented_by": RepresentedBy,
"short_name": "abc123",
"type": "abc123",
"username": "xyz789"
}
OrganizationDetails
OrganizationDetailsInput
OrganizationType
Description
Тип юридического лица
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AO"
PaginationInput
Example
{
"limit": 123,
"page": 123,
"sortBy": "xyz789",
"sortOrder": "xyz789"
}
ParticipantAccount
Fields
Field Name | Description |
---|---|
braname - String
|
Имя кооперативного участка |
created_at - DateTime!
|
Время создания записи о члене |
has_vote - Boolean!
|
LEGACY Флаг, имеет ли член право голоса |
is_initial - Boolean!
|
LEGACY Флаг, внесен ли регистрационный взнос |
is_minimum - Boolean!
|
LEGACY Флаг, внесен ли минимальный паевый взнос |
last_min_pay - DateTime!
|
Время последнего минимального платежа |
last_update - DateTime!
|
Время последнего обновления информации о члене |
status - String!
|
Статус члена кооператива (accepted | blocked) |
type - String
|
Тип участника (individual | entrepreneur | organization) |
username - String!
|
Уникальное имя члена кооператива |
Example
{
"braname": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"has_vote": false,
"is_initial": true,
"is_minimum": true,
"last_min_pay": "2007-12-03T10:15:30Z",
"last_update": "2007-12-03T10:15:30Z",
"status": "abc123",
"type": "abc123",
"username": "xyz789"
}
ParticipantApplicationDecisionDocument
Fields
Field Name | Description |
---|---|
binary - String!
|
Бинарное содержимое документа (base64) |
full_title - String!
|
Полное название документа |
hash - String!
|
Хэш документа |
html - String!
|
HTML содержимое документа |
meta - ParticipantApplicationDecisionMetaDocumentOutput!
|
Метаинформация для создания проекта свободного решения |
Example
{
"binary": "abc123",
"full_title": "abc123",
"hash": "abc123",
"html": "abc123",
"meta": ParticipantApplicationDecisionMetaDocumentOutput
}
ParticipantApplicationDecisionGenerateDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String
|
Дата и время создания документа |
decision_id - Float!
|
Идентификатор протокола решения собрания совета |
generator - String
|
Имя генератора, использованного для создания документа |
lang - String
|
Язык документа |
links - [String!]
|
Ссылки, связанные с документом |
timezone - String
|
Часовой пояс, в котором был создан документ |
title - String
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "xyz789",
"created_at": "xyz789",
"decision_id": 123.45,
"generator": "abc123",
"lang": "xyz789",
"links": ["abc123"],
"timezone": "xyz789",
"title": "xyz789",
"username": "xyz789",
"version": "abc123"
}
ParticipantApplicationDecisionMetaDocumentOutput
Fields
Field Name | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
decision_id - Float!
|
Идентификатор протокола решения собрания совета |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - LangType!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "xyz789",
"created_at": "abc123",
"decision_id": 987.65,
"generator": "abc123",
"lang": "ru",
"links": ["abc123"],
"registry_id": 987,
"timezone": "abc123",
"title": "xyz789",
"username": "abc123",
"version": "abc123"
}
ParticipantApplicationDocument
Fields
Field Name | Description |
---|---|
binary - String!
|
Бинарное содержимое документа (base64) |
full_title - String!
|
Полное название документа |
hash - String!
|
Хэш документа |
html - String!
|
HTML содержимое документа |
meta - ParticipantApplicationMetaDocumentOutput!
|
Метаинформация для создания проекта свободного решения |
Example
{
"binary": "xyz789",
"full_title": "abc123",
"hash": "xyz789",
"html": "abc123",
"meta": ParticipantApplicationMetaDocumentOutput
}
ParticipantApplicationGenerateDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String
|
Дата и время создания документа |
generator - String
|
Имя генератора, использованного для создания документа |
lang - String
|
Язык документа |
links - [String!]
|
Ссылки, связанные с документом |
signature - String!
|
Изображение собственноручной подписи (base-64) |
skip_save - Boolean!
|
Флаг пропуска сохранения документа (используется для предварительной генерации и демонстрации пользователю) |
timezone - String
|
Часовой пояс, в котором был создан документ |
title - String
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "abc123",
"created_at": "abc123",
"generator": "xyz789",
"lang": "xyz789",
"links": ["xyz789"],
"signature": "abc123",
"skip_save": true,
"timezone": "abc123",
"title": "abc123",
"username": "xyz789",
"version": "xyz789"
}
ParticipantApplicationMetaDocumentOutput
Fields
Field Name | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - LangType!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "abc123",
"created_at": "abc123",
"generator": "abc123",
"lang": "ru",
"links": ["abc123"],
"registry_id": 987,
"timezone": "abc123",
"title": "abc123",
"username": "abc123",
"version": "abc123"
}
ParticipantApplicationSignedDocumentInput
Fields
Input Field | Description |
---|---|
hash - String!
|
Хэш документа |
meta - ParticipantApplicationSignedMetaDocumentInput!
|
Метаинформация для создания проекта свободного решения |
public_key - String!
|
Публичный ключ документа |
signature - String!
|
Подпись документа |
Example
{
"hash": "xyz789",
"meta": ParticipantApplicationSignedMetaDocumentInput,
"public_key": "xyz789",
"signature": "xyz789"
}
ParticipantApplicationSignedMetaDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - String!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
registry_id - Int!
|
ID документа в реестре |
signature - String!
|
Изображение собственноручной подписи (base-64) |
skip_save - Boolean!
|
Флаг пропуска сохранения документа (используется для предварительной генерации и демонстрации пользователю) |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "xyz789",
"created_at": "xyz789",
"generator": "xyz789",
"lang": "xyz789",
"links": ["xyz789"],
"registry_id": 123,
"signature": "xyz789",
"skip_save": true,
"timezone": "xyz789",
"title": "abc123",
"username": "abc123",
"version": "xyz789"
}
Passport
PassportInput
Payment
Fields
Field Name | Description |
---|---|
amount - Float!
|
Сумма платежа |
blockchain_id - Float!
|
Идентификационный номер платежа в блокчейне |
created_at - DateTime!
|
Дата создания платежа |
details - PaymentDetails!
|
Детали платежа |
expired_at - DateTime!
|
Дата истечения срока давности платежа |
id - String!
|
Идентификатор платежа во внутренней системе учёта |
message - String!
|
Содержит сервисное сообщение провайдера об ошибке обработки платежа |
provider - String!
|
Идентификатор наименования провайдера платежа, ответственного за обработку |
status - PaymentStatus!
|
Идентификатор номера платежа, который отображается пользователю в платежных документах |
symbol - String!
|
Символ тикера валюты платежа |
updated_at - DateTime!
|
Дата обновления платежа |
username - String!
|
Имя аккаунта пользователя, совершающего платеж |
Example
{
"amount": 123.45,
"blockchain_id": 123.45,
"created_at": "2007-12-03T10:15:30Z",
"details": PaymentDetails,
"expired_at": "2007-12-03T10:15:30Z",
"id": "abc123",
"message": "abc123",
"provider": "xyz789",
"status": "COMPLETED",
"symbol": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"username": "xyz789"
}
PaymentDetails
Fields
Field Name | Description |
---|---|
amount_plus_fee - String!
|
Сумма платежа с учетом комиссии |
amount_without_fee - String!
|
Сумма платежа без учета комиссии |
data - String!
|
Строка с данными платежа |
fact_fee_percent - Float!
|
Фактический процент комиссии |
fee_amount - String!
|
Размер комиссии в абсолютных значениях |
fee_percent - Float!
|
Процент комиссии |
tolerance_percent - Float!
|
Допустимый процент отклонения |
Example
{
"amount_plus_fee": "xyz789",
"amount_without_fee": "abc123",
"data": "abc123",
"fact_fee_percent": 987.65,
"fee_amount": "xyz789",
"fee_percent": 123.45,
"tolerance_percent": 123.45
}
PaymentMethod
Fields
Field Name | Description |
---|---|
created_at - DateTime!
|
Дата создания |
data - PaymentMethodData!
|
Данные метода оплаты |
is_default - Boolean!
|
Флаг основного метода платежа, который отображается в документах |
method_id - String!
|
Идентификатор метода оплаты |
method_type - String!
|
Тип метода оплаты (например, sbp, bank_transfer) |
updated_at - DateTime!
|
Дата обновления |
username - String!
|
Имя пользователя, к которому привязан метод оплаты |
Example
{
"created_at": "2007-12-03T10:15:30Z",
"data": BankAccount,
"is_default": true,
"method_id": "xyz789",
"method_type": "xyz789",
"updated_at": "2007-12-03T10:15:30Z",
"username": "xyz789"
}
PaymentMethodData
Types
Union Types |
---|
Example
BankAccount
PaymentMethodPaginationResult
Fields
Field Name | Description |
---|---|
currentPage - Int!
|
Текущая страница |
items - [PaymentMethod!]!
|
Элементы текущей страницы |
totalCount - Int!
|
Общее количество элементов |
totalPages - Int!
|
Общее количество страниц |
Example
{
"currentPage": 123,
"items": [PaymentMethod],
"totalCount": 123,
"totalPages": 123
}
PaymentPaginationResult
Fields
Field Name | Description |
---|---|
currentPage - Int!
|
Текущая страница |
items - [Payment!]!
|
Элементы текущей страницы |
totalCount - Int!
|
Общее количество элементов |
totalPages - Int!
|
Общее количество страниц |
Example
{
"currentPage": 987,
"items": [Payment],
"totalCount": 123,
"totalPages": 123
}
PaymentStatus
Description
Статус платежа
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETED"
Permission
Fields
Field Name | Description |
---|---|
parent - String!
|
Родительское разрешение |
perm_name - String!
|
Имя разрешения |
required_auth - Authority!
|
Требуемые разрешения |
Example
{
"parent": "xyz789",
"perm_name": "abc123",
"required_auth": Authority
}
PermissionLevel
PermissionLevelWeight
Fields
Field Name | Description |
---|---|
permission - PermissionLevel!
|
Уровень разрешения |
weight - Int!
|
Вес |
Example
{"permission": PermissionLevel, "weight": 987}
ProjectFreeDecisionDocument
Fields
Field Name | Description |
---|---|
binary - String!
|
Бинарное содержимое документа (base64) |
full_title - String!
|
Полное название документа |
hash - String!
|
Хэш документа |
html - String!
|
HTML содержимое документа |
meta - ProjectFreeDecisionMetaDocumentOutput!
|
Метаинформация для создания проекта свободного решения |
Example
{
"binary": "abc123",
"full_title": "abc123",
"hash": "xyz789",
"html": "abc123",
"meta": ProjectFreeDecisionMetaDocumentOutput
}
ProjectFreeDecisionGenerateDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String
|
Дата и время создания документа |
generator - String
|
Имя генератора, использованного для создания документа |
lang - String
|
Язык документа |
links - [String!]
|
Ссылки, связанные с документом |
project_id - String!
|
Идентификатор проекта решения |
timezone - String
|
Часовой пояс, в котором был создан документ |
title - String
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 123,
"coopname": "abc123",
"created_at": "abc123",
"generator": "xyz789",
"lang": "abc123",
"links": ["abc123"],
"project_id": "abc123",
"timezone": "abc123",
"title": "abc123",
"username": "abc123",
"version": "xyz789"
}
ProjectFreeDecisionMetaDocumentOutput
Fields
Field Name | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - LangType!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
project_id - String!
|
Идентификатор проекта решения |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"coopname": "abc123",
"created_at": "xyz789",
"generator": "xyz789",
"lang": "ru",
"links": ["xyz789"],
"project_id": "xyz789",
"registry_id": 123,
"timezone": "xyz789",
"title": "xyz789",
"username": "xyz789",
"version": "abc123"
}
ProjectFreeDecisionSignedDocumentInput
Fields
Input Field | Description |
---|---|
hash - String!
|
Хэш документа |
meta - ProjectFreeDecisionSignedMetaDocumentInput!
|
Метаинформация для создания проекта свободного решения |
public_key - String!
|
Публичный ключ документа |
signature - String!
|
Подпись документа |
Example
{
"hash": "abc123",
"meta": ProjectFreeDecisionSignedMetaDocumentInput,
"public_key": "xyz789",
"signature": "xyz789"
}
ProjectFreeDecisionSignedMetaDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - String!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
project_id - String!
|
Идентификатор проекта решения |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 123,
"coopname": "abc123",
"created_at": "xyz789",
"generator": "abc123",
"lang": "abc123",
"links": ["abc123"],
"project_id": "abc123",
"registry_id": 987,
"timezone": "abc123",
"title": "xyz789",
"username": "abc123",
"version": "abc123"
}
PublicChairman
PublishProjectFreeDecisionInput
Fields
Input Field | Description |
---|---|
coopname - String!
|
Имя аккаунта кооператива |
document - ProjectFreeDecisionSignedDocumentInput!
|
Подписанный электронный документ (generateProjectOfFreeDecision) |
meta - String!
|
Строка мета-информации |
username - String!
|
Имя аккаунта пользователя |
Example
{
"coopname": "abc123",
"document": ProjectFreeDecisionSignedDocumentInput,
"meta": "abc123",
"username": "abc123"
}
RefreshInput
RefundRequest
RegisterAccountInput
Fields
Input Field | Description |
---|---|
email - String!
|
Электронная почта |
entrepreneur_data - CreateEntrepreneurDataInput
|
Данные индивидуального предпринимателя |
individual_data - CreateIndividualDataInput
|
Данные физического лица |
organization_data - CreateOrganizationDataInput
|
Данные организации |
public_key - String
|
Публичный ключ |
referer - String
|
Имя аккаунта реферера |
role - RegisterRole!
|
Роль пользователя |
type - AccountType!
|
Тип аккаунта |
username - String!
|
Имя пользователя |
Example
{
"email": "abc123",
"entrepreneur_data": CreateEntrepreneurDataInput,
"individual_data": CreateIndividualDataInput,
"organization_data": CreateOrganizationDataInput,
"public_key": "xyz789",
"referer": "abc123",
"role": "User",
"type": "Entrepreneur",
"username": "xyz789"
}
RegisterParticipantInput
Fields
Input Field | Description |
---|---|
privacy_agreement - SignedDigitalDocumentInput!
|
Подписанный документ политики конфиденциальности от пайщика |
signature_agreement - SignedDigitalDocumentInput!
|
Подписанный документ положения о цифровой подписи от пайщика |
statement - ParticipantApplicationSignedDocumentInput!
|
Подписанный документ заявления на вступление в кооператив от пайщика |
user_agreement - SignedDigitalDocumentInput!
|
Подписанный документ пользовательского соглашения от пайщика |
username - String!
|
Имя аккаунта пайщика |
wallet_agreement - SignedDigitalDocumentInput!
|
Подписанный документ положения целевой потребительской программы "Цифровой Кошелёк" от пайщика |
Example
{
"privacy_agreement": SignedDigitalDocumentInput,
"signature_agreement": SignedDigitalDocumentInput,
"statement": ParticipantApplicationSignedDocumentInput,
"user_agreement": SignedDigitalDocumentInput,
"username": "xyz789",
"wallet_agreement": SignedDigitalDocumentInput
}
RegisterRole
Description
Роль пользователя при регистрации
Values
Enum Value | Description |
---|---|
|
Example
"User"
RegisteredAccount
RepresentedBy
Example
{
"based_on": "abc123",
"first_name": "abc123",
"last_name": "xyz789",
"middle_name": "xyz789",
"position": "xyz789"
}
RepresentedByInput
ResetKeyInput
ResourceDelegationDTO
ResourceOverview
SbpAccount
Fields
Field Name | Description |
---|---|
phone - String!
|
Мобильный телефон получателя |
Example
{"phone": "abc123"}
SelectBranchDocument
Fields
Field Name | Description |
---|---|
binary - String!
|
Бинарное содержимое документа (base64) |
full_title - String!
|
Полное название документа |
hash - String!
|
Хэш документа |
html - String!
|
HTML содержимое документа |
meta - SelectBranchMetaDocumentOutput!
|
Метаинформация для документа выбора кооперативного участка |
Example
{
"binary": "xyz789",
"full_title": "abc123",
"hash": "xyz789",
"html": "xyz789",
"meta": SelectBranchMetaDocumentOutput
}
SelectBranchGenerateDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int
|
Номер блока, на котором был создан документ |
braname - String!
|
Идентификатор имени аккаунта кооперативного участка |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String
|
Дата и время создания документа |
generator - String
|
Имя генератора, использованного для создания документа |
lang - String
|
Язык документа |
links - [String!]
|
Ссылки, связанные с документом |
timezone - String
|
Часовой пояс, в котором был создан документ |
title - String
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 123,
"braname": "xyz789",
"coopname": "xyz789",
"created_at": "xyz789",
"generator": "abc123",
"lang": "xyz789",
"links": ["xyz789"],
"timezone": "abc123",
"title": "xyz789",
"username": "xyz789",
"version": "abc123"
}
SelectBranchInput
Fields
Input Field | Description |
---|---|
braname - String!
|
Имя аккаунта кооперативного участка |
coopname - String!
|
Имя аккаунта кооператива |
document - SelectBranchSignedDocumentInput!
|
Подписанный электронный документ (generateSelectBranchDocument) |
username - String!
|
Имя аккаунта пользователя |
Example
{
"braname": "xyz789",
"coopname": "abc123",
"document": SelectBranchSignedDocumentInput,
"username": "abc123"
}
SelectBranchMetaDocumentOutput
Fields
Field Name | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
braname - String!
|
Идентификатор имени аккаунта кооперативного участка |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - LangType!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"braname": "xyz789",
"coopname": "abc123",
"created_at": "xyz789",
"generator": "abc123",
"lang": "ru",
"links": ["abc123"],
"registry_id": 123,
"timezone": "abc123",
"title": "xyz789",
"username": "xyz789",
"version": "xyz789"
}
SelectBranchSignedDocumentInput
Fields
Input Field | Description |
---|---|
hash - String!
|
Хэш документа |
meta - SelectBranchSignedMetaDocumentInput!
|
Метаинформация для документа выбора кооперативного участка |
public_key - String!
|
Публичный ключ документа |
signature - String!
|
Подпись документа |
Example
{
"hash": "xyz789",
"meta": SelectBranchSignedMetaDocumentInput,
"public_key": "abc123",
"signature": "xyz789"
}
SelectBranchSignedMetaDocumentInput
Fields
Input Field | Description |
---|---|
block_num - Int!
|
Номер блока, на котором был создан документ |
braname - String!
|
Идентификатор имени аккаунта кооперативного участка |
coopname - String!
|
Название кооператива, связанное с документом |
created_at - String!
|
Дата и время создания документа |
generator - String!
|
Имя генератора, использованного для создания документа |
lang - String!
|
Язык документа |
links - [String!]!
|
Ссылки, связанные с документом |
registry_id - Int!
|
ID документа в реестре |
timezone - String!
|
Часовой пояс, в котором был создан документ |
title - String!
|
Название документа |
username - String!
|
Имя пользователя, создавшего документ |
version - String!
|
Версия генератора, использованного для создания документа |
Example
{
"block_num": 987,
"braname": "abc123",
"coopname": "abc123",
"created_at": "abc123",
"generator": "abc123",
"lang": "abc123",
"links": ["xyz789"],
"registry_id": 123,
"timezone": "abc123",
"title": "xyz789",
"username": "abc123",
"version": "xyz789"
}
SetPaymentStatusInput
Fields
Input Field | Description |
---|---|
id - String!
|
Идентификатор платежа, для которого устанавливается статус |
status - PaymentStatus!
|
Новый статус платежа |
Example
{"id": "xyz789", "status": "COMPLETED"}
SetWifInput
SignedBlockchainDocument
SignedDigitalDocumentInput
Fields
Input Field | Description |
---|---|
hash - String!
|
Хэш документа |
meta - MetaDocumentInput!
|
Метаинформация документа |
public_key - String!
|
Публичный ключ документа |
signature - String!
|
Подпись документа |
Example
{
"hash": "abc123",
"meta": MetaDocumentInput,
"public_key": "xyz789",
"signature": "abc123"
}
SovietMemberInput
Fields
Input Field | Description |
---|---|
individual_data - CreateIndividualDataInput!
|
|
role - String!
|
Example
{
"individual_data": CreateIndividualDataInput,
"role": "abc123"
}
StartResetKeyInput
Fields
Input Field | Description |
---|---|
email - String!
|
Электронная почта |
Example
{"email": "abc123"}
StatementDetail
Description
Комплексный объект цифрового документа заявления (или другого ведущего документа для цепочки принятия решений совета)
Fields
Field Name | Description |
---|---|
action - ExtendedBlockchainAction!
|
|
document - StatementDocumentUnion!
|
Example
{
"action": ExtendedBlockchainAction,
"document": ParticipantApplicationDocument
}
StatementDocumentUnion
Description
Объединение типов документов заявлений, или других документов, за которыми следует появление протокола решения совета
Types
Union Types |
---|
Example
ParticipantApplicationDocument
String
Description
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SystemInfo
Fields
Field Name | Description |
---|---|
blockchain_account - BlockchainAccount!
|
Объект системного аккаунта кооператива в блокчейне |
blockchain_info - BlockchainInfoDTO!
|
Набор данных с информацией о состоянии блокчейна |
contacts - ContactsDTO
|
Контакты кооператива |
cooperator_account - CooperativeOperatorAccount!
|
Объект аккаунта кооператива у оператора |
coopname - String!
|
Имя аккаунта кооператива |
system_status - SystemStatus!
|
Статус контроллера кооператива |
vars - Vars
|
Переменные кооператива |
Example
{
"blockchain_account": BlockchainAccount,
"blockchain_info": BlockchainInfoDTO,
"contacts": ContactsDTO,
"cooperator_account": CooperativeOperatorAccount,
"coopname": "xyz789",
"system_status": "active",
"vars": Vars
}
SystemStatus
Description
Состояние контроллера кооператива
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"active"
Token
Tokens
UninstallExtensionInput
Fields
Input Field | Description |
---|---|
name - String!
|
Фильтр по имени |
Example
{"name": "xyz789"}
Update
Fields
Input Field | Description |
---|---|
organization_data - UpdateOrganizationDataInput
|
Собственные данные кооператива, обслуживающего экземпляр платформы |
vars - VarsInput
|
Переменные кооператива, используемые для заполнения шаблонов документов |
Example
{
"organization_data": UpdateOrganizationDataInput,
"vars": VarsInput
}
UpdateAccountInput
Fields
Input Field | Description |
---|---|
email - String!
|
Электронная почта |
entrepreneur_data - UpdateEntrepreneurDataInput
|
Данные индивидуального предпринимателя |
individual_data - UpdateIndividualDataInput
|
Данные физического лица |
organization_data - UpdateOrganizationDataInput
|
Данные организации |
public_key - String
|
Публичный ключ |
referer - String
|
Имя аккаунта реферера |
role - RegisterRole!
|
Роль пользователя |
type - AccountType!
|
Тип аккаунта |
username - String!
|
Имя пользователя |
Example
{
"email": "abc123",
"entrepreneur_data": UpdateEntrepreneurDataInput,
"individual_data": UpdateIndividualDataInput,
"organization_data": UpdateOrganizationDataInput,
"public_key": "abc123",
"referer": "abc123",
"role": "User",
"type": "Entrepreneur",
"username": "xyz789"
}
UpdateBankAccountInput
Fields
Input Field | Description |
---|---|
data - BankAccountInput!
|
Данные банковского счёта |
is_default - Boolean!
|
Флаг основного метода платежа, который отображается в документах |
method_id - String!
|
Идентификатор платежного метода |
username - String!
|
Имя аккаунта пользователя |
Example
{
"data": BankAccountInput,
"is_default": false,
"method_id": "xyz789",
"username": "abc123"
}
UpdateEntrepreneurDataInput
Fields
Input Field | Description |
---|---|
birthdate - String!
|
Дата рождения |
city - String!
|
Город |
country - Country!
|
Страна |
details - EntrepreneurDetailsInput!
|
Детали индивидуального предпринимателя |
first_name - String!
|
Имя |
full_address - String!
|
Полный адрес |
last_name - String!
|
Фамилия |
middle_name - String!
|
Отчество |
phone - String!
|
Телефон |
Example
{
"birthdate": "abc123",
"city": "xyz789",
"country": "Russia",
"details": EntrepreneurDetailsInput,
"first_name": "xyz789",
"full_address": "xyz789",
"last_name": "abc123",
"middle_name": "xyz789",
"phone": "xyz789"
}
UpdateIndividualDataInput
Example
{
"birthdate": "abc123",
"first_name": "abc123",
"full_address": "xyz789",
"last_name": "abc123",
"middle_name": "xyz789",
"passport": PassportInput,
"phone": "abc123"
}
UpdateOrganizationDataInput
Fields
Input Field | Description |
---|---|
city - String!
|
Город |
country - String!
|
Страна |
details - OrganizationDetailsInput!
|
Детали организации |
fact_address - String!
|
Фактический адрес |
full_address - String!
|
Полный адрес |
full_name - String!
|
Полное наименование организации |
phone - String!
|
Телефон |
represented_by - RepresentedByInput!
|
Представитель организации |
short_name - String!
|
Краткое наименование организации |
type - OrganizationType!
|
Тип организации |
Example
{
"city": "xyz789",
"country": "abc123",
"details": OrganizationDetailsInput,
"fact_address": "xyz789",
"full_address": "abc123",
"full_name": "xyz789",
"phone": "xyz789",
"represented_by": RepresentedByInput,
"short_name": "abc123",
"type": "AO"
}
UserAccount
Fields
Field Name | Description |
---|---|
meta - String!
|
Метаинформация |
referer - String!
|
Реферал |
registered_at - String!
|
Дата регистрации |
registrator - String!
|
Регистратор |
status - String!
|
Статус аккаунта |
storages - [String!]!
|
Список хранилищ |
type - String!
|
Тип учетной записи |
username - String!
|
Имя аккаунта |
verifications - [Verification!]!
|
Дата регистрации |
Example
{
"meta": "xyz789",
"referer": "xyz789",
"registered_at": "xyz789",
"registrator": "abc123",
"status": "abc123",
"storages": ["abc123"],
"type": "abc123",
"username": "abc123",
"verifications": [Verification]
}
UserDataUnion
Description
Объединение информации о пользователях
Types
Union Types |
---|
Example
Entrepreneur
UserStatus
Description
Статус пользователя
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Active"
Vars
Fields
Field Name | Description |
---|---|
confidential_email - String!
|
|
confidential_link - String!
|
|
contact_email - String!
|
|
coopenomics_agreement - AgreementVar
|
|
coopname - String!
|
|
full_abbr - String!
|
|
full_abbr_dative - String!
|
|
full_abbr_genitive - String!
|
|
name - String!
|
|
participant_application - AgreementVar!
|
|
passport_request - String!
|
|
privacy_agreement - AgreementVar!
|
|
short_abbr - String!
|
|
signature_agreement - AgreementVar!
|
|
user_agreement - AgreementVar!
|
|
wallet_agreement - AgreementVar!
|
|
website - String!
|
Example
{
"confidential_email": "xyz789",
"confidential_link": "abc123",
"contact_email": "xyz789",
"coopenomics_agreement": AgreementVar,
"coopname": "abc123",
"full_abbr": "xyz789",
"full_abbr_dative": "abc123",
"full_abbr_genitive": "xyz789",
"name": "xyz789",
"participant_application": AgreementVar,
"passport_request": "xyz789",
"privacy_agreement": AgreementVar,
"short_abbr": "xyz789",
"signature_agreement": AgreementVar,
"user_agreement": AgreementVar,
"wallet_agreement": AgreementVar,
"website": "abc123"
}
VarsInput
Fields
Input Field | Description |
---|---|
confidential_email - String!
|
|
confidential_link - String!
|
|
contact_email - String!
|
|
coopenomics_agreement - AgreementInput
|
|
coopname - String!
|
|
full_abbr - String!
|
|
full_abbr_dative - String!
|
|
full_abbr_genitive - String!
|
|
name - String!
|
|
participant_application - AgreementInput!
|
|
passport_request - String!
|
|
privacy_agreement - AgreementInput!
|
|
short_abbr - String!
|
|
signature_agreement - AgreementInput!
|
|
user_agreement - AgreementInput!
|
|
wallet_agreement - AgreementInput!
|
|
website - String!
|
Example
{
"confidential_email": "abc123",
"confidential_link": "abc123",
"contact_email": "abc123",
"coopenomics_agreement": AgreementInput,
"coopname": "xyz789",
"full_abbr": "abc123",
"full_abbr_dative": "xyz789",
"full_abbr_genitive": "xyz789",
"name": "xyz789",
"participant_application": AgreementInput,
"passport_request": "abc123",
"privacy_agreement": AgreementInput,
"short_abbr": "abc123",
"signature_agreement": AgreementInput,
"user_agreement": AgreementInput,
"wallet_agreement": AgreementInput,
"website": "xyz789"
}
Verification
Example
{
"created_at": "abc123",
"is_verified": false,
"last_update": "abc123",
"notice": "xyz789",
"procedure": "abc123",
"verificator": "abc123"
}