Histórico da Página
Atributos | Descrição | Tamanho | Tipo | Chave Primária | Requerido | Valor default | Instancia | Código da instancia. | 5 | STRING | N | codigoExterno | Código do parceiro usado para recuperar a instancia. | 5Default | Valores Válidos | ||
codigo | Código do Grupo de Material | 4 | NUMBER | S | S | ||||||||||||
descricaoAbreviada | Descrição Abreviada do Grupo de Material | 10 | STRING | N | codigoEmpresa | Código da empresa. | N | ||||||||||
descricao | Descrição do Grupo de Material | 40 | 5STRING | SN | N | ||||||||||||
fgCustoOS | Flag de Custos da O.S | codigoMater | Código do material.20 | 1 | STRING | S | dataRefer | Data do consumo do material ( AAAA-MM-DD ) | 10 | DATE | S | daSituacaoErp | Descrição do retorno do ERP | N | N | S = Sim | N = Não | |
fgCustoAbastecimento | Flag de Custos de Abastecimento | 1 | 40STRING | N | N | S = Sim | N = Não | |||||||||||
fgCustoLubrificacao | Flag de Custos de Lubrificação | dataSituacaoErp | Data do retorno do ERP ( AAAA-MM-DD ) | 10 | DATE | N | situacaoErp | Flag de retorno do ERP | 1 | STRING | N | ||||||
qtMater | Quantidade de consumo. | 13 , 4 | NUMBER | N | 1 | qtValor | Valor do consumo (moeda corrente). | 13 , 4 | NUMBER | N | |||||||
qtValor1, qtValor2, qtValor3, qtValor2 | Valor do consumo (outra moeda). | 16 , 4 | NUMBER | N | 0 |
Atributos da chave primária composta
instancia, codigoEmpresa, codigoMater, dataRefer.
N | S = Sim | N = Não | ||||||
fgExportaErp | Flag Controlador de Exportação ERP | 1 | STRING | N | N | S = Exporta | N = Não exporta | |
codigoErp | Código de Relacionamento com ERP | 15 | STRING | N | N |
GET (Consulta Grupos de Materiais)GET
http:127.0.0.1:8080/entity/v1/valorMateriaisgrupoMateriais?page=1&pagesize=20
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"hasNext": false,
"items": [
{
"codigoEmpresa": "EMP90",
"codigoMater": "MATER1234",
"dataRefer": "2024-09-01",
"daSituacaoErp": "Descrição do retorno do ERP",
"dataSituacaoErp": "2024-09-01",
"situacaoErp": "S",
"qtMater": 123,
"qtValor": 123,
"qtValor1": 123456789,
"qtValor2": 123456789,
"qtValor3": 123456789,
"qtValor4": 0,
"instancia": "INST01"
}
]
} |
...
- 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 Grupo de Material)
http:127.0.0.1:8080/entity/v1/valorMateriais→ cadastra um objetohttp:127.0.0.1:8080/entity/v1/valorMateriais/batch → cadastra uma lista do objeto.grupoMateriais
Estrutura de dados para envio:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "codigoEmpresa": "EMP9043", "codigoMater": "MATER1234", "dataRefer": "2024-09-01", "daSituacaoErp": "Descrição do retorno do ERP", "dataSituacaoErp": "2024-09-01", "situacaoErp": "S", "codigoExterno":"INSTEX01", "qtMater": 123, "qtValor": 123, "qtValor1": 123456789, "qtValor2": 123456789, "qtValor3": 123456789, "qtValor4": null } ou uma lista [ { "codigoEmpresa": "EMP9043", "codigoMater": "MATER1234", "dataRefer": "2024-09-01", "daSituacaoErp": "Descrição do retorno do ERP", "dataSituacaoErp": "2024-09-01", "situacaoErp": "S", "codigoExterno":"INSTEX01", "qtMater": 123, "qtValor": 123, "qtValor1": 123456789, "qtValor2": 123456789, "qtValor3": 123456789, "qtValor4": null }, { "codigoEmpresa": "EMP9043", "codigoMater": "MATER1234", "dataRefer": "2024-09-01", "daSituacaoErp": "Descrição do retorno do ERP", "dataSituacaoErp": "2024-09-01", "situacaoErp": "S", "qtMater": 123, "qtValor": 123, "qtValor1": 123456789, "qtValor2": 123456789, "qtValor3": 123456789, "qtValor4": null } ] |
Estrutura de dados retorno:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"codigoEmpresa": "EMP90",
"codigoMater": "MATER1234",
"dataRefer": "2024-09-01",
"daSituacaoErp": "Descrição do retorno do ERP",
"dataSituacaoErp": "2024-09-01",
"situacaoErp": "S",
"codigoExterno": "INSTEX01",
"qtMater": 123,
"qtValor": 123,
"qtValor1": 123456789,
"qtValor2": 123456789,
"qtValor3": 123456789,
"qtValor4": 0,
"instancia": "INST01"
} ou uma lista {
"status": "COMPLETED",
"totalRecords": 2,
"processedRecords": 1,
"failRecords": 1,
"result": [
{
"recordId": {
"codigoEmpresa": "EMP90",
"codigoMater": "MATER1234",
"instancia": "201",
"dataRefer": "2024-09-01"
},
"status": "SUCCESS",
"message": null
},
{
"recordId": {
"codigoEmpresa": "EMP90",
"codigoMater": "MATER1234",
"instancia": null,
"dataRefer": "2024-09-01"
},
"status": "ERROR",
"message": "A instancia ou o código externo devem ser preenchidos"
}
]
} |
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.
...
PUT (Atualiza Grupo de Material)
- O retorno do cadastro em lista é uma lista com a pk do objeto, status e mensagem. Em caso de erro é registrado no status e na mensagem o ocorrido.
PUT
http:127.0.0.1:8080/entity/v1/valorMateriais→ atualiza um objeto
http:127.0.0.1:8080/entity/v1/valorMateriais/batch → atualiza uma lista de objeto.
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.
...
grupoMateriais
DELETE (Apaga Grupo de Material)
- O retorno do update em lista é uma lista com a pk do objeto, status e mensagem. Em caso de erro é registrado no status e na mensagem o ocorrido.
DELETE
http:127.0.0.1:8080/entity/v1/valorMateriaisgrupoMateriais
Observações
- É obrigatório informar os atributos que formam compõe a chave primária .
- Caso seja informado o codigoExterno, será usado como parâmetro, para a deleção, a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.
- A instancia e o codigoExterno não podem ser nulos simultaneamente. Ex: caso a instancia seja nula o codigoExternodeve existircomo parâmetros.