Pular para o conteúdo principal

Recuperação do contrato


Recuperação do Contrato​

Retorna um contrato de cessão, com seus documentos e produtos. É a forma de consultar o status de cada produto e a assignment_configuration_key gerada após a assinatura.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer contratos de cessão

URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY
MÉTODO
GET

Response​

STATUS
200
Response Body
{
"assignment_contract_key": "UUID",
"fund_class": {
"fund_class_key": "UUID",
"name": "SAMPLE FUND NAME",
"document_number": "22.233.344/0001-83",
"manager": {
"manager_key": "UUID",
"document_number": "33.344.455/0001-83",
"manager_name": "SAMPLE MANAGER NAME"
}
},
"assignor": {
"assignor_key": "UUID",
"document_number": "55.666.777/0001-81",
"name": "SAMPLE ASSIGNOR NAME"
},
"assignment_contract_template": {
"assignment_contract_template_key": "UUID",
"document_template_key": "UUID",
"name": "NOME DO TEMPLATE",
"borrower_agreement": null
},
"attached_documents": [
{
"document_key": "UUID",
"document_type": "assignment_contract",
"status": "pending_generate",
"document_template_key": "UUID",
"required_parties": ["manager", "assignor", "consultant"]
}
],
"proposal_agent": "consultant",
"status": "pending_document",
"credit_limit": 1000000.0,
"external_id": "ID EXTERNO",
"case_number": "NÚMERO DO PROCESSO",
"denial_reason": null,
"observation": "OBSERVAÇÃO",
"disbursement_account_key": null,
"creation_datetime": "YYYY-MM-DDTHH:MM:SSZ",
"products": [
{
"product_key": "UUID",
"assignment_configuration_key": null,
"fund_class_configuration_key": "UUID",
"product_type": "assignment_term",
"asset_type": "ccb",
"status": "pending_contract_signature",
"has_coobligation": true
}
],
"signature_batch_key": "UUID"
}

Definição de Contrato de Cessão​

CampoTipoDescriçãoCaracteres
assignment_contract_key *stringChave única de identificação do contrato.36
fund_class *objectObjeto fundo--
assignor *objectObjeto cedente.--
consultantobjectObjeto consultor. Somente quando o consultor for parte do contrato.--
assignment_contract_template *objectObjeto template de contrato.--
attached_documents *arrayLista de documentos anexos.Ver Definição de Documento Anexo.
products *arrayLista de produtos sob o contrato.Ver Definição de Produto.
proposal_agent *stringTipo do agente proponente do contrato.--
status *stringStatus do contrato.Ver Enumeradores de status do contrato de cessão.
credit_limitnumberLimite de crédito enviado.--
external_idstringIdentificador externo do contrato. Normalmente o número do contratoAté 50
case_numberstringNúmero de caso. Único por fundo--
denial_reasonstringDetalhes da recusa do gestor.Até 500
observationstringObservações enviadas.Até 1000
disbursement_account_keystringConta de desembolso fixada no contrato, quando o template exige uma.36
signature_batch_keystringIdentificador do lote de assinaturas.36
creation_datetimestringDatetime da criação do contrato.--

Definição de Documento Anexo​

CampoTipoDescriçãoCaracteres
document_key *stringChave única de identificação do documento.36
document_type *stringTipo do documento.--
status *stringStatus do documento.Ver Enumeradores de status do documento.
document_template_keystringChave única de identificação do template que gerou o documento36
required_partiesarrayLista de partes que assinam o documento em questão--

Definição de Produto​

CampoTipoDescriçãoCaracteres
product_key *stringChave única de identificação do produto.36
assignment_configuration_keystringChave de identificação da configuração de cessão. Necessária na esteira de compra de ativos. null até o produto ficar active.36
fund_class_configuration_key *stringConfiguração do fundo que originou o produto.36
product_type *stringTipo do produto (por exemplo, assignment_term, assignment_repurchase).--
asset_type *stringTipo do ativo.--
has_coobligation *booleanSe há coobrigação do cedente.--
status *stringStatus do produto. Ver Product Status.--

Erros​

StatusCódigoQuando acontece
404ACT000023assignment_contract_key não encontrado.
403ACT000024O contrato existe, mas o agente autenticado não é parte dele.

Erros de autenticação, permissão e host: veja Erros da API.


Listagem de Contratos de Cessão​

Lista os contratos de cessão visíveis para o agente autenticado, com paginação.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer contratos de cessão

URL base de cada host: Ambientes (Hosts).

Request​

ENDPOINT
/assignment_contract/assignment_contracts
MÉTODO
GET

Query Params​

ParâmetroDescrição
assignor_document_numberDocumento do cedente
fund_class_document_numberDocumento do fundo
fund_class_keyIdentificador único do fundo (UUID)
statusStatus do contrato. Aceita vários, separados por vírgula
proposal_agent_typeQuem propôs o contrato: manager ou consultant
case_numberNúmero do caso
start_dateData de início (YYYY-MM-DD)
end_dateData de fim (YYYY-MM-DD)
pagePágina, começando em 0. Padrão 0
limitItens por página. Padrão 20, máximo 100

Use is_last_page da resposta para saber quando parar de paginar.

Response​

STATUS
200
Response Body
{
"data": [
{
"assignment_contract_key": "UUID",
"fund_class": {
"fund_class_key": "UUID",
"name": "SAMPLE FUND NAME",
"document_number": "22.233.344/0001-83",
"manager": {
"manager_key": "UUID",
"document_number": "33.344.455/0001-83",
"manager_name": "SAMPLE MANAGER NAME"
}
},
"assignor": {
"assignor_key": "UUID",
"document_number": "55.666.777/0001-81",
"name": "SAMPLE ASSIGNOR NAME"
},
"assignment_contract_template": {
"assignment_contract_template_key": "UUID",
"document_template_key": "UUID",
"name": "NOME DO TEMPLATE",
"borrower_agreement": null
},
"attached_documents": [
{
"document_key": "UUID",
"document_type": "assignment_contract",
"status": "pending_generate",
"document_template_key": "UUID",
"required_parties": ["manager", "assignor", "consultant"]
}
],
"proposal_agent": "consultant",
"status": "pending_document",
"credit_limit": 1000000.0,
"external_id": "ID EXTERNO",
"case_number": "NÚMERO DO PROCESSO",
"denial_reason": null,
"observation": "OBSERVAÇÃO",
"disbursement_account_key": null,
"creation_datetime": "YYYY-MM-DDTHH:MM:SSZ",
"products": [
{
"product_key": "UUID",
"assignment_configuration_key": null,
"fund_class_configuration_key": "UUID",
"product_type": "assignment_term",
"asset_type": "ccb",
"status": "pending_contract_signature",
"has_coobligation": true
}
],
"signature_batch_key": "UUID"
}
],
"limit": 20,
"page": 0,
"is_last_page": true
}

Erros​

StatusCódigoQuando acontece
400—limit acima de 100 ou page negativo.

Erros de autenticação, permissão e host: veja Erros da API.

Enumeradores​

Os status do contrato, dos produtos e dos documentos estão em Criação do Contrato › Enumeradores.