Árvore de páginas

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 4 Próxima »

01. DADOS GERAIS

Produto:

TOTVS CRM Automação da Força de Vendas

Linha de Produto:

Linha TOTVS CRM

ERPs impactados:Todos
Módulo:Integração
Função:API REST
Ambiente:APIs de integração
Ticket:
Requisito/Story/Issue:


02. ESCOPO FUNCIONAL/TÉCNICO


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

Nome rota: Cota

Tabela: cota

GET, POST, PUT, DELETE

CampoPropriedade da APITipagem da propriedade
idcotainternalid

integer


descricao

descricao

varchar

sgltipocotasgltipocotavarchar
datainiciovigenciadatainiciovigenciadata
datafimvigenciadatafimvigenciadata
idnativoidnativoboolean
idunidadefederativaidunidadefederativainteger
idunidadefederativa > unidadefederativa.codigoerpidunidadefederativa_externalidvarchar
codigoerpexternalidvarchar
datacadastrodatacadastrodata
horacadastrohoracadastrovarchar
numerocotanumerocotavarchar
observacaocotaobservacaocotavarchar

Os seguintes campos podem ser inseridos com valor fixo:

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


Nome rota: Saldo Cota

Tabela: controlecota

GET, POST, PUT, DELETE

CampoPropriedade da APITipagem da propriedade
idcontrolecotainternalidinteger
idnativoidnativoboolean
saldoiniciosaldoiniciodecimal
saldocotasaldocotadecimal
saldodisponivelsaldodisponiveldecimal
idcotaidcotainteger
idcota > cota.codigoerpidcota_externalidvarchar
idusuarioidusuariointeger
idusuario > usuario.codigoerpidusuario_externalidvarchar
idprodutoidprodutointeger
idproduto > produto.codigoerpidproduto_externalidvarchar
idgrupoprodutoidgrupoprodutointeger
idgrupoproduto > grupoproduto.codigoerpidgrupoproduto_externalidvarchar
idlocalidlocalinteger
idlocal > local.codigoerpidlocal_externalidvarchar
idlocalfilialidlocalfilialinteger
idlocalfilial > local.codigoerpidlocalfilial_externalidvarchar
idsegmentoidsegmentointeger
idsegmento > segmento.codigoerpidsegmento_externalidvarchar
idtabelaprecoidtabelaprecointeger
idtabelapreco > tabelapreco.codigoerpidtabelapreco_externalidvarchar
idparceiroidparceirointeger
idparceiro > parceiro.codigoerpidparceiro_externalidvarchar
idusuariosuperioridusuariosuperiorinteger
idusuariosuperior > usuario.codigoerpidusuariosuperior_externalidvarchar
codigoerpexternalidvarchar

Nome da Rota: Movimento Cota

GET
PUT, de nome "Processar Movimento"

  • Rota que atualiza o idnprocessado do movimento para 1
    • Caso já esteja processado, retornar validação


DELETE, de nome "Cancelar Movimento"

  • Rota que atualiza o idnativo do movimento para 0
    • Caso já esteja cancelado, retornar validação
CampoPropriedade da APITipagem da propriedade
idpedidoidpedidointeger
idpedido > pedido.codigoerpidpedido_externalidvarchar
idpedidoprodutoidpedidoprodutointeger
idpedidoproduto > pedidoproduto.codigoerpidpedido_externalidvarchar

O SFA deve receber novos campos em rotas existentes, sendo esses:

Rota: Nota fiscal Produto

GET, POST, PUT

CampoPropriedade da APITipagem da propriedade
valorcomissaovalorcomissaodecimal
percentualcomissaopercentualcomissaodecimal

Rota: Segmento

GET, POST, PUT

CampoPropriedade da APITipagem da propriedade
siglasiglavarchar
  • Sem rótulos