Histórico da Página

Disponibilizado endpoint para integração das solicitações de materiais e serviços industriais 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.

...

dataEnvioData da coleta registro10DATETRUNC(SYSDATE)codigoMaterialCódigo no PIMS12INTEGERcodigoMaterialERP do material no ERP2512,35

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

2012

STRINGNUMBER

S (lógica)

S

-

Gerado automaticamente quando o registro é inserido na tabela

origem

Origem do registro

10

STRING

N

Abastecimento: CS_MNFABAS

Lubrificação: CS_MNFLUBR

-

instancia

Código da instância

5

STRING

N

-

boletimordemServico

Número do boletim

10

da ordem de serviço

7

NUMBERINTEGER

N

-

sequencia

Sequência

31

INTEGERNUMBER

N

N-

"1"

-

codigoMaterial

Código do material no PIMS

13

STRING

ordemServico

Número da ordem de serviço

7

INTEGER

N

Null-

-

Não envia.-

dataApontamentocodigoMaterialERP

Data Código do apontamentomaterial no ERP

1025

DATESTRING

N

-

descricaoMaterial

Descrição do

material

65

STRING

N

-

descricaoDetalhadaMaterial

Descrição detalhada do material

500

STRING

N

-

unidadeMedida

Código

da unidade de medida no PIMS

8

STRING

N

-

quantidade

Quantidade

NUMBER

N

-

unidadeMedidaERP

Código da unidade de medida no ERP

8

STRING

N

-

quantidadeSolicitada

Quantidade solicitada

12,4

NUMBER

centroCusto

Código do centro de custo no PIMS

20

INTEGER

N

-

valorUnitarioPrevisto

Valor unitário previsto

13,2

NUMBER

centroCustoERP

Código do centro de custo no ERP

20

INTEGER

N

-

dataNecessidade

Data da necessidade da solicitação

10

DATE

codigoDepositoERP

Código do depósito do material no ERP

15

STRING

N

-

comentario

Comentário

2000

usuario

Usuário responsável pelo apontamento

250

STRING

N

-

Caso o usuário não esteja preenchido no apontamento:

Resgatado a partir do parâmetro do BioEnergia

Seção: 'INT_ERP' / Entrada: 'CD_REQUISITANTE_MNF'

codigoEmpresaERP

Código da empresa no ERP

250

-

codigoCentroCusto

Código do centro de custo no PIMS

20

NUMBER

N

-

codigoCentroCustoERP

Código do centro de custo no ERP

20

NUMBERSTRING

N

-

-Resgatado

-

codigoDepositoERP

Código do depósito do material no ERP

15

STRING

N

-

Caso o campo código do almoxarifado/depósito esteja preenchido no apontamento ele será enviado e caso não esteja será enviado o valor default resgatado a partir do parâmetro do

BioEnergia

Bioenergia:

Seção: 'INT_ERP' / Entrada: '

EMPRESA

DEPOSITO_MATERIAIS_

ERP

INDUSTRIAIS'

codigoFilialERPcodigoContaContabilERP

Código da filial conta contábil no ERP

25025

STRING

N

-

Resgatado Caso o campo código da conta contábil esteja preenchido no apontamento ele será enviado e caso não esteja será enviado o valor default resgatado a partir do parâmetro do BioEnergiaBioenergia:

Seção: 'INT_ERP' / Entrada: '

FILIAL_ERP'

GET (Consulta Solicitações de Materiais/Serviços Industriais)

http:127.0.0.1:8080/query/v1/solicitacaoMaterialServicoIndustrialMativ?page=1&pagesize=2

CD_CTA_CTB_MI_MATSERV_APIHUB'
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 X = Solicitação de compra de serviços O = Solicitação de orçamento	-
solicitante	Usuário responsável pelo apontamento	250	STRING	N	N	-	-	Caso o usuário não esteja preenchido no apontamento: Resgatado a partir do parâmetro do Bioenergia Seção: 'INT_ERP' / Entrada: 'CD_REQUISITANTE_MI'
codigoEmpresa	Código da empresa	2	NUMBER	N	N	-	-	-
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 = Manutenção I = Investimento	-
inspecaoInterna	Inspeção interna	1	STRING	N	N	-	1 = Sim / 0 = Não	-
inspecaoExterna	Inspeção externa	1	STRING	N	N	-	1 = Sim / 0 = Não	-
detalhamentoInspecao	Detalhamento da inspeção	2000	STRING	N	N	-	-	-
equipeManutencaoSolicitante	Equipe de manutenção solicitante	40	STRING	N	N	-	-	-
comprador	Comprador	20	STRING	N	N	-	-	-
codigoContaInvestimento	Código da conta de investimento	20	STRING	N	N	-	-	-
imprimeBoleto	Imprime boleto	1	NUMBER	N	N	-	1 = Sim / 0 = Não	-
codigoDepartamentoCusto	Código do departamento de custo	6	NUMBER	N	N	-	-	-
codigoDivisaoCusto	Código da divisão de custo	6	NUMBER	N	N	-	-	-
codigoOrdemInvestimentoCusto	Código da ordem de investimento de custo	8	NUMBER	N	N	-	-	-
codigoEmpresaCusto	Código da empresa de custo	2	NUMBER	N	N	-	-	-
classificacaoSolicitacao	Classificação da solicitação	1	STRING	N	N	-	1 = Cotação urgente 2 = Cotação normal 3 = Com orçamento 7 = Contrato	-

