TOTVS AGRO

Páginas filhas
  • API Requisição Interna e Solicitação de Compra de Materiais e Serviços (Manutenção Industrial)

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.


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

12

NUMBER

S

S

-

-

Gerado automaticamente quando o registro é inserido na tabela

instancia

Código da instância

5

STRING

N

N

-

-

-

ordemServico

Número da ordem de serviço

7

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

-

-

-

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

-

-

-

codigoCentroCusto

Código do centro de custo no PIMS

20

NUMBER

N

N

-

-

-

codigoCentroCustoERP

Código do centro de custo no ERP

20

NUMBER

N

N

-

-

-

codigoDepositoERP

Código do depósito do material no ERP

15

STRING

N

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:

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

codigoContaContabilERP

Código da conta contábil no ERP

25

STRING

N

N

-

-

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 Bioenergia:

Seção: 'INT_ERP' / Entrada: '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

Response
{
    "hasNext": false,
    "items": [
        {
            "id": "100000002033",
            "instancia": "1",
            "ordemServico": 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",
            "codigoCentroCustoERP": "30",
            "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": "DESTILARIA",
            "comprador": null,
            "codigoContaInvestimento": "2",
            "imprimeBoleto": "0",
            "codigoDepartamentoCusto": null,
            "codigoDivisaoCusto": null,
            "codigoOrdemInvestimentoCusto": null,
            "codigoEmpresaCusto": null,
            "classificacaoSolicitacao": null
        },
        {
            "id": "100000002034",
            "instancia": "1",
            "ordemServico": 260229,
            "sequencia": 1,
            "codigoMaterial": "3271",
            "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": "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:

Body 
{
    "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:

Body 
{
    "id": "100000002033",
    "statusERP": "AT",
    "codigoMaterial": "221",
    "codigoMaterialERP": null,
    "descricaoMaterial": null,
    "unidadeMedida": null,
    "dataAtendimento": "2025-07-07T17:30:45",
    "quantidadeAtendida": 1,
    "valorUnitario": 300,
    "numeroDocumentoERP": 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.