Exibir origem

Disponibilizado endpoint para integração do cadastro de Centro de Custo Industrial 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
id	Id único para rastreamento do registro de ponta a ponta	12	NUMBER	S	N	-	-	Gerado automaticamente quando o registro é inserido na tabela
codigoEmpresa	Código da empresa	2	NUMBER	N	N	-	-	-
codigoCCusto	Código do centro de custo	20	STRING	N	N	-	-	-
codigo	Código do subcentro de custo	20	STRING	N	N	-	-	-
descricao	Descrição do centro/subcentro de custo	40	STRING	N	N	-	-	-
descricaoResumida	Descrição resumida do centro/subcentro de custo	10	STRING	N	N	-	-	-
referencia	Referência do subcentro de custo	20	STRING	N	N	-	-	-
ativo	Situação do subcentro de custo	1	STRING	N	N	"1"	0 = Inativo 1 = Ativo	-

GET (Consulta Centro de Custo Industrial)

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

{
    "hasNext": true,
    "items": [
        {
            "id": 203,
            "codigoEmpresa": 1,
            "codigoCCusto": "1",
            "codigo": "30",
            "descricao": "ALIMENTAÇÃO",
            "descricaoResumida": "ALIMENTAÇÃ",
            "referencia": null,
            "ativo": "0"
        },
        {
            "id": 208,
            "codigoEmpresa": 1,
            "codigoCCusto": "6",
            "codigo": "10",
            "descricao": "ANÁLISE CANA DE AÇÚCAR",
            "descricaoResumida": "ANÁLISE CA",
            "referencia": null,
            "ativo": "1"
        }
    ]
}

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.

PUT/PATCH (Modifica Centro de Custo Industrial)

http:127.0.0.1:8080/entity/v1/centroCustosIndustriais

Estrutura de dados para envio:

{
    "codigo": "ABC123",
    "saldo": 50
}

Estrutura de dados retorno:

{
    "codigo": "ABC123",
    "saldo": 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.
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.

POST (Insere Centro de Custo Industrial)

http:127.0.0.1:8080/entity/v1/centroCustosIndustriais

Estrutura de dados para envio:

{
    "codigo": "ABC123",
    "tipo": null,
    "codigoEmpresa": null,
    "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
}

Estrutura de dados retorno:

{
    "codigo": "ABC123",
    "tipo": "M",
    "codigoEmpresa": "1",
    "descricao": "MATERIAL TESTE API-HUB",
    "descricaoDetalhada": null,
    "codigoAlmoxarifado": null,
    "descricaoAlmoxarifado": null,
    "codigoUnidadeMedida": "UN",
    "familia": 1,
    "grupo": 10,
    "precoUltimaCompra": 0,
    "situacao": "1",
    "saldo": 0,
    "vidaUtil": 0,
    "estocavel": null,
    "compra": null,
    "integraERP": "1",
    "precoMedioUnitario": 0,
    "ultimaAtualizacao": null,
    "ultimaCompra": null,
    "localizacao": null,
    "categoria": null,
    "codigoERP": null,
    "contaERP": null,
    "gestaoEstoque": null
}

Observações

Caso o Código da Empresa não for enviado, 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.

DELETE (Exclui Centro de Custo Industrial)

Disponibilizado endpoint para excluir o Centro de Custo.

Método DELETE:

http:127.0.0.1:8080/entity/v1/centroCustosIndustriais

Parâmetros

Deverá ser informado o mesmo id referente ao registro de solicitação que foi capturado no método GET.