API Centro de Custo (Manutenção Industrial)

Disponibilizado endpoint para integração do cadastro de Centro de Custo 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	-	-	Caso não informada será atribuído o código da empresa padrão configurado em default-company-ind.
codigoEmpresaERP	Código da empresa no ERP	5	STRING	N	N	-	-	-
codigo	Código do subcentro de custo	20	STRING	N	S	-	-	-
descricao	Descrição do centro/subcentro de custo	40	STRING	N	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

Response

{
    "hasNext": true,
    "items": [
        {
            "id": 203,
            "codigoEmpresa": 1,
            "codigo": "30",
            "descricao": "ALIMENTAÇÃO",
            "descricaoResumida": "ALIMENTAÇÃ",
            "referencia": null,
            "ativo": "0"
        },
        {
            "id": 208,
            "codigoEmpresa": 1,
            "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

Estrutura de dados para envio:

Body

{
	"id": 348,
    "codigoEmpresa": null, 
    "codigoEmpresaERP": 1,
    "codigo": "API123",
    "descricao": "TESTE TA-API-HUB",
    "descricaoResumida": "TESTE TA-A",
    "referencia": null,
    "ativo": "1"
}

Estrutura de dados retorno:

Response

{
    "id": 348,
    "descricao": "TESTE TA-API-HUB",
    "descricaoResumida": "TESTE TA-A",
    "referencia": null,
    "ativo": "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 (id ou codigoEmpresa+codigo).
No caso de PUT deverão ser enviados os atributos que necessitam de atualização, bem como os atributos obrigatórios e os atributos que compõe a chave primária (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.

POST (Insere Centro de Custo Industrial)

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

Estrutura de dados para envio:

Body

{
    "codigo": "api123",
    "descricao": "Teste ta-API-Hub",
    "codigoEmpresaERP": 1
}

Estrutura de dados retorno:

Response

{
    "codigo": "API123",
    "descricao": "TESTE TA-API-HUB",
    "ativo": "1",
    "codigoEmpresa": "1",
    "id": "348",
    "descricaoResumida": "TESTE TA-A"
}

Observações

Caso os atributos codigoEmpresa e codigoEmpresaERP não forem informados, será utilizado como default o valor definido no parâmetro default-company-ind.
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á mostrado.

DELETE (Exclui Centro de Custo Industrial)

Disponibilizado endpoint para excluir o Centro de Custo.

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.

Páginas filhas

API Centro de Custo (Manutenção Industrial)