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

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

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

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

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

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.