Histórico da Página

Atributos	Descrição	Tamanho	Tipo	Requerido	Valor default
Instancia	Código da instancia.	5	STRING	N
codigoEstabelecimento	Código do parceiro usado para recuperar a instancia. Também pode sobrepor o código da empresa.	30	STRING	N
codigoEmpresa	Código da empresa.	5	STRING	N
dataRefer	Data do consumo do material (AAAA-MM-DD)	10	DATE	S
codigoCcusto	Código do Centro de Custos	20	INTEGER	S
codigoCtaCon	Código da Conta Contábil.	15	STRING	S
qtValorqtValorDebito	Valor da Despesa (moeda corrente)	16 , 4	INTEGER	N
qtValorInicial, qtValorFinalqtValorCredito	Valores inicial e final usados credito usado para calcular o valor das despesas caso necessário.	16 , 4	NUMBER	N
qtValor1, qtValor2, qtValor3 ,qtValor4	Valor do Consumo em outra moeda	16 , 4	NUMBER	N
vlTarifa1, vlTarifa2, vlTarifa3, vlTarifa4	Tarifa ERP (pertence a CSTG_INTDG_ERP)	16 , 4	NUMBER	N

Atributos da chave primária composta

...

Bloco de código

language	java
title	Response despesasGerais

{
    "hasNext": false,
    "items": [
        {
            "dataRefer": "2014-04-30",
            "codigoCcusto": 12355561234,
            "codigoCtaCon": "411010031234",
            "qtValor": 0,
            "qtValor1": 0,
            "qtValor2": 0,
            "qtValor3": 0,
            "qtValor4": 0,
            "instancia": "2011",
            "codigoEmpresa": "2011"
        }
    ]
}

Bloco de código

language	java
title	Response despesasGeraisERP

{
    "hasNext": false,
    "items": [
        {
            "instancia": "2011",
            "codigoEmpresa": "2011",
            "dataRefer": "2014-04-30",
            "codigoCcusto": 12355561234,
            "codigoCtaCon": "411010031234",
            "qtValor": 0,
            "qtValor1": 0,
            "qtValor2": 0,
            "qtValor3": 0,
            "qtValor4": 0,
            "vlTarifa1": null,
            "vlTarifa2": null,
            "vlTarifa3": null,
            "vlTarifa4": null
        }
    ]
}

...

- Os atributos relacionados a vlTarifa só funciona quando usado para buscar na despesasGeraisERP.

- O atributo codigoEstabelecimento pode ser usado no lugar do codigoEmpresa(dependendo de como o sistema é configurado)- Caso queira usar a instancia para a busca, mas não possua seu valor, é possível deixar o atributo recuperarInstancia true e enviar codigoEmpresaInst ou codigoEstabelecimentoInst (dependendo de como o sistema é configurado).

- O atributo codigoEstabelecimento pode ser usado no lugar do codigoEmpresa(dependendo de como o sistema é configurado).

- O atributo codigoEmpresa informado pode ser erp, então será resgatado o código do bioenergia (dependendo de como o sistema é configurado).

Configuração de parâmetros

...

Bloco de código

language	java
title	Horas Manutenção MecânicaDespesas Gerais
collapse	true

