Fazer download de XMLs a partir de chaves de acesso ou filtros específicos
Retorna um arquivo compactado (.zip) dos XMLs informados. Há duas formas de utilizar este endpoint:
1. Por lista de chaves de acesso: informe as chaves de acesso, separadas por ponto, vírgula, ponto e vírgula, quebra de linha ou um caractere de espaço | . | , | ; | \n |
2. Por filtros específicos: na ausência da chave de acesso, informe o tipo de relação, CNPJ, modelo, data inicial, data final e série. Neste caso, todos esses campos são obrigatórios.
Obs.: O parâmetro ambiente é obrigatório em ambas opções. Caso retorne erro de resultados acima do limite, entre em contato com a pessoa que gerencia sua conta Oobj.
Header Parameters
- x-auth-token string required
identificador de sessão
- application/json
Request Body required
filtroDownloadDTO
- ambiente string required
Possible values: [
hom,prod]Tipo do ambiente
- chavesAcesso string
Lista de chaves de acesso
- codModelo int32
Possible values: [
55,57,58,59,65,66,99]Código do modelo
- dataFinal date-time
Data Final, no formato aaaa-mm-dd'T'hh:mm:ssZ. Exemplo: '2019-03-26T12:25:59-03:00'
- dataInicial date-time
Data Inicial, no formato aaaa-mm-dd'T'hh:mm:ssZ. Exemplo: '2018-03-26T12:25:59-03:00'
- empresa string
CNPJ da empresa
- serie int64
Série
- tipoRelacao string
Possible values: [
emitente,destinatario,transportador,remetente,recebedor,expedidor,tomador,autorizado]Tipo Relação, emitente ou destinatario
- 200
- 201
- 401
- 403
- 404
OK
- */*
- Schema
- Example (from schema)
Schema
body object
- statusCode string
Possible values: [
100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,509,510,511] - statusCodeValue int32
{
"body": {},
"statusCode": "100",
"statusCodeValue": 0
}
Created
Unauthorized
Forbidden
Not Found
