Histórico da Página

...

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 YML	-
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

Bloco de código

language	java
title	Response

{
    "hasNext": false,
    "items": [
        {
            "codigo": 1"ABC123",
            "descricaotipo": "TESTE MATERIALM",
            "codigoExternocodigoEmpresa": "1",
            "codigoContaErpdescricao": "1MATERIAL TESTE API-HUB",
            "codigoErpdescricaoDetalhada": "1"null,
            "codigoReferenciacodigoAlmoxarifado": "COD_REF"null,
            "codigoGrupoMaterialdescricaoAlmoxarifado": 2null,
            "codigoUnidadeMedida": "UN",
            "codigoUnidadeMedidaErpfamilia": null"1",
            "fatorConversaoUnidMedidaErpgrupo": null10,
            "exportaPalmprecoUltimaCompra": null0,
            "observacaoIntegracaosituacao": null"1",
            "materialComprasaldo": null0,
            "materialEstoquevidaUtil": null0,
            "materialServicoestocavel": null,
            "indisponibilidadePedOficinacompra": null,
            "materialAtivointegraERP": "S1",
            "classificacaoMaterialprecoMedioUnitario": "M"0,
            "ultimaAtualizacao": null,
            "fabricanteultimaCompra": null,
            "FABlocalizacao": null,
            "marcacategoria": "MAR"null,
            "codigoERP": null,
            "descricaoExternacontaERP": "TESTE MATERIAL"null,
            "rowversiongestaoEstoque": 1null
        }
    ]
}

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 Material Industrial)

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

Estrutura de dados para envio:

Bloco de código

language	java
title	Body
collapse	true

{
	"codigo": 1,
	"descricao": "TESTE MATERIAL",
	"codigoExterno": "1",
	"codigoContaErp"codigo": "1ABC123",
	"codigoErp": "1",
	"codigoReferencia": "COD_REF",
	"codigoGrupoMaterial": 2,
	"codigoUnidadeMedida": "UN",
	"codigoUnidadeMedidaErp"tipo": null,
	"fatorConversaoUnidMedidaErp    "codigoEmpresa": null,
	"exportaPalm": null,
	"observacaoIntegracao": null,
	"materialCompra": null,
	"materialEstoque": null,
	"materialServicocodigoEmpresaERP": null1,
	"indisponibilidadePedOficina": null,
	"materialAtivo": "S",
	"classificacaoMaterial": "M",
	"fabricante": "FAB",
	"marca "descricao": "MAR",
	"descricaoExterna": "TESTE MATERIALMATERIAL TESTE API-HUB",
	"rowversion": null
}

Estrutura de dados retorno:

Bloco de código

language	java
title	Response
collapse	true

{
    "codigodescricaoDetalhada": 1null,
    "descricaocodigoAlmoxarifado": "TESTE MATERIAL"null,
    "codigoExternodescricaoAlmoxarifado": "1"null,
    "codigoContaErpcodigoUnidadeMedida": "1UN",
    "codigoErpfamilia": "1",
    "codigoReferenciagrupo": "COD_REF"10,
    "codigoGrupoMaterialprecoUltimaCompra": 2null,
    "codigoUnidadeMedidasituacao": "UN"null,
    "codigoUnidadeMedidaErpsaldo": null,
    "fatorConversaoUnidMedidaErpvidaUtil": null,
    "exportaPalmestocavel": null,
    "observacaoIntegracaocompra": null,
    "materialCompraintegraERP": null,
    "materialEstoqueprecoMedioUnitario": null,
    "materialServicoultimaAtualizacao": null,
    "indisponibilidadePedOficinaultimaCompra": null,
    "materialAtivolocalizacao": "S"null,
    "classificacaoMaterialcategoria": "M"null,
    "fabricantecodigoERP": "FAB"null,
    "marcacontaERP": "MAR"null,
    "descricaoExternagestaoEstoque": "TESTE MATERIAL",
    "rowversion": 1
}

PUT (Atualiza Material Industrial)

...

null
}

Estrutura de dados para envioretorno:

Bloco de código

language	java
title	BodyResponse
collapse	true

{
    "codigo": 1"ABC123",
    "descricaotipo": "TESTE MATERIALM",
    "codigoExternocodigoEmpresa": "1",
    "codigoContaErpdescricao": "1MATERIAL TESTE API-HUB",
    "codigoErpdescricaoDetalhada": "1"null,
    "codigoReferenciacodigoAlmoxarifado": "COD_REF"null,
    "codigoGrupoMaterialdescricaoAlmoxarifado": 2null,
    "codigoUnidadeMedida": "UN",
    "codigoUnidadeMedidaErpfamilia": null1,
    "fatorConversaoUnidMedidaErpgrupo": null10,
    "exportaPalmprecoUltimaCompra": null0,
    "observacaoIntegracaosituacao": null"1",
    "materialComprasaldo": null0,
    "materialEstoquevidaUtil": null0,
    "materialServicoestocavel": null,
    "indisponibilidadePedOficinacompra": null,
    "materialAtivointegraERP": "S1",
    "classificacaoMaterialprecoMedioUnitario": "M"0,
    "fabricanteultimaAtualizacao": "FAB"null,
    "marcaultimaCompra": "MAR"null,
    "descricaoExternalocalizacao": "TESTE MATERIAL"
}

Estrutura de dados retorno:

Bloco de código

language	java
title	Response
collapse	true

{
null,
    "codigocategoria": 1null,
    "descricaocodigoERP": "TESTE MATERIAL"null,
    "codigoExternocontaERP": "1"null,
    "codigoContaErp": "1",
    "codigoErp": "1",
    "codigoReferencia": "COD_REF",
    "codigoGrupoMaterial": 2,
    "codigoUnidadeMedida": "UN",
    "codigoUnidadeMedidaErp": 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:

Bloco de código

language	java
title	Body
collapse	true

{
    "fatorConversaoUnidMedidaErpcodigo": null,
    "exportaPalm": null"ABC123",
    "observacaoIntegracaosaldo": null,
    "materialCompra": null,50
}

Estrutura de dados retorno:

Bloco de código

language	java
title	Response
collapse	true

{
    "materialEstoquecodigo": null,
    "materialServico": null"ABC123",
    "indisponibilidadePedOficinasaldo": null,
    "materialAtivo": "S",
    "classificacaoMaterial": "M",
    "fabricante": "FAB",
    "marca": "MAR",
    "descricaoExterna": "TESTE MATERIAL"
}50
}

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 (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"):

- 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.

DELETE (Apaga Material Industrial)

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

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 4

Nova versão Atual

Chave

Parâmetros