Atributos

Descrição

Tamanho

Tipo

Requerido

Valor default

Instancia

Código da instancia.

5

STRING

N


codigoExterno

Código do parceiro usado para recuperar a instancia.

5

STRING

N


codigoEmpresa

Código da empresa.

5

STRING

S


codigoMater

Código do material.

20

STRING

S


dataRefer

Data do consumo do material  ( AAAA-MM-DD )

10

DATE

S


daSituacaoErp

Descrição do retorno do ERP

40

STRING

N


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.

GET

http:127.0.0.1:8080/entity/v1/valorMateriais?page=1&pagesize=20

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

Parâmetros

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

http:127.0.0.1:8080/entity/v1/valorMateriais→ cadastra um objeto

http:127.0.0.1:8080/entity/v1/valorMateriais/batch  → cadastra uma lista do objeto.

Estrutura de dados para envio:

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

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

- A instancia e o codigoExterno não podem ser nulos simultaneamente. Ex: caso a instancia seja nula o codigoExterno deve existir.

- 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.

- A instancia e o codigoExterno não podem ser nulos simultaneamente. Ex: caso a instancia seja nula o codigoExterno deve existir.

- 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/valorMateriais

Observações

- É obrigatório informar os atributos que formam 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 codigoExterno deve existir.