Skip to main content

Submission for Analysis

After creating the analysis and uploading the documents, submit the analysis for QI Tech review by changing the status to pending_adm_approval.

Prerequisite

At least one document with status pending_adm_approval or approved is required before submitting the analysis. Otherwise, the request will be rejected with error VGR000030.


Submit the analysis​

ENDPOINT
/vendor_registry/analysis/{analysis_key}
METHOD
PUT

Path params​

ParameterTypeDescription
analysis_keystringUnique key of the analysis (UUID)
Request Body
{
"status": "pending_adm_approval"
}

Body attributes​

FieldTypeRequiredAccepted valuesDescription
statusstringrequiredpending_adm_approval, pending_submissionNew status of the analysis. Use pending_adm_approval to submit for review, or pending_submission to return to draft.

Response​

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

Response attributes​

FieldTypeDescription
analysis_keystringUnique key of the analysis.
statusstringNew status of the analysis.

Analysis life cycle​

The table below describes all the possible status transitions and who performs them:

StatusDescriptionWho transitions
pending_submissionAnalysis created, awaiting submissionInitial state; the agent returns it for editing
pending_adm_approvalSubmitted, awaiting QI Tech reviewIntegrating agent
approvedApproved by QI Tech; vendor activatedQI Tech (internal)
rejectedRejected by QI TechQI Tech (internal)
canceledCanceled by the integrating agentIntegrating agent via the cancellation endpoint
other_analysis_approvedAnother analysis of the same vendor was approved firstAutomatic

Transitions allowed for the integrating agent​

pending_submission ──→ pending_adm_approval (submission for review)
pending_submission ──→ canceled (cancellation)
pending_adm_approval ──→ pending_submission (return for editing)
pending_adm_approval ──→ canceled (cancellation)
Editing after a return

When QI Tech returns the analysis to pending_submission, you can update the payment data and the requires_invoice flag before submitting it again. See the data update page.


Possible errors​

STATUS
400
Analysis without documents

The analysis has no document with status pending_adm_approval or approved. Upload at least one document before submitting.

{
"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
Status transition not allowed

The requested status transition is not allowed for the current status of the analysis.

{
"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"
}
Analysis already rejected

Rejected analyses cannot have their status changed.

{
"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"
}
Analysis already approved

Approved analyses cannot have their status changed.

{
"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
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 submitting the analysis, the QI Tech review process starts. During this period:

After approval, the vendor's vendor_key will be available for use in expense contracts.