TOTVS AGRO

Páginas filhas
  • API de Cadastro de Prestador de Serviços

Versões comparadas

Versão antiga 4

changes.mady.by.user Thaina de Fatima Massutti

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Carlos Eugenio dos Santos Junior

Gravado em

Chave

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

Contexto Geral

A API de Cadastro de Prestador de Serviços é responsável por gerenciar as informações dos profissionais e empresas contratados para prestar serviços à organização, permitindo operações como: consulta, inclusão, atualização e exclusão de dados cadastrais.


Estrutura:

AtributosDescriçãoTamanhoTipoChave PrimáriaRequeridoValor DefaultValores VálidosObservação
ativoFlag Para Indicar Ativação Do Fornecs1
codigoAgenciaAgencia5INTEGER
STRING
NN--
-codigoFornecCódigo Do Fornecedor
Atributo relacionado a tabela AGENCIA e coluna CD_AGENCIA
codigoBancoBanco4
8
INTEGER
S
N
S
N--
-
Atributo relacionado a tabela BANCO e coluna CD_BANCO
codigoCompoCódigo Do Componente De Custos Para Mão-De-Obra12
codigoFornecGrdCodigo Fornecedor Contabilizacao8
INTEGERNN---
codigoGrpForn
codigoCompoComisCódigo Do
Grupo De Fornecedor
Componente De Custos Para Comissão Da Mdo-Rural12
3
INTEGERNN--Atributo relacionado a tabela
GRPFORNECS
COMPONEN e coluna CD_
GRP_FORN
COMPO
codigoIntErp
codigoCompoServCódigo Do
Fornecedor Erp20STRINGNN---codigoMunicCódigo Do Município4
Componente De Custos Para Serviços12INTEGERNN--Atributo relacionado a tabela
MUNICIPIOS
COMPONEN e coluna CD_
MUNIC
COMPO
codigoPessoaCódigo Da Pessoa5
codigoContabConta Contábil15STRING
INTEGER
NN---
codigoTranspCódigo Do Prestador De Serviços8
codigoContabAuxConta Contábil Auxiliar15STRING
INTEGER
NN--
Atributo relacionado a tabela TRANSPORTA e coluna CD_TRANSP
-
codigoContabCcCentro De Custo20STRING
dataInclusaoData De Inclusão10DATETIME
NN---
deBairro
codigoContabHpr
Bairro
Histórico Padrão
20
5STRINGNN---
deEnderecoEndereço70
codigoEmpresaCódigo Da Empresa Responsável Pelo Prestador (Pagto Serviços)5STRINGNN--
-deFornecDescrição Do Fornecedor70STRINGN
Atributo relacionado a tabela EMPRESAS e coluna CD_EMPRESA
codigoEmpresaErpCodigo Da Empresa Erp15STRINGNN---
codigoEscritorioEscritório Contábil4INTEGERNN--Atributo relacionado a tabela SV_ESCONTABIL e coluna CD_ESCRITORIO
codigoMunicCódigo Do Município4INTEGERNS--Atributo relacionado a tabela MUNICIPIOS e coluna CD_MUNIC
codigoPessoaCódigo Da Pessoa5INTEGERNN---
codigoSindicaCódigo Do Sindicato3INTEGERNN---
codigoTpServicoCódigo Do Tipo De Serviço3INTEGERNN---
codigoTranspCódigo Do Prestador De Serviços8INTEGERSN--Caso não informe o valor, a API criará um código automático, prevendo lacunas ou sequencial.
codigoTranspErpCodigo Erp15STRINGNN---
dataInclusaoData De Inclusão10DATETIMENN---
dataValidadeData De Validade Até10DATETIMENN---
deBairroBairro20STRINGNN---
deEmailEndereço De E-Mail50STRINGNN---
deEnderecoEndereço40STRINGNN---
deObsIntegracaoObservação (Utilizada Qdo Dado É Inserida/Atualizado Por Sistema Externo)250STRINGNN---
descCombIdentifica Se Desconta Combustivel No Preço De Serviços ( Tab 02 )1STRINGNN-S,N-
descIssDesconta Iss (S/N)1STRINGNN-S,N-
deTranspDescrição Do Prestador De Serviço40STRINGNS---
imprCpcFlag De Impressão De Cpc1STRINGNN---
imprExtratoFlag De Impressão De Extrato1STRINGNN---
intStatusFlag De Status Entre Pimcs X Erp1STRINGNN---
numeroCcorrenteConta Corrente15STRINGNN---
numeroCepCep10STRINGNN---
numeroCgcCpfInscrição De Cpf Ou Cgc18STRINGNN---
numeroFaxNúmero Do Fax15STRINGNN---
numeroIdentidadeDocumento De Identidade (Qdo Fg_Tp_Pess=F)25STRINGNN---
numeroInscrEstInscrição Estadual16STRINGNN---
numeroInscrInssIncrição No Inss16STRINGNN---
numeroInscrMunInscrição Municipal16STRINGNN---
numeroTelefoneNúmero Do Telefone15STRINGNN---
opSimpOptante Pelo Simples (S/N)1STRINGNN-S,N-
pcImpServPercentual Impostos Sobre Serviços6NUMBERNN---
peIcmsPercentual Icms5NUMBERNN---
peRetFornPercentual Retenção Cana Fornecedor5NUMBERNN---
peRetPropPercentual Retenção Cana Própria5NUMBERNN
S
---
deObsIntegracaoObservação (Utilizada Qdo Dado É Inserida/Atualizado Por Sistema Externo)
pgtDiariaPagto Diária De Transporte (S/N)1
250
STRINGNN-
-
S,N-
fornecPropInt
pgtIntegPagamento Integral
Flag - Fornecedor Próprio
(S
=Sim -
/N
=Não
)1STRINGNN-S,N-
numeroCepCódigo Postal
pgTransfFlag Para Indicar Se O Pagamento Deve Ser Por Transferência Bancária1
10
STRINGNN---
numeroCgcCpf
prestCtrc
Número Do Cnpj Ou Cpf
Flag De Participação Do Prestador De Serviços No Ctrc1
18
STRINGNN
-
N--
numeroInscrEstNúmero Da Inscrição Estadual18
qtDepIrQuantidad De Dependentes Para Ir2INTEGER
STRING
NN---
numeroTelefoneTelefone
retFornRetenção De Cana Fornecedor (S/N)1
20
STRINGNN-
-
S,N-
qtDepIr
retProp
Qtde De Dependentes Para Imposto De Renda3
Retenção De Cana Própria (S/N)1STRING
INTEGER
NN-
-
S,N-
tpFornec
tpPessFlag De Tipo De
Fornecedor (1-Acionista; 2-Fornecedor; 3-Eventual; 4-Próprio;5-Parceiro
Pessoa (Física, Jurídica)1STRINGNS-
1,2,3,4,5
--
tpPess
tpTransp
Flag - Tipo De Pessoa (F=Fisica - J=Juridica)
Tipo Transportador [Tab1]1STRINGNN-
F,J
--
usrInclusaoUsuário
Que Incluiu
De Inclusão10STRINGNN---
vlPensaoValor
De Desconto De Pensao
Pensão Alimentícia9
10
NUMBERNN---


Método POSTGET:

http:127.0.0.1:8080/api/entity/v1/transporta1:8080/api/entity/v1/transporta?page=1&pagesize=1

Bloco de código
languagejava
titleRequest
{
    "hasNext": true,
    "items": [
Bloco de código
languagejava
titleRequest
 {
            "codigoTransp": 99998,
            "codigoEscritorio": null,
            "codigoMunic": 5011,
            "codigoAgencia": null,
            "codigoBanco": null,
            "codigoCompo": null,
            "codigoCompoComis": null,
            "codigoCompoServ": null,
            "codigoContab": null,
            "codigoContabAux": null,
            "codigoContabCc": null,
            "codigoContabHpr": null,
            "codigoEmpresa": null,
            "codigoEmpresaErp": "''",
            "codigoPessoa": null,
            "codigoSindica": null,
            "codigoTpServico": null,
            "codigoTranspErp": "200123",
            "deBairro": null,
            "deEmail": null,
            "deEndereco": "AV:MAURILIO BIAGI,2322ENDEREÇO EXEMPLO",
            "deObsIntegracao": null,
            "deTransp": "TESTE",
            "dataInclusao": "2016-03-02T09:56:19",
            "dataValidade": null,
            "descComb": null,
            "descIss": null,
            "imprCpc": null,
            "imprExtrato": null,
            "intStatus": null,
            "opSimp": null,
            "pgtDiaria": null,
            "pgtInteg": null,
            "pgTransf": null,
            "prestCtrc": "S",
            "retForn": null,
            "retProp": null,
            "tpPess": "F",
            "tpTransp": "1",
            "numeroCcorrente": null,
            "numeroCep": "1402100012345678",
            "numeroCgcCpf": "5512.955456.793789/00010000-9410",
            "numeroFax": null,
            "numeroIdentidade": null,
            "numeroInscrEst": "582006030113123456789101112",
            "numeroInscrInss": null,
            "numeroInscrMun": null,
            "numeroTelefone": "1612 3993930012345678",
            "pcImpServ": null,
            "peIcms": null,
            "peRetForn": null,
            "peRetProp": null,
            "qtDepIr": null,
            "rowversion": 1,
            "usrInclusao": "ERP",
            "vlPensao": null
 }
        }
    ]
}

Parâmetros

  • page: Número da página.
  • pagesize: Quantidade de registros por página.


Método POSTMétodo GET:

http:127.0.0.1:8080/api/entity/v1/transporta?page=1&pagesize=1

Bloco de código
languagejava
titleResponse
{
    "hasNext": true,
    "items": [
        {
            "codigoTransp": 1,
            "codigoEscritorio": null,
            "codigoMunic": 50,
            "codigoAgencia": null,
            "codigoBanco": null,
            "codigoCompo": null,
            "codigoCompoComis": null,
            "codigoCompoServ": null,
            "codigoContab": null,
            "codigoContabAux": null,
            "codigoContabCc": null,
            "codigoContabHpr": null,
            "codigoEmpresa": null,
            "codigoEmpresaErp": "''",
            "codigoPessoa": null,
            "codigoSindica": null,
            "codigoTpServico": null,
            "codigoTranspErp": "200",
            "deBairro": null,
            "deEmail": null,
            "deEndereco": "AV:MAURILIO BIAGI,2322ENDEREÇO EXEMPLO",
            "deObsIntegracao": null,
            "deTransp": "TESTE",
            "dataInclusao": "2016-03-02T09:56:19",
            "dataValidade": null,
            "descComb": null,
            "descIss": null,
            "imprCpc": null,
            "imprExtrato": null,
            "intStatus": null,
            "opSimp": null,
            "pgtDiaria": null,
            "pgtInteg": null,
            "pgTransf": null,
            "prestCtrc": "S",
            "retForn": null,
            "retProp": null,
            "tpPess": "F",
            "tpTransp": "1",
            "numeroCcorrente": null,
            "numeroCep": "1402100012345678",
            "numeroCgcCpf": "5512.955456.793789/00010000-9410",
            "numeroFax": null,
            "numeroIdentidade": null,
            "numeroInscrEst": "582006030113123456789101112",
            "numeroInscrInss": null,
            "numeroInscrMun": null,
            "numeroTelefone": "1612 3993930012345678",
            "pcImpServ": null,
            "peIcms": null,
            "peRetForn": null,
            "peRetProp": null,
            "qtDepIr": null,
            "rowversion": 1,
            "usrInclusao": "ERP",
            "vlPensao": null
        }
    ]
}

