Consulta de Acordos Promocionais - GET

Objetivo

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

Chamada

/api/v1/AcordosPromocionais/consulta-acordos-promocionais
 
Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Name	Description	Type	Adittional Information
NumeroAcordo	Número do acordo	integer
NumeroEmpresa	Número da empresa	integer
CnpjEmpresa	CNPJ da empresa Formato: 00000000000000 (14 dígitos)	string	Obrigatório
CnpjFornecedor	CNPJ do fornecedor Formato: 00000000000000 (14 dígitos)	string
DataInicioEmissao	Data início da emissão do acordo – Obrigatório – Formato: yyyy-MM-dd	string	Obrigatório
DataFimEmissão	Data fim da emissão do acordo – Obrigatório – Formato: yyyy-MM-dd	string	Obrigatório
_pageNo	Número da página	integer
_pageSize	Quantidade de acordos por página	integer

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

	Name	Description	Type
Topo
	NumeroAcordo	Número do acordo	Integer
	NumeroProcesso	Número do processo	Integer
	NumeroEmpresa	Número da empresa	Integer
	Descricao	Descrição do Acordo	sample string
	Referencia	Descrição da referência do acordo	sample string
	CnpjEmpresa	CNPJ da empresa Formato: 00000000000000 (14 dígitos)	string
	RazaoSocialEmpresa	Razão social da empresa que fez o acordo para o fornecedor	sample string
	NumeroTipoAcordo	Número do tipo do acordo	Integer
	TipoAcordo	Nome do tipo do acordo	string
	CnpjFornecedor	CNPJ do fornecedor Formato: 00000000000000 (14 dígitos)	string
	RazaoFornecedor	Razão social do fornecedor	sample string
	DataEmissão	Data de emissão do acordo	Date
	Comprador	Nome do comprador	sample string
	Status	Status do acordo promocional	sample string
	Situacao	Situação do acordo	sample string
	ValorTotal	Valor total do acordo	integer
	Observacao	Observação do acordo	string
	FormaPagamento	Descrição da forma de pagamento do acordo	string
	ResponsabelFornecedor	Nome do responsável do fornecedor	string
	DocumentoIdentidadeResponsavelFornecedor	Documento de Identidade do Responsável Fornecedor	string
	CpfResponsavelFornecedor	CPF do Responsável Fornecedor	string
	CargoResponsavelFornecedor	Cargo do Responsável Fornecedor	string
Vencimentos
	NumeroParcela	Número do vencimento da parcela	integer
	DataVencimento	Data de vencimento da parcela	Date
	ValorParcela	Valor da Parcela	sample 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",
    "observacao": "string",
    "formaPagamento": "string",
    "responsavelFornecedor": "string",
    "documentoIdentidadeResponsavelFornecedor": "string",
    "cpfResponsavelFornecedor": "string",
    "cargoResponsavelFornecedor": "string",
    "vencimentos": [
      {
        "numeroParcela": integer,
        "dataVencimento": "string",
        "valorParcela": "string"
      }
    ]
  }
]

Árvore de páginas

Consulta de Acordos Promocionais - GET

Objetivo

Chamada

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Formatos de Resposta (Response Formats)

application/json, text/json