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 | |
qtValorDebito | Valor da Despesa (moeda corrente) | 16 , 4 | INTEGER | N | |
qtValorCredito | Valores 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
instancia, codigoEmpresa, dataRefer, codigoCcusto, codigoCtaCon.
GET
http:127.0.0.1:8080/entity/v1/despesasGerais?dataRefer=2014-04-30&page=1&pagesize=20
http:127.0.0.1:8080/entity/v1/despesasGeraisERP?dataRefer=2014-04-30page=1&pagesize=20
{
"hasNext": false,
"items": [
{
"dataRefer": "2014-04-30",
"codigoCcusto": 1235556,
"codigoCtaCon": "41101003",
"qtValor": 0,
"qtValor1": 0,
"qtValor2": 0,
"qtValor3": 0,
"qtValor4": 0,
"instancia": "201",
"codigoEmpresa": "201"
}
]
} |
{
"hasNext": false,
"items": [
{
"instancia": "201",
"codigoEmpresa": "201",
"dataRefer": "2014-04-30",
"codigoCcusto": 1235556,
"codigoCtaCon": "41101003",
"qtValor": 0,
"qtValor1": 0,
"qtValor2": 0,
"qtValor3": 0,
"qtValor4": 0,
"vlTarifa1": null,
"vlTarifa2": null,
"vlTarifa3": null,
"vlTarifa4": null
}
]
} |
Observações
- Os atributos podem ser usados como parâmetro para a busca.
- É obrigatório informar a dataRefer para efetuar a busca.
- Os atributos relacionados a vlTarifa só funciona quando usado para buscar na despesasGeraisERP.
- 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
- 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.
POST
http:127.0.0.1:8080/entity/v1/despesasGerais→ cadastra um objeto
http:127.0.0.1:8080/entity/v1/despesasGerais/batch → cadastra uma lista do objeto.
Estrutura de dados para envio:
{
"codigoEmpresa": "002",
"dataRefer": "2018-04-31",
"codigoCcusto": 1235556,
"codigoCtaCon": "41101003",
"qtValor": 0,
"qtValorInicial": 145.36,
"qtValorFinal": 145.36
} ou uma lista [{
"codigoEmpresa": "002",
"dataRefer": "2014-04-30",
"codigoCcusto": 72108,
"codigoCtaCon": "41101003",
"qtValor": 0,
"qtValorInicial": 145.36,
"qtValorFinal": 145.36,
"qtValor1": null,
"qtValor2": null,
"qtValor3": null,
"qtValor4": null
},
{
"codigoEmpresa": "281",
"instancia": "201",
"dataRefer": "2020-10-19",
"codigoCcusto": 1235556,
"codigoCtaCon": "ABCPD",
"qtValor": 2600,
"qtValor1": 12890.5678,
"qtValor2": 123890.5678,
"qtValor3": 123450.5678,
"qtValor4": 123890.5678,
"vlTarifa1": 15
}] |
Estrutura de dados retorno:
{
"codigoEmpresa": "201",
"dataRefer": "2018-04-30T00:00:00",
"codigoCcusto": 1235556,
"codigoCtaCon": "41101003",
"qtValor": 0,
"qtValorInicial": 145.36,
"qtValorFinal": 145.36,
"qtValor1": 0,
"qtValor2": 0,
"qtValor3": 0,
"qtValor4": 0,
"instancia": "201"
} ou uma lista {
"status": "COMPLETED",
"totalRecords": 2,
"processedRecords": 1,
"failRecords": 1,
"result": [
{
"recordId": {
"codigoEmpresa": "002",
"instancia": null,
"codigoCtaCon": "41101003",
"codigoCcusto": 72108,
"dataRefer": "2014-04-30"
},
"status": "ERROR",
"message": "Código do Centro de Custo inválido"
},
{
"recordId": {
"codigoEmpresa": "204",
"instancia": "201",
"codigoCtaCon": "ABCPD",
"codigoCcusto": 1235556,
"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).
- 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 , 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: 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.1:8080/entity/v1/despesasGerais→ atualiza um objeto
http:127.0.0.1:8080/entity/v1/despesasGerais/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 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
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.