Atributos

Descrição

Tamanho

Tipo

Requerido

Valor default

codigoDeposito

  Código de depósito de insumo

8

INTEGER

S


descricaoDeposito

  Descrição do depósito de insumo

40

STRING

S


codigoDepositoERP

  Código do depósito no ERP

15

STRING

S


codigoOrganizacaoERP

  Código da organização ERP

15

STRING

S


codigoEmpresaERP

  Código da empresa ERP

15

STRING

S


codigoLocalizacaoERP

  Código da localização ERP

15

STRING

N


Atributos da chave primária simples

codigoDeposito.


Premissa para que a API esteja disponível e funcional

Possuir ativado controle de digitação de depósito de insumo no apontamento de insumos. Esta informação é identificada pelo parâmetro ATRC_INS→FG_DIG_DEP_INS estando com valor 1 que é responsável por disponibilizar a opção de menu contendo o cadastro no módulo Totvs Agro Bioenergia Configuração Central(CFGCEN.EXE). Caso contrário a API retornará a seguinte exceção: 

"message": "Opção não disponível para parametrização atual".


GET

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

{
    "hasNext": false,
    "items": [
        {
            "codigoDeposito": 1,
            "descricaoDeposito": "Novo depósito fazenda São Geraldo",
            "codigoDepositoERP": "CODERP789012345",
            "codigoOrganizacaoERP": "ORGERP78912345",
            "codigoEmpresaERP": "EMPERP789012345",
            "codigoLocalizacaoERP": null,
            "rowversion": 1
        },
        {
            "codigoDeposito": 2,
            "descricaoDeposito": "Novo depósito fazenda São Lucas",
            "codigoDepositoERP": "123456789",
            "codigoOrganizacaoERP": "ORG_ERP",
            "codigoEmpresaERP": "EMP_ERP",
            "codigoLocalizacaoERP": null,
            "rowversion": 1
        },
        {
            "codigoDeposito": 3,
            "descricaoDeposito": "Novo depósito fazenda São  II",
            "codigoDepositoERP": "CODERP78901II",
            "codigoOrganizacaoERP": "ORGERP789II",
            "codigoEmpresaERP": "EMPERP7890OO",
            "codigoLocalizacaoERP": null,
            "rowversion": 1
        }
    ]
}

Parâmetros

Observações

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


POST

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

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

Estrutura de dados para envio:

{
    "codigoDeposito": -99,
    "descricaoDeposito": "Novo depósito fazenda São Geraldo",
    "codigoDepositoERP": "CODERP789012345",
    "codigoOrganizacaoERP": "ORGERP78912345",
    "codigoEmpresaERP": "EMPERP789012345"
} ou uma lista 
[{
    "codigoDeposito": -99,
    "descricaoDeposito": "Novo depósito fazenda São Geraldo",
    "codigoDepositoERP": "CODERP789012345",
    "codigoOrganizacaoERP": "ORGERP78912345",
    "codigoEmpresaERP": "EMPERP789012345"
}, {
    "codigoDeposito": -99,
    "descricaoDeposito": "Novo depósito fazenda São Lucas",
    "codigoDepositoERP": "123456789",
    "codigoOrganizacaoERP": "ORG_ERP",
    "codigoEmpresaERP": "EMP_ERP"
}]

Estrutura de dados retorno:

{
    "codigoDeposito": "3",
    "descricaoDeposito": "Novo depósito fazenda São  II",
    "codigoDepositoERP": "CODERP78901II",
    "codigoOrganizacaoERP": "ORGERP789II",
    "codigoEmpresaERP": "EMPERP7890OO",
    "rowversion": 1
} ou uma lista   {
    "status": "COMPLETED",
    "totalRecords": 2,
    "processedRecords": 2,
    "failRecords": 0,
    "result": [
        {
            "recordId": {
                "codigoDeposito": "1"
            },
            "status": "SUCCESS",
            "message": null
        },
        {
            "recordId": {
                "codigoDeposito": "2"
            },
            "status": "SUCCESS",
            "message": null
        }
    ]
}

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.

- O codigoCcusto e o codigoEquipto não podem estar zerados ou nulos simultaneamente. Ex: caso o codigoCcusto seja zero o codigoEquipto deve existir.

- É verificado se o codigoEmpresa referencia uma empresa consolidada.

- 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/depositoInsumos→ atualiza um objeto

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

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

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.