Contract retrieval

Contract Retrieval

Returns an assignment contract, with its documents and products. It is the way to check the status of each product and the assignment_configuration_key generated after signature.

Available on

Profile	Host	Required permission
Manager	`manager-api`	Read
Consultant	`consultant-api`	View assignment contracts

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY

METHOD

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": "TEMPLATE NAME",
        "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": "EXTERNAL ID",
      "case_number": "CASE NUMBER",
      "denial_reason": null,
      "observation": "OBSERVATION",
      "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"
    }

Assignment Contract Definition

Field	Type	Description	Characters
`assignment_contract_key` *	string	Unique key identifying the contract.	36
`fund_class` *	object	Fund object	--
`assignor` *	object	Assignor object.	--
`consultant`	object	Consultant object. Only when the consultant is a party to the contract.	--
`assignment_contract_template` *	object	Contract template object.	--
`attached_documents` *	array	List of attached documents.	See Attached Document Definition.
`products` *	array	List of products under the contract.	See Product Definition.
`proposal_agent` *	string	Type of the agent proposing the contract.	--
`status` *	string	Contract status.	See Assignment contract status enumerators.
`credit_limit`	number	Credit limit submitted.	--
`external_id`	string	External identifier of the contract. Usually the contract number	Up to 50
`case_number`	string	Case number. Unique per fund	--
`denial_reason`	string	Details of the manager's rejection.	Up to 500
`observation`	string	Observations submitted.	Up to 1000
`disbursement_account_key`	string	Disbursement account fixed in the contract, when the template requires one.	36
`signature_batch_key`	string	Identifier of the signature batch.	36
`creation_datetime`	string	Datetime the contract was created.	--

Attached Document Definition

Field	Type	Description	Characters
`document_key` *	string	Unique key identifying the document.	36
`document_type` *	string	Document type.	--
`status` *	string	Document status.	See Document status enumerators.
`document_template_key`	string	Unique key identifying the template that generated the document	36
`required_parties`	array	List of parties that sign the document in question	--

Product Definition

Field	Type	Description	Characters
`product_key` *	string	Unique key identifying the product.	36
`assignment_configuration_key`	string	Key identifying the assignment configuration. Required in the asset purchase pipeline. `null` until the product becomes `active`.	36
`fund_class_configuration_key` *	string	Fund configuration that originated the product.	36
`product_type` *	string	Product type (for example, `assignment_term`, `assignment_repurchase`).	--
`asset_type` *	string	Asset type.	--
`has_coobligation` *	boolean	Whether there is co-obligation by the assignor.	--
`status` *	string	Product status. See Product Status.	--

Errors

Status	Code	When it happens
404	`ACT000023`	`assignment_contract_key` not found.
403	`ACT000024`	The contract exists, but the authenticated agent is not a party to it.

Authentication, permission and host errors: see API errors.

Assignment Contract Listing

Lists the assignment contracts visible to the authenticated agent, with pagination.

Available on

Profile	Host	Required permission
Manager	`manager-api`	Read
Consultant	`consultant-api`	View assignment contracts

Base URL for each host: Environments (Hosts).

Request

ENDPOINT

/assignment_contract/assignment_contracts

METHOD

GET

Query Params

Parameter	Description
`assignor_document_number`	Assignor's document
`fund_class_document_number`	Fund's document
`fund_class_key`	Unique identifier of the fund (UUID)
`status`	Contract status. Accepts several values, comma-separated
`proposal_agent_type`	Who proposed the contract: `manager` or `consultant`
`case_number`	Case number
`start_date`	Start date (`YYYY-MM-DD`)
`end_date`	End date (`YYYY-MM-DD`)
`page`	Page, starting at `0`. Default `0`
`limit`	Items per page. Default `20`, maximum `100`

Use is_last_page from the response to know when to stop paginating.

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": "TEMPLATE NAME",
        "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": "EXTERNAL ID",
      "case_number": "CASE NUMBER",
      "denial_reason": null,
      "observation": "OBSERVATION",
      "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
}

Errors

Status	Code	When it happens
400	—	`limit` above `100` or negative `page`.

Authentication, permission and host errors: see API errors.

Enumerators

The contract, product and document statuses are in Contract Creation › Enumerators.