Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Método que disponibiliza informações de Acordos Promocionais.

Chamada

/api/v1/AcordosPromocionais/consulta-acordos-promocionais

GET [URLAPI]/APIAcordosPromocionais/api/v1/AcordosPromocionais/consulta-acordos-promocionais

...

Parâmetros URI (URI Parameters)

NameDescriptionTypeAdittional Information

CodigoLoteProcesso

Código do lote processointeger

NumeroProcesso

Número do processointeger
NumeroAcordo                    Número do acordo            integer  
NumeroEmpresaNúmero da empresainteger
CnpjEmpresaCNPJ da empresa
Formato: 00000000000000 (14 dígitos)
stringObrigatório
CnpjFornecedorCNPJ do fornecedor
Formato: 00000000000000 (14 dígitos)
string
DataInicioEmissaoData início da emissão do acordo – Obrigatório – Formato: yyyy-MM-ddstringObrigatório
DataFimEmissãoData fim da emissão do acordo – Obrigatório – Formato: yyyy-MM-ddstringObrigatório
_pageNoNúmero da páginainteger
_pageSizeQuantidade de acordos por páginainteger


São utilizadas as seguintes regras de obrigatoriedade para a requisição:

  • Pelo menos um filtro deve ser informado.
  • Caso nenhum dos filtros a seguir seja informado — NumeroAcordoNumeroProcesso ou CodigoLoteProcesso — é obrigatório informar o período de emissão.
  • Quando NumeroEmpresa CNPJEmpresa forem informados simultaneamente, o sistema desconsidera o CNPJEmpresa na busca.
  • Se a data de início da emissão for informada, a data de fim da emissão também deve ser informada, e vice-versa.
  • A data de início da emissão não pode ser maior que a data de fim da emissão.


Parâmetros do Corpo (Body Parameters)

...