Invoice submission
Submitting the invoice sends the current consolidation analysis for QI Tech's review. First, attach the invoice and the other documents to the analysis.
Submit the invoice
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Create and Edit Expenses or Submit Consolidations |
Base URL for each host: Environments (Hosts).
ENDPOINT
/expense/fund_class/{fund_class_key}/expense/{expense_key}/consolidation_analysis/submitMETHOD
PUTSubmits the current analysis for QI Tech's review. Allowed with the analysis in pending_submission and the expense in pre_approved or in_provision.
On expenses created by the manager or consultant, the body is optional: without it, the expense amount and the current destination apply. Use the body to report a different amount or change the payment destination.
Request body — different amount and bank slip
{
"payment_value": 14800.00,
"payment_method": "bank_slip",
"payment": {
"target": {
"name": "AUDITORES EXEMPLO S.A.",
"document_number": "44.555.666/0001-81"
},
"bank_slip": {
"digitable_line": "34191090086352151004791020150008110010000148000"
}
}
}
| Field | Type | Required | Description |
|---|---|---|---|
payment_value | number | Conditional | Invoice amount, greater than zero. Required on expenses calculated by QI Tech; on those created by the manager or consultant, the default is the expense amount. |
payment_method | string | Conditional | transfer, pix or bank_slip. To change the destination, send it together with payment. |
payment | object | Conditional | New destination, following the rules of expense creation: target_account, vendor_bank_account_key, target_pix_key or bank_slip.digitable_line. To change the payee, include target; without it, the current one is kept. The previous destination is discarded. Does not accept pix_qrcode, source_account or conciliation_metadata. |
Submission rules:
- Invoice. The analysis must have a non-canceled
invoice; on types without a contract,invoiceorbank_slip.cvm_taxandanbima_taxdo not require an invoice. - Different amount. The required document depends on the expense's origin:
- Created by the manager or consultant: a
payment_valuedifferent from the analysis amount requires avariance_justification. - Calculated by QI Tech: the amount is compared with the provisioned amount (the recognized amount, if the expense has no provisioned amount).
consulting_feealways requires acalculation_memory. On recurring expenses, a different amount requires acalculation_memory. On the others, a different amount requires avariance_justification(orsettlement_term, on the management fee).
- Created by the manager or consultant: a
- Reimbursement. Requires a
payment_receiptin the analysis. - Destination. Without
payment, the current destination applies. If an expense paid by TED or Pix has no account, key or QR Code, the API uses the active main account of the contract's vendor. An expense paid by automatic debit does not change destination. - Payee. With
payment, the payee (the newtargetor the current one) follows the who can receive rules of expense creation. It must be:- the contract's vendor, except with
vendor_bank_account_key; - on
cvm_tax,anbima_tax,cetip_taxandselic_tax, the fixed entity of the type; - on a reimbursement, the manager or a consultant with an active link to the fund, according to
reimbursement_recipient.
- the contract's vendor, except with
- Management fee and rebates.
payment_valueis the net amount paid to the manager, already without the rebates.- The sum of the fee's rebates (excluding canceled or rejected ones) is stored in
total_rebate_value. - The amount compared with the provisioned amount is
payment_value + total_rebate_value. A difference requires avariance_justificationorsettlement_term. pre_approvedrebates with an analysis inpending_submissionare submitted together.- A rebate's invoice is not submitted on its own: submit the management fee's invoice.
STATUS
200The analysis with status: in_manual_analysis, in the structure of analysis attributes, without rebates.
Errors
| Status | code | When it happens |
|---|---|---|
| 400 | EXP000164 | The expense does not accept a consolidation analysis, or the analysis or the expense is not in the status the submission requires. |
| 400 | EXP000165 | Submission without the required invoice. The message lists the accepted types. |
| 400 | EXP000167 | Different amount without the justification document. |
| 400 | EXP000169 | Expense calculated by QI Tech without payment_value. |
| 400 | EXP000138 | Expense calculated by QI Tech: consulting_fee without a calculation memory, or recurring expense with a different amount and no calculation memory. |
| 400 | EXP000135 | Reimbursement without a payment receipt. |
| 400 | EXP000205 | Submission of a rebate's invoice. Submit the management fee's invoice instead. |
| 400 | EXP000203 | payment without payment_method, or payment_method without payment. |
| 400 | EXP000200 | Destination change on an expense paid by automatic debit. |
| 400 | EXP000202 | The destination does not match the payment method: bank slip with an account or Pix, or TED and Pix with a bank slip. |
| 400 | EXP000201 | No destination, and the vendor has no active main account. |
| 400 | EXP000208 | The payee is not the contract's vendor. |
| 400 | EXP000209 | The reimbursement payee is not the manager. |
| 400 | EXP000210 | The reimbursement payee is not a consultant linked to the fund. |
| 400 | EXP000211 | The payee of the CVM, ANBIMA, CETIP or SELIC fee is neither the entity nor the QI Tech group. |
| 400 | EXP000085 | Missing payee. |
| 400 | EXP000036 | Missing destination: TED without an account, or Pix without an account, key or QR Code. |
| 400 | EXP000043 | Bank slip without a digitable line. |
| 400 | EXP000104 | Pix with more than one destination. |
| 400 | EXP000175 | TED with a Pix key. |
| 400 | EXP000178 to EXP000183 | Problems with the vendor's account or the bank, detailed in Payment details. |
| 400 | QIT000001 | Invalid body: missing required field, payment_method outside the list, non-positive payment_value, a payment field in the wrong format (payee CPF or CNPJ, digitable line not 47 or 48 characters long) or an unexpected field. |
| 400 | EXP000069 | The fund class does not belong to the manager. |
| 403 | EXP000156 | You did not create the expense: the consultant created it and the caller is the manager, or the other way round. Only the agent who created it submits the invoice. |
| 404 | EXP000010 | The expense does not exist in the fund. |
Example
{
"title": "Invoice Required For Consolidation Analysis",
"description": "The consolidation analysis requires one of the documents ['invoice'] to be submitted.",
"translation": "A analise de consolidacao exige um dos documentos ['invoice'] para ser enviada.",
"code": "EXP000165"
}
Authentication, permission and host errors: see API Errors.