Parâmetros

...


Método PUT:
http:127.0.0.1:8080/api/entity/v1/fornecstransporta
 Bloco de código
languagejava
titleRequest
{
            "codigoTransp": 99998,
            "codigoEscritorio": null,
            "codigoMunic": 4912,
            "codigoAgencia": null,
            "codigoBanco": null,
            "codigoCompo": null,
            "codigoCompoComis": null,
            "codigoCompoServ": null,
            "codigoContab": null,
            "codigoContabAux": null,
            "codigoContabCc": null,
            "codigoContabHpr": null,
            "codigoEmpresa": null,
            "codigoEmpresaErp": "''",
            "codigoPessoa": null,
            "codigoSindica": null,
            "codigoTpServico": null,
            "codigoTranspErp": "200",
            "deBairro": null,
            "deEmail": null,
            "deEndereco": "AV:MAURILIO BIAGI,2322ENDEREÇO EXEMPLO",
            "deObsIntegracao": null,
            "deTransp": "TESTE",
            "dataInclusao": "2016-03-02T09:56:19",
            "dataValidade": null,
            "descComb": null,
            "descIss": null,
            "imprCpc": null,
            "imprExtrato": null,
            "intStatus": null,
            "opSimp": null,
            "pgtDiaria": null,
            "pgtInteg": null,
            "pgTransf": null,
            "prestCtrc": "S",
            "retForn": null,
            "retProp": null,
            "tpPess": "F",
            "tpTransp": "1",
            "numeroCcorrente": null,
            "numeroCep": "1402100012345678",
            "numeroCgcCpf": "5512.955456.793789/00010000-9410",
            "numeroFax": null,
            "numeroIdentidade": null,
            "numeroInscrEst": "582006030113123456789101112",
            "numeroInscrInss": null,
            "numeroInscrMun": null,
            "numeroTelefone": "1612 3993930012345678",
            "pcImpServ": null,
            "peIcms": null,
            "peRetForn": null,
            "peRetProp": null,
            "qtDepIr": null,
            "rowversion": 1,
            "usrInclusao": "ERP",
            "vlPensao": null
 }
...