{
    
  "codigoExterno": "INSTEX01""codigoEmpresa": "1",
  "codigoEmpresa": "EMP01",
  "dataRefer": "20242018-0904-0131",
  "codigoFunciocodigoCcusto": 123451234,
  "codigoEquiptocodigoCtaCon": "EQUIP1234561234",
  "codigoCcustoqtValorDebito ": 1234567890145.36,
  "quantidadeHorasqtValorCredito ": 1
145.36

} ou uma lista 
 [{
    "codigoEmpresa": "1",
  "codigoExternodataRefer": "INSTEX012014-04-30",
  "codigoEmpresacodigoCcusto": "EMP01"12345,
  "dataRefercodigoCtaCon": "2024-09-011234",
  "codigoFuncioqtValorDebito ": 12345145.36,
  "codigoEquiptoqtValorCredito ": "EQUIP123456"145.36,
  "codigoCcustoqtValor1": 1234567890null,
  "quantidadeHorasqtValor2": 1


}, {null,
    "qtValor3": null,
  "codigoExterno"qtValor4": null
},
{
  "codigoEmpresa": "INSTEX014",
  "codigoEmpresainstancia": "EMP0021",
  "dataRefer": "20242020-0910-0119",
  "codigoFunciocodigoCcusto": 123451234,
  "codigoEquiptocodigoCtaCon": "EQUIP123456ABCPD",
  "codigoCcustoqtValorDebito": 12345678902600,
  "quantidadeHorasqtValor1": 112890.5


}5678,
  "qtValor2": 123890.5678,
  "qtValor3": 123450.5678,
  "qtValor4": 123890.5678,
   "vlTarifa1": 15
}]

Estrutura de dados retorno:

Bloco de código

language	java
title	Horas Manutenção MecânicaDespesas Gerais
collapse	true