GET (Consulta Solicitações de Materiais/Serviços Industriais)

http:127.0.0.1:8080/api/query/v1/solicitacaoMaterialServicoIndustrialMativ?page=1&pagesize=2

Bloco de código

language	java
title	Response

{
    "hasNext": false,
    "items": [
        {
            "id": "100000002033

Bloco de código

language	java
title	Response

{
    "hasNext": false,
    "items": [
        {
            "id": "100000002033",
            "instancia": "1",
            "ordemServico": 260199,
            "sequencia": 1,
            "tipoPecaServico": null,
            "codigoMaterial": "221",
            "codigoMaterialERP": null,
            "descricaoMaterial": "DESCRIÇÃO DO MATERIAL SOLICITADO",
            "descricaoDetalhadaMaterial": null,
            "unidadeMedida": "PC",
            "unidadeMedidaERP": "PC",
            "quantidadeSolicitada": 1,
            "valorUnitarioPrevisto": null,
            "dataNecessidade": "2025-07-05T03:00:00.000+00:00",
            "comentario": null,
            "codigoCentroCusto": "30",
            "codigoCentroCustoERP": "30",
            "codigoDepositoERP": null,
            "codigoContaERP": null,
            "tipoMovimento": "S",
            "tipoDocumento": "R",
            "solicitante": null,
            "codigoEmpresa": 1,
            "codigoEmpresaERP": null,
            "codigoFilialERP": null,
            "dataSolicitacao": "2025-07-07T16:27:26.000+00:00",
            "manutencaoInvestimento": "M",
            "origeminstancia": "PIMS-MI1",
            "codigoSistemaVeicularordemServico": null260199,
            "codigoSubsistemaVeicularsequencia": null1,
            "codigoComponentecodigoMaterial": null"221",
            "inspecaoInternacodigoMaterialERP": "0"null,
            "inspecaoExternadescricaoMaterial": "0DESCRIÇÃO DO MATERIAL SOLICITADO",
            "detalhamentoInspecaodescricaoDetalhadaMaterial": null,
            "equipeManutencaoSolicitanteunidadeMedida": "DESTILARIAPC",
            "compradorunidadeMedidaERP": null"PC",
            "codigoInvestimentoquantidadeSolicitada": "2"1,
            "idSolicitacaoMatServIndvalorUnitarioPrevisto": 100000002033null,
            "imprimeBoletodataNecessidade": "02025-07-05T03:00:00.000+00:00",
            "codigoDepartamentoCustocomentario": null,
            "codigoDivisaoCustocodigoCentroCusto": null"30",
            "codigoOrdemInvestimentoCustocodigoCentroCustoERP": null"30",
            "codigoEmpresaCustocodigoDepositoERP": null,
            "classificacaoSolicitacaocodigoContaContabilERP": null
        },
        {
            "idtipoMovimento": "100000002034S",
            "instanciatipoDocumento": "1R",
            "ordemServicosolicitante": 260229null,
            "sequenciacodigoEmpresa": 1,
            "tipoPecaServicocodigoEmpresaERP": null,
            "codigoMaterialcodigoFilialERP": "3271"null,
            "codigoMaterialERPdataSolicitacao": null"2025-07-07T16:27:26.000+00:00",
            "descricaoMaterialmanutencaoInvestimento": "DESCRIÇÃO DO MATERIAL SOLICITADOM",
            "descricaoDetalhadaMaterialinspecaoInterna": null"0",
            "unidadeMedidainspecaoExterna": "PC0",
            "unidadeMedidaERPdetalhamentoInspecao": "PC"null,
            "quantidadeSolicitadaequipeManutencaoSolicitante": 1"DESTILARIA",
            "valorUnitarioPrevistocomprador": null,
            "dataNecessidadecodigoContaInvestimento": "2025-07-05T03:00:00.000+00:00","2",
            "comentarioimprimeBoleto": null"0",
            "codigoCentroCustocodigoDepartamentoCusto": "10"null,
            "codigoCentroCustoERPcodigoDivisaoCusto": "10"null,
            "codigoDepositoERPcodigoOrdemInvestimentoCusto": null,
            "codigoContaERPcodigoEmpresaCusto": null,
            "tipoMovimentoclassificacaoSolicitacao": "S",null
        },
    "tipoDocumento": "R",
   {
            "solicitanteid": null"100000002034",
            "codigoEmpresainstancia": "1",
            "codigoEmpresaERPordemServico": null260229,
            "codigoFilialERPsequencia": null1,
            "dataSolicitacaocodigoMaterial": "2025-07-07T16:27:26.000+00:003271",
            "manutencaoInvestimentocodigoMaterialERP": "M"null,
            "origemdescricaoMaterial": "PIMS-MIDESCRIÇÃO DO MATERIAL SOLICITADO",
            "codigoSistemaVeiculardescricaoDetalhadaMaterial": null,
            "codigoSubsistemaVeicularunidadeMedida": null"PC",
            "codigoComponenteunidadeMedidaERP": null"PC",
            "inspecaoInternaquantidadeSolicitada": 1,
      "0"      "valorUnitarioPrevisto": null,
            "inspecaoExternadataNecessidade": "02025-07-05T03:00:00.000+00:00",
            "detalhamentoInspecao": null,
            "equipeManutencaoSolicitante": "OFICINA MECANICA",
            "comprador": null,
            "codigoInvestimento": "2",
            "idSolicitacaoMatServInd": 100000002034,
            "imprimeBoleto": "0",
            "codigoDepartamentoCusto": null,
            "codigoDivisaoCusto": null,
            "codigoOrdemInvestimentoCusto": null,
            "codigoEmpresaCusto": null,
            "classificacaoSolicitacao": null
        }
    ]
}

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" ou nulo.

PUT (Atualiza o status da Solicitação de Material/Serviço)

http:127.0.0.1:8080/query/v1/solicitacaoMaterialServicoIndustrialMativ

Estrutura de dados para envio:

comentario": null,
            "codigoCentroCusto": "10",
            "codigoCentroCustoERP": "10",
            "codigoDepositoERP": null,
            "codigoContaContabilERP": null,
            "tipoMovimento": "S",
            "tipoDocumento": "R",
            "solicitante": null,
            "codigoEmpresa": 1,
            "codigoEmpresaERP": null,
            "codigoFilialERP": null,
            "dataSolicitacao": "2025-07-07T16:27:26.000+00:00",
            "manutencaoInvestimento": "M",
            "inspecaoInterna": "0",
            "inspecaoExterna": "0",
            "detalhamentoInspecao": null,
            "equipeManutencaoSolicitante": "OFICINA MECANICA",
            "comprador": null,
            "codigoContaInvestimento": "2",
            "imprimeBoleto": "0",
            "codigoDepartamentoCusto": null,
            "codigoDivisaoCusto": null,
            "codigoOrdemInvestimentoCusto": null,
            "codigoEmpresaCusto": null,
            "classificacaoSolicitacao": null
        }
    ]
}

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.

