Páginas filhas
  • API Centro de Custo (Manutenção Industrial)

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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 POSTdo cadastro de Centro de Custo com os métodos GET, POST, PUT, PATCH e DELETE.


Estrutura:

codigoCentroCustoERPCódigo no ERPtipoMovimento 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'

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

SS

N

-

-

Gerado automaticamente quando o registro é inserido na tabela.

instanciacodigoEmpresa

Código da instânciaempresa

5

STRING

N

N

-

-

-

ordemServico

Número da ordem de serviço

7

2

NUMBER

N

N

-

-

-

sequencia

Sequência

1

NUMBER

N

N

"1"

-

-

codigoMaterial

Código do material no PIMS

13

STRING

N

N

-

-

-

codigoMaterialERP

Código do material no ERP

25

STRING

N

N

-

-

-

descricaoMaterial

Descrição do material

65

STRING

N

N

-

-

-

descricaoDetalhadaMaterial

Descrição detalhada do material

500

STRING

N

N

-

-

-

unidadeMedida

Código da unidade de medida no PIMS

8

STRING

N

N

-

-

-

Caso não informada será atribuído o código da empresa padrão configurado em default-company-ind.

codigoEmpresaERP

Código da empresa no ERP

5

unidadeMedidaERP

Código da unidade de medida no ERP

8

STRING

N

N

-

-

-

quantidadeSolicitada

Quantidade solicitada

12,4

NUMBER

N

N

-

-

-

valorUnitarioPrevisto

Valor unitário previsto

13,2

NUMBER

N

N

-

-

-

dataNecessidade

Data da necessidade da solicitação

10

DATE

N

N

-

-

-

comentario

Comentário

2000

STRING

N

N

-

-

-

codigo

Código do subcentro de custo

20

STRING

N

S

codigoCentroCusto

Código do centro de custo no PIMS

20

NUMBER

N

N

-

-

-

descricao

Descrição do centro/subcentro de custo

20

NUMBER

N

N

-

-

-

codigoDepositoERP

Código do depósito do material no ERP

15

STRING

N

N

-

-

Resgatado a partir do parâmetro do Bioenergia

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

codigoContaERP

Código da conta contábil padrão

25

STRING

N

N

40

STRING

N

S

-

-

-

descricaoResumida

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

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

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

-

-

-

ativo

Situação do subcentro de custo

classificacaoSolicitacao

Classificação da solicitação

1

STRING

N

N

-

"1"

0 = Inativo

1 = Ativo

1 = Cotação urgente

2 = Cotação normal

3 = Com orçamento

7 = Contrato

-


GET (Consulta Solicitações de Materiais/Serviços IndustriaisCentro de Custo Industrial)

http:127.0.0.1:8080/api/queryentity/v1/solicitacaoMaterialServicoIndustrialMativcentroCustosIndustriais?page=1&pagesize=2

Bloco de código
languagejava
titleResponse
{
    "hasNext": falsetrue,
    "items": [
        {
            "id": "100000002033"203,
            "instanciacodigoEmpresa": "1",
            "ordemServicocodigo": 260199,
            "sequencia": 1,
            "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",
            "codigoCentroCustoERPdescricao": "30ALIMENTAÇÃO",
            "codigoDepositoERPdescricaoResumida": null,
            "codigoContaERP": null"ALIMENTAÇÃ",
            "tipoMovimento": "S",
            "tipoDocumento": "R",
            "solicitante": referencia": null,
            "codigoEmpresaativo": 1,
            "codigoEmpresaERP": null,
            "codigoFilialERP": null,
            "dataSolicitacao": "2025-07-07T16:27:26.000+00:00",
            "manutencaoInvestimento": "M",
            "inspecaoInterna": "0",
            "inspecaoExterna": "0",
            "detalhamentoInspecao": null,
            "equipeManutencaoSolicitante": "DESTILARIA",
            "comprador": null,
            "codigoContaInvestimento": "2",
            "imprimeBoleto": "0",
            "codigoDepartamentoCusto": null,
            "codigoDivisaoCusto": null,
            "codigoOrdemInvestimentoCusto": null,
            "codigoEmpresaCusto": null,
            "classificacaoSolicitacao": null
        },
        {
            "id": "100000002034"208,
            "instanciacodigoEmpresa": "1",
            "ordemServicocodigo": 260229,
            "sequencia": 1"10",
            "codigoMaterialdescricao": "3271",
ANÁLISE CANA           "codigoMaterialERP": nullDE AÇÚCAR",
            "descricaoMaterialdescricaoResumida": "DESCRIÇÃO DO MATERIAL SOLICITADOANÁLISE CA",
            "descricaoDetalhadaMaterialreferencia": null,
            "unidadeMedidaativo": "PC1",
            "unidadeMedidaERP": "PC",}
            "quantidadeSolicitada": 1,
            "valorUnitarioPrevisto": null,
            "dataNecessidade": "2025-07-05T03:00:00.000+00:00",
            "comentario": null,
            "codigoCentroCusto": "10",
            "codigoCentroCustoERP": "10",
            "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",
            "inspecaoInterna": "0",
            "inspecaoExterna": "0",
            "detalhamentoInspecao"]
}

Parâmetros

  • page: Número da página.
  • pagesize: Quantidade máxima de registros por página.

Observações

  • Todos os atributos podem ser usados como parâmetro para a busca.


PUT/PATCH (Modifica Centro de Custo Industrial)

http:127.0.0.1:8080/api/entity/v1/centroCustosIndustriais

Estrutura de dados para envio:

Bloco de código
languagejava
titleBody
collapsetrue
{
	"id": 348,
    "codigoEmpresa": null, 
    "codigoEmpresaERP": 1,
    "codigo": "API123",
    "descricao": "TESTE TA-API-HUB",
    "descricaoResumida": "TESTE TA-A",
    "referencia": null,
            "equipeManutencaoSolicitante"ativo": "OFICINA MECANICA1",
            "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)

...

Estrutura de dados para envioretorno:

Bloco de código
languagejava
titleBodyResponse
collapsetrue
{
    "id": "100000002033"348,
    "statusERPdescricao": "ERTESTE TA-API-HUB",
    "mensagemIntegracaodescricaoResumida": "Mensagem de erro indicando o que precisa ser corrigido.TESTE TA-A",
    "numeroSolicitacaoComprareferencia": 8875null,
    "numeroPedidoCompraativo": 952,
    "dataPrevistaEntrega": "2025-07-10T17:30:45",
    "comprador": "Nome do Comprador"
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 Industrial

...

POST (Atendimento 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
languagejava
titleBody
collapsetrue
{
    "idcodigo": "100000002033api123",
    "statusERPdescricao": "ATTeste ta-API-Hub",
    "codigoMaterialcodigoEmpresaERP": 1
}

Estrutura de dados retorno:

Bloco de código
languagejava
titleResponse
collapsetrue
{"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
    • .