MDFe

Lista os MDFes da conta com base nos filtros aplicados

Este endpoint permite buscar todos os MDFes da conta, retornando as chaves de acesso, origens e os XMLs, encodados em base64, dos MDFes obtidos.

post/v1/dfe/mdfe

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/dfe/mdfe
  • Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway

Headers

X-API-IDstring required

API ID usado para autenticação.

X-API-KEYstring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Request body

Limitinteger

Número máximo de resultados por página.

Paginatorstring

Token de paginação para buscar a próxima página de resultados.

Fieldsstring[]

Define os campos a serem retornados. Quando não informado, o padrão retornado é: AccessKey, Origin, Owner.

Example request

{
  "Filter": {
    "AccessKeys": [
      "35260544914992000138580020007357391702793584"
    ],
    "CompanyRole": [
      "emitted",
      "received",
      "transporter"
    ],
    "CreatedAt": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "EmissionDate": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "EmitterCnpj": [
      "03160081000185"
    ],
    "EmitterType": [
      1,
      2,
      3
    ],
    "Modals": [
      1,
      2,
      3,
      4
    ],
    "Number": 42,
    "Origin": [
      "sefaz",
      "upload"
    ],
    "Owners": [
      "03160081000185"
    ],
    "Status": [
      "authorized",
      "canceled",
      "closed"
    ],
    "TransporterType": [
      1,
      2,
      3
    ]
  },
  "Limit": 25,
  "Paginator": "cursor-1",
  "Fields": [
    "AccessKey",
    "Number",
    "Serie",
    "Model",
    "Code",
    "Status",
    "Origin",
    "Owner",
    "TransporterType",
    "Modal",
    "EmissionDate",
    "EmitterState",
    "EmitterType",
    "CompanyRole",
    "CreatedAt",
    "IsProtocoled",
    "IsSigned",
    "Totals",
    "RouteStates",
    "ShipmentState",
    "DischargeState",
    "ShipmentCitiesInfo",
    "EmitterInfo",
    "DischargeCitiesInfo",
    "TravelStartsAt",
    "RoadTransportInfo",
    "RailTransportInfo",
    "AirTransportInfo",
    "ShipTransportInfo",
    "XML",
    "Events"
  ]
}

Response

Resposta da chamada para a API de listagem de MDFes.

Paginatorstring

Paginator é a hash utilizada para a próxima página de MDFes encontrados.

Totalinteger

Total é a quantidade total de MDFes obtida na listagem

Example response

{
  "Mdfes": [
    {
      "Totals": {
        "CargoValue": 73103.35,
        "CTe": 1,
        "WeightUnit": "Kg",
        "WeightValue": 13171.15
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.