Histórico da Página
...
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 no TA-API-HUB |
codigoCCusto | Código do centro de custo | 20 | STRING | N | N | - | -- | Chave relacionada com tabela de Centro de Custo (será espelhada a partir desta) |
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 | - | -- | 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 | - |
...
- 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)
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": 348,
"codigoEmpresa": 1,
"codigo": "ABC123""API123",
"descricao": "TESTE TA-API-HUB",
"descricaoResumida": "TESTE TA-A",
"referencia": null,
"saldoativo": 50"1"
} |
Estrutura de dados retorno:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": 348,
"descricao": "TESTE TA-API-HUB",
"codigodescricaoResumida": "TESTE "ABC123"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 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 não esteja informado, será utilizado o valor definido no parâmetro default-company-ind.
- O conteúdo do atributo codigoCCusto será sempre desconsiderado e será atribuído o valor do atributo 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 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 e codigo.
- Os atributos codigoEmpresa, codigoCCusto 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)
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"codigo": "ABC123api123",
"tipocodigoCCusto": null,
"codigoEmpresa": null,"XXX",
"descricao": "MATERIALTeste 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
ta-API-Hub"
} |
Estrutura de dados retorno:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"codigo": "ABC123API123",
"tipocodigoCCusto": "MAPI123",
"codigoEmpresa": "1",
"descricao": "MATERIAL TESTE TA-API-HUB",
"descricaoDetalhadaativo": null,
"codigoAlmoxarifado": null,
"descricaoAlmoxarifado": null,
"codigoUnidadeMedida": "UN",
"familia": 1,
"grupo": 10,
"precoUltimaCompracodigoEmpresa": 0,
"situacao": "1",
"saldoid": 0,
"vidaUtil348": 0,
"estocaveldescricaoResumida": null,
"compra": 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 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.
...