TOTVS CRM Automação da Força de Vendas (SFA)

Árvore de páginas

PONTOS DE ENTRADA DE CUSTOMIZAÇÕES

Produto: Automação da Força de Vendas
Linha de Produto: TOTVS CRM
Segmento: Cross Segmentos
Módulo: API de integração
Aplicação: Web/App móvel
Identificador: DTSFAPD-2265
       

    VISÃO GERAL

Esta melhoria introduz a abordagem de "Pontos de Entrada de Customizações" no TOTVS CRM Automação da Força de Vendas. Ela permite que os desenvolvedores personalizem a solução de forma mais eficiente, implementando modificações em um repositório separado, de acordo com os Contratos Técnicos de Customização.


    OBJETIVO

Aprimorar a flexibilidade e a manutenção da solução, permitindo customizações mais organizadas, redução de conflitos e facilitação das atualizações.


  ANTES DE COMEÇAR

Requisitos

  • Versão padrão da solução TOTVS CRM - SFA.

  DETALHES FUNCIONAIS

Funções

  1. Introdução de novas rotas nas APIs padrão para manipulação de dados, como "Cota" e "Saldo Cota".
  2. Adição de novos campos em rotas existentes, como "ClienteSub", "PedidoSub", "Nota fiscal Produto", entre outras.
  3. Inclusão de propriedades "Sub" para permitir campos adicionais em diferentes contextos, como PedidoCabecalhoCampo, PedidoProdutoCampo, etc.
  4. Adição de campos específicos em rotas como "Segmento", "Pedido", "Tabela Preço Produto", entre outras, para enriquecer as informações.

  DETALHES TÉCNICOS

Novas Rotas

O SFA deverá receber novas rotas em suas APIs padrão, sendo elas:


Nome da Rota: Cota

Tabela: cota

Métodos: GET, POST, PUT, DELETE


Campo Propriedade da API Tipagem da Propriedade Observações
idcota internalid integer Não presente na rota POST
descricao descricao varchar
sgltipocota sgltipocota varchar
datainiciovigencia datainiciovigencia data
datafimvigencia datafimvigencia data
idnativo idnativo boolean
idunidademedida idunidademedida integer
idunidademedida_externalid idunidademedida > unidademedida.codigoerp varchar
codigoerp externalid varchar
datacadastro datacadastro data
horacadastro horacadastro varchar
numerocota numerocota varchar
observacaocota observacaocota varchar

Campos com Valores Fixos

  • idnvalidaproduto: 1
  • idnvalidaunidademedida: 1
  • idnvalidalocalfilial: 1
  • idnvalidasegmento: 1
  • idnvalidatabelapreco: 1
  • idnvalidagrupoproduto: 1
  • sglorigem: "INTEGRACAO"
  • idnfinalizado: 0

Nome da Rota: Saldo Cota

Tabela: controlecota

Métodos: GET, POST, PUT, DELETE


Campo Propriedade da API Tipagem da Propriedade Observações
idcontrolecota internalid integer Não presente na rota POST
idnativo idnativo boolean
saldoinicio saldoinicio decimal
saldocota saldocota decimal
saldodisponivel saldodisponivel decimal
idcota idcota integer
idcota_externalid idcota > cota.codigoerp varchar
idusuario idusuario integer
idusuario_externalid idusuario > usuario.codigoerp varchar
idproduto idproduto integer
idproduto_externalid idproduto > produto.codigoerp varchar
idgrupoproduto idgrupoproduto integer
idgrupoproduto_externalid idgrupoproduto > grupoproduto.codigoerp varchar
idlocal idlocal integer
idlocal_externalid idlocal > local.codigoerp varchar
idlocalfilial idlocalfilial integer
idlocalfilial_externalid idlocalfilial > local.codigoerp varchar
idsegmento idsegmento integer
idsegmento_externalid idsegmento > segmento.codigoerp varchar
idtabelapreco idtabelapreco integer
idtabelapreco_externalid idtabelapreco > tabelapreco.codigoerp varchar
idparceiro idparceiro integer
idparceiro_externalid idparceiro > parceiro.codigoerp varchar
idusuariosuperior idusuariosuperior integer
idusuariosuperior_externalid idusuariosuperior > usuario.codigoerp varchar
codigoerp externalid varchar

