合同附件
附件是合同的补充文件,例如商业提案或已签署的解除协议书。附件不经过自动读取。合同必须处于 pending_submission、active 或 expired。
添加附件的步骤:
- 创建附件。
- 获取附件上传 URL。
- 将文件直接上传到该 URL。
如需下载文件,请使用合同查询中的 attachments[].download_url。
创建附件
适用范围
| 角色 | 主机 | 所需权限 |
|---|---|---|
| 管理人 | manager-api | 写入 |
| 顾问 | consultant-api | 创建费用合同 |
各主机的 Base URL:环境(主机)。
ENDPOINT
/expense_contract/fund_class/{fund_class_key}/contract/{contract_key}/attachment方法
POST路径参数
| 参数 | 类型 | 说明 |
|---|---|---|
fund_class_key | string | 基金类别的 key(UUID)。 |
contract_key | string | 合同的 key(UUID)。 |
此调用不带请求体。
响应
STATUS
201Corpo da resposta
{
"attachment_key": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"status": "active",
"created_at": "2026-11-09T14:20:11.004512"
}
| 字段 | 类型 | 说明 |
|---|---|---|
attachment_key | string | 附件的 key(UUID)。 |
status | string | 创建后为 active;取消后为 canceled。 |
created_at | string | 创建时间,不带时区的 ISO 8601。 |
获取附件上传 URL
ENDPOINT
/expense_contract/fund_class/{fund_class_key}/contract/{contract_key}/attachment/{attachment_key}/upload_url方法
GET权限:管理人(manager-api):写入。顾问(consultant-api):创建费用合同。
路径参数
| 参数 | 类型 | 说明 |
|---|---|---|
fund_class_key | string | 基金类别的 key(UUID)。 |
contract_key | string | 合同的 key(UUID)。 |
attachment_key | string | 附件的 key(UUID)。 |
响应
STATUS
200Corpo da resposta
{
"attachment_key": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"status": "active",
"created_at": "2026-11-09T14:20:11.004512",
"upload_url": {
"url": "https://<link-temporario-de-envio>",
"fields": {
"key": "3f2b8c1e-7d4a-4e9b-9a61-0c5d2e8f4b17/d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"policy": "<policy>",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-credential": "<credential>",
"x-amz-date": "20261109T142100Z",
"x-amz-signature": "<signature>"
}
}
}
按照合同文件的方式上传文件:向 upload_url.url 发起 multipart/form-data 的 POST,包含 upload_url.fields 中的所有字段,文件放在 file 字段中。该 URL 3 分钟后过期,接受最大 50 MB 的文件。
新的上传会替换附件的文件。没有确认调用。
取消附件
将附件标记为 canceled。取消已取消的附件 不会产生任何效果。
ENDPOINT
/expense_contract/fund_class/{fund_class_key}/contract/{contract_key}/attachment/{attachment_key}方法
DELETE权限:管理人(manager-api):写入。顾问(consultant-api):更新费用合同。
路径参数
| 参数 | 类型 | 说明 |
|---|---|---|
fund_class_key | string | 基金类别的 key(UUID)。 |
contract_key | string | 合同的 key(UUID)。 |
attachment_key | string | 附件的 key(UUID)。 |
响应
STATUS
204响应不带响应体。
错误
| 状态 | code | 发生情形 |
|---|---|---|
| 404 | ECT000005 | 基金类别不存在,或您无权访问该基金类别。 |
| 404 | ECT000009 | 该基金类别中不存在此合同。 |
| 404 | ECT000050 | 该合同中不存在此附件。 |
| 409 | ECT000048 | 合同不处于 pending_submission、active 或 expired。 |
Exemplo
{
"title": "Attachment not allowed",
"description": "Attachments are not handled on a contract in status canceled.",
"translation": "Anexos nao sao tratados num contrato com status canceled.",
"code": "ECT000048"
}
认证、权限和主机相关错误:参见 API 错误。