Pular para o conteúdo principal

Submissão para Análise

Após criar a análise e fazer upload dos documentos, submeta a análise para revisão da QI Tech alterando o status para pending_adm_approval.

Pré-requisito

É obrigatório ter ao menos um documento com status pending_adm_approval ou approved antes de submeter a análise. Caso contrário, a requisição será rejeitada com erro VGR000030.


Submeter a análise

ENDPOINT
/vendor_registry/analysis/{analysis_key}
MÉTODO
PUT

Path params

ParâmetroTipoDescrição
analysis_keystringChave única da análise (UUID)
Request Body
{
"status": "pending_adm_approval"
}

Atributos do body

CampoTipoObrigatoriedadeValores aceitosDescrição
statusstringobrigatóriopending_adm_approval, pending_submissionNovo status da análise. Use pending_adm_approval para submeter para revisão, ou pending_submission para retornar ao rascunho.

Response

STATUS
202
Response Body
{
"analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"status": "pending_adm_approval"
}

Atributos da resposta

CampoTipoDescrição
analysis_keystringChave única da análise.
statusstringNovo status da análise.

Ciclo de vida da análise

A tabela abaixo descreve todas as transições de status possíveis e quem as executa:

StatusDescriçãoQuem transita
pending_submissionAnálise criada, aguardando submissãoEstado inicial; agente retorna para edição
pending_adm_approvalSubmetida, aguardando revisão da QI TechAgente integrador
approvedAprovada pela QI Tech; fornecedor ativadoQI Tech (interno)
rejectedRejeitada pela QI TechQI Tech (interno)
canceledCancelada pelo agente integradorAgente integrador via endpoint de cancelamento
other_analysis_approvedOutra análise do mesmo fornecedor foi aprovada primeiroAutomático

Transições permitidas pelo agente integrador

pending_submission ──→ pending_adm_approval (submissão para revisão)
pending_submission ──→ canceled (cancelamento)
pending_adm_approval ──→ pending_submission (retorno para edição)
pending_adm_approval ──→ canceled (cancelamento)
Edição após retorno

Quando a QI Tech retorna a análise para pending_submission, é possível atualizar os dados de pagamento e a flag requires_invoice antes de submeter novamente. Consulte a página de atualização de dados.


Possíveis erros

STATUS
400
Análise sem documentos

A análise não possui nenhum documento com status pending_adm_approval ou approved. Faça o upload de ao menos um documento antes de submeter.

{
"title": "Analysis Submission Must Have At Least One Pending Analysis Document",
"description": "Analysis with key {analysis_key} must have at least one pending analysis document to be submitted.",
"translation": "A análise com a chave {analysis_key} deve ter pelo menos um documento de análise pendente para ser enviada.",
"code": "VGR000030"
}
STATUS
409
Transição de status não permitida

A transição de status solicitada não é permitida para o status atual da análise.

{
"title": "Analysis Status Transition Denied",
"description": "Analysis with key {analysis_key} is not allowed to switch status from {current_status} to {new_status}.",
"translation": "Análise com chave {analysis_key} não pode trocar de status de {current_status} para {new_status}.",
"code": "VRG000008"
}
Análise já rejeitada

Análises rejeitadas não podem ter o status alterado.

{
"title": "Canceled Analysis",
"description": "Analysis with key {analysis_key} is already rejected, it can't be updated.",
"translation": "Análise com chave {analysis_key} está rejeitada, não pode ser atualizada.",
"code": "VRG0000009"
}
Análise já aprovada

Análises aprovadas não podem ter o status alterado.

{
"title": "Completed Analysis",
"description": "Analysis with key {analysis_key} is already completed, it can't be updated.",
"translation": "Análise com chave {analysis_key} está finalizada, não pode ser atualizada.",
"code": "VRG0000010"
}
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 submeter a análise, o processo de revisão da QI Tech se inicia. Durante este período:

Após aprovação, a vendor_key do fornecedor estará disponível para uso em contratos de despesa.