Atualização de Dados da Análise

Enquanto a análise estiver no status pending_submission, é possível atualizar os dados de pagamento e a flag requires_invoice. Após submeter para pending_adm_approval, a edição não é mais permitida.

Restrição de status

Este endpoint só aceita atualizações quando a análise está no status pending_submission. Se a análise foi retornada pela QI Tech para este status, também é possível editar antes de reenviar.

---

Request

ENDPOINT

/vendor_registry/analysis/{analysis_key}/update

MÉTODO

PUT

Path params

Parâmetro	Tipo	Descrição
analysis_key	string	Chave única da análise (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"
    }
}

Atributos do body

Ao menos um campo deve ser informado.

Campo	Tipo	Obrigatoriedade	Descrição
requires_invoice	boolean	opcional	Indica se esta análise exige nota fiscal.
payment_method	string	opcional	Método de pagamento padrão. Atualmente suporta apenas transfer. Obrigatório quando payment é informado.
payment	object	opcional	Dados bancários do fornecedor. Consulte os atributos de payment. Obrigatório quando payment_method é informado.

Limpeza dos dados de pagamento

Se apenas um dos campos payment ou payment_method for informado (sem o outro), ambos serão removidos da análise.

---

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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "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"
    }
}

---

Possíveis erros

STATUS

409

Análise não editável

A análise está em um status que não permite edição. Somente análises no status pending_submission podem ser editadas via este 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

Análise não encontrada

A analysis_key informada na URL não corresponde a nenhuma análise cadastrada.

{
  "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"
}

---

Próximos passos

Após atualizar os dados, prossiga para:

Submeter a análise — encaminhe para revisão da QI Tech.