Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

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

Chamada

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


Parâmetros URI (URI Parameters)

NameDescriptionType

CodigoLoteProcesso

Código do lote processo

NumeroProcesso

Número do processo
NumeroAcordo                    Número do acordo            integer  
NumeroEmpresaNúmero da empresainteger
CnpjEmpresaCNPJ da empresa
Formato: 00000000000000 (14 dígitos)		string
CnpjFornecedorCNPJ do fornecedor
Formato: 00000000000000 (14 dígitos)		string
DataInicioEmissaoData início da emissão do acordo – Obrigatório – Formato: yyyy-MM-ddstring
DataFimEmissãoData fim da emissão do acordo – Obrigatório – Formato: yyyy-MM-ddstring
_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 — NumeroAcordo, NumeroProcesso ou CodigoLoteProcesso — é obrigatório informar o período de emissão.
  • Quando NumeroEmpresa e 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)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)


NameDescriptionType
Topo



NumeroAcordoNúmero do acordo Integer

NumeroProcessoNúmero do processoInteger

NumeroEmpresaNúmero da empresaInteger

DescricaoDescrição do Acordosample string

ReferenciaDescrição da referência do acordosample string

CnpjEmpresaCNPJ da empresa
Formato: 00000000000000 (14 dígitos)		string

RazaoSocialEmpresaRazão social da empresa que fez o acordo para o fornecedorsample string

NumeroTipoAcordoNúmero do tipo do acordoInteger

TipoAcordoNome do tipo do acordostring

CnpjFornecedorCNPJ do fornecedor
Formato: 00000000000000 (14 dígitos)		string

RazaoFornecedorRazão social do fornecedorsample string

DataEmissãoData de emissão do acordoDate

CompradorNome do compradorsample string

StatusStatus do acordo promocionalsample string

SituacaoSituação do acordosample string

ValorTotalValor total do acordointeger

SaldoFinanceiroValor do Saldo Financeiro do Acordostring

ObservacaoObservação do acordostring

FormaPagamentoDescrição da forma de pagamento do acordostring

ResponsabelFornecedorNome do responsável do fornecedorstring

DocumentoIdentidadeResponsavelFornecedorDocumento de Identidade do Responsável Fornecedorstring

CpfResponsavelFornecedorCPF do Responsável Fornecedorstring

CargoResponsavelFornecedorCargo do Responsável Fornecedorstring
Vencimentos



NumeroParcelaNúmero do vencimento da parcelainteger

DataVencimentoData de vencimento da parcelaDate

ValorParcelaValor da Parcelasample integer

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "numeroAcordo": integer,
    "numeroProcesso": integer,
    "numeroEmpresa": integer,
    "descricao": "string",
    "referencia": "string",
    "cnpjEmpresa": "string",
    "razaoSocialEmpresa": "string",
    "numeroTipoAcordo": 0,
    "tipoAcordo": "string",
    "cnpjFornecedor": "string",
    "razaoSocialFornecedor": "string",
    "dataEmissao": "string",
    "comprador": "string",
    "status": "string",
    "situacao": "string",
    "valorTotal": "string",
    "saldoFinanceiro": "string",
    "observacao": "string",
    "formaPagamento": "string",
    "responsavelFornecedor": "string",
    "documentoIdentidadeResponsavelFornecedor": "string",
    "cpfResponsavelFornecedor": "string",
    "cargoResponsavelFornecedor": "string",
    "vencimentos": [
      {
        "numeroParcela": integer,
        "dataVencimento": "string",
        "valorParcela": "string"
      }
    ]
  }
]

  • Sem rótulos