Histórico da Página

Disponibilizado endpoint para integração do cadastro de Materiais por Empresas com os métodos GET, POST, PUT, PATCH e DELETE.

Estrutura:

SexportaERPNUMBER

Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

Observação

id

tipoPonto

Flag para indicar o tipo do ponto se abastecimento ou manutenção

1

Id

18

INTEGER

SSTRING

N

S-

-

A = Abastecimento | M = Manutenção

-

instancia

Código da instância relacionada ao ponto de abastecimento/manutenção

5

STRING

N

S

-

Instância cadastrada

-

codigo

Código do ponto de abastecimento/manutenção

5

NUMBER

S

-

descricaoAbreviada

Descrição Abreviada do ponto de abastecimento/manutenção

10

STRING

N

S

-

descricao

Descrição Completa do ponto de abastecimento/manutenção

40

STRING

N

Gerado automaticamente no Insert, obrigatório no Update

material

Código do material

12

INTEGER

N

-

Material cadastrado

-

instancia

Código da instância

5

STRING

N

-

Instância cadastrada

-

codigoExterno

Código do parceiro usado para recuperar a instancia.

30

STRING

N

-

deposito

Código do depósito

10

movelFixo

Flag para indicar se o ponto de abastecimento/manutenção é móvel ou fixo

1

STRING

N

S

-

M = Móvel | F = Fixo

-

captaCusto

Apontamentos realizados no ponto de abastecimento/manutenção serão captados pelo CUSTAG

1

STRING

N

S

-

S = Sim | N = Não

-

Apontamentos realizados no ponto de abastecimento/manutenção serão exportados para o ERP

1

STRING

N

S

-

S = Sim | N = Não

-

saldo

Saldo do material

13,4

NUMBER

empresaERP

Código da empresa no ERP relacionada ao ponto de abastecimento/manutenção

15

STRING

N

-

organizacaoERPultimaAtualizacao

Código da organização no ERP relacionada ao ponto de abastecimento/manutenção

15

Data da última atualização

10

DATESTRING

N

-

depositoERP

Código do depósito no ERP relacionado ao ponto de abastecimento/manutenção

15

ultimaCompra

Data da última compra

10

DATESTRING

N

-

pontoERP

valorUnitarioMedio

Valor unitário médio

13,4

NUMBER

Código do ponto de abastecimento/manutenção no ERP

12

STRING

N

-

pontoCTF

Código do ponto de abastecimento no CTF

valorUnitarioReposicao

Valor unitário reposição

13,45

NUMBER

N

-

estocavel

Estocável

1

pontoGTFrota

Código do ponto de abastecimento no GTFrota

8

STRING

N

-

compra

Compra

tipoRavoTag

Forma de identificação RAVO/TAG do ponto de abastecimento no GTFrota

1

STRING

N

-

R = RAVO | T = TAG

Obrigatório quanto tipoPonto = 'A' e MNF_ABAST/ FG_MNF_GTFROTA = 'S'

-

conta

Conta

25

codigoRavoTag

Código de identificação RAVO/TAG do ponto de abastecimento no GTFrota

19

STRING

N

-

origem

Origem do ponto de manutenção

1

STRING

N

-

I = Interna | C = Campo | T = Terceiros | E = Concessionária

Obrigatório quanto tipoPonto = 'M'

prestadorServico

Código do prestador de serviço do ponto de manutenção

8

codigoMaterialERP

Código do material vindo do ERP

20

STRING

tempoMedioAtendimento

Tempo Médio entre a finalização de uma manutenção de um equipamento e o ínicio em outro equipamento

7,2

NUMBER

N

0

N

-

Prestador de serviço cadastrado e ativo

Obrigatório quanto tipoPonto = 'M' e origem = 'T' ou 'E'

dataValidade

Data para inativação do ponto de abastecimento/manutenção

10

DATE

N

S

-

Se informado, valor deve ser menor ou igual a 24

-

Data válida

-

GET (Consulta DepósitosMaterial por Empresa)

http:127.0.0.1:8080/api/entity/v1/pontoAbastmaterialEmpresa?page=1&pagesize=1

Bloco de código

language	java
title	Response

{
    "hasNext": true,
    "items": [{
            "instancia": "11",{
            "codigoid": 1,
            "descricaoAbreviadamaterial": "VACO05"207052,
            "descricaoinstancia": "11-VACO02-DESTILARIA",
            "movelFixodeposito": "MVIRTBORR01",
            "captaCustosaldo": "S"25,
            "exportaERPultimaAtualizacao": "S",
            "empresaERP": "101",
            "organizacaoERP": "101"2023-08-03T00:00:00",
            "depositoERPultimaCompra": "VIRTCOMB05",
            "pontoERP": "VIRTCOMB05",
            "pontoCTF": null,
            "pontoGTFrota": null2024-01-01T00:00:00",
            "tipoRavoTagvalorUnitarioMedio": null10.25,
            "codigoRavoTagvalorUnitarioReposicao": null11.25,
            "origemestocavel": "TN",
            "prestadorServicocompra": 110000,
            "tempoMedioAtendimento": 0"S",
            "dataValidadeconta": "2999-12-31T00:00:00",123.456.789"
            "rowversion": 94456
  }
      }]
}

Parâmetros

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

...

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

- Caso seja informado o codigoExterno, será usado como parâmetro, para a busca, a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

POST (Cadastra DepósitosMaterial por Empresa)

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

Estrutura de dados para envio:

Bloco de código

language	java
title	Body
collapse	true

