Recuperação do Contrato

---

Recuperação do Contrato

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": "00.000.000/0000-00",
        "manager": {
          "manager_key": "UUID",
          "document_number": "00.000.000/0000-00",
          "manager_name": "SAMPLE MANAGER NAME"
        }
      },
      "assignor": {
        "assignor_key": "UUID",
        "document_number": "00.000.000/0000-00",
        "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": 0.00,
      "external_id": "ID EXTERNO",
      "case_number": "NÚMERO DO PROCESSO",
      "denial_reason": "MOTIVO DA NEGATIVA",
      "creation_datetime": "YYYY-MM-DDTHH:MM:SSZ",
      "products": [
        {
          "product_key": "UUID",
          "assignment_configuration_key": "UUID",
          "asset_type": "ccb | duplicata_mercantil | duplicata_servico",
          "status": "pending_signature | active | canceled",
          "has_coobligation": true,
        }
      ],
      "signature_batch_key": "UUID"
    }

Definição de Contrato de Cessão

Campo	Tipo	Descrição	Caracteres
assignment_contract_key *	string	Chave única de identificação do contrato.	36
fund_class *	object	Objeto fundo	--
assignor *	object	Objeto cedente.	--
consultant	object	Objeto consultor. Somente quando o consultor for parte do contrato.	--
assignment_contract_template *	object	Objeto template de contrato.	--
attached_documents *	array	Lista de documentos anexos.	Ver Definição de documentos anexos.
products *	array	Lista de produtos sob o contrato.	Ver Definição de documentos anexos.
proposal_agent *	string	Tipo do agente proponente do contrato.	--
status *	string	Status do contrato.	Ver Enumeradores de status do contrato de cessão.
credit_limit	number	Limite de crédito enviado.	--
external_id	string	Identificador externo do contrato. Normalmente o número do contrato	1 a 255
case_number	string	Número de caso. Único por fundo	--
denial_reason	string	Detalhes da recusa do gestor.	1 a 255
observation	string	Observações enviadas.	1 a 500
signature_batch_key	string	Identificador do lote de assinaturas.	36
creation_datetime	string	Datetime da criação do contrato.	--

Definição de Documento Anexo

Campo	Tipo	Descrição	Caracteres
document_key *	string	Chave única de identificação do documento.	36
document_type *	string	Tipo do documento.	--
status *	string	Status do documento.	Ver Enumeradores de status do documento.
document_template_key	string	Chave única de identificação do template que gerou o documento	36
required_parties	array	Lista de partes que assinam o documento em questão	--

Definição de Produto

Campo	Tipo	Descrição	Caracteres
product_key *	string	Chave única de identificação do produto.	36
assignment_configuration_key *	string	Chave de identificação da configuração de cessão. Necssária na esteira de compra de ativos.	36
asset_type *	string	Tipo do ativo.	--
status *	string	Status do produto.	--

---

Listagem de Contratos de Cessão

---

Request

ENDPOINT

/assignment_contract/assignment_contracts

MÉTODO

GET

Query Params

Parâmetro	Descrição
assignor_document_number	Documento do cedente
fund_class_document_number	Documento do fundo
fund_class_key	Identificador único do fundo (UUID)
status	Status da cessão
case_number	Número do caso
start_date	Data de início
end_date	Data de fim

Response

STATUS

200

Response Body

{
  "data": [
    {
      "assignment_contract_key": "UUID",
      "fund_class": {
        "fund_class_key": "UUID",
        "name": "SAMPLE FUND NAME",
        "document_number": "00.000.000/0000-00",
        "manager": {
          "manager_key": "UUID",
          "document_number": "00.000.000/0000-00",
          "manager_name": "SAMPLE MANAGER NAME"
        }
      },
      "assignor": {
        "assignor_key": "UUID",
        "document_number": "00.000.000/0000-00",
        "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": 0.00,
      "external_id": "ID EXTERNO",
      "case_number": "NÚMERO DO PROCESSO",
      "denial_reason": "MOTIVO DA NEGATIVA",
      "creation_datetime": "YYYY-MM-DDTHH:MM:SSZ",
      "products": [
        {
          "product_key": "UUID",
          "assignment_configuration_key": "UUID",
          "asset_type": "ccb | duplicata_mercantil | duplicata_servico",
          "status": "pending_signature | active | canceled",
          "has_coobligation": true,
        }
      ],
      "signature_batch_key": "UUID"
    }
  ],
  "limit": 10,
  "page": 0,
  "is_last_page": true
}

Enumeradores

Assignment Contract Status

Enumerador	Descrição
pending_document	Pendente geração dos documentos
sending_to_signature	Em envio para assinatura
pending_signature	Disponível para assinatura das partes
signed	Assinado
pending_manager_approval	Pendente aprovação do gestor
denied	Reprovado na análise do gestor
pending_signature_submission	Pendente envio manual para assinatura
pending_assignor_registry_release	Pendente liberação do cadastro de cedente vinculado (Em proceso de cadastro ou atualização)
canceled	Cancelado

Attached Document Status

Enumerador	Descrição
pending_generate	Pendente geração do documento
approved	Documento gerado
signed	Documento assinado