Exibir origem

Disponibilizado endpoint para integração do cadastro de Fornecedores com os métodos GET, POST, PUT, PATCH e DELETE.

Estrutura:

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/entity/v1/fornecedoresInd?page=1&pagesize=2

{
    "hasNext": false,
    "items": [
        {
            "id": 2,
            "codigoErp": "FORNEC23",
            "razaoSocial": "ID FORNECEDOR",
            "nomeFantasia": "TESTE DE FORNCEDOR",
            "endereco": null,
            "bairro": null,
            "cidade": null,
            "uf": "SP",
            "codigoCep": "19800000",
            "numeroCaixaPostal": null,
            "cnpj": "38646495000101",
            "inscricaoEstadual": "189289389489",
            "numeroDDD": null,
            "numeroTelefone": null,
            "numeroFax": "18- 3302-",
            "siteEmail": null,
            "classeFornecedor": "A"
        }
    ]
}

Parâmetros

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

Observações

Todos os atributos podem ser usados como parâmetro para a busca.

PUT/PATCH (Modifica Fornecedor)

http:127.0.0.1:8080/entity/v1/fornecedoresInd

Estrutura de dados para envio (exemplo):

{
    "codigoErp": "FORNEC23", 
    "cnpj": "38.646.495/0001-01",
    "inscricaoEstadual": "189.289.389-489",
    "codigoCep": "19800-000",
    "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"
}

Estrutura de dados retorno:

{
    "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

Deverá ser informado ao menos um dos atributos para localização do Fornecedor (id ou codigoErp).
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/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 letras.

POST (Insere Fornecedor)

http:127.0.0.1:8080/entity/v1/fornecedoresInd

Estrutura de dados para envio:

{
    "codigoErp": "FORNEC25",
    "razaoSocial": "Razão social do fornecedor",
    "nomeFantasia": "Nome fantasia do fornecedor"
}

Estrutura de dados retorno:

{
    "codigoErp": "FORNEC25",
    "razaoSocial": "Razão social do fornecedor",
    "nomeFantasia": "Nome fantasia do fornecedor",
    "classeFornecedor": "A",
    "id": "23"
}

Observações

O atributo id será gerado automaticamente e atribuído ao novo fornecedor, e caso seja informado será desconsiderado.
Caso o 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 letras.

DELETE (Exclui Fornecedor)

Disponibilizado endpoint para excluir o Fornecedor.

Método DELETE:

http:127.0.0.1:8080/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.