{
    "codigoExternocodigoEmpresa": "INSTEX011",
    "codigoEmpresadataRefer": "EMP012018-04-30T00:00:00",
    "dataRefercodigoCcusto": 1234,
    "codigoCtaCon": "2024-09-011234",
    "codigoFuncioqtValorDebito": 123450,
    "codigoEquiptoqtValor1": 0,
    "EQUIP123456qtValor2": 0,
    "codigoCcustoqtValor3": 12345678900,
    "quantidadeHorasqtValor4": 10,
    "instancia": "INST011"
} ou uma lista  
 {
    "status": "COMPLETED",
    "totalRecords": 2,
    "processedRecords": 1,
    "failRecords": 1,
    "result": [
        {
            "recordId": {
                "codigoEmpresa": "EMP011",
                "codigoFuncioinstancia": 12346null,
                "codigoEquiptocodigoCtaCon": "EQUIP1234561234",
                "codigoCcusto": 123456789012345,
                "dataRefer": "20242014-0904-0130"
            },
            "status": "SUCCESSERROR",
            "message": null "Código do Centro de Custo inválido"
        },
        {
            "recordId": {
                "codigoEmpresa": "EMP0024",
                "codigoFuncioinstancia": 12345"1",
                "codigoEquiptocodigoCtaCon": "EQUIP123456ABCPD",
                "codigoCcusto": 12345678901234,
                "dataRefer": "20242020-09-0110-19T00:00:00"
            },
            "status": "ERRORSUCCESS",
            "message": "Tamanho inválido para o atributo codigoEmpresa. Máximo: 5"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.

Configuração de parâmetros

- Entrada: CSTGDG_FG_CCUST , Seção: INT_ERP. Se o valor for 'D', o código é erp e será resgatado na tabela CCUSTO o código do bioenergia. Se o valor for 'P', não há alteração no código informado.

O atributo codigoCcusto informado pode ser erp, então será resgatado o código do bioenergia (dependendo de como o sistema é configurado).

- Caso a instancia não seja informada, ela será recuperada através do codigoEmpresa ou codigoEstabelecimento (dependendo de como o sistema é configurado).

- O atributo codigoEstabelecimento pode ser usado no lugar do codigoEmpresa(dependendo de como o sistema é configurado).

- O atributo codigoEmpresa informado pode ser erp, então será resgatado o código do bioenergia (dependendo de como o sistema é configurado).

- Dependendo da configuração do sistema o atributo qtValorDebito é calculado (qtValorDebito - qtValorCredito ).

- Dependendo da configuração do sistema essas informações também são salvas na tabela CSTG_INTDG_ERP.

- Os atributos relacionados a vlTarifa só são salvos na tabela CSTG_INTDG_ERP.

- A tabela CSTG_INTDG_ERP pode apenas ser modificada junto com a CSTG_INTDG, porém é possível realizar o GET.

Configuração de parâmetros

- Entrada: CSTGDG_FG_CCUST - Entrada: CSTGDG_FILT_EST, Seção: INT_ERP. Se o valor for 'S' a instancia é recuperada usando o codigoEstabelecimentoD', o codigoCcusto é erp e será resgatado na tabela CCUSTO o código do bioenergia. Se o valor for 'N'P', não há alteração no código informado.

- Entrada: CSTGDG_FILT_EST, Seção: INT_ERP. Se o valor for 'S' a instancia é recuperada usando o codigoEstabelecimento. Se o valor for 'N' instancia é recuperada usando o codigoEmpresa.

- Entrada: FG_EMPR_FILIAL, Seção: INT_ERP. Se o valor for 'F' é usado o codigoEstabelecimento como o codigoEmpresa. Se o valor for 'E' continua sendo usado o codigoEmpresa.

...

- Entrada: CSTGDG_DEB_CRED , Seção: INT_ERP. Se o valor for 1 continua sendo usado o codigoEmpresa, atributo o qtValorDebito não é modificado. Se o valor for 2 o atributo qtValor qtValorDebito será calculado usando qtValorInicial e qtValorFinal (qtValorFinal qtValorDebito - qtValorInicial )

Image Removed

ele é chamado de debito e crédito mudo o nome?

PUT

qtValorCredito ), os dois atributos são necessários para efetuar a conta.

- Entrada: FG_CSTG_INTDG_ERP , Seção: INT_ERP. Se o valor for 'S' as informações também serão salvas na tabela CSTG_INTDG_ERP. Se o valor for 'N' as informações são salvas apenas na CSTG_INTDG

PUT

http:127.0.0.http:127.0.0.1:8080/entity/v1/horasManutencaoMecanica→ despesasGerais→ atualiza um objeto
http:127.0.0.1:8080/entity/v1/horasManutencaoMecanicadespesasGerais/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/horasManutencaoMecanica

Observações

- É obrigatório informar os atributos que formam a chave primária.

O atributo codigoCcusto informado pode ser erp, então será resgatado o código do bioenergia (dependendo de como o sistema é configurado).

- Caso a instancia não seja informada, ela será recuperada através do codigoEmpresa ou codigoEstabelecimento (dependendo de como o sistema é configurado).

- O atributo codigoEstabelecimento pode ser usado no lugar do codigoEmpresa(dependendo de como o sistema é configurado).

- O atributo codigoEmpresa informado pode ser erp, então será resgatado o código do bioenergia (dependendo de como o sistema é configurado).

- Dependendo da configuração do sistema o atributo qtValorDebito é calculado (qtValorDebito - qtValorCredito ).

- Dependendo da configuração do sistema o atributo qtValorDebito é somado com o valor existente no banco, e essa soma que será o novo qtValorDebito .

- Dependendo da configuração do sistema essas informações também são atualizadas na tabela CSTG_INTDG_ERP.

- Os atributos relacionados a vlTarifa só são atualizadas na tabela CSTG_INTDG_ERP.

- A tabela CSTG_INTDG_ERP pode apenas ser modificada junto com a CSTG_INTDG, porém é possível realizar o GET.

Configuração de parâmetros

- Entrada: CSTGDG_FG_CCUST , Seção: INT_ERP. Se o valor for 'D', o codigoCcusto é erp e será resgatado na tabela CCUSTO o código do bioenergia. Se o valor for 'P', não há alteração no código informado.

- Entrada: CSTGDG_FILT_EST, Seção: INT_ERP. Se o valor for 'S' a instancia é recuperada usando o codigoEstabelecimento. Se o valor for 'N' instancia é recuperada usando o codigoEmpresa.

- Entrada: FG_EMPR_FILIAL, Seção: INT_ERP. Se o valor for 'F' é usado o codigoEstabelecimento como o codigoEmpresa. Se o valor for 'E' continua sendo usado o codigoEmpresa.

- Entrada: FG_INT_EMPRESA, Seção: CSTG_C. Se o valor for 1, o código é erp e será resgatado na tabela PMMAPPIMS_EXT o código do bioenergia. Se o valor for 2, não há alteração no código informado.

- Entrada: CSTGDG_TAM_CTA, Seção: INT_ERP. O valor define o tamanho do codigoCtaCon, se for maior do que o esperado ele é cortado.

- Entrada: CSTGDG_DEB_CRED , Seção: INT_ERP. Se o valor for 1, atributo o qtValorDebito não é modificado. Se o valor for 2 o atributo qtValorDebito será calculado usando (qtValorDebito - qtValorCredito ), os dois atributos são necessários para efetuar a conta.

- Entrada: CSTGDG_FG_SOMA, Seção: INT_ERP. Se o valor for 'S' será feita a soma do valor informado com o valor existente do banco, e o resultado será gravado. Se o valor for 'N' o valor informado que será gravado.

- Entrada: FG_CSTG_INTDG_ERP , Seção: INT_ERP. Se o valor for 'S' as informações também serão atualizadas na tabela CSTG_INTDG_ERP. Se o valor for 'N' as informações são atualizadas apenas na CSTG_INTDG.

DELETE

http:127.0.0.1:8080/entity/v1/despesasGerais

Parâmetros

recuperarInstancia: Usado para quando se quer recuperar a instancia por outros parâmetros.

Observações

- Os atributos podem ser usados como parâmetro para a deleção.

- Todos os parâmetros podem ser informados através de um único ou de um intervalo, mas um mesmo parâmetro não pode ser informado das duas formas simultaneamente. Ex: pode ser informado a dataRefer ou dataReferInicial e dataReferFinal.

- É obrigatório informar a dataRefer ou seu intervalo para efetuar a deleção.

- Os atributos relacionados a vlTarifa não podem ser usados.

- Caso queira usar a instancia para a deleção, mas não possua seu valor, é possível deixar o atributo recuperarInstancia true e enviar codigoEmpresaInst ou codigoEstabelecimentoInst (dependendo de como o sistema é configurado).

- Caso a instancia seja recuperada não é possível passar um intervalo de codigoEmpresaInst ou codigoEstabelecimentoInst.

- O atributo codigoEstabelecimento pode ser usado no lugar do codigoEmpresa(dependendo de como o sistema é configurado).

- O atributo codigoEmpresa informado pode ser erp, então será resgatado o código do bioenergia (dependendo de como o sistema é configurado).

- Dependendo da configuração do sistema essas informações também são deletadas na tabela CSTG_INTDG_ERP.

- A tabela CSTG_INTDG_ERP pode apenas ser modificada junto com a CSTG_INTDG, porém é possível realizar o GET.

Configuração de parâmetros

- Entrada: CSTGDG_FILT_EST, Seção: INT_ERP. Se o valor for 'S' instancia é recuperada usando o codigoEstabelecimento. Se o valor for 'N' instancia é recuperada usando o codigoEmpresa.

- Entrada: FG_EMPR_FILIAL, Seção: INT_ERP. Se o valor for 'F' é usado o codigoEstabelecimento como o codigoEmpresa. Se o valor for 'E' continua sendo usado o codigoEmpresa.

- Entrada: FG_INT_EMPRESA, Seção: CSTG_C. Se o valor for 1, o código é erp e será resgatado na tabela PMMAPPIMS_EXT o código do bioenergia. Se o valor for 2, não há alteração no código informado.

- Entrada: FG_CSTG_INTDG_ERP , Seção: INT_ERP. Se o valor for 'S' as informações também serão deletadas na tabela CSTG_INTDG_ERP. Se o valor for 'N' as informações são deletadas apenas na CSTG_INTDG- 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.

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Parâmetros