← InícioFleetPay / API

Uma Referência para Construir.

Explore o contrato da API. Confira ambientes, escopos e condições de cada operação antes de integrar.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

82 operações · 171 schemas · core 368eda3

82 operações

GET
Verificar acesso e prontidão fiscal/fiscal/status
GET
Consultar configuração fiscal da transportadora/fiscal/configuracao
PUT
Atualizar configuração fiscal da transportadora/fiscal/configuracao
GET
Consultar metadados do certificado digital/fiscal/certificado
POST
Enviar certificado digital A1/fiscal/certificado
DELETE
Remover certificado digital/fiscal/certificado
GET
Obter domínios fiscais/fiscal/catalogos
GET
Obter indicadores do trilho fiscal/fiscal/painel
GET
Listar NF-e importadas/fiscal/nfe
POST
Importar arquivos de NF-e/fiscal/nfe/importacoes
GET
Consultar NF-e/fiscal/nfe/{access_key}
DELETE
Remover NF-e não vinculada/fiscal/nfe/{access_key}
POST
Entregar um CT-e emitido pela sua transportadora/fiscal/cte-emitidos
GET
Listar CT-e recebidos/fiscal/cte-subcontratacao
POST
Receber um CT-e de terceiro/fiscal/cte-subcontratacao
GET
Consultar um CT-e recebido/fiscal/cte-subcontratacao/{access_key}
GET
Baixar o XML arquivado/fiscal/cte-subcontratacao/{access_key}/xml
GET
Listar autorizações de emissão (concedidas e recebidas)/fiscal/cte-subcontratacao/autorizacoes
POST
Autorizar uma contratante a emitir contra-CT-e em seu nome/fiscal/cte-subcontratacao/autorizacoes
DELETE
Revogar a autorização de uma contratante/fiscal/cte-subcontratacao/autorizacoes/{cnpj}
POST
Emitir contra-CT-e em lote (1:1 ou em pernas)/fiscal/cte-subcontratacao/lote
GET
Acompanhar um lote de contra-CT-e/fiscal/cte-subcontratacao/lote/{batch_id}
POST
Declarar CIOT sem CT-e/fiscal/ciot
GET
Consultar uma operação de transporte/fiscal/ciot/{ciot_uuid}
GET
Listar CT-e/fiscal/cte
POST
Criar rascunho de CT-e/fiscal/cte
POST
Emitir contra-CT-e (subcontratação ou redespacho)/fiscal/cte/contra
GET
Consultar CT-e/fiscal/cte/{cte_uuid}
PUT
Atualizar rascunho de CT-e/fiscal/cte/{cte_uuid}
POST
Repassar o CT-e à subcontratada (ponte da subcontratação)/fiscal/cte/{cte_uuid}/subcontratacao
POST
Gerar prévia do CT-e/fiscal/cte/{cte_uuid}/previa
POST
Emitir CT-e/fiscal/cte/{cte_uuid}/emissao
POST
Consultar autorização do CT-e/fiscal/cte/{cte_uuid}/consulta
GET
Baixar DACTE/fiscal/cte/{cte_uuid}/dacte
POST
Cancelar CT-e/fiscal/cte/{cte_uuid}/eventos/cancelamento
POST
Registrar carta de correção/fiscal/cte/{cte_uuid}/eventos/carta-correcao
POST
Confirmar entrega do CT-e/fiscal/cte/{cte_uuid}/eventos/entrega
POST
Cancelar confirmação de entrega/fiscal/cte/{cte_uuid}/eventos/entrega/cancelamento
POST
Reconciliar evento pendente do CT-e/fiscal/cte/{cte_uuid}/eventos/{event_key}/reconciliacao
POST
Validar dados para emissão do CIOT/fiscal/cte/{cte_uuid}/ciot/validacao
POST
Emitir CIOT/fiscal/cte/{cte_uuid}/ciot/emissao
POST
Consultar CIOT/fiscal/cte/{cte_uuid}/ciot/consulta
POST
Cancelar CIOT/fiscal/cte/{cte_uuid}/ciot/cancelamento
POST
Retificar CIOT/fiscal/cte/{cte_uuid}/ciot/retificacao
POST
Encerrar CIOT/fiscal/cte/{cte_uuid}/ciot/encerramento
GET
Listar veículos ativos/fiscal/veiculos
POST
Cadastrar veículo/fiscal/veiculos
PUT
Atualizar dados fiscais do veículo/fiscal/veiculos/{id}/dados-fiscais
GET
Listar motoristas/fiscal/motoristas
PUT
Atualizar dados fiscais do motorista/fiscal/motoristas/{id}/dados-fiscais
GET
Listar MDF-e/fiscal/mdfe
POST
Criar rascunho de MDF-e/fiscal/mdfe
GET
Consultar MDF-e/fiscal/mdfe/{mdfe_uuid}
PUT
Atualizar rascunho de MDF-e/fiscal/mdfe/{mdfe_uuid}
POST
Emitir MDF-e/fiscal/mdfe/{mdfe_uuid}/emissao
POST
Consultar autorização do MDF-e/fiscal/mdfe/{mdfe_uuid}/consulta
POST
Encerrar MDF-e/fiscal/mdfe/{mdfe_uuid}/encerramento
POST
Cancelar MDF-e/fiscal/mdfe/{mdfe_uuid}/cancelamento
POST
Incluir condutor no MDF-e/fiscal/mdfe/{mdfe_uuid}/condutores
GET
Baixar DAMDFE/fiscal/mdfe/{mdfe_uuid}/damdfe
GET
Listar regras de tributação/fiscal/regras-tributacao
POST
Criar regra de tributação/fiscal/regras-tributacao
DELETE
Remover regra de tributação/fiscal/regras-tributacao/{ruleId}
GET
Consultar a situação do RNTRC/consultas/rntrc
GET
Consultar o veículo no operador de pedágio/consultas/veiculo-pedagio
GET
Consultar a frota de um transportador (ANTT)/consultas/frota
POST
Convidar uma transportadora/convites/transportadoras
GET
Listar os seus agregados e a situação de cada um/agregados
GET
Consultar um agregado pelo CPF/CNPJ/agregados/{documento}
GET
Conferir a chave PIX de um agregado/agregados/{documento}/chave-pix
GET
Consultar as parcelas de repasse de um documento/carriers/parcelas-repasse/{documento}
POST
Liberar uma parcela/carriers/parcelas-repasse/liberar
POST
Pagar uma parcela/carriers/parcelas-repasse/pagar
POST
Liberar a parcela N de todos os CT-e de um MDF-e/carriers/parcelas-repasse/liberar-por-mdfe
POST
Ordenar o pagamento da parcela N de todos os CT-e de um MDF-e/carriers/parcelas-repasse/pagar-por-mdfe
POST
Roteirizar trajeto e calcular tarifas de pedágio/vale-pedagio/roteirizar
POST
Cotação de rotas e tarifas de Vale-Pedágio/vale-pedagio/cotacao
POST
Comprar e emitir Vale-Pedágio Obrigatório (VPO)/vale-pedagio/comprar
GET
Consultar detalhes de um Vale-Pedágio/vale-pedagio/{uuid}
POST
Cancelar Vale-Pedágio Obrigatório/vale-pedagio/{uuid}/cancelar
GET
Obter recibo/comprovante do Vale-Pedágio/vale-pedagio/{uuid}/recibo
POST
Emitir Vale-Pedágio complementar por desvio de rota/vale-pedagio/{uuid}/complemento