v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consultar pedido de consulta de débitos veiculares.

get/vehicledebts/consult

Query parameters

IdConsultstring

Identificador da consulta de débitos.

ClientRequestIdstring

Identificador do cliente.

DebitIdstring

Identificador do débito.

Response

200

versionstring
statusstring

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "clientRequestId": "58d6faf2-98f5-4cd5-b855-2adac6e2b985",
    "idConsult": "1ae8a57d-b15d-4b4b-b943-4cf76ebabca1",
    "status": "PENDING",
    "debts": [
      {
        "ait": "string",
        "debitId": "string",
        "description": "string",
        "dueDate": "2024-12-05T18:48:59.714Z",
        "expirationDate": "2024-12-05T18:48:59.714Z",
        "hasDiscount": true,
        "isExpired": true,
        "required": true,
        "title": "string",
        "type": "string",
        "distinct": [
          "string"
        ],
        "dependsOn": [
          "string"
        ]
      }
    ],
    "vehicle": {
      "document": "11111111111",
      "licensePlate": "JFI8753",
      "renavam": "56387604559",
      "uf": "SP"
    },
    "error": [
      {
        "errorCode": "XXX001",
        "message": "Ocorreu um erro interno durante a chamada da api."
      }
    ]
  }
}