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:
| Atributos | Descrição | Tamanho | Tipo | Chave Primária | Requerido | Valor Default | Valores Válidos | Observação |
| codigoAgencia | Agencia | 5 | INTEGER | N | N | - | - | Atributo relacionado a tabela AGENCIA e coluna CD_AGENCIA |
| codigoBanco | Banco | 4 | INTEGER | N | N | - | - | Atributo relacionado a tabela BANCO e coluna CD_BANCO |
| codigoCompo | Código Do Componente De Custos Para Mão-De-Obra | 12 | INTEGER | N | N | - | - | - |
| codigoCompoComis | Código Do Componente De Custos Para Comissão Da Mdo-Rural | 12 | INTEGER | N | N | - | - | Atributo relacionado a tabela COMPONEN e coluna CD_COMPO |
| codigoCompoServ | Código Do Componente De Custos Para Serviços | 12 | INTEGER | N | N | - | - | Atributo relacionado a tabela COMPONEN e coluna CD_COMPO |
| codigoContab | Conta Contábil | 15 | STRING | N | N | - | - | - |
| codigoContabAux | Conta Contábil Auxiliar | 15 | STRING | N | N | - | - | - |
| codigoContabCc | Centro De Custo | 20 | STRING | N | N | - | - | - |
| codigoContabHpr | Histórico Padrão | 5 | STRING | N | N | - | - | - |
| codigoEmpresa | Código Da Empresa Responsável Pelo Prestador (Pagto Serviços) | 5 | STRING | N | N | - | - | Atributo relacionado a tabela EMPRESAS e coluna CD_EMPRESA |
| codigoEmpresaErp | Codigo Da Empresa Erp | 15 | STRING | N | N | - | - | - |
| codigoEscritorio | Escritório Contábil | 4 | INTEGER | N | N | - | - | Atributo relacionado a tabela SV_ESCONTABIL e coluna CD_ESCRITORIO |
| codigoMunic | Código Do Município | 4 | INTEGER | N | S | - | - | Atributo relacionado a tabela MUNICIPIOS e coluna CD_MUNIC |
| codigoPessoa | Código Da Pessoa | 5 | INTEGER | N | N | - | - | - |
| codigoSindica | Código Do Sindicato | 3 | INTEGER | N | N | - | - | - |
| codigoTpServico | Código Do Tipo De Serviço | 3 | INTEGER | N | N | - | - | - |
| codigoTransp | Código Do Prestador De Serviços | 8 | INTEGER | S | N | - | - | Caso não informe o valor, a API criará um código automático, prevendo lacunas ou sequencial. |
| codigoTranspErp | Codigo Erp | 15 | STRING | N | N | - | - | - |
| dataInclusao | Data De Inclusão | 10 | DATETIME | N | N | - | - | - |
| dataValidade | Data De Validade Até | 10 | DATETIME | N | N | - | - | - |
| deBairro | Bairro | 20 | STRING | N | N | - | - | - |
| deEmail | Endereço De E-Mail | 50 | STRING | N | N | - | - | - |
| deEndereco | Endereço | 40 | STRING | N | N | - | - | - |
| deObsIntegracao | Observação (Utilizada Qdo Dado É Inserida/Atualizado Por Sistema Externo) | 250 | STRING | N | N | - | - | - |
| descComb | Identifica Se Desconta Combustivel No Preço De Serviços ( Tab 02 ) | 1 | STRING | N | N | - | S,N | - |
| descIss | Desconta Iss (S/N) | 1 | STRING | N | N | - | S,N | - |
| deTransp | Descrição Do Prestador De Serviço | 40 | STRING | N | S | - | - | - |
| imprCpc | Flag De Impressão De Cpc | 1 | STRING | N | N | - | - | - |
| imprExtrato | Flag De Impressão De Extrato | 1 | STRING | N | N | - | - | - |
| intStatus | Flag De Status Entre Pimcs X Erp | 1 | STRING | N | N | - | - | - |
| numeroCcorrente | Conta Corrente | 15 | STRING | N | N | - | - | - |
| numeroCep | Cep | 10 | STRING | N | N | - | - | - |
| numeroCgcCpf | Inscrição De Cpf Ou Cgc | 18 | STRING | N | N | - | - | - |
| numeroFax | Número Do Fax | 15 | STRING | N | N | - | - | - |
| numeroIdentidade | Documento De Identidade (Qdo Fg_Tp_Pess=F) | 25 | STRING | N | N | - | - | - |
| numeroInscrEst | Inscrição Estadual | 16 | STRING | N | N | - | - | - |
| numeroInscrInss | Incrição No Inss | 16 | STRING | N | N | - | - | - |
| numeroInscrMun | Inscrição Municipal | 16 | STRING | N | N | - | - | - |
| numeroTelefone | Número Do Telefone | 15 | STRING | N | N | - | - | - |
| opSimp | Optante Pelo Simples (S/N) | 1 | STRING | N | N | - | S,N | - |
| pcImpServ | Percentual Impostos Sobre Serviços | 6 | NUMBER | N | N | - | - | - |
| peIcms | Percentual Icms | 5 | NUMBER | N | N | - | - | - |
| peRetForn | Percentual Retenção Cana Fornecedor | 5 | NUMBER | N | N | - | - | - |
| peRetProp | Percentual Retenção Cana Própria | 5 | NUMBER | N | N | - | - | - |
| pgtDiaria | Pagto Diária De Transporte (S/N) | 1 | STRING | N | N | - | S,N | - |
| pgtInteg | Pagamento Integral (S/N) | 1 | STRING | N | N | - | S,N | - |
| pgTransf | Flag Para Indicar Se O Pagamento Deve Ser Por Transferência Bancária | 1 | STRING | N | N | - | - | - |
| prestCtrc | Flag De Participação Do Prestador De Serviços No Ctrc | 1 | STRING | N | N | N | - | - |
| qtDepIr | Quantidad De Dependentes Para Ir | 2 | INTEGER | N | N | - | - | - |
| retForn | Retenção De Cana Fornecedor (S/N) | 1 | STRING | N | N | - | S,N | - |
| retProp | Retenção De Cana Própria (S/N) | 1 | STRING | N | N | - | S,N | - |
| tpPess | Flag De Tipo De Pessoa (Física, Jurídica) | 1 | STRING | N | S | - | - | - |
| tpTransp | Tipo Transportador [Tab1] | 1 | STRING | N | N | - | - | - |
| usrInclusao | Usuário De Inclusão | 10 | STRING | N | N | - | - | - |
| vlPensao | Valor Pensão Alimentícia | 9 | NUMBER | N | N | - | - | - |
Método GET:
http:127.0.0.1:8080/api/entity/v1/transporta?page=1&pagesize=1
Request
{
"hasNext": true,
"items": [ {
"codigoTransp": 99998,
"codigoEscritorio": null,
"codigoMunic": 11,
"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": "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 POST:
http:127.0.0.1:8080/api/entity/v1/transporta
Response
{
"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": "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
}
Método PUT:
http:127.0.0.1:8080/api/entity/v1/transporta
Request
{
"codigoTransp": 99998,
"codigoEscritorio": null,
"codigoMunic": 12,
"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": "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
}
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.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas