获取合同
获取合同
返回一份转让合同及其文件和产品。可通过此方式查询每个产品的状态,以及签署后生成的 assignment_configuration_key。
适用范围
| 角色 | 主机 | 所需权限 |
|---|---|---|
| 管理人 | manager-api | 读取 |
| 顾问 | consultant-api | View assignment contracts |
各主机的 Base URL:环境(主机)。
Request
ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEYMÉTODO
GETResponse
STATUS
200Response 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 | 转让方对象。 | -- |
consultant | object | 顾问对象。仅当顾问为合同一方时返回。 | -- |
assignment_contract_template * | object | 合同模板对象。 | -- |
attached_documents * | array | 附件文件列表。 | 见 附件文件定义。 |
products * | array | 合同下的产品列表。 | 见 产品定义。 |
proposal_agent * | string | 合同提出方代理方的类型。 | -- |
status * | string | 合同状态。 | 见 转让合同状态枚举值。 |
credit_limit | number | 所发送的信用额度。 | -- |
external_id | string | 合同的外部标识。通常为合同编号 | 最多 50 |
case_number | string | 案件编号。在同一基金内唯一 | -- |
denial_reason | string | 管理人拒绝的详细说明。 | 最多 500 |
observation | string | 所发送的备注。 | 最多 1000 |
disbursement_account_key | string | 当模板要求时,合同中固定的放款账户。 | 36 |
signature_batch_key | string | 签署批次的标识。 | 36 |
creation_datetime | string | 合同的创建日期时间。 | -- |
附件文件定义
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
document_key * | string | 文件的唯一标识 key。 | 36 |
document_type * | string | 文件类型。 | -- |
status * | string | 文件状态。 | 见 文件状态枚举值。 |
document_template_key | string | 生成该文件的模板的唯一标识 key | 36 |
required_parties | array | 签署该文件的各方列表 | -- |
产品定义
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
product_key * | string | 产品的唯一标识 key。 | 36 |
assignment_configuration_key | string | 转让配置的标识 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。 | -- |
错误
| 状态码 | 代码 | 触发条件 |
|---|---|---|
| 404 | ACT000023 | 未找到 assignment_contract_key。 |
| 403 | ACT000024 | 合同存在,但已认证的代理方不是合同一方。 |
认证、权限和主机相关错误:参见 API 错误。
转让合同列表
分页列出已认证代理方可见的转让合同。
适用范围
| 角色 | 主机 | 所需权限 |
|---|---|---|
| 管理人 | manager-api | 读取 |
| 顾问 | consultant-api | View assignment contracts |
各主机的 Base URL:环境(主机)。
Request
ENDPOINT
/assignment_contract/assignment_contractsMÉTODO
GETQuery 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
200Response 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 错误。
枚举值
合同、产品和文件的状态参见创建合同 › 枚举值。