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
Novas rotas
- O SFA deverá receber novas rotas em suas APIs padrão, sendo elas:
Nome rota: Cota Tabela: cota 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 > unidademedida.codigoerp | idunidademedida_externalid | varchar | |
| codigoerp | externalid | varchar | |
| datacadastro | datacadastro | data | |
| horacadastro | horacadastro | varchar | |
| numerocota | numerocota | varchar | |
| observacaocota | observacaocota | varchar | |
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 | |||
|---|---|---|---|
| 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 > cota.codigoerp | idcota_externalid | varchar | |
| idusuario | idusuario | integer | |
| idusuario > usuario.codigoerp | idusuario_externalid | varchar | |
| idproduto | idproduto | integer | |
| idproduto > produto.codigoerp | idproduto_externalid | varchar | |
| idgrupoproduto | idgrupoproduto | integer | |
| idgrupoproduto > grupoproduto.codigoerp | idgrupoproduto_externalid | varchar | |
| idlocal | idlocal | integer | |
| idlocal > local.codigoerp | idlocal_externalid | varchar | |
| idlocalfilial | idlocalfilial | integer | |
| idlocalfilial > local.codigoerp | idlocalfilial_externalid | varchar | |
| idsegmento | idsegmento | integer | |
| idsegmento > segmento.codigoerp | idsegmento_externalid | varchar | |
| idtabelapreco | idtabelapreco | integer | |
| idtabelapreco > tabelapreco.codigoerp | idtabelapreco_externalid | varchar | |
| idparceiro | idparceiro | integer | |
| idparceiro > parceiro.codigoerp | idparceiro_externalid | varchar | |
| idusuariosuperior | idusuariosuperior | integer | |
| idusuariosuperior > usuario.codigoerp | idusuariosuperior_externalid | varchar | |
| codigoerp | externalid | varchar | |
Rota: Pedido Campo Opção Fixa Tabela: wsconfigcampoopcaofixo 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 > wsconfigcampo.codigoerp | idwsconfigcampo_externalid | varchar | |
| valor | valor | varchar | |
| descricao | descricao | varchar | |
| codigoerp | externalid | varchar | |
Novos campos em rotas existentes
Rota: ClienteSub 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 > campo.codigoerp | idcampo_externalid | varchar | |
| idcampoopcaofixo | idcampoopcaofixo | integer | |
| idcampoopcaofixo > campoopcaofixo.codigoerp | idcampoopcaofixo_externalid | varchar | |
| resposta | resposta | varchar | |
| codigoerp | externalid | varchar | |
Rota: PedidoSub GET, POST, PUT Nova propriedade Sub "PedidoCabecalhoCampo" | |||
|---|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade | Observações |
| idpedidocabecalhocampo | internalid | integer | Não presente na rota POST |
| idwsconfigcampo | idwsconfigcampo | integer | |
| idwsconfigcampo > wsconfigcampo.codigoerp | idwsconfigcampo_externalid | varchar | |
| valor | valor | varchar | |
| idnobrigatorio | Valor fixo 0 | ||
| ordem | ordem | integer | |
| codigoerp | externalid | varchar | |
Rota: PedidoSub GET, POST, PUT Nova propriedade Sub "PedidoProdutoCampo" | |||
|---|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade | Observações |
| idpedidocabecalhocampo | internalid | integer | Não presente na rota POST |
| idwsconfigcampo | idwsconfigcampo | integer | |
| idwsconfigcampo > wsconfigcampo.codigoerp | idwsconfigcampo_externalid | varchar | |
| valor | valor | varchar | |
| codigoerp | externalid | varchar | |
Rota: PedidoSub GET, POST, PUT Nova propriedade Sub "PedidoEntregaCampo" | |||
|---|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade | Observações |
| idpedidocabecalhocampo | internalid | integer | Não presente na rota POST |
| idwsconfigcampo | idwsconfigcampo | integer | |
| idwsconfigcampo > wsconfigcampo.codigoerp | idwsconfigcampo_externalid | varchar | |
| valor | valor | varchar | |
| idnobrigatorio | Valor fixo 0 | ||
| ordem | ordem | integer | |
| codigoerp | externalid | varchar | |
Rota: PedidoSub GET, POST, PUT Nova propriedade Sub "PedidoResumoCampo" | |||
|---|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade | Observações |
| idpedidocabecalhocampo | internalid | integer | Não presente na rota POST |
| idwsconfigcampo | idwsconfigcampo | integer | |
| idwsconfigcampo > wsconfigcampo.codigoerp | idwsconfigcampo_externalid | varchar | |
| valor | valor | varchar | |
| idnobrigatorio | Valor fixo 0 | ||
| ordem | ordem | integer | |
| codigoerp | externalid | varchar | |
Rota: PedidoSub GET, POST, PUT Nova propriedade Sub "PedidoComplementoCampo" | |||
|---|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade | Observações |
| idpedidocabecalhocampo | internalid | integer | Não presente na rota POST |
| idwsconfigcampo | idwsconfigcampo | integer | |
| idwsconfigcampo > wsconfigcampo.codigoerp | idwsconfigcampo_externalid | varchar | |
| valor | valor | varchar | |
| idnobrigatorio | Valor fixo 0 | ||
| ordem | ordem | integer | |
| codigoerp | externalid | varchar | |
Rota: Nota fiscal Produto GET, POST, PUT | ||
|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade |
| valorcomissao | valorcomissao | decimal |
| percentualcomissao | percentualcomissao | decimal |
Rota: Segmento GET, POST, PUT | ||
|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade |
| sigla | sigla | varchar |
Rota: Pedido, PedidoSub GET, POST, PUT | ||
|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade |
| datafaturamento | datafaturamento | date |
Rota: Tabela Preço Produto GET, POST, PUT | ||
|---|---|---|
| Campo | Propriedade da API | Tipagem da propriedade |
| precocusto | precocusto | decimal |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas