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

Versões comparadas

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
codigoAgenciaAgencia5INTEGERNN--Atributo relacionado a tabela AGENCIA e coluna CD_AGENCIA
codigoBancoBanco4INTEGERNN--Atributo relacionado a tabela BANCO e coluna CD_BANCO
codigoCompoCódigo Do Componente De Custos Para Mão-De-Obra12INTEGERNN---
codigoCompoComisCódigo Do Componente De Custos Para Comissão Da Mdo-Rural12INTEGERNN--Atributo relacionado a tabela COMPONEN e coluna CD_COMPO
codigoCompoServCódigo Do Componente De Custos Para Serviços12INTEGERNN--Atributo relacionado a tabela COMPONEN e coluna CD_COMPO
codigoContabConta Contábil15STRINGNN---
codigoContabAuxConta Contábil Auxiliar15STRINGNN---
codigoContabCcCentro De Custo20STRINGNN---
codigoContabHprHistórico Padrão5STRINGNN---
codigoEmpresaCódigo Da Empresa Responsável Pelo Prestador (Pagto Serviços)5STRINGNN--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---
pgtDiariaPagto Diária De Transporte (S/N)1STRINGNN-S,N-
pgtIntegPagamento Integral (S/N)1STRINGNN-S,N-
pgTransfFlag Para Indicar Se O Pagamento Deve Ser Por Transferência Bancária1STRINGNN---
prestCtrcFlag De Participação Do Prestador De Serviços No Ctrc1STRINGNNN--
qtDepIrQuantidad De Dependentes Para Ir2INTEGERNN---
retFornRetenção De Cana Fornecedor (S/N)1STRINGNN-S,N-
retPropRetenção De Cana Própria (S/N)1STRINGNN-S,N-
tpPessFlag De Tipo De Pessoa (Física, Jurídica)1STRINGNS---
tpTranspTipo Transportador [Tab1]1STRINGNN---
usrInclusaoUsuário De Inclusão10STRINGNN---
vlPensaoValor Pensão Alimentícia9NUMBERNN---


Método GET:

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

Bloco de código
languagejava
titleRequest
{
    "hasNext": true,
    "items": [ {

Disponibilizado endpoint para cadastro de Prestadores de Serviço.

.

Método POST:

http:127.0.0.1:8080/entity/v1/fornecs

Estrutura de dados:

Bloco de código
languagejava
titleFornecedor
 {
            "codigoTransp": 99998,
            "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,2322",
            "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",
            "numeroCcorrentecodigoTransp": null99998,
            "numeroCepcodigoEscritorio": "14021000"null,
            "numeroCgcCpfcodigoMunic": "55.955.793/0001-94"11,
            "numeroFaxcodigoAgencia": null,
            "numeroIdentidadecodigoBanco": null,
            "numeroInscrEstcodigoCompo": "582006030113"null,
            "numeroInscrInsscodigoCompoComis": null,
            "numeroInscrMuncodigoCompoServ": null,
            "numeroTelefonecodigoContab": "16 39939300"null,
            "pcImpServcodigoContabAux": null,
            "peIcmscodigoContabCc": null,
            "peRetForncodigoContabHpr": null,
            "peRetPropcodigoEmpresa": null,
            "qtDepIrcodigoEmpresaErp": null"''",
            "rowversioncodigoPessoa": 1null,
            "usrInclusaocodigoSindica": "ERP"null,
            "vlPensao": null
 }

Ordem de Pesagem

  • codigoTransp: Código do Prestador de Serviços.
  • codigoEscritorio: Escritório contábil.
  • codigoMunic: Código do Município.
  • codigoAgencia: Agencia..
  • codigoBanco: Banco..
  • codigoCompo: Código do Componente de Custos para Mão-de-Obra.
  • codigoCompoComis: Código do Componente de Custos para Comissão da MDO-Rural.
  • codigoCompoServ: Código do Componente de Custos para Serviços.
  • codigoContab: Conta Contábil.
  • codigoContabAux: Conta Contábil Auxiliar.
  • codigoContabCc: Centro de Custo.
  • codigoContabHpr: Histórico Padrão.
  • codigoEmpresa: Codigo da Empresa ERP.
  • codigoEmpresaErp: Flag - Fornecedor Próprio (S=Sim - N=Não).
  • codigoPessoa: Código da pessoa.
  • codigoSindica: Código do Sindicato.
  • codigoTpServico: Codigo ERP.
  • codigoTranspErp: Número do CNPJ ou CPF.
  • deBairro: Bairro.
  • deEmail: Endereço de e-mail.
  • deEndereco: Endereço.
  • deObsIntegracao: Observação (utilizada qdo dado é inserida/atualizado por sistema externo).
  • deTransp: Descrição do Prestador de Serviço.
  • dataInclusao: Data de Inclusão.
  • dataValidade: Data de validade até.
  • descComb: Identifica se desconta combustivel no preço de serviços ( TAB 02 ).
  • descIss: Desconta ISS (S/N).
  • imprCpc: Flag de Impressão de CPC.
  • imprExtrato: Flag de Impressão de Extrato.
  • intStatus: Flag de Status entre PIMCS x ERP.
  • opSimp: Optante pelo Simples (S/N).
  • pgtDiaria: Pagto Diária de Transporte (S/N).
  • pgtInteg: Pagamento Integral (S/N).
  • pgTransf: Flag para indicar se o pagamento deve ser por transferência bancária.
  • prestCtrc: Flag de Participação do Prestador de Serviços no CTRC.
  • retForn: Retenção de Cana Fornecedor (S/N).
  • retProp: Retenção de Cana Própria (S/N).
  • tpPess: Flag de Tipo de Pessoa (Física, Jurídica).
  • tpTransp: Tipo Transportador [TAB1].
  • numeroCcorrente: Conta Corrente.
  • numeroCep: Código Postal.
  • numeroCgcCpf: Número do CNPJ ou CPF.
  • numeroCgcCpf: Número do CNPJ ou CPF.
  • numeroFax: Número do Fax.
  • numeroIdentidade: Documento de identidade (qdo FG_TP_PESS=F).
  • numeroInscrEst: Inscrição Estadual..
  • numeroInscrInss: Incrição no INSS.
  • numeroInscrMun: Inscrição Municipal.
  • numeroTelefone: Número do Telefone.
  • pcImpServ: Percentual impostos sobre serviços.
  • peIcms: Percentual ICMS.
  • peRetForn: Percentual Retenção Cana Fornecedor.
  • peRetProp: Percentual Retenção Cana Própria.
  • qtDepIr: Quantidad de dependentes para IR.
  • rowversion: Controle interno.
  • usrInclusao: Usuário de Inclusão.
  • vlPensao: Valor de Desconto de Pensão.

   

Consulta dos Prestadores de Serviço

Disponibilizado endpoint para consulta dos Prestadores de Serviço.

"codigoTpServico": null,
            "codigoTranspErp": "123",
            "deBairro": null,
            "deEmail": null,
            "deEndereco": "ENDEREÇ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": "12345678",
            "numeroCgcCpf": "12.456.789/0000-10",
            "numeroFax": null,
            "numeroIdentidade": null,
            "numeroInscrEst": "123456789101112",
            "numeroInscrInss": null,
            "numeroInscrMun": null,
            "numeroTelefone": "12 12345678",
            "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

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

Modifica Prestadores de Serviço.

...

    }


Método PUT:

http:127.0.0.1:8080/api/entity/v1/fornecstransporta

Estrutura de dados:

Bloco de código
languagejava
titleFornecedorRequest
{
            "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
 }

Exclui Prestador de Serviço.

Disponibilizado endpoint para excluir o Fornecedor.


Método DELETE:

http:127.0.0.1:8080/api/entity/v1/transporta?codigoTransp=99998

Parâmetros

  • codigoTransp: Código do Prestador de Serviços.

...