跳到主要内容

获取合同


获取合同​

返回一份转让合同及其文件和产品。可通过此方式查询每个产品的状态,以及签署后生成的 assignment_configuration_key。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-apiView assignment contracts

各主机的 Base URL:环境(主机)。

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": "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_key *string合同的唯一标识 key。36
fund_class *object基金对象--
assignor *object转让方对象。--
consultantobject顾问对象。仅当顾问为合同一方时返回。--
assignment_contract_template *object合同模板对象。--
attached_documents *array附件文件列表。见 附件文件定义。
products *array合同下的产品列表。见 产品定义。
proposal_agent *string合同提出方代理方的类型。--
status *string合同状态。见 转让合同状态枚举值。
credit_limitnumber所发送的信用额度。--
external_idstring合同的外部标识。通常为合同编号最多 50
case_numberstring案件编号。在同一基金内唯一--
denial_reasonstring管理人拒绝的详细说明。最多 500
observationstring所发送的备注。最多 1000
disbursement_account_keystring当模板要求时,合同中固定的放款账户。36
signature_batch_keystring签署批次的标识。36
creation_datetimestring合同的创建日期时间。--

附件文件定义​

字段类型描述字符数
document_key *string文件的唯一标识 key。36
document_type *string文件类型。--
status *string文件状态。见 文件状态枚举值。
document_template_keystring生成该文件的模板的唯一标识 key36
required_partiesarray签署该文件的各方列表--

产品定义​

字段类型描述字符数
product_key *string产品的唯一标识 key。36
assignment_configuration_keystring转让配置的标识 key。在资产购买流程中需要使用。产品变为 active 之前为 null。36
fund_class_configuration_key *string产生该产品的基金配置。36
product_type *string产品类型(例如:assignment_term、assignment_repurchase)。--
asset_type *string资产类型。--
has_coobligation *boolean转让方是否承担共同责任。--
status *string产品状态。见 Product Status。--

错误​

状态码代码触发条件
404ACT000023未找到 assignment_contract_key。
403ACT000024合同存在,但已认证的代理方不是合同一方。

认证、权限和主机相关错误:参见 API 错误。


转让合同列表​

分页列出已认证代理方可见的转让合同。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-apiView assignment contracts

各主机的 Base URL:环境(主机)。

Request​

ENDPOINT
/assignment_contract/assignment_contracts
MÉTODO
GET

Query Params​

参数描述
assignor_document_number转让方的证件号
fund_class_document_number基金的证件号
fund_class_key基金的唯一标识(UUID)
status合同状态。可接受多个值,以逗号分隔
proposal_agent_type合同的提出方:manager 或 consultant
case_number案件编号
start_date开始日期(YYYY-MM-DD)
end_date结束日期(YYYY-MM-DD)
page页码,从 0 开始。默认 0
limit每页条目数。默认 20,最大 100

使用响应中的 is_last_page 判断何时停止分页。

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
}

错误​

状态码代码触发条件
400—limit 超过 100 或 page 为负数。

认证、权限和主机相关错误:参见 API 错误。

枚举值​

合同、产品和文件的状态参见创建合同 › 枚举值。