Nome da Rota: Pedido Campo Opção Fixa

Tabela: wsconfigcampoopcaofixo

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade Observações
idwsconfigcampoopcaofixo internalid integer Não presente na rota POST
idwsconfigcampo idwsconfigcampo integer
idwsconfigcampo_externalid idwsconfigcampo > wsconfigcampo.codigoerp varchar
valor valor varchar
descricao descricao varchar
codigoerp externalid varchar

Rota: ClienteSub

Métodos: GET, POST, PUT

Nova Propriedade Sub "CampoResposta"


Campo Propriedade da API Tipagem da Propriedade Observações
idcamporesposta internalid integer Não presente na rota POST
idcampo idcampo integer
idcampo_externalid idcampo > campo.codigoerp varchar
idcampoopcaofixo idcampoopcaofixo integer
idcampoopcaofixo_externalid idcampoopcaofixo > campoopcaofixo.codigoerp varchar
resposta resposta varchar
codigoerp externalid varchar

Rota: PedidoSub - Nova Propriedade Sub 'PedidoCabecalhoCampo'

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade Observações
idpedidocabecalhocampo internalid integer Não presente na rota POST
idwsconfigcampo idwsconfigcampo integer
idwsconfigcampo_externalid idwsconfigcampo > wsconfigcampo.codigoerp varchar
valor valor varchar
idnobrigatorio Valor fixo 0
ordem ordem integer
codigoerp externalid varchar

Rota: PedidoSub - Nova Propriedade Sub 'PedidoProdutoCampo'

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade Observações
idpedidocabecalhocampo internalid integer Não presente na rota POST
idwsconfigcampo idwsconfigcampo integer
idwsconfigcampo_externalid idwsconfigcampo > wsconfigcampo.codigoerp varchar
valor valor varchar
codigoerp externalid varchar

Rota: PedidoSub - Nova Propriedade Sub 'PedidoEntregaCampo'

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade Observações
idpedidocabecalhocampo internalid integer Não presente na rota POST
idwsconfigcampo idwsconfigcampo integer
idwsconfigcampo_externalid idwsconfigcampo > wsconfigcampo.codigoerp varchar
valor valor varchar
idnobrigatorio Valor fixo 0
ordem ordem integer
codigoerp externalid varchar

Rota: PedidoSub - Nova Propriedade Sub 'PedidoResumoCampo'

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade Observações
idpedidocabecalhocampo internalid integer Não presente na rota POST
idwsconfigcampo idwsconfigcampo integer
idwsconfigcampo_externalid idwsconfigcampo > wsconfigcampo.codigoerp varchar
valor valor varchar
idnobrigatorio Valor fixo 0
ordem ordem integer
codigoerp externalid varchar

Rota: PedidoSub - Nova Propriedade Sub 'PedidoComplementoCampo'

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade Observações
idpedidocabecalhocampo internalid integer Não presente na rota POST
idwsconfigcampo idwsconfigcampo integer
idwsconfigcampo_externalid idwsconfigcampo > wsconfigcampo.codigoerp varchar
valor valor varchar
idnobrigatorio Valor fixo 0
ordem ordem integer
codigoerp externalid varchar

Rota: Nota fiscal Produto, NotafiscalSub

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade
valorcomissao valorcomissao decimal
percentualcomissao percentualcomissao decimal

Rota: Segmento

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade
sigla sigla varchar

Rota: Pedido, PedidoSub

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade
datafaturamento datafaturamento date

Rota: Tabela Preço Produto

Métodos: GET, POST, PUT


Campo Propriedade da API Tipagem da Propriedade
precocusto precocusto decimal

PERGUNTAS FREQUENTES

  • question_answer