Disponibilizado endpoint para integração das solicitações de materiais e serviços automotivos através do método GET, atualização do status de integração através do método PUT e atendimento da solicitação através do método POST.
Estrutura:
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 | 23 | String | S | S | - | - | Composto pela concatenação dos atributos ordemServico + sequencia + instancia |
instancia | Código da instância | 5 | STRING | N | N | - | - | - |
ordemServico | Número da ordem de serviço | 9 | NUMBER | N | N | - | - | - |
sequencia | Sequência | 9 | NUMBER | N | N | - | - | - |
tipoPecaServico | Tipo da Peça/Serviço | 3 | NUMBER | N | N | - | - | - |
codigoMaterial | Código do material no PIMS | 12 | NUMBER | N | N | - | - | - |
codigoMaterialERP | Código do material no ERP | 25 | STRING | N | N | - | - | - |
descricaoMaterial | Descrição do material | 60 | STRING | N | N | - | - | - |
descricaoDetalhadaMaterial | Descrição detalhada do material | 150 | STRING | N | N | - | - | - |
unidadeMedida | Código da unidade de medida no PIMS | 3 | STRING | N | N | - | - | - |
unidadeMedidaERP | Código da unidade de medida no ERP | 3 | STRING | N | N | - | - | - |
quantidadeSolicitada | Quantidade solicitada | 9,2 | NUMBER | N | N | - | - | - |
valorUnitarioPrevisto | Valor unitário previsto | 10,3 | NUMBER | N | N | - | - | - |
dataNecessidade | Data da necessidade da solicitação | 10 | DATE | N | N | - | - | - |
comentario | Comentário | 250 | STRING | N | N | - | - | - |
codigoCentroCusto | Código do centro de custo no PIMS | 20 | NUMBER | N | N | - | - | - |
codigoCentroCustoERP | Código do centro de custo no ERP | 15 | STRING | N | N | - | - | - |
codigoDepositoERP | Código do depósito do material no ERP | 15 | STRING | N | N | - | - | - |
codigoContaContabilERP | Código da conta contábil no ERP | 20 | STRING | N | N | - | - | Caso o parâmetro do Bioenergia esteja preenchido: Seção: 'INT_ERP' / Entrada: 'CD_CTA_CTB_MATSERV_APIHUB' Envia o valor do parâmetro e caso não esteja envia o valor preenchido no apontamento. |
tipoMovimento | Tipo do movimento | 1 | STRING | N | N | - | S = Saída / E = Entrada | - |
tipoDocumento | Tipo do documento | 1 | STRING | N | N | - | R = Requisição de materiais S = Solicitação de compra de materiais ou serviços | - |
solicitante | Usuário responsável pelo apontamento | 10 | STRING | N | N | - | - | - |
codigoEmpresa | Código da empresa | 5 | STRING | N | N | - | - | Resgatado a partir do parâmetro do Bioenergia Seção: 'GERAIS' / Entrada: 'CD_EMPRESA' |
codigoEmpresaERP | Código da empresa no ERP | 250 | STRING | N | N | - | - | Resgatado a partir do parâmetro do Bioenergia Seção: 'INT_ERP' / Entrada: 'EMPRESA_ERP' |
codigoFilialERP | Código da filial no ERP | 250 | STRING | N | N | - | - | Resgatado a partir do parâmetro do Bioenergia Seção: 'INT_ERP' / Entrada: 'FILIAL_ERP' |
dataSolicitacao | Data da solicitação | 10 | DATE | N | N | SYSDATE | - | - |
manutencaoInvestimento | Tipo da conta contábil padrão | 1 | STRING | N | N | "M" | M = Manutenção I = Investimento | - |
codigoSistemaVeicular | Código do sistema veicular | 5 | NUMBER | N | N | - | - | - |
codigoSubsistemaVeicular | Código do subsistema veicular | 5 | NUMBER | N | N | - | - | - |
codigoComponente | Código do componente | 10 | NUMBER | N | N | - | - | - |
GET (Consulta Solicitações de Materiais/Serviços Automotivos)
http:127.0.0.1:8080/api/query/v1/solicitacaoMaterialServicoMativ?page=1&pagesize=1
{
"hasNext": true,
"items": [
{
"id": "00043113100000000111",
"instancia": "11",
"ordemServico": 431131,
"sequencia": 1,
"tipoPecaServico": 1,
"codigoMaterial": 214697,
"codigoMaterialERP": "214697",
"descricaoMaterial": "MANCAL CONJUNTO DISCO",
"descricaoDetalhadaMaterial": "MANCAL CONJUNTO DISCO ERP",
"unidadeMedida": "UN",
"unidadeMedidaERP": "UN",
"quantidadeSolicitada": 1,
"valorUnitarioPrevisto": 761.335,
"dataNecessidade": "2025-07-10T03:00:00.000+00:00",
"comentario": "100039",
"codigoCentroCusto": 114037100,
"codigoCentroCustoERP": "4.03.7.100",
"codigoDepositoERP": "EAM-FGERAL",
"codigoContaContabilERP": "001.001.001",
"tipoMovimento": "S",
"tipoDocumento": "R",
"solicitante": "HEVERSONCP",
"codigoEmpresa": "11",
"codigoEmpresaERP": "123",
"codigoFilialERP": "456",
"dataSolicitacao": "2025-07-08T15:24:44.000+00:00",
"manutencaoInvestimento": "M",
"codigoSistemaVeicular": 100,
"codigoSubsistemaVeicular": 104,
"codigoComponente": 8
}
]
}
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 integração com o ERP.
- Serão disponibilizados registros de solicitação cujo status de integração seja igual a "ER" (Erro) ou nulo.
PUT (Atualiza o status da Solicitação de Material/Serviço)
http:127.0.0.1:8080/api/query/v1/solicitacaoMaterialServicoMativ
Estrutura de dados para envio:
Observações
- Esse método deverá ser chamado para cada registro capturado no método GET, sinalizando que o mesmo foi recebido pelo ERP, só então o registro deixará de ser enviado no método GET.
- Deverá ser informado o mesmo id referente ao registro de solicitação que foi capturado no método GET.
- Caso não seja informado o atributo statusERP, será atribuído o valor "NP" (Não Processado pelo ERP) como valor default, ainda assim o registro deixará de ser enviado no método GET.
- Quando o atributo statusERP informado for igual a "ER" indicando um erro, além da atualização dos demais campos informados, a solicitação será liberada para que o usuário efetue a devida correção e disponibilize esse registro novamente para o ERP, somente então o registro será enviado novamente no método GET.
- Os atributos mensagemIntegracao, numeroSolicitacaoCompra, numeroPedidoCompra, dataPrevistaEntrega e comprador são de envio opcional.
POST (Atendimento da Solicitação de Material/Serviço)
http:127.0.0.1:8080/api/query/v1/solicitacaoMaterialServicoMativ
Estrutura de dados para envio:
Observações
- 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 informado, o material será localizado pelo atributo codigoMaterial e o atributo codigoMaterialERP será ignorado mesmo sendo informado.
- Caso o atributo codigoMaterialERP esteja informado, o material será localizado pelo atributo codigoMaterialERP somente se o atributo codigoMaterial não estiver informado.
- 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 informado ou recuperado.
- 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.