Páginas filhas
  • API Centro de Custo (Manutenção Industrial)

Versões comparadas

Chave

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

Disponibilizado endpoint para integração do cadastro de Centro de Custo Industrial com os métodos GET, POST, PUT, PATCH e DELETE.

...

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

-

-

Caso não informada será atribuído o código da empresa padrão configurado em default-company-ind.

codigoCCustocodigoEmpresaERP

Código do centro de custoda empresa no ERP

520

STRING

N

N

-

-

-

codigo

Código do subcentro de custo

20

STRING

NN

S

-

-

-

descricao

Descrição do centro/subcentro de custo

40

STRING

NN

S

-

-

-

descricaoResumida

Descrição resumida do centro/subcentro de custo

10

STRING

N

N

-

--

Caso não informada será atribuído o valor do atributo "descricao" limitado a 10 caracteres.

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/api/entity/v1/centroCustosIndustriais?page=1&pagesize=2

Bloco de código
languagejava
titleResponse
{
    "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/api/entity/v1/centroCustosIndustriais

...

Bloco de código
languagejava
titleBody
collapsetrue
{
	"id": 348,
    "codigoEmpresa": null, 
    "codigoEmpresaERP": 1,
    "codigo": "API123",
    "descricao": "ABC123"TESTE TA-API-HUB",
    "descricaoResumida": "TESTE TA-A",
    "referencia": null,
    "saldoativo": 50"1"
}

Estrutura de dados retorno:

Bloco de código
languagejava
titleResponse
collapsetrue
{
    "codigo": "ABC123"id": 348,
    "descricao": "TESTE TA-API-HUB",
    "descricaoResumida": "TESTE TA-A",
    "referencia": null,
    "saldoativo": 50"1"
}

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 acimaid ou codigoEmpresa+codigo).
  • No caso de PUT deverão ser enviados os atributos que necessitam de atualização, bem como 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.
  • (id ou codigoEmpresa+codigo).
  • Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado.
  • Caso o atributo codigoEmpresaERP seja informado, ele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
  • O centro de custo será localizado seguindo a seguinte regra:
    • Caso o atributo id esteja informado, o centro de custo será localizado pelo atributo id e os atributos codigoEmpresa/codigoEmpresaERP e codigo serão ignorados mesmo sendo informados.
    • Caso o atributo id não esteja informado, o centro de custo será localizado pelos atributos codigoEmpresa/codigoEmpresaERP e codigo.
  • Os atributos codigoEmpresa e codigo não serão alterados mesmo sendo informados.
  • Caso o atributo descricao esteja informado e o atributo descricaoResumida não esteja informado, será atribuído o valor do atributo descricao ao atributo descricaoResumida limitado a 10 caracteres
  • 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/api/entity/v1/centroCustosIndustriais

...

Bloco de código
languagejava
titleBody
collapsetrue
{
    "codigo": "ABC123api123",
    "tipo": null,
    "codigoEmpresa": null,
    "descricao": "MATERIALTeste TESTE ta-API-HUBHub",
    "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
codigoEmpresaERP": 1
}

Estrutura de dados retorno:

Bloco de código
languagejava
titleResponse
collapsetrue
{
    "codigo": "ABC123API123",
    "tipo": "M",
    "codigoEmpresa": "1",
    "descricao": "MATERIAL TESTE TA-API-HUB",
    "descricaoDetalhada": null,
    "codigoAlmoxarifadoativo": null,
    "descricaoAlmoxarifado": null,
    "codigoUnidadeMedida": "UN",
    "familia": 1,
    "grupo": 10,
    "precoUltimaCompracodigoEmpresa": 0,
    "situacao": "1",
    "saldoid": 0,
    "vidaUtil348": 0,
    "estocavel": null,
    "compradescricaoResumida": null,
    "integraERP": "1",
    "precoMedioUnitario": 0,
    "ultimaAtualizacao": null,
    "ultimaCompra": null,
    "localizacao": null,
    "categoria": null,
    "codigoERP": null,
    "contaERP": null,
    "gestaoEstoque": null
"TESTE TA-A"
}

Observações

  • Caso o Código da Empresa não for enviadoos atributos codigoEmpresa e codigoEmpresaERP não forem informados, será utilizado como default 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.
  • Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado.
  • Caso o atributo codigoEmpresaERP seja informado, ele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
  • Os atributos codigo e descricao deverão ser informados.
  • O conteúdo do atributo id será sempre desconsiderado caso informado e gerado um novo.
  • Caso o atributo descricaoResumida não esteja informado, será atribuído o valor do atributo descricao ao atributo descricaoResumida limitado a 10 caracteres.
  • Caso já exista um centro de custo para a chave codigoEmpresa/codigoEmpresaERP+codigo informada não será permitida a inclusão e um aviso será mostradoValidaçã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)

...

Método DELETE:

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

Parâmetros

  • Caso o atributo codigoEmpresa seja informado, o codigoEmpresaERP será sempre desconsiderado.
  • Caso o atributo codigoEmpresaERP seja informado, ele será utilizado para localizar e atribuir o código da empresa no atributo codigoEmpresa.
  • Deverão ser informados os atributos que compõe a chave primária (id ou codigoEmpresa/codigoEmpresaERP+codigo).
  • O centro de custo será localizado seguindo a seguinte regra:
    • Caso o atributo id esteja informado, o centro de custo será localizado pelo atributo id e os atributos codigoEmpresa/codigoEmpresaERP e codigo serão ignorados mesmo sendo informados.
    • Caso o atributo id não esteja informado, o centro de custo será localizado pelos atributos codigoEmpresa/codigoEmpresaERP e codigo
    Deverá ser informado o mesmo id referente ao registro de solicitação que foi capturado no método GET
    • .