Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Parâmetros do Corpo (Body Parameters)

Response Information


Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
acordos
Obrigatório - Por acordo


nroEmpresaNúmero da empresaintegerA API valida se a empresa existe e está ativa

codTipoAcordoCódigo do tipo do acordointegerA API valida se o tipo acordo existe

seqCompradorCódigo do compradorintegerA API valida se o comprador existe e está ativo

seqFornecedorCódigo do fornecedorintegerA API valida se o fornecedor existe

descricaoDescrição do acordostring

referenciaReferência do acordostring
parcelas
Obrigatório - Deve conter no mínimo uma parcela


dataVencimentoData de vencimento da parceladateA data de vencimento deve ser maior que a data atual
Não é permitido parcelas com a mesma data de vencimento

valorParcelaValor da parcelanumber
acordos
Opcional - Por acordo


nomeRepresentanteNome do representantestring

doctoRepresentanteDocumento do representantestring

cpfRepresentanteCPF do representantestring

cargoRepresentanteCargo do representantestring

nroFormaPagamentoNúmero da forma de pagamentointeger

observacaoObservação do acordostring


Formatos da Requisição (Request Formats)

...

{
"resultado": boolean,
  "mensagem": "string"
}

Observações (Observations)

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.