跳到主要内容

清算查询

按插入时提供的 external_id 返回付款批次中的一笔清算。可用于核对清算状态，或在插入返回重复（SET000013）时使用。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-apiView Batches
转让方assignor-api读取

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/settlement/fund_class/{fund_class_key}/payment_batch/{external_id}/settlement/{settlement_external_id}
MÉTODO
GET

Path params​

参数类型描述
fund_class_keystring基金的 key（UUID）。
external_idstring付款批次的 external_id。
settlement_external_idstring清算的 external_id，即插入时请求体中提供的值。

Response​

STATUS
200

该对象与插入清算时返回的对象相同：插入时请求体中发送的字段，加上 QI Tech 计算的数据，以及当前的 status。

Response Body
{
    "asset_type": "ccb",
    "total_value": 130.50,
    "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
    "settlement_type": "installment_settlement",
    "contract_number": "0123456789/ABC",
    "installment_number": 1,
    "collection_date": "2025-01-01",
    "collection_origin_type": "borrower",
    "asset_external_id": "CCB-0001",
    "assignor_document_number": "33.444.555/0001-81",
    "borrower_document_number": "969.698.790-03",
    "status": "settled",
    "type": "installment_settlement",
    "settlement_key": "b2c3d4e5-f6a7-8901-abcd-ef1234567890",
    "total_number_of_units": 1,
    "settlement_result": 0.0,
    "next_execution_datetime": "2025-01-01 13:00:00.000000",
    "counter_party_document_number": "969.698.790-03",
    "assets": [
        {
            "asset_key": "f34e9437-d025-41ab-bb53-6b94e10fd361",
            "number_of_units": 1,
            "present_value": 1250.00,
            "installment_face_value": 130.50
        }
    ]
}

清算状态​

状态含义
validated已插入并通过；等待批次付款。
pending_validation付款金额超出容差；等待 QI Tech 审核。
waiting_send_to_queue / on_queue批次已付款；清算正在基金投资组合中处理。
settled已完成并在投资组合中对账。最终状态。
discarded已废弃，无资金变动。最终状态。如有原因，denial_reason 字段会返回。
inconsistent_asset由于资产不一致，投资组合拒绝了该付款。由 QI Tech 处理；只要还有清算处于此状态，批次就不会进入 completed。

完整的状态图（包括会触发 webhook 的状态）参见清算 webhook。

错误​

状态码代码触发条件
404SET000011所指定的批次中不存在使用此 settlement_external_id 的清算（或该批次在此基金中不存在）。
404SET000005该 fund_class_key 不存在。
403SET000028该基金不属于您的角色（基金的管理人、关联的顾问或相关的转让方）。

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