PUT (Atualiza o status da Solicitação de Material/Serviço)

http:127.0.0.1:8080/api/query/v1/solicitacaoMaterialServicoIndustrialMativ

Estrutura de dados para envio:

Bloco de código

language	java
title	Body
collapse	true

{
    "id": "100000002033",
    "statusERP": "ER",
    "mensagemIntegracao": "Mensagem de erro indicando o que precisa ser corrigido.",
    "numeroSolicitacaoCompra": 8875,
    "numeroPedidoCompra": 952,
    "dataPrevistaEntrega": "2025-07-10T17:30:45",
    "comprador": "Nome do Comprador"
}

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 "NP" (Não Processado pelo ERP)como valor default.
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/solicitacaoMaterialServicoIndustrialMativ

Estrutura de dados para envio:

Bloco de código

language	java
title	Body
collapse	true

{
    "id": "100000002033",
    "statusERP": "AT",
    "codigoMaterial": "221",
    "codigoMaterialERP": null,
    "descricaoMaterial": null,
    "unidadeMedida": null,
    "dataAtendimento": "2025-07-07T17:30:45

Bloco de código

language	java
title	Body
collapse	true

{
    "id": "2028",
    "statusERPquantidadeAtendida": "ER"1,
    "valorUnitario": 300,
    "mensagemIntegracaonumeroDocumentoERP": "Mensagem de erro indicando o que precisa ser corrigido.",
    "numeroSolicitacaoCompra": 8875,
    "numeroPedidoCompra": 952,
    "dataPrevistaEntrega": "2025-07-10T17:30:45",
    "comprador": "Nome do Comprador"
}

Observações

 1234567890,
    "sequenciaDocumentoERP": 1 
}

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 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
Deverá ser enviado o mesmo id referente ao registro de solicitação que foi capturado no método GET.
Caso seja enviado o statusERP = null ou em branco, será atribuído "NP" como valor default.
Quando o statusERP enviado for igual a "ER" indicando um erro, além da atualização dos demais campos enviados, o campo OSP_ENVIADO será atualizado para "0" para que quando for efetuada a correção o usuário disponibilize novamente esse registro para o ERP.
Os atributos mensagemIntegracao, numeroSolicitacaoCompra, numeroPedidoCompra, dataPrevistaEntrega e comprador são de envio opcional.

Páginas filhas

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

Parâmetros

Parâmetros