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 de Referência (AAAA-MM-DD). | 10 | DATE | S | |
codigoCcusto | Código do Centro de Custos. | 20 | INTEGER | S | 0 |
codigoCompo | Código do Componente. | 15 | STRING | S | |
codigoEquipto | Código do Equipamento ou Patrimônio | 20 | STRING | S | 0 |
qtValor | Valor da Depreciação(moeda corrente). | 16 , 4 | INTEGER | N |
Atributos da chave primária composta
instancia, codigoEmpresa, codigoCcusto, codigoEquipto.
GET
http:127.0.0.1:8080/entity/v1/depreciacao?dataRefer=2014-04-30&page=1&pagesize=20
"hasNext": false,
"items": [
{
"codigoCcusto": 0,
"codigoEquipto": "EQUIPTO01",
"dataRefer": "2014-04-30",
"qtValor": 150,
"codigoEmpresa": "EMPRE01",
"instancia": "INST01",
"codigoCompo": 1
},] |
Observações
- Os atributos podem ser usados como parâmetro para a busca.
- 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 precisar que seu valor consolidado seja usado na busca(dependendo de como o sistema é configurado).
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, não precisa da consolidação da empresa. Se o valor for 2, a empresa consolidada é resgatada e sobrepõe o codigoEmpresa, ela é recuperada na tabela PLCEMPR_INT, informando a coluna CD_EMP_INT e pegando a coluna CD_EMP_CONS
POST
http:127.0.0.1:8080/entity/v1/depreciacao→ cadastra um objeto
http:127.0.0.1:8080/entity/v1/depreciacao/batch → cadastra uma lista do objeto.
Estrutura de dados para envio:
{
"codigoEmpresa": "1",
"dataRefer": "2018-04-31",
"codigoCcusto": 1234,
"codigoCtaCon": "1234",
"qtValorDebito ": 145.36,
"qtValorCredito ": 145.36
} ou uma lista [{
"codigoEmpresa": "1",
"dataRefer": "2014-04-30",
"codigoCcusto": 12345,
"codigoCtaCon": "1234",
"qtValorDebito ": 145.36,
"qtValorCredito ": 145.36,
"qtValor1": null,
"qtValor2": null,
"qtValor3": null,
"qtValor4": null
},
{
"codigoEmpresa": "4",
"instancia": "1",
"dataRefer": "2020-10-19",
"codigoCcusto": 1234,
"codigoCtaCon": "ABCPD",
"qtValorDebito": 2600,
"qtValor1": 12890.5678,
"qtValor2": 123890.5678,
"qtValor3": 123450.5678,
"qtValor4": 123890.5678,
"vlTarifa1": 15
}] |
Estrutura de dados retorno:
{
"codigoEmpresa": "1",
"dataRefer": "2018-04-30T00:00:00",
"codigoCcusto": 1234,
"codigoCtaCon": "1234",
"qtValorDebito": 0,
"qtValor1": 0,
"qtValor2": 0,
"qtValor3": 0,
"qtValor4": 0,
"instancia": "1"
} ou uma lista {
"status": "COMPLETED",
"totalRecords": 2,
"processedRecords": 1,
"failRecords": 1,
"result": [
{
"recordId": {
"codigoEmpresa": "1",
"instancia": null,
"codigoCtaCon": "1234",
"codigoCcusto": 12345,
"dataRefer": "2014-04-30"
},
"status": "ERROR",
"message": "Código do Centro de Custo inválido"
},
{
"recordId": {
"codigoEmpresa": "4",
"instancia": "1",
"codigoCtaCon": "ABCPD",
"codigoCcusto": 1234,
"dataRefer": "2020-10-19T00:00:00"
},
"status": "SUCCESS",
"message": null
}
]
} |
Observações
- 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).
- Entrada: FG_INT_EMPRESA, Seção: CSTG_C. Se o valor for 1, não precisa da consolidação da empresa. Se o valor for 2, a empresa consolidada é resgatada e sobrepõe o codigoEmpresa, ela é recuperada na tabela PLCEMPR_INT, informando a coluna CD_EMP_INT e pegando a coluna CD_EMP_CONS
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, não precisa da consolidação da empresa. Se o valor for 2, a empresa consolidada é resgatada e sobrepõe o codigoEmpresa, ela é recuperada na tabela PLCEMPR_INT, informando a coluna CD_EMP_INT e pegando a coluna CD_EMP_CONS
PUT
http:127.0.0.1:8080/entity/v1/depreciacao→ atualiza um objeto
http:127.0.0.1:8080/entity/v1/depreciacao/batch → atualiza uma lista de objeto.
Observações
- 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 precisar que seu valor consolidado seja usado(dependendo de como o sistema é configurado).
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, não precisa da consolidação da empresa. Se o valor for 2, a empresa consolidada é resgatada e sobrepõe o codigoEmpresa, ela é recuperada na tabela PLCEMPR_INT, informando a coluna CD_EMP_INT e pegando a coluna CD_EMP_CONS
DELETE
http:127.0.0.1:8080/entity/v1/depreciacao
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.
- Para informar um intervalo devo colocar o nome do atributo com sufixo Inicial e outro com o sufixo Final ( atributoInicial, atributoFinal). Ex: dataReferInicial e dataReferFinal.
- 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 precisar que seu valor consolidado seja usado(dependendo de como o sistema é configurado).
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, não precisa da consolidação da empresa. Se o valor for 2, a empresa consolidada é resgatada e sobrepõe o codigoEmpresa, ela é recuperada na tabela PLCEMPR_INT, informando a coluna CD_EMP_INT e pegando a coluna CD_EMP_CONS