TOTVS AGRO

Páginas filhas
  • API Materiais (Manutenção Industrial)

Versões comparadas

Versão antiga 10

changes.mady.by.user Raul Goulart Rodrigues

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Raul Goulart Rodrigues

Gravado em

Chave

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

...

Atributos

Descrição

Tamanho

Tipo

Chave Primária

Requerido

Valor Default

Valores Válidos

codigo

Código do Material Industrial

13

STRING

S

S

-

-

descricao

Descrição do Material Industrial

60

STRING

N

S

-

-

tipo

Tipo do Material Industrial

1

STRING

N

N

M

M = Material | S = Serviço

codigoEmpresa

Código da Empresa

2

INTEGER

N

N

Empresa padrão

-

codigoEmpresaERP

Código da Empresa no ERP

5

STRING

N

N

-

-

descricaoDetalhada

Detalhamento do Material Industrial

2000

STRING

N

N

-

-

codigoAlmoxarifado

Código do Almoxarifado (Localização física)

10

STRING

N

N

-

-

descricaoAlmoxarifado

Descrição do Almoxarifado

40

STRING

N

N

-

-

codigoUnidadeMedida

Codigo da Unidade de Medida

8

STRING

N

N

-

-

familia

Família do Material Industrial

10

STRING

N

N

-

-

grupo

Grupo do Material Industrial

5

INTEGER

N

N

-

-

precoUltimaCompra

Preço Unit. Última Compra

13,4

NUMBER

N

N

0

-

situacao

Situação do Material Industrial

1

STRING

N

N

1

1 = Ativo | 0 = Inativo

saldo

Saldo

15,4

NUMBER

N

N

0

-

vidaUtil

Vida útil estimada (Meses)

4

INTEGER

N

N

0

-

estocavel

Estocável

1

STRING

N

N

-

-

compra

Compra

1

STRING

N

N

-

-

integraERP

Integra ERP

1

STRING

N

N

1

1 = Sim | 0 = Não

precoMedioUnitario

Preço Médio Unitário

13,4

NUMBER

N

N

0

-

ultimaAtualizacao

Data da última atualização

10

DATE

N

N

-

-

ultimaCompra

Data da última compra

10

DATE

N

N

-

-

localizacao

Localização do Material

10

STRING

N

N

-

-

categoria

Categoria

3

STRING

N

N

-

-

codigoERP

Código ERP

25

STRING

N

N

-

-

contaERP

Conta ERP

25

STRING

N

N

-

-

gestaoEstoque

Gestão de Estoque

1

INTEGER

N

N

-

-

...

GET (Consulta Materiais Industriais)

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

...

POST (Cadastra Material Industrial)

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

Estrutura de dados para envio:

Bloco de código
languagejava
titleBody
collapsetrue
{
    "codigo": "ABC123",
    "tipo": null,
    "codigoEmpresa": null,
    "codigoEmpresaERP": 1,
    "descricao": "MATERIAL TESTE API-HUB",
    "descricaoDetalhada": null,
    "codigoAlmoxarifado": null,
    "descricaoAlmoxarifado": null,
    "codigoUnidadeMedida": "UN",
    "familia": 1,
    "grupo": 10,
    "precoUltimaCompra": null,
    "situacao": null,
    "saldo": null,
    "vidaUtil": null,
    "estocavel": null,
    "compra": null,
    "integraERP": null,
    "precoMedioUnitario": null,
    "ultimaAtualizacao": null,
    "ultimaCompra": null,
    "localizacao": null,
    "categoria": null,
    "codigoERP": null,
    "contaERP": null,
    "gestaoEstoque": null
}

...

Observações

  • Caso o Código da Empresa ERP seja enviado e o Código da Empresa não for enviado, será localizado o código da empresa pelo código da empresa ERP e atribuído ao atributo codigoEmpresa.
  • Caso o Código da Empresa ERP e o Código da Empresa forem enviados, será desconsiderado o código da empresa ERP e acatado o código da empresa.
  • Caso o Código da Empresa ERP e o Código da Empresa não forem enviados, será utilizado o valor definido no parâmetro default-company-ind.
  • A chave estrangeira composta da Família/Grupo será validada pelo banco de dados apenas se os dois campos forem informados.
  • A Família poderá ser informada sem o Grupo porém o Grupo não poderá ser informado sem a Família.
  • Validação da conta contábil (atributo "contaERP"):
    • Caso o parâmetro geral do PIMSMI CON_CTACONTAB for diferente de '1' e o parâmetro "CCONTABIL" da seção "GERAL" também for diferente de '1' não será acatada a conta contábil informada sendo zerado o atributo antes da gravação.
    • Caso o parâmetro "C.CONTABIL" da seção "OS_MATPREVISTO" for diferente de '1' o código da conta contábil informada será validada na tabela do bioenergia através de um sinônimo entre os owners e caso a conta for inválida será mostrada uma mensagem ao usuário e abortada a gravação.

...

PUT/PATCH (Atualiza Material Industrial)

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

Estrutura de dados para envio:

...

  • Quando PATCH poderão ser enviados apenas os atributos que necessitam de atualização e os atributos que compõe a chave primária (conforme exemplo acima).
  • No caso de PUT deverão ser enviados os atributos necessários/obrigatórios e os atributos que compõe a chave primária.
  • Caso o Código da Empresa ERP seja enviado e o Código da Empresa não for enviado, será localizado o código da empresa pelo código da empresa ERP e atribuído ao atributo codigoEmpresa.
  • Caso o Código da Empresa ERP e o Código da Empresa forem enviados, será desconsiderado o código da empresa ERP e acatado o código da empresa.
  • A chave estrangeira composta da Família/Grupo será validada pelo banco de dados apenas se os dois campos forem informados.
  • A Família poderá ser informada sem o Grupo porém o Grupo não poderá ser informado sem a Família.
  • Validação da conta contábil (atributo "contaERP"):

...

DELETE (Apaga Material Industrial)

http:127.0.0.1:8080/api/entity/v1/materiaisInd?codigo=ABC123

...