API Materiais por Empresas

Disponibilizado endpoint para integração do cadastro de Materiais por Empresas 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	18	INTEGER	S	N	-	-	Gerado automaticamente no Insert, obrigatório no Update
material	Código do material	12	INTEGER	N	N	-	Material cadastrado	-
instancia	Código da instância	5	STRING	N	N	-	Instância cadastrada	-
codigoExterno	Código do parceiro usado para recuperar a instancia.	30	STRING	N	N	-	-	-
deposito	Código do depósito	10	STRING	N	N	-	-	-
saldo	Saldo do material	13,4	NUMBER	N	N	-	-	-
ultimaAtualizacao	Data da última atualização	10	DATE	N	N	-	-	-
ultimaCompra	Data da última compra	10	DATE	N	N	-	-	-
valorUnitarioMedio	Valor unitário médio	13,4	NUMBER	N	N	-	-	-
valorUnitarioReposicao	Valor unitário reposição	13,4	NUMBER	N	N	-	-	-
estocavel	Estocável	1	STRING	N	N	-	-	-
compra	Compra	1	STRING	N	N	-	-	-
conta	Conta	25	STRING	N	N	-	-	-
codigoMaterialERP	Código do material vindo do ERP	20	STRING	N	N	-	-	-

GET (Consulta Material por Empresa)

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

Response

{
    "hasNext": true,
    "items": [
        {
            "id": 1,
            "material": 207052,
            "instancia": "11",
            "deposito": "VIRTBORR01",
            "saldo": 25,
            "ultimaAtualizacao": "2023-08-03T00:00:00",
            "ultimaCompra": "2024-01-01T00:00:00",
            "valorUnitarioMedio": 10.25,
            "valorUnitarioReposicao": 11.25,
            "estocavel": "N",
            "compra": "S",
            "conta": "123.456.789"
        }
    ]
}

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.

- Caso seja informado o codigoExterno, será usado como parâmetro, para a busca, a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

POST (Cadastra Material por Empresa)

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

Estrutura de dados para envio:

Body

{
    "material": 1000,
    "instancia": "11",
    "deposito": "VIRTBORR01",
    "saldo": 50,
    "ultimaAtualizacao": "2023-08-30T00:00:00",
    "ultimaCompra": "2024-01-02T00:00:00",
    "valorUnitarioMedio": 5.5,
    "valorUnitarioReposicao": 6.5,
    "estocavel": "S",
    "compra": "N",
    "conta": "987.654.321"
}

Estrutura de dados retorno:

Response

{
    "material": 1000,
    "instancia": "11",
    "deposito": "VIRTBORR01",
    "saldo": 50,
    "ultimaAtualizacao": "2023-08-30T00:00:00",
    "ultimaCompra": "2024-01-02T00:00:00",
    "valorUnitarioMedio": 5.5,
    "valorUnitarioReposicao": 6.5,
    "estocavel": "S",
    "compra": "N",
    "conta": "987.654.321",
    "id": "26"
}

Observações

- Caso seja informado o codigoExterno, será cadastrado a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

- É obrigatório informar a instancia ou o codigoExterno.

- É obrigatório informar ou o atributo material ou o atributo codigoMaterialERP, ambos serão validados contra a tabela MATERIAIS para verificação de sua existência.

- Será realizada validação para verificar se o registro já não é existente na base, caso sim o mesmo será atualizado, caso não, o mesmo será inserido.

PUT e PATCH (Atualiza Material por Empresa)

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

Estrutura de dados para envio:

Body

{
    "id": 26,
    "material": 1000,
    "instancia": "11",
    "deposito": "VIRTBORR01",
    "saldo": 49,
    "ultimaAtualizacao": "2023-08-30T00:00:00",
    "ultimaCompra": "2024-01-02T00:00:00",
    "valorUnitarioMedio": 5.5,
    "valorUnitarioReposicao": 6.5,
    "estocavel": "S",
    "compra": "N",
    "conta": "987.654.321"
}

Estrutura de dados retorno:

Response

{
    "id": 26,
    "material": 1000,
    "instancia": "11",
    "deposito": "VIRTBORR01",
    "saldo": 49,
    "ultimaAtualizacao": "2023-08-30T00:00:00",
    "ultimaCompra": "2024-01-02T00:00:00",
    "valorUnitarioMedio": 5.5,
    "valorUnitarioReposicao": 6.5,
    "estocavel": "S",
    "compra": "N",
    "conta": "987.654.321"
}

Observações

- Caso seja informado o codigoExterno, será atualizada a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

- É obrigatório informar a instancia ou o codigoExterno.

- É obrigatório informar ou o atributo material ou o atributo codigoMaterialERP, ambos serão validados contra a tabela MATERIAIS para verificação de sua existência.

- Será realizada validação para verificar se o registro já não é existente na base, caso sim o mesmo será atualizado, caso não, o mesmo será inserido.

DELETE (Apaga Material por Empresa)

http:127.0.0.1:8080/api/entity/v1/materialEmpresa?id=26

Observações

- É obrigatório informar os atributos que compõem a chave primária como parâmetros da chamada.

Páginas filhas

API Materiais por Empresas

Parâmetros