Updating the Analysis Data

While the analysis is in the pending_submission status, you can update the payment data and the requires_invoice flag. After submitting it to pending_adm_approval, editing is no longer allowed.

Status restriction

This endpoint only accepts updates when the analysis is in the pending_submission status. If the analysis was returned by QI Tech to this status, you can also edit it before resubmitting.

---

Request

ENDPOINT

/vendor_registry/analysis/{analysis_key}/update

METHOD

PUT

Path params

Parameter	Type	Description
analysis_key	string	Unique key of the analysis (UUID)

Request Body

{
    "requires_invoice": false,
    "payment_method": "transfer",
    "payment": {
        "target": {
            "name": "AUDITORES EXEMPLO S.A.",
            "document_number": "12.345.678/0001-90"
        },
        "target_pix_key": "12345678000190",
        "transfer_type": "pix"
    }
}

Body attributes

At least one field must be provided.

Field	Type	Required	Description
requires_invoice	boolean	optional	Indicates whether this analysis requires an invoice.
payment_method	string	optional	Default payment method. Currently supports only transfer. Required when payment is provided.
payment	object	optional	Vendor's bank details. See the payment attributes. Required when payment_method is provided.

Clearing the payment data

If only one of the payment or payment_method fields is provided (without the other), both will be removed from the analysis.

---

Response

STATUS

200

Response Body

{
    "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "status": "pending_submission",
    "requires_invoice": false,
    "manager": {
        "name": "EXEMPLO GESTORA LTDA",
        "manager_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
        "document_number": "45.585.471/0001-47"
    },
    "vendor": {
        "vendor_key": "3571e292-3a83-4011-904d-20ee963022ef",
        "name": "AUDITORES EXEMPLO S.A.",
        "document_number": "12.345.678/0001-90",
        "requires_invoice": true,
        "status": "pending_analysis"
    },
    "payment_method": "transfer",
    "payment": {
        "target": {
            "name": "AUDITORES EXEMPLO S.A.",
            "document_number": "12.345.678/0001-90"
        },
        "target_pix_key": "12345678000190",
        "transfer_type": "pix"
    }
}

---

Possible errors

STATUS

409

Analysis not editable

The analysis is in a status that does not allow editing. Only analyses in the pending_submission status can be edited through this endpoint.

{
  "title": "Analysis Not Editable",
  "description": "Analysis with key {analysis_key} is on status '{current_status}' and cannot be edited.",
  "translation": "A análise com chave {analysis_key} está no status '{current_status}' e não pode ser editada.",
  "code": "VRG000032"
}

STATUS

404

Analysis not found

The analysis_key provided in the URL does not correspond to any registered analysis.

{
  "title": "Analysis not found",
  "description": "Analysis with the key {analysis_key} was not found.",
  "translation": "A análise com a chave {analysis_key} não foi encontrada.",
  "code": "VRG000007"
}

---

Next steps

After updating the data, proceed to:

Submit the analysis — forward it for QI Tech review.