Histórico da Página
...
Atributos | Descrição | Tamanho | Tipo | Chave Primária | Requerido | Valor Default | Valores Válidos | Observação |
id | Id único para rastreamento do registro de ponta a ponta | 12 | NUMBER | S | N | - | - | Gerado automaticamente quando o registro é inserido na tabela. |
codigoErp | Código de relacionamento com o ERP | 15 | STRING | N | N | - | - | - |
razaoSocial | Razão social | 40 | STRING | N | S | - | - | - |
nomeFantasia | Nome fantasia | 40 | STRING | N | S | - | - | - |
endereco | Endereço e número | 40 | STRING | N | N | - | - | - |
bairro | Bairro | 40 | STRING | N | N | - | - | - |
cidade | Cidade | 40 | STRING | N | N | - | - | - |
uf | Sigla da unidade federativa | 2 | STRING | N | N | - | Unidades Federativas do Brasil ou "EX" para Exterior. | - |
codigoCep | Código do CEP | 9 | STRING | N | N | - | - | - |
numeroCaixaPostal | Número da caixa postal | 9 | STRING | N | N | - | - | - |
cnpj | CNPJ | 18 | STRING | N | N | - | - | CNPJ será validado caso informado. |
inscricaoEstadual | Inscrição estadual | 18 | STRING | N | N | - | - | - |
numeroDDD | Número do DDD | 4 | STRING | N | N | - | - | - |
numeroTelefone | Número do telefone | 9 | STRING | N | N | - | - | - |
numeroFax | Número do fax | 9 | STRING | N | N | - | - | - |
siteEmail | Site ou e-mail | 40 | STRING | N | N | - | - | - |
classeFornecedor | Classe do fornecedor | 1 | STRING | N | N | "A" | "A" = Ambos "P" = Produto "S" = Serviço | - |
...
GET (Consulta Fornecedor)
http:127.0.0.1:8080/api/entity/v1/fornecedoresInd?page=1&pagesize=2
...
PUT/PATCH (Modifica Fornecedor)
http:127.0.0.1:8080/api/entity/v1/fornecedoresInd
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": 1,
"codigoErp": "FORNEC23",
"cnpj": "38646495000101",
"inscricaoEstadual": "189289389489",
"codigoCep": "19800000",
"razaoSocial": "ID FORNECEDOR",
"nomeFantasia": "TESTE DE FORNCEDOR",
"endereco": null,
"bairro": null,
"cidade": null,
"uf": "SP",
"numeroCaixaPostal": null,
"numeroDDD": null,
"numeroTelefone": null,
"numeroFax": "18- 3302-",
"siteEmail": null,
"classeFornecedor": "A"
} |
Observações
- Quando PATCH poderão ser enviados apenas os atributos que necessitam de atualização e os Deverá ser informado ao menos um dos atributos para localização do Fornecedor (id ou codigoErp).
- No caso de PUT deverão ser enviados os atributos necessários/obrigatórios e os atributos para localização do Fornecedor (id ou codigoErp).
- Caso o atributo codigoEmpresa não esteja informado, será utilizado o valor definido no parâmetro default-company-ind.
- O conteúdo do atributo codigoCCusto será sempre desconsiderado caso informado e será atribuído o valor do atributo codigo.
- O centro de custo será localizado seguindo a seguinte regra:
- Caso o atributo id esteja informado, o centro de custo será localizado pelo atributo id e os atributos codigoEmpresa e codigo serão ignorados mesmo sendo informados.
- Caso o atributo id não esteja informado, o centro de custo será localizado pelos atributos codigoEmpresa e codigo.
- Os atributos codigoEmpresa, codigoCCusto e codigo não serão alterados mesmo sendo informados.
- Caso os dois atributos id e codigoErp forem informados, será considerado apenas o atributo id para localização do fornecedor. Será realizada uma busca por outros fornecedores que utilizem o codigoErp informado e caso nenhum fornecedor seja encontrado, o valor informado será atualizado para o fornecedor do id informado, e caso seja encontrado um ou mais fornecedores já utilizando este codigoErp uma mensagem será exibida e a atualização não poderá ser feita.
- Quando PATCH poderão ser informados apenas os atributos que necessitam de atualização.
- No caso de PUT deverão ser informados os atributos necessários bem como os obrigatórios.
- Caso o atributo cnpj seja informado, o conteúdo será validado aceitando apenas um cnpj válido.
- Caso os atributos cnpj, inscricaoEstadual e codigoCep forem informados, será removido caracteres especiais, mantendo-se apenas números e letrasCaso o atributo descricao esteja informado e o atributo descricaoResumida não esteja informado, será atribuído o valor do atributo descricao ao atributo descricaoResumida limitado a 10 caracteres.
POST (Insere Fornecedor)
http:127.0.0.1:8080/api/entity/v1/fornecedoresInd
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"codigocodigoErp": "api123FORNEC25",
"codigoCCustorazaoSocial": "XXXRazão social do fornecedor",
"descricaonomeFantasia": "Teste ta-API-HubNome fantasia do fornecedor"
} |
Estrutura de dados retorno:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"codigocodigoErp": "API123FORNEC25",
"codigoCCustorazaoSocial": "API123",
Razão social "descricao": "TESTE TA-API-HUB"do fornecedor",
"ativonomeFantasia": "1",
Nome fantasia do "codigoEmpresa": "1"fornecedor",
"idclasseFornecedor": "348A",
"descricaoResumidaid": "TESTE TA-A23"
} |
Observações
- O atributo id será gerado automaticamente e atribuído ao novo fornecedor, e caso seja informado será desconsiderado.
- Caso o atributo codigoEmpresa não esteja informado, será utilizado o valor definido no parâmetro default-company-ind.
- Os atributos codigo e descricao deverão ser informados.
- O conteúdo do atributo codigoCCusto será sempre desconsiderado caso informado e será atribuído o valor do atributo codigo.
- O conteúdo do atributo id será sempre desconsiderado caso informado e gerado um novo.
- Caso o atributo descricaoResumida não esteja informado, será atribuído o valor do atributo descricao ao atributo descricaoResumida limitado a 10 caracteres.
- atributo codigoErp for informado, será realizada uma busca por outros fornecedores que utilizem esse código e caso seja encontrado um ou mais fornecedores já utilizando este codigoErp uma mensagem será exibida e a inclusão não poderá ser feita.
- Deverão ser informados os atributos requeridos razaoSocial e nomeFantasia.
- Caso o atributo cnpj seja informado, o conteúdo será validado aceitando apenas um cnpj válido.
- Caso os atributos cnpj, inscricaoEstadual e codigoCep forem informados, será removido caracteres especiais, mantendo-se apenas números e letrasCaso já exista um centro de custo para a chave codigoEmpresa+codigo informada não será permitida a inclusão e um aviso será mostrado.
DELETE (Exclui Fornecedor)
...
Método DELETE:
http:127.0.0.1:8080/api/entity/v1/fornecedoresInd
Parâmetros
- Deverá ser informado ao menos um dos atributos para localização do Fornecedor (id ou codigoErp).
- Caso seja informado apenas o atributo codigoErp, será realizada uma busca por fornecedores que utilizem esse código e caso seja encontrado dois ou mais fornecedores utilizando este codigoErp uma mensagem será exibida e a deleção não poderá ser feita.
- Caso os dois atributos id e codigoErp forem informados, será considerado apenas o atributo id para localização e exclusão do fornecedor e o codigoErp será desconsiderado.
- Caso o registro do fornecedor esteja sendo utilizado por registros de outras tabelas relacionadas a exclusão não será permitida e uma mensagem será exibida
- Caso o atributo codigoEmpresa não esteja informado, será utilizado o valor definido no parâmetro default-company-ind.
- Deverão ser informados os atributos que compõe a chave primária (id ou codigoEmpresa+codigo).
- O conteúdo do atributo codigoCCusto será sempre desconsiderado caso informado e será atribuído o valor do atributo codigo.
- O centro de custo será localizado seguindo a seguinte regra:
- Caso o atributo id esteja informado, o centro de custo será localizado pelo atributo id e os atributos codigoEmpresa e codigo serão ignorados mesmo sendo informados. Caso o atributo id não esteja informado, o centro de custo será localizado pelos atributos codigoEmpresa e codigo.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas