Histórico da Página

Objetivo

...

Possibilitar

...

A finalidade deste método é realizar a inclusão de acordos promocionais no ERP TOTVS Varejo Supermercados - Linha Consinco utilizando sistemas de terceiros.

...

Após a inclusão, a empresa poderá utilizar o acordo promocional para realizar a cobrança do fornecedor.

Publicação

A publicação deverá ser feita por meio da ferramenta Publica Web. 

Chamada

POST [URLAPI]/APIAcordosPromocionais/api/v2/AcordosPromocionais/inserir-acordos-promocionais

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Aplicação Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Varejo > Acordos e Verbas > API Acordos Promocionais

Image Added

Imagem 1 - Configurar permissão para inserir na API

Informações para Requisição

Parâmetros do Corpo 

Formatos da

...

Requisição

{
  "acordos": [
    { 
      "identificador": 1,
	  "nroEmpresa": 1,
      "codTipoAcordo": 1,
      "seqComprador": 1,
      "seqFornecedor": 1,
      "descricao": "Descrição",
      "referencia": "Referência",
      "parcelas": [
        {
          "dataVencimento": "2025-03-08",
          "valorParcela": 10
        }
      ],
      "nomeRepresentante": "Teste",
      "doctoRepresentante": "123456789",
      "cpfRepresentante": "123.456.789-01",
      "cargoRepresentante": "Representante",
      "nroFormaPagamento": 1,
      "observacao": "Observação"
    }
  ]
}

Formatos da Resposta

...

Bloco de código
language actionscript3 title Code 200

...

{

...

"sucesso":

...

false, "codigoLoteProcesso": 1, "acordosInseridos": [ { "identificador": 1, "numeroAcordo": 123, "numeroEmpresa": 1 } ], "acordosComErro": [ { "identificador": 2, "erros": [ "Não foi informado nenhum acordo para inserir." ] } ] }

Bloco de código
language actionscript3 title Code 400
[   {     "guid": "Código de guia",     "code": "400",     "message": "Erro ao inserir os acordos promocionais",     "detailedMessage": "Não foi informado nenhum acordo para inserir."   } ]

Código	Nome	Descrição	Tipo	Informações Adicionais
200		Sucesso
	sucesso	Identificador de sucesso da requisição	boolean	Se sucesso = true: todos os acordos foram incluídos com sucesso; Se sucesso = false: o retorno trará um ou mais itens em acordosComErro descrevendo as falhas individuais.
	codigoLoteProcesso	Código do lote processo	integer
acordosInseridos
	identificador	Identificador do acordo na requisição	integer
	numeroAcordo	Número do Acordo Promocional	integer
	numeroEmpresa	Número de empresa	integer
acordosComErro
	identificador	Identificador do acordo na requisição	integer
	erros	Mensagem detalhada das falhas no processo	string
400		Erro

Código (Code)Nome (Name)Descrição (Description)Tipo (Type)200Sucesso (Seccess)mensagemMensagem de retornostringmensagemDetalhadaDetalhe da mensagemstringtotalAcordosGeradosNúmero total de acordos geradosintegertotalAcordosNaoGeradosNúmero total de acordos não geradosintegerseqLoteProcessoCódigo do Lote do Processointeger400Erro (Error)

	guid	Código de guia	string
	code	Código de retorno	string
	message	Mensagem de retorno	string
	detailedMessage	Detalhe da mensagem	string

Observações

...

A API NÃO trata os seguintes processos do Acordo:

...