{ "swagger": "2.0", "info": { "description": "This API has the following features: -Performs registration of Lien and encumbrances -Consultation protocol pending approval of registration of encumbrances -Query inclusion status and record maintenance of encumbrances -Performs record maintenance of encumbrances -Approval of the registration of encumbrances -Performs execution of encumbrances -Performs extinction of registration of encumbrances ", "version": "1.0.0-rc18", "title": "Liens" }, "schemes": [ "https" ], "basePath": "/api/liens/v1", "host": "Caminho_backend", "tags": [ { "name": "Liens" } ], "paths": { "/liens/{protocolNumber}/approvals": { "patch": { "tags": [ "Liens" ], "summary": "Approval of the registration of encumbrances ", "operationId": "ApprovalPatch", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": true, "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, { "in": "query", "name": "approvalStatusCode", "description": "Contains the information of the approval or rejection of the destination party. Domains True = approved False = rejected", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/EncumbranceApprovalRspPatch" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error" } } } }, "/liens/{protocolNumber}/executions": { "put": { "tags": [ "Liens" ], "summary": "Performs execution of encumbrances", "operationId": "ExecutionPut", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": true, "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, { "in": "body", "name": "DataEncumbranceReq", "required": true, "schema": { "$ref": "#/definitions/DataEncumbranceReq" } } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DataEncumbranceRsp" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error" } } } }, "/liens": { "get": { "tags": [ "Liens" ], "summary": "Consultation protocol pending approval of registration of encumbrances", "operationId": "EncumbranceInformationGet", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationTypeCode", "description": "Informs the operation type code Domains 1 - Registration 2 - Maintenance 3 - Extinction 4 - Execution", "required": true, "type": "integer", "enum": [ 1, 2, 3, 4 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, { "in": "query", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": false, "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, { "in": "query", "name": "encumbranceTypeCode", "description": "Informs the encumbrance type. Domains 1 - Fiduciary alienation 2 - Usufruct 3 - Pledge 4 - Inalienability 5 - Unseizability", "required": false, "type": "integer", "enum": [ 1, 2, 3 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, { "in": "query", "name": "creditorCustodianCode", "description": "Operational Code of the Creditors Custodian. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3. ", "required": false, "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, { "in": "query", "name": "creditorInvestorCode", "description": "Creditor Investor Code. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3. ", "required": false, "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, { "in": "query", "name": "creditorDocumentNumber", "description": "Creditors Investor Document CPF CNPJ.", "required": false, "type": "string", "maxLength": 19 }, { "in": "query", "name": "debtorCustodianCode", "description": "Operational Code of the Debtors Custodian ", "required": false, "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, { "in": "query", "name": "debtorInvestorCode", "description": "Debtor Investor Code ", "required": false, "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, { "in": "query", "name": "debtorDocumentNumber", "description": "Debtors Investor Document CPF CNPJ ", "required": false, "type": "string", "maxLength": 19 }, { "in": "query", "name": "protocolStatusCode", "description": "Informs the status of the encumbrance registration or maintenance request. Domains OperationTypeCode = 1 - registration S1 - Registro aguardando confirmação do Agente de Custódia S3 - Aguardando confirmação de alterações na solicitação de registro S5 - Registro aguardando confirmação OperationTypeCode = 2 - maintenance S8 - Aguardando confirmação de alteração pelo agente de custódia S10 - Alteração aguardando confirmação OperationTypeCode = 3 - extinction S12 - Aguardando confirmação de extinção pelo agente de custódia S14 - Extinção aguardando confirmação OperationTypeCode = 4 - execution S17 - Execução aguardando confirmação S25 - Execução parcial aguardando confirmação ", "required": false, "type": "string", "enum": [ "S1", "S3", "S5", "S8", "S10", "S12", "S14", "S17", "S25" ], "maxLength": 3 } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/EncumbranceInformationRspGet" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error." } } }, "post": { "tags": [ "Liens" ], "summary": "Performs registration of Lien and encumbrances", "operationId": "EncumbranceInformationPost", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "EncumbranceInformationReqPost", "required": true, "schema": { "$ref": "#/definitions/EncumbranceInformationReqPost" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/EncumbranceInformationRspPost" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": " Bad Request", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": " Not Found", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": " Unprocessable Entity", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error" } } } }, "/liens/{protocolNumber}/instruments": { "get": { "tags": [ "Liens" ], "summary": "Consultation of contractual instruments sent by protocol by the participant", "operationId": "ContractualInstrumentGet", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": true, "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ContractualInstrumentRspGet" }, "headers": { "x-v": { "type": "string", "maxLength": 20, "minLength": 9, "description": "Versão da API. Ex: 1.0.0-rc1" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error." } } } }, "/liens/instruments": { "post": { "tags": [ "Liens" ], "summary": "Performs inclusion of the contractual instrument for the registration of liens and encumbrances", "operationId": "InstrumentPost", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "EncumbranceInstrumenReqPost", "required": true, "schema": { "$ref": "#/definitions/EncumbranceInstrumenReqPost" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/EncumbranceInstrumentRspPost" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": " Bad Request", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": " Not Found", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": " Unprocessable Entity", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Liens" ], "summary": "Consultation of the contractual instrument through Instrument ID", "operationId": "ContractualInstrument2Get", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": true, "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 }, { "in": "query", "name": "fileInstrumentNumber", "description": "File identification in the SOG base", "required": true, "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ContractualInstrument2RspGet" }, "headers": { "x-v": { "type": "string", "maxLength": 20, "minLength": 9, "description": "Versão da API. Ex: 1.0.0-rc1" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error." } } } }, "/liens/{protocolNumber}/extinctions": { "put": { "tags": [ "Liens" ], "summary": "Performs extinction of registration of encumbrances ", "operationId": "ExtinctionPut", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": true, "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/EncumbranceExtinctionsRspPut" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error" } } } }, "/liens/{protocolNumber}": { "put": { "tags": [ "Liens" ], "summary": "Performs record maintenance of encumbrances ", "operationId": "EncumbranceInformationPut", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": true, "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, { "in": "body", "name": "EncumbranceInformationReqPut", "required": true, "schema": { "$ref": "#/definitions/EncumbranceInformationReqPut" } } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/EncumbranceInformationRspPut" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Liens" ], "summary": "Query inclusion status and record maintenance of encumbrances", "operationId": "EncumbranceOperationGet", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "protocolNumber", "description": "Protocol number generated by the SOG system ", "required": true, "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/EncumbranceOperationRspGet" }, "headers": { "x-v": { "type": "string", "description": "Versão da api. Ex 1.0.0" } } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/Errors" } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/Errors" } }, "422": { "description": "Unprocessable Entity.", "schema": { "$ref": "#/definitions/Errors" } }, "500": { "description": "Internal Server Error." } } } } }, "definitions": { "EncumbranceApprovalRspPatch": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataApprovalRsp" } }, "required": [ "data" ] }, "DataEncumbranceReq": { "type": "object", "properties": { "data": { "$ref": "#/definitions/Data2" } }, "required": [ "data" ] }, "EncumbranceInformationRspGet": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/DataEncumbranceInformationRspGet" } }, "links": { "$ref": "#/definitions/Link" } }, "required": [ "data", "links" ] }, "EncumbranceInformationReqPost": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbranceInformationReq" } } }, "ContractualInstrumentRspGet": { "type": "object", "properties": { "data": { "$ref": "#/definitions/Data4" }, "links": { "$ref": "#/definitions/Link" } }, "required": [ "data", "links" ] }, "DataContractualInstrumentInformationReq": { "type": "object", "properties": { "protocolNumber": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "Número do protocolo gerado pelo Sistema de Ônus e Gravames", "example": 9999999999 }, "numberOfFiles": { "type": "integer", "format": "int16", "minimum": -32768, "maximum": 32768, "description": "Informa a quantidade de arquivos que esta sendo enviada", "example": 32767 }, "operationTypeCode": { "type": "integer", "format": "int16", "minimum": -32768, "maximum": 32768, "description": "Informs the operation type code Informa o código tipo da operação", "example": 32767 }, "dailyFileSequence": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informa a sequência de arquivos enviados naquele dia", "example": 2147483647 }, "instrumentFiles": { "type": "array", "items": { "$ref": "#/definitions/InstrumentFile" } } }, "required": [ "protocolNumber", "numberOfFiles", "operationTypeCode", "dailyFileSequence", "instrumentFiles" ] }, "EncumbranceInformationRspPut": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbrance1Rsp" } }, "required": [ "data" ] }, "EncumbranceOperationRspGet": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbranceOperationRsp" }, "links": { "$ref": "#/definitions/Link" } }, "required": [ "data", "links" ] }, "DataApprovalRsp": { "type": "object", "properties": { "protocolNumber": { "type": "integer", "format": "int64", "minimum": -2147483648, "maximum": 2147483647, "description": "Protocol number generated by the SOG system ", "example": 9999999999 }, "operationTypeCode": { "type": "integer", "enum": [ 1, 2, 3, 4 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the operation type code Domains 1 - Registration 2 - Maintenance 3 - Extinction 4 - Execution", "example": 2147483647 }, "encumbranceTypeCode": { "type": "integer", "enum": [ 1, 2, 3, 4, 5 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the encumbrance type. Domains 1 - Fiduciary alienation 2 - Usufruct 3 - Pledge 4 - Inalienability 5 - Unseizability", "example": 2147483647 }, "universalEncumbranceIndicator": { "type": "boolean", "description": "Informs whether the encumbrance is universal true false " }, "protocolStatusCode": { "type": "string", "enum": [ "S1", "S3", "S5", "S8", "S10", "S12", "S14", "S17", "S25" ], "maxLength": 3, "description": "Informs the status of the encumbrance registration or maintenance request. Domains OperationTypeCode = 1 - registration S1 - Registro aguardando confirmação do Agente de Custódia S3 - Aguardando confirmação de alterações na solicitação de registro S5 - Registro aguardando confirmação OperationTypeCode = 2 - maintenance S8 - Aguardando confirmação de alteração pelo agente de custódia S10 - Alteração aguardando confirmação OperationTypeCode = 3 - extinction S12 - Aguardando confirmação de extinção pelo agente de custódia S14 - Extinção aguardando confirmação OperationTypeCode = 4 - execution S17 - Execução aguardando confirmação S25 - Execução parcial aguardando confirmação " }, "status": { "type": "array", "items": { "$ref": "#/definitions/Status" } } }, "required": [ "protocolNumber", "operationTypeCode", "encumbranceTypeCode", "universalEncumbranceIndicator", "protocolStatusCode" ] }, "Asset2": { "type": "object", "properties": { "segmentTypeCode": { "type": "integer", "enum": [ 1 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Inform the segment.1 - Listado.", "example": 2147483647 }, "tickerCode": { "type": "string", "maxLength": 12, "description": "Asset ticker code. Mandatory inform ticker code or ISIN code." }, "isinCode": { "type": "string", "maxLength": 12, "description": "Asset ISIN code. Mandatory inform ticker code or ISIN code." }, "acquisitionDate": { "type": "string", "format": "date", "description": "Informs date of acquisition", "example": "2020-07-21" }, "acquisitionValue": { "type": "number", "format": "double", "pattern": "^-?(\\d{1,15})(\\.\\d{1,6})?$", "description": "Informs price of acquisition" }, "assetQuantityExecution": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "Asset quantity", "example": 9999999999 } } }, "DataEncumbranceInformationRspGet": { "type": "object", "properties": { "operationTypeCode": { "type": "integer", "enum": [ 1, 2, 3, 4 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the operation type code Domains 1 - Registration 2 - Maintenance 3 - Extinction 4 - Execution", "example": 2147483647 }, "protocolStatusCode": { "type": "string", "enum": [ "S1", "S3", "S5", "S8", "S10", "S12", "S14", "S17", "S25" ], "maxLength": 3, "description": "Informs the status of the encumbrance registration or maintenance request. Domains OperationTypeCode = 1 - registration S1 - Registro aguardando confirmação do Agente de Custódia S3 - Aguardando confirmação de alterações na solicitação de registro S5 - Registro aguardando confirmação OperationTypeCode = 2 - maintenance S8 - Aguardando confirmação de alteração pelo agente de custódia S10 - Alteração aguardando confirmação OperationTypeCode = 3 - extinction S12 - Aguardando confirmação de extinção pelo agente de custódia S14 - Extinção aguardando confirmação OperationTypeCode = 4 - execution S17 - Execução aguardando confirmação S25 - Execução parcial aguardando confirmação " }, "protocolNumber": { "type": "integer", "format": "int64", "minimum": -2147483648, "maximum": 2147483647, "description": "Protocol number generated by the SOG system ", "example": 9999999999 }, "encumbranceInformation": { "$ref": "#/definitions/EncumbranceInformation" }, "assets": { "type": "array", "items": { "$ref": "#/definitions/Assets" } }, "corporateEventTreatment": { "$ref": "#/definitions/CorporateEventTreatment" } }, "required": [ "operationTypeCode", "protocolStatusCode", "protocolNumber", "encumbranceInformation" ] }, "DataEncumbranceInformationReq": { "type": "object", "properties": { "encumbranceInformation": { "$ref": "#/definitions/EncumbranceInformation" }, "assets": { "type": "array", "items": { "$ref": "#/definitions/Asset1" } }, "corporateEventTreatment": { "$ref": "#/definitions/CorporateEventTreatment" } }, "required": [ "encumbranceInformation" ] }, "Data4": { "type": "object", "properties": { "protocolNumber": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "Protocol number generated by the SOG system", "example": 9999999999 }, "participantCode": { "type": "integer", "format": "int16", "minimum": -32768, "maximum": 32768, "description": "Participant code in SINCAD", "example": 32767 }, "instrumentFiles": { "type": "array", "items": { "$ref": "#/definitions/InstrumentFile2" } } }, "required": [ "protocolNumber", "participantCode" ] }, "EncumbranceInstrumenReqPost": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataContractualInstrumentInformationReq" } }, "required": [ "data" ] }, "ContractualInstrument2RspGet": { "type": "object", "properties": { "data": { "$ref": "#/definitions/Data3" }, "links": { "$ref": "#/definitions/Link" } }, "required": [ "data", "links" ] }, "EncumbranceExtinctionsRspPut": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbrance1Rsp" } }, "required": [ "data" ] }, "DataEncumbrance1Rsp": { "type": "object", "properties": { "protocolNumber": { "type": "integer", "format": "int64", "minimum": -2147483648, "maximum": 2147483647, "description": "Protocol number generated by the SOG system ", "example": 9999999999 }, "status": { "type": "array", "items": { "$ref": "#/definitions/Status" } } }, "required": [ "protocolNumber" ] }, "DataEncumbranceOperationRsp": { "type": "object", "properties": { "protocolNumber": { "type": "integer", "format": "int64", "minimum": -2147483648, "maximum": 2147483647, "description": "Protocol number generated by the SOG system ", "example": 9999999999 }, "status": { "type": "array", "items": { "$ref": "#/definitions/Status" } }, "encumbranceInformation": { "$ref": "#/definitions/EncumbranceInformation" }, "assets": { "type": "array", "items": { "$ref": "#/definitions/Assets" } }, "corporateEventTreatment": { "$ref": "#/definitions/CorporateEventTreatment" } }, "required": [ "protocolNumber", "encumbranceInformation" ] }, "Data2": { "type": "object", "properties": { "parcialExecution": { "type": "boolean", "description": "Indicates whether the operation is a partial execution." }, "assets": { "type": "array", "items": { "$ref": "#/definitions/Asset2" } } }, "required": [ "parcialExecution" ] }, "InstrumentFile": { "type": "object", "properties": { "fileName": { "type": "string", "maxLength": 200, "description": "Informa o nome do arquivo" }, "fileSequenceCode": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informa o código sequencial do arquivo", "example": 2147483647 }, "fileHexadecimal": { "type": "string", "description": "Informa o hexadecimal do arquivo" } }, "required": [ "fileName", "fileSequenceCode", "fileHexadecimal" ] }, "Status": { "type": "object", "properties": { "statusCode": { "type": "string", "maxLength": 2000, "description": "Request status " }, "statusDateTime": { "type": "string", "format": "datetime", "description": "Request processing date time ", "example": "2020-07-21T08:30:20.0Z" }, "comprehensiveDescription": { "type": "string", "maxLength": 2000, "description": "Provides comprehensive and detailed status information about requisition processing" } }, "required": [ "statusCode", "statusDateTime" ] }, "DataEncumbranceRsp": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbrance1Rsp" } }, "required": [ "data" ] }, "Asset1": { "type": "object", "properties": { "segmentTypeCode": { "type": "integer", "enum": [ 1 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Inform the segment.1 - Listado.", "example": 2147483647 }, "tickerCode": { "type": "string", "maxLength": 12, "description": "Asset ticker code. Mandatory inform ticker code or ISIN code." }, "isinCode": { "type": "string", "maxLength": 12, "description": "Asset ISIN code. Mandatory inform ticker code or ISIN code." }, "acquisitionDate": { "type": "string", "format": "date", "description": "Informs date of acquisition", "example": "2020-07-21" }, "acquisitionValue": { "type": "number", "format": "double", "pattern": "^-?(\\d{1,15})(\\.\\d{1,6})?$", "description": "Informs price of acquisition" }, "assetQuantity": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "Asset quantity", "example": 9999999999 }, "assetSubAccountCode": { "type": "string", "enum": [ "21016", "29017", "29068", "81019" ], "maxLength": 5, "description": "Identification of the portfolio at the depository. Domain values 21016 29017 29068 81019 *válido apenas para ativo ouro " }, "assetSubAccountCodeDestiny": { "type": "string", "enum": [ "62014", "62057", "62022", "62030" ], "maxLength": 5, "description": "Identification of the portfolio destiny at the depository. Domain values 62014 62057 62022 62030" } }, "required": [ "segmentTypeCode" ] }, "InstrumentFile2": { "type": "object", "properties": { "fileInstrumentNumber": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "File identification in the SOG base", "example": 2147483647 }, "fileName": { "type": "string", "maxLength": 255, "description": "File name" }, "fileType": { "type": "string", "maxLength": 50, "description": "File type" }, "instrumentSendDate": { "type": "string", "format": "date", "description": "Date of submission of the file by the participant", "example": "2020-07-21" }, "fileSize": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "File size", "example": 2147483647 } }, "required": [ "fileInstrumentNumber", "fileName", "fileType", "instrumentSendDate", "fileSize" ] }, "EncumbranceInstrumentRspPost": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbrance1Rsp" } }, "required": [ "data" ] }, "EncumbranceInformation": { "type": "object", "properties": { "encumbranceTypeCode": { "type": "integer", "enum": [ 1, 2, 3, 4, 5 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the encumbrance type. Domains 1 - Fiduciary alienation 2 - Usufruct 3 - Pledge 4 - Inalienability 5 - Unseizability", "example": 2147483647 }, "contractTypeCode": { "type": "integer", "enum": [ 1, 2, 3 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the representativeness of the registrys inclusion custody agent. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3. Domains 1 - Creditor 2 - Debtor 3 - Direct ", "example": 2147483647 }, "universalEncumbranceIndicator": { "type": "boolean", "description": "Informs whether the encumbrance is universal true false " }, "universalContractualInstrumentIndicator": { "type": "boolean", "description": "Universal Contractual Instrument. Informs whether the registry has a contractual instrument. *required if universalEncumbranceIndicator = true" }, "creditorCustodianCode": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Operational Code of the Creditors Custodian. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3.", "example": 2147483647 }, "creditorInvestorCode": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Creditor Investor Code. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3.", "example": 2147483647 }, "creditorDocumentNumber": { "type": "string", "maxLength": 19, "description": "Creditors Investor Document CPF CNPJ." }, "debtorCustodianCode": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Operational Code of the Debtors Custodian ", "example": 2147483647 }, "debtorInvestorCode": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Debtor Investor Code ", "example": 2147483647 }, "debtorDocumentNumber": { "type": "string", "maxLength": 19, "description": "Debtors Investor Document CPF CNPJ " }, "instrumentMaturityDate": { "type": "string", "format": "date", "description": "Contractual instrument maturity date. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3.", "example": "2020-07-21" }, "indeterminateInstrumentMaturityDate": { "type": "boolean", "description": "Informs whether the contractual instrument is indeterminated." }, "debtValue": { "type": "string", "maxLength": 30, "description": "Informs the debt value. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3. " }, "interestRateValue": { "type": "string", "maxLength": 30, "description": "Informs interest rate. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3 " }, "monetaryAdjustmentValue": { "type": "string", "maxLength": 30, "description": "Informs monetary adjustment. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3 " }, "penaltyClauseDescription": { "type": "string", "maxLength": 300, "description": "Informs penalty clause. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3 " }, "commissionValue": { "type": "string", "maxLength": 30, "description": "Informs commissions and charges. Required only forENCUMBRANCE TYPE CODE 1, 2 or 3 " }, "refereeIndicator": { "type": "boolean", "description": "Informs if there is a referee to define the execution of the encumbrance. true false " }, "refereeInformationDescription": { "type": "string", "maxLength": 200, "description": " Informs the referees data for execution " }, "balancePositionTypeCode": { "type": "integer", "enum": [ 1, 2 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the position of the balance. Mandatory only for ENCUMBRANCE TYPE CODE 1 - Fiduciary Alienation Domains 1 - CREDITOR 2 - DEBTOR", "example": 2147483647 }, "judicialProtocolNumber": { "type": "string", "maxLength": 80, "description": "Informs the number of judicial order" } }, "required": [ "encumbranceTypeCode", "debtorCustodianCode", "debtorInvestorCode", "refereeIndicator" ] }, "Assets": { "type": "object", "properties": { "segmentTypeCode": { "type": "integer", "enum": [ 1 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Inform the segment.1 - Listado.", "example": 2147483647 }, "tickerCode": { "type": "string", "maxLength": 12, "description": "Asset ticker code. Mandatory inform ticker code or ISIN code." }, "isinCode": { "type": "string", "maxLength": 12, "description": "Asset ISIN code. Mandatory inform ticker code or ISIN code." }, "acquisitionDate": { "type": "string", "format": "date", "description": "Informs date of acquisition", "example": "2020-07-21" }, "acquisitionValue": { "type": "number", "format": "double", "pattern": "^-?(\\d{1,15})(\\.\\d{1,6})?$", "description": "Informs price of acquisition" }, "assetQuantity": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "description": "Asset quantity", "example": 9999999999 }, "assetSubAccountCode": { "type": "string", "enum": [ "21016", "29017", "29068", "81019" ], "maxLength": 5, "description": "Identification of the portfolio at the depository. Domain values 21016 29017 29068 81019 *válido apenas para ativo ouro " }, "assetSubAccountCodeDestiny": { "type": "string", "enum": [ "62014", "62057", "62022", "62030" ], "maxLength": 5, "description": "Identification of the portfolio destiny at the depository. Domain values 62014 62057 62022 62030" } }, "required": [ "segmentTypeCode" ] }, "CorporateEventTreatment": { "type": "object", "properties": { "involuntaryFinancialPositionCode": { "type": "integer", "enum": [ 1, 2, 3, 4 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the direction of involuntary financial events.Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3 Domains 1 - CREDITOR 2 - DEBTOR 3 - INDICATE INSTITUTION ", "example": 2147483647 }, "involuntaryAssetPositionCode": { "type": "integer", "enum": [ 1, 2 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the direction of involuntary assets events. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3 Domains 1 - CREDITOR 2 - DEBTOR ", "example": 2147483647 }, "voluntaryAssetPositionCode": { "type": "integer", "enum": [ 1, 2 ], "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Informs the direction for the voluntary assets events. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3 Domains 1 - CREDITOR 2 - DEBTOR", "example": 2147483647 }, "bankAccountInformation": { "$ref": "#/definitions/BankAccountInformation" } }, "required": [ "involuntaryFinancialPositionCode", "involuntaryAssetPositionCode", "voluntaryAssetPositionCode" ] }, "EncumbranceInformationRspPost": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbrance1Rsp" } }, "required": [ "data" ] }, "InstrumentFile3": { "type": "object", "properties": { "fileInstrumentNumber": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "File identification in the SOG base", "example": 2147483647 }, "fileName": { "type": "string", "maxLength": 255, "description": "File name" }, "fileType": { "type": "string", "maxLength": 50, "description": "File type" }, "instrumentSendDate": { "type": "string", "format": "date", "description": "Date of submission of the file by the participant", "example": "2020-07-21" }, "fileSize": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "File size", "example": 2147483647 }, "fileHexadecimal": { "type": "string", "description": "Informs the file hexadecimal" } }, "required": [ "fileInstrumentNumber", "fileName", "fileType", "instrumentSendDate", "fileSize", "fileHexadecimal" ] }, "EncumbranceInformationReqPut": { "type": "object", "properties": { "data": { "$ref": "#/definitions/DataEncumbranceInformationReqPut" } } }, "BankAccountInformation": { "type": "object", "properties": { "bankCode": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Inform bank code", "example": 2147483647 }, "bankName": { "type": "string", "maxLength": 80, "description": "Inform bank name " }, "bankingAgencyCode": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647, "description": "Enter bank branch code", "example": 2147483647 }, "currentAccountNumber": { "type": "integer", "format": "int64", "minimum": -2147483648, "maximum": 2147483647, "description": "Enter current account number ", "example": 9999999999 }, "ownerAccountName": { "type": "string", "maxLength": 80, "description": "Enter the name of the account owner " }, "ownerAccountDocumentNumber": { "type": "string", "maxLength": 19, "description": "Informs CPF or CNPJ document of the account owner " } }, "required": [ "bankCode", "bankName", "bankingAgencyCode", "currentAccountNumber", "ownerAccountName", "ownerAccountDocumentNumber" ] }, "Data3": { "type": "object", "properties": { "protocolNumber": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "Protocol number generated by the SOG system", "example": 9999999999 }, "participantCode": { "type": "integer", "format": "int16", "minimum": -32768, "maximum": 32768, "description": "Participant code in SINCAD", "example": 32767 }, "instrumentFile": { "$ref": "#/definitions/InstrumentFile3" } }, "required": [ "protocolNumber", "participantCode", "instrumentFile" ] }, "DataEncumbranceInformationReqPut": { "type": "object", "properties": { "encumbranceInformation": { "$ref": "#/definitions/EncumbranceInformation1" }, "assets": { "type": "array", "items": { "$ref": "#/definitions/Assets" } }, "corporateEventTreatment": { "$ref": "#/definitions/CorporateEventTreatment1" } } }, "Link": { "type": "object", "properties": { "self": { "type": "string", "maxLength": 2000, "description": "Current page link" }, "first": { "type": "string", "maxLength": 2000, "description": "First page link" }, "prev": { "type": "string", "maxLength": 2000, "description": "Next page link" }, "next": { "type": "string", "maxLength": 2000, "description": "Next page link" }, "last": { "type": "string", "maxLength": 2000, "description": "Last page link" } }, "required": [ "self" ] }, "EncumbranceInformation1": { "type": "object", "properties": { "instrumentMaturityDate": { "type": "string", "format": "date", "description": "Contractual instrument maturity date. Required only for ENCUMBRANCE TYPE CODE 1, 2 or 3.", "example": "2020-07-21" }, "debtValue": { "type": "string", "maxLength": 30, "description": "Informs the debt value. " }, "interestRateValue": { "type": "string", "maxLength": 30, "description": "Informs interest rate. " }, "monetaryAdjustmentValue": { "type": "string", "maxLength": 30, "description": "Informs monetary adjustment." }, "penaltyClauseDescription": { "type": "string", "maxLength": 300, "description": "Informs penalty clause." }, "commissionValue": { "type": "string", "maxLength": 30, "description": "Informs commissions and charges. " }, "refereeIndicator": { "type": "boolean", "description": "Informs if there is a referee to define the execution of the encumbrance. true false " }, "refereeInformationDescription": { "type": "string", "maxLength": 200, "description": " Informs the referees data for execution " } } }, "Errors": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/Error" } }, "meta": { "$ref": "#/definitions/Meta" } } }, "Error": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 10, "description": "Código do erro." }, "title": { "type": "string", "maxLength": 100, "description": "Mensagem do erro." }, "detail": { "type": "string", "maxLength": 2000, "description": "Informações complementares sobre o erro." } }, "required": [ "code", "title", "detail" ] }, "CorporateEventTreatment1": { "type": "object", "properties": { "bankAccountInformation": { "$ref": "#/definitions/BankAccountInformation" } } }, "Meta": { "type": "object", "properties": { "errorDateTime": { "type": "string", "format": "datetime", "description": "Date and time of the business status.", "example": "2020-07-21T08:30:20.0Z" } } } } }