TOTVS AGRO

Páginas filhas
  • API Depósitos
Tempo aproximado para leitura: 6 minutos

 Disponibilizado endpoint para integração do cadastro de Depósito com os métodos GET, POST, PUT, PATCH e DELETE.


Estrutura:

Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

Observação

tipoPonto

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

1

STRING

N

S

A

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

S

-

-

-

descricaoAbreviada

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

10

STRING

N

N

TRUNC(descricao, 10)

-

-

descricao

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

40

STRING

N

S

-

-

-

movelFixo

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

1

STRING

N

S

F

M = Móvel | F = Fixo

-

captaCusto

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

1

STRING

N

S

N

S = Sim | N = Não

-

exportaERP

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

1

STRING

N

S

N

S = Sim | N = Não

-

empresaERP

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

15

STRING

N

N

-

-

-

organizacaoERP

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

15

STRING

N

N

-

-

-

depositoERP

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

15

STRING

N

N

-

-

-

pontoERP

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

12

STRING

N

N

-

-

-

pontoCTF

Código do ponto de abastecimento no CTF

5

NUMBER

N

N

-

-

-

pontoGTFrota

Código do ponto de abastecimento no GTFrota

8

STRING

N

N

-

-

-

tipoRavoTag

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

1

STRING

N

N

-

R = RAVO | T = TAG

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

codigoRavoTag

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

19

STRING

N

N

-

-

-

origem

Origem do ponto de manutenção

1

STRING

N

N

I

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

NUMBER

N

N

-

Prestador de serviço cadastrado e ativo

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

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

N

0

-

Se informado, valor deve ser menor ou igual a 24

dataValidade

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

10

DATE

N

S

31/12/2099

Data válida

-


GET (Consulta Depósitos)

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

Response
{
    "hasNext": true,
    "items": [{
            "instancia": "11",
            "codigo": 1,
            "descricaoAbreviada": "VACO05",
            "descricao": "11-VACO02-DESTILARIA",
            "movelFixo": "M",
            "captaCusto": "S",
            "exportaERP": "S",
            "empresaERP": "101",
            "organizacaoERP": "101",
            "depositoERP": "VIRTCOMB05",
            "pontoERP": "VIRTCOMB05",
            "pontoCTF": null,
            "pontoGTFrota": null,
            "tipoRavoTag": null,
            "codigoRavoTag": null,
            "origem": "T",
            "prestadorServico": 110000,
            "tempoMedioAtendimento": 0,
            "dataValidade": "2999-12-31T00:00:00",
            "rowversion": 94456
        }]
}

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.


POST (Cadastra Depósitos)

http:127.0.0.1:8080/entity/v1/pontoAbast

Estrutura de dados para envio:

Body 
{
    "tipoPonto": "A",
    "instancia": "11",
    "codigo": 2000,
    "descricaoAbreviada": "11070007",
    "descricao": "12-CAM COMB 11070007",
    "movelFixo": "M",
    "captaCusto": "S",
    "exportaERP": "S",
    "empresaERP": "150",
    "organizacaoERP": "150",
    "depositoERP": "VIRTCOMB01",
    "pontoERP": "VIRTCOMB01",
    "pontoCTF": 12,
    "pontoGTFrota": "M002",
    "tipoRavoTag": "R",
    "codigoRavoTag": "900000000000000M002",
    "origem": "C",
    "prestadorServico": null,
    "tempoMedioAtendimento": 0,
    "dataValidade": "2999-12-31T00:00:00"
}

Estrutura de dados retorno:

Response 
{
    "tipoPonto": "A",
    "instancia": "11",
    "codigo": 2000,
    "descricaoAbreviada": "11070007",
    "descricao": "12-CAM COMB 11070007",
    "movelFixo": "M",
    "captaCusto": "S",
    "exportaERP": "S",
    "empresaERP": "150",
    "organizacaoERP": "150",
    "depositoERP": "VIRTCOMB01",
    "pontoERP": "VIRTCOMB01",
    "pontoCTF": 12,
    "pontoGTFrota": "M002",
    "tipoRavoTag": "R",
    "codigoRavoTag": "900000000000000M002",
    "origem": "C",
    "prestadorServico": null,
    "tempoMedioAtendimento": 0,
    "dataValidade": "2999-12-31T00:00:00",
    "rowversion": 1
}


PUT e PATCH (Atualiza Depósitos)

http:127.0.0.1:8080/entity/v1/pontoAbast

Estrutura de dados para envio:

Body 
{
    "tipoPonto": "A",
    "instancia": "11",
    "codigo": 2000,
    "descricaoAbreviada": "11070007",
    "descricao": "12-CAM COMB 11070007",
    "movelFixo": "M",
    "captaCusto": "S",
    "exportaERP": "S",
    "empresaERP": "150",
    "organizacaoERP": "150",
    "depositoERP": "VIRTCOMB01",
    "pontoERP": "VIRTCOMB01",
    "pontoCTF": 12,
    "pontoGTFrota": "M002",
    "tipoRavoTag": "R",
    "codigoRavoTag": "900000000000000M002",
    "origem": "C",
    "prestadorServico": null,
    "tempoMedioAtendimento": 5,
    "dataValidade": "2999-12-31T00:00:00"
}

Estrutura de dados retorno:

Response 
{
    "tipoPonto": "A",
    "instancia": "11",
    "codigo": 2000,
    "descricaoAbreviada": "11070007",
    "descricao": "12-CAM COMB 11070007",
    "movelFixo": "M",
    "captaCusto": "S",
    "exportaERP": "S",
    "empresaERP": "150",
    "organizacaoERP": "150",
    "depositoERP": "VIRTCOMB01",
    "pontoERP": "VIRTCOMB01",
    "pontoCTF": 12,
    "pontoGTFrota": "M002",
    "tipoRavoTag": "R",
    "codigoRavoTag": "900000000000000M002",
    "origem": "C",
    "prestadorServico": null,
    "tempoMedioAtendimento": 5,
    "dataValidade": "2999-12-31T00:00:00"
}


DELETE (Apaga Depósito)

http:127.0.0.1:8080/entity/v1/pontoAbast?codigo=2000

Observações

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