Inclusão de Acordos Promocionais - POST

Objetivo

Possibilitar 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]/v2/AcordosPromocionais/inserir-acordos-promocionais

Informações para Requisição

Parâmetros do Corpo

	Nome	Descrição	Tipo	Informações Adicionais
acordos		Obrigatório - Por acordo
	nroEmpresa	Número da empresa	integer	A API valida se a empresa existe e está ativa
	codTipoAcordo	Código do tipo do acordo	integer	A API valida se o tipo acordo existe
	seqComprador	Código do comprador	integer	A API valida se o comprador existe e está ativo
	seqFornecedor	Código do fornecedor	integer	A API valida se o fornecedor existe e está ativo A API valida se a Divisão da Empresa está configurada e ativa para o fornecedor
	descricao	Descrição do acordo	string	Não pode conter mais de 50 caracteres
	referencia	Referência do acordo	string	Não pode conter mais de 50 caracteres
parcelas		Obrigatório - Deve conter no mínimo uma parcela
	dataVencimento	Data de vencimento da parcela	date	A Data de Vencimento deve ser maior que a data atual Não é permitido parcelas com a mesma data de vencimento Não é permitido informar uma Data de Vencimento menor que a Data de Vencimento da parcela anterior
	valorParcela	Valor da parcela	number	O Valor da Parcela deve ser maior que zero O valor total do acordo será a somatória dos valores das parcelas O valor total do acordo não pode ser maior que R$ 99999999999,99
acordos		Opcional - Por acordo
	nomeRepresentante	Nome do representante	string	Não pode conter mais de 100 caracteres
	doctoRepresentante	Documento do representante	string	Não pode conter mais de 20 caracteres
	cpfRepresentante	CPF do representante	string	A API valida se o CPF é válido
	cargoRepresentante	Cargo do representante	string	Não pode conter mais de 40 caracteres
	nroFormaPagamento	Número da forma de pagamento	integer	A API valida se a Forma de Pagamento existe e está ativa A API valida se a Forma de Pagamento existe para a Empresa e está ativa
	observacao	Observação do acordo	string	Não pode conter mais de 4000 caracteres

Formatos da Requisição

Exemplo

{
  "acordos": [
    {
      "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

Code 200

{
  "mensagem": "Acordos inseridos com sucesso",
  "mensagemDetalhada": "Alguns acordos não foram gerados. Verifique o Log para mais detalhes",
  "totalAcordosGerados": 1,
  "totalAcordosNaoGerados": 1,
  "seqLoteProcesso": 1
}

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
200		Sucesso
	mensagem	Mensagem de retorno	string
	mensagemDetalhada	Detalhe da mensagem	string
	totalAcordosGerados	Número total de acordos gerados	integer
	totalAcordosNaoGerados	Número total de acordos não gerados	integer
	seqLoteProcesso	Código do Lote do Processo	integer
400		Erro
	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:

Acordo Genérico
Acordo de Acréscimo
Conta Corrente
Integração com TOTVS Assinatura Eletrônica

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

Desconto%
Exige Grupo Contábil
Exige Informar Período de Validade
Utiliza Prazo Pagamento Fornecedor
Vencimento último dia do mês

A API NÃO considera as regras dos seguintes Parâmetros Dinâmicos:

BLOQ_USU_OUTRO_COMPR
UTIL_PARCELA_ACORDO
ACORDO_PROMOC.UTIL_CONC_DIV_EMP
UTIL_GRUPOCONT_ACORDO

Outras regras:

Não será possível visualizar as parcelas na aplicação caso o PD ACORDO_PROMOC.UTIL_CONC_DIV_EMP = ‘S’
Será possível visualizar as parcelas na aplicação somente se o PD UTIL_PARCELA_ACORDO = S
Diferente da aplicação, na API não é permitido inserir um acordo com a data atual na Data de Vencimento.
Não é permitido informar a mesma Data de Vencimento para mais de uma parcela do acordo.
A Data de Emissão será configurada pela API, considerando a data de inclusão do acordo.
O Valor Total do acordo será calculado pela API somando os valores informados nas parcelas.
O Valor Total do acordo não pode ser maior que R$ 99999999999,99.
A cada requisição, será possível inserir no máximo 500 acordos.
Todos os acordos inseridos na mesma requisição serão do mesmo Código do Lote do Processo.

Árvore de páginas