{
    "tipoPontomaterial": "A"1000,
    "instancia": "11",
    "codigo": 2000,
    "descricaoAbreviadadeposito": "11070007VIRTBORR01",
    "descricaosaldo": "12-CAM COMB 11070007"50,
    "movelFixoultimaAtualizacao": "M",
    "captaCusto": "S",
    "exportaERP": "S2023-08-30T00:00:00",
    "empresaERPultimaCompra": "150",
    "organizacaoERP": "150",
    "depositoERP": "VIRTCOMB012024-01-02T00:00:00",
    "pontoERPvalorUnitarioMedio": "VIRTCOMB01"5.5,
    "pontoCTFvalorUnitarioReposicao": 126.5,
    "pontoGTFrotaestocavel": "M002S",
    "tipoRavoTagcompra": "RN",
    "codigoRavoTagconta": "900000000000000M002",
    "origem": "C",
    "prestadorServico": null,
    "tempoMedioAtendimento": 0,
    "dataValidade": "2999-12-31T00:00:00987.654.321"
}

Estrutura de dados retorno:

Bloco de código

language	java
title	Response
collapse	true

{
    "tipoPontomaterial": "A"1000,
    "instancia": "11",
    "codigodeposito": 2000,
    "descricaoAbreviada": "11070007"VIRTBORR01",
    "descricaosaldo": "12-CAM COMB 11070007"50,
    "movelFixoultimaAtualizacao": "M",
    "captaCusto": "S",
    "exportaERP": "S2023-08-30T00:00:00",
    "empresaERPultimaCompra": "150",
    "organizacaoERP": "150",
    "depositoERP": "VIRTCOMB01"2024-01-02T00:00:00",
    "pontoERPvalorUnitarioMedio": "VIRTCOMB01"5.5,
    "pontoCTFvalorUnitarioReposicao": 126.5,
    "pontoGTFrotaestocavel": "M002S",
    "tipoRavoTagcompra": "RN",
    "codigoRavoTagconta": "900000000000000M002987.654.321",
    "origemid": "C26",
    "prestadorServico": null,
    "tempoMedioAtendimento": 0,
    "dataValidade": "2999-12-31T00:00:00",
    "rowversion": 1
}
}

Observações

- Caso seja informado o codigoExterno, será cadastrado a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

- É obrigatório informar a instancia ou o codigoExterno.

- É obrigatório informar ou o atributo material ou o atributo codigoMaterialERP, ambos serão validados contra a tabela MATERIAIS para verificação de sua existência.

- Será realizada validação para verificar se o registro já não é existente na base, caso sim o mesmo será atualizado, caso não, o mesmo será inserido.

PUT e PATCH (Atualiza Material por EmpresaPUT (Atualiza Depósitos)

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

Estrutura de dados para envio:

Bloco de código

language	java
title	Body
collapse	true

{
    "tipoPontoid": "A"26,
    "instanciamaterial": "11"1000,
    "codigoinstancia": 2000,
    "descricaoAbreviada": "11070007""11",
    "descricaodeposito": "12-CAM COMB 11070007VIRTBORR01",
    "movelFixosaldo": "M"49,
    "captaCustoultimaAtualizacao": "S",
    "exportaERP": "S",
    "empresaERP": "150"2023-08-30T00:00:00",
    "organizacaoERPultimaCompra": "150",
    "depositoERP": "VIRTCOMB01",
    "pontoERP": "VIRTCOMB01"2024-01-02T00:00:00",
    "pontoCTFvalorUnitarioMedio": 125.5,
    "pontoGTFrotavalorUnitarioReposicao": "M002"6.5,
    "tipoRavoTagestocavel": "RS",
    "codigoRavoTagcompra": "900000000000000M002N",
    "origemconta": "C",
    "prestadorServico": null,
    "tempoMedioAtendimento": 5,
    "dataValidade": "2999-12-31T00:00:00"987.654.321"
}

Estrutura de dados retorno:

Bloco de código

language	java
title	Response
collapse	true

{
    "tipoPontoid": "A"26,
    "instanciamaterial": "11"1000,
    "codigoinstancia": 2000,
    "descricaoAbreviada": "11070007""11",
    "descricaodeposito": "12-CAM COMB 11070007VIRTBORR01",
    "movelFixosaldo": "M"49,
    "captaCustoultimaAtualizacao": "S",
    "exportaERP": "S",
    "empresaERP": "1502023-08-30T00:00:00",
    "organizacaoERPultimaCompra": "150",
    "depositoERP": "VIRTCOMB01",
    "pontoERP": "VIRTCOMB012024-01-02T00:00:00",
    "pontoCTFvalorUnitarioMedio": 125.5,
    "pontoGTFrotavalorUnitarioReposicao": "M002"6.5,
    "tipoRavoTagestocavel": "RS",
    "codigoRavoTagcompra": "900000000000000M002N",
    "origemconta": "C987.654.321",
    "prestadorServico": null,
    "tempoMedioAtendimento": 5,
    "dataValidade": "2999-12-31T00:00:00"
}
}

Observações

- Caso seja informado o codigoExterno, será atualizada a instancia referente a ele no Bioenergia. Essa informação sobrepõe a instancia caso ela seja informada.

- É obrigatório informar a instancia ou o codigoExterno.

- É obrigatório informar ou o atributo material ou o atributo codigoMaterialERP, ambos serão validados contra a tabela MATERIAIS para verificação de sua existência.

- Será realizada validação para verificar se o registro já não é existente na base, caso sim o mesmo será atualizado, caso não, o mesmo será inserido.

DELETE (Apaga Material por EmpresaDELETE (Apaga Depósito)

http:127.0.0.1:8080/api/entity/v1/pontoAbastmaterialEmpresa?codigoid=200026

Observações

- É obrigatório informar os atributos que compõem a chave primária como parâmetros da chamada.

...

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Parâmetros