Histórico da Página
Disponibilizado endpoint para integração do cadastro de Centro de Custo Industrial com os métodos GET, POST, PUT, PATCH e DELETE.
...
Atributos | Descrição | Tamanho | Tipo | Chave Primária | Requerido | Valor Default | Valores Válidos | Observação |
id | Id único para rastreamento do registro de ponta a ponta | 12 | NUMBER | S | N | - | - | Gerado automaticamente quando o registro é inserido na tabela. |
codigoEmpresa | Código da empresa | 2 | NUMBER | N | N | - | - | Caso não informada será atribuído o código da empresa padrão configurado em default-company-ind. |
codigoCCustocodigoEmpresaERP | Código do centro de custoda empresa no ERP | 520 | STRING | N | N | - | - | - |
codigo | Código do subcentro de custo | 20 | STRING | NN | S | - | - | - |
descricao | Descrição do centro/subcentro de custo | 40 | STRING | NN | S | - | - | - |
descricaoResumida | Descrição resumida do centro/subcentro de custo | 10 | STRING | N | N | - | -- | Caso não informada será atribuído o valor do atributo "descricao" limitado a 10 caracteres. |
referencia | Referência do subcentro de custo | 20 | STRING | N | N | - | - | - |
ativo | Situação do subcentro de custo | 1 | STRING | N | N | "1" | 0 = Inativo 1 = Ativo | - |
GET (Consulta Centros Centro de Custos IndustriaisCusto Industrial)
http:127.0.0.1:8080/queryapi/entity/v1/centroCustosIndustriais?page=1&pagesize=2
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"hasNext": true,
"items": [
{
"id": 203,
"codigoEmpresa": 1,
"codigoCCusto": "1",
"codigo": "30",
"descricao": "ALIMENTAÇÃO",
"descricaoResumida": "ALIMENTAÇÃ",
"referencia": null,
"ativo": "0"
},
{
"id": 208,
"codigoEmpresa": 1,
"codigoCCusto": "6",
"codigo": "10",
"descricao": "ANÁLISE CANA DE AÇÚCAR",
"descricaoResumida": "ANÁLISE CA",
"referencia": null,
"ativo": "1"
}
]
} |
Parâmetros
- page: Número da página.
- pagesize: Quantidade máxima de registros por página.
Observações
- O usuário deverá disponibilizar a solicitação para o ERP.
- Serão disponibilizados registros de solicitação cujo status de integração seja igual a "ER" (Erro) ou nulo.
- Todos os atributos podem ser usados como parâmetro para a busca.
PUT/PATCH (Modifica Centro de Custo IndustrialPUT (Atualiza o status da Solicitação de Material/Serviço)
http:127.0.0.1:8080/queryapi/entity/v1/solicitacaoMaterialServicoIndustrialMativcentroCustosIndustriais
Estrutura de dados para envio:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": 348,
"idcodigoEmpresa": null,
"100000002033codigoEmpresaERP": 1,
"statusERPcodigo": "ERAPI123",
"mensagemIntegracaodescricao": "Mensagem de erro indicando o que precisa ser corrigido."TESTE TA-API-HUB",
"descricaoResumida": "TESTE TA-A",
"referencia": null,
"numeroSolicitacaoCompraativo": 8875,"1"
} |
Estrutura de dados retorno:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "numeroPedidoCompraid": 952348, "dataPrevistaEntregadescricao": "2025TESTE TA-07-10T17:30:45API-HUB", "descricaoResumida": "TESTE TA-A", "compradorreferencia": "Nome do Compradornull, "ativo": "1" } |
Observações
...
- Quando PATCH poderão ser enviados apenas os atributos que necessitam de atualização e os atributos que compõe a chave primária (id ou codigoEmpresa+codigo).
- No caso de PUT deverão ser enviados os atributos que necessitam de atualização, bem como os atributos obrigatórios e os atributos que compõe a chave primária (id ou codigoEmpresa+codigo).
- Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado.
- Caso o atributo codigoEmpresaERP seja informado, ele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
- O centro de custo será localizado seguindo a seguinte regra:
- Caso o atributo id esteja informado, o centro de custo será localizado pelo atributo id e os atributos codigoEmpresa/codigoEmpresaERP e codigo serão ignorados mesmo sendo informados.
- Caso o atributo id não esteja informado, o centro de custo será localizado pelos atributos codigoEmpresa/codigoEmpresaERP e codigo.
- Os atributos codigoEmpresa e codigo não serão alterados mesmo sendo informados.
- Caso o atributo descricao esteja informado e o atributo descricaoResumida não esteja informado, será atribuído o valor do atributo descricao ao atributo descricaoResumida limitado a 10 caracteres.
POST (Insere Centro de Custo IndustrialPOST (Atendimento da Solicitação de Material/Serviço)
http:127.0.0.1:8080/api/queryentity/v1/solicitacaoMaterialServicoIndustrialMativcentroCustosIndustriais
Estrutura de dados para envio:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"idcodigo": "100000002033api123",
"statusERPdescricao": "ATTeste ta-API-Hub",
"codigoMaterialcodigoEmpresaERP": 1
} |
Estrutura de dados retorno:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{"221", "codigoMaterialERP": null, "descricaoMaterialcodigo": null, "unidadeMedidaAPI123": null, "dataAtendimentodescricao": "2025TESTE TA-07-07T17:30:45API-HUB", "quantidadeAtendidaativo": "1", "valorUnitariocodigoEmpresa": 300"1", "numeroDocumentoERPid": 1234567890"348", "sequenciaDocumentoERPdescricaoResumida": 1 "TESTE TA-A" } |
Observações
- Caso os atributos codigoEmpresa e codigoEmpresaERP não forem informados, será utilizado como default o valor definido no parâmetro default-company-ind.
- Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado
- Deverá ser informado o mesmo id referente ao registro de solicitação que foi capturado no método GET.
- O atributo statusERP deverá ser informado.
- O material será localizado seguindo a seguinte regra:Caso não seja informado um dos atributos codigoMaterial ou codigoMaterialERP, o material será recuperado da solicitação referente ao id enviado.
- Caso o atributo codigoMaterial esteja codigoEmpresaERP seja informado, o material será localizado pelo atributo codigoMaterial e o atributo codigoMaterialERP será ignorado mesmo sendo informadoele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
- Os atributos codigo e descricao deverão ser informados.
- O conteúdo do atributo id será sempre desconsiderado caso informado e gerado um novo.
- Caso o atributo codigoMaterialERP descricaoResumida não esteja informado, o material será localizado pelo atributo codigoMaterialERP somente se o atributo codigoMaterial não estiver informado.será atribuído o valor do atributo descricao ao atributo descricaoResumida limitado a 10 caracteres.
- Caso já exista um centro de custo para a chave codigoEmpresa/codigoEmpresaERP+codigo informada não será permitida a inclusão e um aviso será mostrado.
DELETE (Exclui Centro de Custo Industrial)
Disponibilizado endpoint para excluir o Centro de Custo.
Método DELETE:
http:127.0.0.1:8080/api/entity/v1/centroCustosIndustriais
Parâmetros
- Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado.
- Caso o atributo codigoEmpresaERP seja informado, ele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
- Deverão ser informados os atributos que compõe a chave primária (id ou codigoEmpresa/codigoEmpresaERP+codigo).
- O centro de custo será localizado seguindo a seguinte regra:
- Caso o atributo id esteja informado, o centro de custo será localizado pelo atributo id e os atributos codigoEmpresa/codigoEmpresaERP e codigo serão ignorados mesmo sendo informados.
- Caso o atributo id não esteja informado, o centro de custo será localizado pelos atributos codigoEmpresa/codigoEmpresaERP e codigo
- O atributo descricaoMaterial é opcional. Caso informado, será acatado e gravado na tabela de atendimento com a descrição enviada e caso nulo manterá a descrição do material recuperada da solicitação.
- O atributo unidadeMedida é opcional. Caso informado, será acatado e gravado na tabela de atendimento com a unidade de medida enviada e caso nulo manterá a unidade de medida recuperada da solicitação.
- O atributo dataAtendimento deverá ser informado.
- O atributo quantidadeAtendida deverá ser informado.
- O atributo valorUnitario deverá ser informado.
- Os atributos numeroDocumentoERP e sequenciaDocumentoERP são de envio opcional.
- Após a inserção do registro de atendimento, o status de integração da solicitação correspondente será atualizado para o mesmo valor do atributo statusERP informado no atendimento
- .