CTe-OS

Lista os CTe-OS da conta com base nos filtros aplicados

Este endpoint permite buscar todos os CTe-OS da conta, retornando os dados conforme a projeção solicitada, com suporte a filtros avançados como chave de acesso, CNPJ do emitente, tomador, status e intervalo de datas.

post/v1/dfe/cteos

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/dfe/cteos
  • 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

Fieldsstring[]

Lista de campos a serem retornados na resposta. Caso não informado, o padrão retornado é: AccessKey e Xml.

Limitinteger

Número máximo de resultados a serem retornados (padrão: 500, máximo: 500).

Paginatorstring

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

Example request

{
  "Fields": [
    "Xml",
    "Origin",
    "Events",
    "Tags",
    "Cfops",
    "AccessKey",
    "EmissionDate",
    "CreatedAt",
    "HasCCE",
    "Manifestations",
    "Number",
    "Owner",
    "OwnerRole",
    "Emitter",
    "Status",
    "Taker"
  ],
  "Filters": {
    "CreatedAt": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "EmissionDate": {
      "From": "2006-01-02",
      "To": "2006-01-02 23:59:59"
    },
    "DocumentIdentifier": "35260544914992000138570010007357391702793584",
    "Owners": [
      "19427033000140",
      "03160081000185"
    ],
    "EmitterCnpj": [
      "19427033000140"
    ],
    "Status": "authorized",
    "Origin": "sefaz",
    "HasCCE": true,
    "Cfops": [
      "5102",
      "6102"
    ],
    "Tags": [
      1,
      2
    ],
    "Types": [
      "normal"
    ]
  },
  "Limit": 100,
  "Paginator": "[\"75e7ccc0a702d0a823a2ef073a023c8fc9afedf7\"]"
}

Response

HTTPCteOSListResponseBodyV1 contém a resposta da chamada para a API de listagem de CTe-OS.

Paginatorstring

Token utilizado para buscar a próxima página de CTe-OS.

Totalinteger

Quantidade total de CTe-OS obtidos na listagem.

Changes

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