跳到主要内容

定期费用

定期费用会按周期自动生成一笔费用。通过 API 只能查询定期费用。定期费用有两个来源：

  • 合同： 在费用合同生效时根据其 recurrences 生成。
  • QI Tech： 其他定期费用由 QI Tech 登记。

定期费用状态​

状态描述
active正在生成费用。
pending_approval等待 QI Tech 批准。
finished已到期结束（end_date）。
canceled在到期前终止。
reproved被 QI Tech 拒绝。

列出定期费用​

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api读取费用或读取合并

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

ENDPOINT
/expense/fund_class/{fund_class_key}/recurring_expenses
方法
GET

查询参数​

参数类型是否必填描述
statusstring否一个定期费用状态。
expense_typestring否一个费用类型。
contract_keystring否某个合同的定期费用。
limitinteger否每页条数，0 至 100。默认：10。
pageinteger否页码，从 0 开始。默认：0。

列表按定期费用从新到旧排序。

STATUS
200
Corpo da resposta
{
    "data": [
        {
            "recurring_expense_key": "a0b1c2d3-e4f5-4a6b-8c7d-9e0f1a2b3c4d",
            "fund_class": {
                "name": "FIDC EXEMPLO",
                "manager": {
                    "name": "EXEMPLO GESTORA LTDA",
                    "manager_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
                    "document_number": "22.333.444/0001-81"
                },
                "fund_class_key": "c1d2e3f4-a5b6-4789-abcd-ef1234567890",
                "document_number": "33.444.555/0001-81",
                "accounting_date": "2026-11-06"
            },
            "expense_type": "audit_tax",
            "description": "Auditoria anual - parcela mensal",
            "recurring_configuration_data": {
                "expense_type": "audit_tax",
                "description": "Auditoria anual - parcela mensal",
                "amount": 2500.0,
                "accrual": {
                    "accrual_system": "monthly"
                },
                "consolidated_by_manager": true,
                "payment": {
                    "payment_reference": {
                        "reference_date": "end_date",
                        "workdays_only": true
                    },
                    "target": {
                        "document_number": "44.555.666/0001-81",
                        "name": "AUDITORES EXEMPLO S.A."
                    }
                },
                "start_date": "2027-01-01",
                "end_date": "2027-12-31",
                "contract_key": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
                "vendor_key": "5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57"
            },
            "amount": 2500.0,
            "consolidated_by_manager": true,
            "status": "active",
            "contract_key": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
            "vendor_key": "5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57",
            "start_date": "2027-01-01",
            "end_date": "2027-12-31"
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true
}
字段描述
recurring_expense_key定期费用的 key（UUID）。
fund_class基金类别，与查询费用中相同。
expense_type所生成费用的类型。
description所生成费用的描述。
recurring_configuration_data登记时的定期费用配置。参见下文。
amount每笔费用的金额。
consolidated_by_manager当管理人为每笔生成的费用发送发票时为 true。
status定期费用的状态。
contract_key, vendor_key合同和供应商，或 null。
start_date, end_date有效期，YYYY-MM-DD；无结束日期时 end_date 为 null。
disabled_at终止时间。仅在已终止的定期费用中出现。

定期费用配置​

在 recurring_configuration_data 中：

  • accrual 定义周期：accrual_system（monthly、bimonthly 或 yearly）和 start_month。
  • payment.payment_reference 定义每笔费用的付款日期：reference_date（周期的 start_date 或 end_date）、workdays_only、days_after 和 months_after。
  • payment 包含收款人；无合同的定期费用还包含付款方式和收款目标。

对于合同类定期费用，每笔费用都在当月最后一个工作日支付给供应商，打入其主账户。

查询定期费用​

返回一项定期费用及由其生成的费用。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api读取费用或读取合并

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

ENDPOINT
/expense/fund_class/{fund_class_key}/recurring_expense/{recurring_expense_key}
方法
GET

响应结构与列表相同，另加一个字段：expenses，即由该定期费用生成的费用（expense_key、status）。

错误​

状态code发生情形
400EXP000069该基金类别不属于该管理人。
403EXP000124顾问与该基金没有有效关联。通常 consultant-api 会先以 401（CIT000018）拒绝。
404EXP000028该定期费用在基金中不存在。
500QIT000500limit 或 page 超出范围或不是整数。这些参数的校验会以内部错误返回：请修正参数后重新调用。

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