← HomeFleetPay / API
A Reference to Build With.
Explore the API contract. Check environments, scopes and each operation’s conditions before integrating.
Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
82 operations · 171 schemas · core 368eda3
82 operations
GET
Check fiscal access and readiness
GET/fiscal/statusGet carrier fiscal configuration
PUT/fiscal/configuracaoUpdate carrier fiscal configuration
GET/fiscal/configuracaoGet digital certificate metadata
POST/fiscal/certificadoUpload an A1 digital certificate
DELETE/fiscal/certificadoRemove the digital certificate
GET/fiscal/certificadoGet fiscal reference values
GET/fiscal/catalogosGet fiscal indicators
GET/fiscal/painelList imported NF-e documents
POST/fiscal/nfeImport NF-e files
GET/fiscal/nfe/importacoesGet an NF-e document
DELETE/fiscal/nfe/{access_key}Remove an unlinked NF-e
POST/fiscal/nfe/{access_key}Submit a CT-e issued by your carrier
GET/fiscal/cte-emitidosList received CT-e documents
POST/fiscal/cte-subcontratacaoReceive a third-party CT-e
GET/fiscal/cte-subcontratacaoGet a received CT-e
GET/fiscal/cte-subcontratacao/{access_key}Download the archived XML
GET/fiscal/cte-subcontratacao/{access_key}/xmlList issuance authorizations
POST/fiscal/cte-subcontratacao/autorizacoesAuthorize a contractor to issue on your behalf
DELETE/fiscal/cte-subcontratacao/autorizacoesRevoke a contractor authorization
POST/fiscal/cte-subcontratacao/autorizacoes/{cnpj}Issue a batch of contra-CT-e documents
GET/fiscal/cte-subcontratacao/loteTrack a contra-CT-e batch
POST/fiscal/cte-subcontratacao/lote/{batch_id}Declare a CIOT without a CT-e
GET/fiscal/ciotGet a transport operation
GET/fiscal/ciot/{ciot_uuid}List CT-e documents
POST/fiscal/cteCreate a CT-e draft
POST/fiscal/cteIssue a contra-CT-e
GET/fiscal/cte/contraGet a CT-e document
PUT/fiscal/cte/{cte_uuid}Update a CT-e draft
POST/fiscal/cte/{cte_uuid}Pass a CT-e to a subcontractor
POST/fiscal/cte/{cte_uuid}/subcontratacaoGenerate a CT-e preview
POST/fiscal/cte/{cte_uuid}/previaIssue a CT-e
POST/fiscal/cte/{cte_uuid}/emissaoCheck CT-e authorization
GET/fiscal/cte/{cte_uuid}/consultaDownload DACTE
POST/fiscal/cte/{cte_uuid}/dacteCancel a CT-e
POST/fiscal/cte/{cte_uuid}/eventos/cancelamentoRegister a correction letter
POST/fiscal/cte/{cte_uuid}/eventos/carta-correcaoConfirm CT-e delivery
POST/fiscal/cte/{cte_uuid}/eventos/entregaCancel a delivery confirmation
POST/fiscal/cte/{cte_uuid}/eventos/entrega/cancelamentoReconcile a pending CT-e event
POST/fiscal/cte/{cte_uuid}/eventos/{event_key}/reconciliacaoValidate CIOT issuance data
POST/fiscal/cte/{cte_uuid}/ciot/validacaoIssue a CIOT
POST/fiscal/cte/{cte_uuid}/ciot/emissaoGet CIOT status
POST/fiscal/cte/{cte_uuid}/ciot/consultaCancel a CIOT
POST/fiscal/cte/{cte_uuid}/ciot/cancelamentoAmend a CIOT
POST/fiscal/cte/{cte_uuid}/ciot/retificacaoClose a CIOT
GET/fiscal/cte/{cte_uuid}/ciot/encerramentoList active vehicles
POST/fiscal/veiculosRegister a vehicle
PUT/fiscal/veiculosUpdate vehicle fiscal data
GET/fiscal/veiculos/{id}/dados-fiscaisList drivers
PUT/fiscal/motoristasUpdate driver fiscal data
GET/fiscal/motoristas/{id}/dados-fiscaisList MDF-e documents
POST/fiscal/mdfeCreate an MDF-e draft
GET/fiscal/mdfeGet an MDF-e document
PUT/fiscal/mdfe/{mdfe_uuid}Update an MDF-e draft
POST/fiscal/mdfe/{mdfe_uuid}Issue an MDF-e
POST/fiscal/mdfe/{mdfe_uuid}/emissaoCheck MDF-e authorization
POST/fiscal/mdfe/{mdfe_uuid}/consultaClose an MDF-e
POST/fiscal/mdfe/{mdfe_uuid}/encerramentoCancel an MDF-e
POST/fiscal/mdfe/{mdfe_uuid}/cancelamentoAdd a driver to an MDF-e
GET/fiscal/mdfe/{mdfe_uuid}/condutoresDownload DAMDFE
GET/fiscal/mdfe/{mdfe_uuid}/damdfeList tax rules
POST/fiscal/regras-tributacaoCreate a tax rule
DELETE/fiscal/regras-tributacaoRemove a tax rule
GET/fiscal/regras-tributacao/{ruleId}Check RNTRC status
GET/consultas/rntrcCheck a vehicle with the toll operator
GET/consultas/veiculo-pedagioCheck a carrier fleet with ANTT
POST/consultas/frotaInvite a carrier
GET/convites/transportadorasList contracted drivers and their status
GET/agregadosGet a contracted driver by tax identifier
GET/agregados/{documento}Verify a contracted driver's Pix key
GET/agregados/{documento}/chave-pixGet transfer installments for a document
POST/carriers/parcelas-repasse/{documento}Release an installment
POST/carriers/parcelas-repasse/liberarPay an installment
POST/carriers/parcelas-repasse/pagarRelease installment N for all CT-e in an MDF-e
POST/carriers/parcelas-repasse/liberar-por-mdfeOrder payment of installment N for an MDF-e
POST/carriers/parcelas-repasse/pagar-por-mdfePlan a route and calculate toll charges
POST/vale-pedagio/roteirizarQuote toll voucher routes and charges
POST/vale-pedagio/cotacaoPurchase a mandatory toll voucher
GET/vale-pedagio/comprarGet toll voucher details
POST/vale-pedagio/{uuid}Cancel a mandatory toll voucher
GET/vale-pedagio/{uuid}/cancelarGet a toll voucher receipt
POST/vale-pedagio/{uuid}/reciboIssue an additional toll voucher for a detour
/vale-pedagio/{uuid}/complemento