Pular para o conteúdo principal

Respostas e erros

Envelope​

Toda resposta, de sucesso ou de erro, vem no mesmo envelope JSON:

CampoTipoDescrição
messagestringMensagem curta: o nome da operação no sucesso, o motivo no erro.
resultbooleantrue no sucesso, false no erro.
dataobjeto ou nullO conteúdo da resposta. null no erro.
errorstring ou nullO motivo do erro. null no sucesso.

Sucesso:

{
"message": "Pedido recebido",
"result": true,
"data": { "status": "RECEIVED" },
"error": null
}

Erro:

{
"message": "page_size must not be greater than 1000",
"result": false,
"data": null,
"error": "page_size must not be greater than 1000"
}
observação

Isso vale também para POST /oauth/token: o token fica em data, e não na raiz do JSON como no formato puro do OAuth 2.0 (RFC 6749). Se a sua biblioteca de OAuth espera o formato puro, leia data.access_token você mesmo.

Códigos HTTP​

CódigoQuando aconteceO que fazer
200Consulta ou emissão de token com sucesso.
202Pedido de acesso ou reemissão recebido.Consulte a situação depois.
400Parâmetro inválido: campo a mais, formato errado, page ou page_size fora do limite, date_from ou date_to antes de 90 dias atrás, etc. A mensagem diz o motivo.Corrija a chamada. Não repita igual.
401Não autorizado. Credencial errada, token vencido ou revogado, company_token inválido. A resposta nunca diz qual parte falhou.Veja Quando dá 401.
403Token sem permissão para a rota.Fale com o Concilia+.
404Rota inexistente.Confira o caminho.
413Corpo da requisição acima de 10 kB.Nenhuma rota precisa de corpo grande: confira o que está sendo enviado.
429Limite de uso excedido. Vem com o header Retry-After (em segundos).Espere o tempo do Retry-After e tente de novo. Veja Limites de uso.
500Erro interno.Tente de novo mais tarde, com espera crescente.
503Serviço temporariamente indisponível. Só no POST /oauth/token.Tente de novo em alguns segundos. Tokens já emitidos continuam valendo.

Validação dos parâmetros​

  • Campos que a rota não conhece são recusados com 400, não ignorados. Envie só o que está documentado.
  • Os formatos são conferidos com rigor: client_id, client_secret, company_token, CNPJ e datas. Exemplo: client_id sempre começa com ci_ e tem 25 caracteres.
  • As mensagens de erro de formato dos campos vêm em inglês (por exemplo, page_size must not be greater than 1000), separadas por ; quando há mais de uma. As regras entre campos e de datas vêm em português (por exemplo, date_from deve ser menor ou igual a date_to). Não dependa do texto: trate pelo código HTTP.

Formatos dos dados​

TipoFormatoExemplo
Data e horaISO 8601 em UTC2026-10-21T14:30:45.000Z
updated_at dos feedsISO 8601 em UTC, com microssegundos2026-10-02T06:15:03.482915Z
DataYYYY-MM-DD2026-10-01
HoraHH:MM:SS14:22:05
Valores em reaisTexto decimal, com ponto e 6 casas"150.000000"
IdsTexto"84213"

:::tip Valores em reais Os valores vêm como texto para não perder precisão. Converta para um tipo decimal do seu sistema; não use ponto flutuante (float/double). :::