statequery · stringOpcionalFiltro por estado da averbação (ex: averbacao_confirmed, averbacao_rejected).
Restrições
{
"type": "string"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/seguro-carga/averbacoesDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Lista protocolos e estados de averbação AT&M do Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023).
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]statequery · stringOpcionalFiltro por estado da averbação (ex: averbacao_confirmed, averbacao_rejected).
{
"type": "string"
}document_typequery · stringOpcionalTipo documental: cte, nfe ou mdfe.
{
"type": "string"
}200 Resposta HTTPOperação processada com sucesso.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTPCredencial ausente, inválida ou de outro ambiente.
403 Resposta HTTPEscopo do painel não habilitado ou recurso fora do escopo da company.
{
"tags": [
"Seguro de Carga"
],
"operationId": "listarAverbacoesSeguroCarga",
"summary": "Listar averbações de Seguro Obrigatório de Carga (RCTR-C / RC-DC)",
"description": "Lista protocolos e estados de averbação AT&M do Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023).",
"parameters": [
{
"name": "state",
"in": "query",
"required": false,
"description": "Filtro por estado da averbação (ex: averbacao_confirmed, averbacao_rejected).",
"schema": {
"type": "string"
}
},
{
"name": "document_type",
"in": "query",
"required": false,
"description": "Tipo documental: cte, nfe ou mdfe.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operação processada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
]
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"ambiente": {
"type": "string",
"enum": [
"homologacao",
"producao"
]
}
}
}
}
}
},
"401": {
"description": "Credencial ausente, inválida ou de outro ambiente."
},
"403": {
"description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "seguro-carga",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"embarcador",
"transportador_frotista"
],
"method": "GET",
"path": "/seguro-carga/averbacoes"
}