curl --request PATCH \
--url https://app.useqx.com/api/v1/documents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"incoterm": "CFR"
}
}
'import requests
url = "https://app.useqx.com/api/v1/documents/{id}"
payload = { "fields": { "incoterm": "CFR" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({fields: {incoterm: 'CFR'}})
};
fetch('https://app.useqx.com/api/v1/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.useqx.com/api/v1/documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
'incoterm' => 'CFR'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/documents/{id}"
payload := strings.NewReader("{\n \"fields\": {\n \"incoterm\": \"CFR\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.useqx.com/api/v1/documents/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"incoterm\": \"CFR\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": {\n \"incoterm\": \"CFR\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "doc_318",
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"status": "uploaded",
"reading_status": "complete",
"contact": {
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda"
},
"collection_id": "col_40",
"in_triage": false,
"discarded": false,
"discard_reason": null,
"number": "INV-81244/2026",
"arrival_channel": "api",
"arrived_at": "2026-09-25T10:32:05.000-03:00",
"files": [
{
"name": "fatura.pdf",
"content_type": "application/pdf",
"size": 182044
}
],
"created_at": "2026-09-25T10:32:05.000-03:00",
"fields": [
{
"key": "invoice_number",
"label": "Número da Fatura",
"value": "INV-81244/2026"
},
{
"key": "invoice_date",
"label": "Data da Fatura",
"value": "2026-09-18"
},
{
"key": "exporter_name",
"label": "Exportador (Vendedor)",
"value": "Shanghai Example Trading Co., Ltd."
},
{
"key": "invoice_amount",
"label": "Valor da Fatura",
"value": "48,250.00"
},
{
"key": "currency",
"label": "Moeda",
"value": "USD"
},
{
"key": "incoterm",
"label": "Incoterm",
"value": "CFR"
},
{
"key": "line_items",
"label": "Itens da Fatura",
"value": [
{
"part_number": "A-100",
"description": "STAINLESS STEEL VALVE 1/2 IN",
"quantity": "1000",
"quantity_unit": "PCS",
"unit_price": "25.00",
"total_price": "25,000.00"
},
{
"part_number": "B-220",
"description": "BRASS FITTING 3/4 IN",
"quantity": "500",
"quantity_unit": "PCS",
"unit_price": "46.50",
"total_price": "23,250.00"
}
]
}
]
}Gravar campos ou preencher um slot
Faz uma de duas mudanças num documento. Com fields, em JSON, a chamada grava as respostas dos campos, e o valor gravado vence o valor que a leitura extraiu. O documento da Triagem volta ao encaixe, e a coleta do documento roda as validações de novo. Com file, em multipart/form-data, a chamada anexa o arquivo ao slot vazio de uma coleta aberta, e a leitura começa. A troca do arquivo de um documento que já tem arquivo não existe na v1. A chamada com file conta no limite de escritas pagas da chave.
curl --request PATCH \
--url https://app.useqx.com/api/v1/documents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"incoterm": "CFR"
}
}
'import requests
url = "https://app.useqx.com/api/v1/documents/{id}"
payload = { "fields": { "incoterm": "CFR" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({fields: {incoterm: 'CFR'}})
};
fetch('https://app.useqx.com/api/v1/documents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.useqx.com/api/v1/documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
'incoterm' => 'CFR'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/documents/{id}"
payload := strings.NewReader("{\n \"fields\": {\n \"incoterm\": \"CFR\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.useqx.com/api/v1/documents/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"incoterm\": \"CFR\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/documents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": {\n \"incoterm\": \"CFR\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "doc_318",
"document_type": {
"id": "dtp_31",
"name": "Fatura Comercial (Commercial Invoice)"
},
"status": "uploaded",
"reading_status": "complete",
"contact": {
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda"
},
"collection_id": "col_40",
"in_triage": false,
"discarded": false,
"discard_reason": null,
"number": "INV-81244/2026",
"arrival_channel": "api",
"arrived_at": "2026-09-25T10:32:05.000-03:00",
"files": [
{
"name": "fatura.pdf",
"content_type": "application/pdf",
"size": 182044
}
],
"created_at": "2026-09-25T10:32:05.000-03:00",
"fields": [
{
"key": "invoice_number",
"label": "Número da Fatura",
"value": "INV-81244/2026"
},
{
"key": "invoice_date",
"label": "Data da Fatura",
"value": "2026-09-18"
},
{
"key": "exporter_name",
"label": "Exportador (Vendedor)",
"value": "Shanghai Example Trading Co., Ltd."
},
{
"key": "invoice_amount",
"label": "Valor da Fatura",
"value": "48,250.00"
},
{
"key": "currency",
"label": "Moeda",
"value": "USD"
},
{
"key": "incoterm",
"label": "Incoterm",
"value": "CFR"
},
{
"key": "line_items",
"label": "Itens da Fatura",
"value": [
{
"part_number": "A-100",
"description": "STAINLESS STEEL VALVE 1/2 IN",
"quantity": "1000",
"quantity_unit": "PCS",
"unit_price": "25.00",
"total_price": "25,000.00"
},
{
"part_number": "B-220",
"description": "BRASS FITTING 3/4 IN",
"quantity": "500",
"quantity_unit": "PCS",
"unit_price": "46.50",
"total_price": "23,250.00"
}
]
}
]
}Authorizations
A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.
Path Parameters
O id do documento. O id começa com doc_.
Body
As respostas dos campos, no formato { "chave": valor }, com pelo menos uma chave. A chave é a key de um campo em GET /documents/{id}. O valor tem a forma do value desse campo, e null apaga a resposta.
Show child attributes
Show child attributes
{ "invoice_number": "INV-81244/2026" }
Response
O documento, com os campos.
Um documento, com os campos.
O id do documento.
^doc_[1-9][0-9]*$"doc_310"
Show child attributes
Show child attributes
O andamento do documento. pending: o documento espera o envio. uploaded: o documento chegou e espera a revisão. approved: o operador aprovou o documento. rejected: o operador recusou o documento.
pending, uploaded, approved, rejected O andamento da leitura do documento. not_started: a leitura não começou. extracting, enriching e validating: a leitura está em curso. complete: a leitura terminou. failed: a leitura falhou. no_reader: o tipo de documento não tem leitura.
not_started, extracting, enriching, validating, complete, failed, no_reader O contato do documento. O valor é null quando o documento não tem contato.
Show child attributes
Show child attributes
O id da coleta do documento. O valor é null enquanto o documento está na Triagem.
^col_[1-9][0-9]*$"col_40"
Com true, o documento está na Triagem e ainda não tem coleta.
Com true, o documento está descartado.
O motivo do descarte. O valor é null no documento que não está descartado. outside_pack: nenhum pacote de operação ativo pede o tipo do documento. identical_copy: o documento repete o arquivo de outro documento. superseded: um documento mais novo substituiu este. operator: o operador descartou o documento.
outside_pack, identical_copy, superseded, operator, null O número impresso que identifica o documento, como o número da fatura. O valor é null antes da leitura.
"INV-81244/2026"
O canal de chegada do arquivo. O valor é null no slot vazio. email: o arquivo chegou por e-mail. portal_upload: o cliente enviou o arquivo no portal. operator_upload: o operador enviou o arquivo na tela. spreadsheet: o arquivo saiu de uma planilha. vault: o cliente reaproveitou no portal um arquivo do Cofre. api: o arquivo chegou pela API.
email, portal_upload, operator_upload, spreadsheet, vault, api, null A data e a hora da chegada do arquivo, no fuso horário da organização. O valor é null no slot vazio.
Os arquivos do documento. No slot vazio, a lista é vazia.
Show child attributes
Show child attributes
A data e a hora da criação, no fuso horário da organização.
"2026-09-25T10:30:00.000-03:00"
Os campos do tipo de documento, na ordem do catálogo, sem os campos de arquivo. O campo sem resposta vem com value igual a null.
Show child attributes
Show child attributes