getAll — Processo
/go/processoGo
GET
Retorna todos os processos orçamentários da empresa vinculada ao token.
URL
https://api.grupoadvis.com.br/go/processoGo/getAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/processoGo/getAll", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/processoGo/getAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "nome": "Orçamento Anual 2026", "moeda": "BRL" },
{ "id": 2, "nome": "Orçamento Revisado 2026", "moeda": "USD" }
]
}
getById — Processo
/go/processoGo
GET
Retorna um processo específico pelo ID. Substitua ID pelo ID do processo, os quais você pode obter em /go/processoGo/getAll.
URL
https://api.grupoadvis.com.br/go/processoGo/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/processoGo/getById/ID", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/processoGo/getById/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "nome": "Orçamento Anual 2026", "moeda": "BRL" }
]
}
insert — Processo
/go/processoGo
POST
Cria um novo processo orçamentário para a empresa vinculada ao token.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "nome" | String | Único por empresa. |
| "moeda" | String | Opcional. Código ISO 4217 de 3 letras maiúsculas (ex: BRL, USD, EUR). Padrão: BRL. |
URL
https://api.grupoadvis.com.br/go/processoGo/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/processoGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Orçamento Anual 2026",
"moeda": "BRL"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/processoGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Orçamento Anual 2026",
"moeda": "BRL"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 10
}
}
update — Processo
/go/processoGo
PUT
Atualiza um processo existente. Substitua ID pelo ID do processo. Envie apenas os campos que deseja alterar.
| Campo | Tipo | Observação |
| "nome" | String | Opcional. Novo nome único do processo. |
| "moeda" | String | Opcional. Código ISO 4217 de 3 letras maiúsculas (ex: USD, EUR). |
URL
https://api.grupoadvis.com.br/go/processoGo/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/processoGo/update/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Orçamento Revisado 2026",
"moeda": "USD"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/processoGo/update/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Orçamento Revisado 2026",
"moeda": "USD"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
delete — Processo
/go/processoGo
DELETE
Exclui um processo. Substitua ID pelo ID do processo. Retorna 409 se o processo possuir períodos vinculados — remova-os antes.
URL
https://api.grupoadvis.com.br/go/processoGo/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/processoGo/delete/ID", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/processoGo/delete/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
getByProcess — Período
/go/periodoGo
GET
Retorna todos os períodos de um processo. Substitua ID pelo ID do processo, os quais você pode obter em /go/processoGo/getAll.
URL
https://api.grupoadvis.com.br/go/periodoGo/getByProcess/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/periodoGo/getByProcess/ID", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/periodoGo/getByProcess/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_processo": 1, "nome": "1º Semestre 2026", "data_inicio": "2026-01-01 00:00:00", "data_fim": "2026-06-30 00:00:00" },
{ "id": 2, "id_go_processo": 1, "nome": "2º Semestre 2026", "data_inicio": "2026-07-01 00:00:00", "data_fim": "2026-12-31 00:00:00" }
]
}
getById — Período
/go/periodoGo
GET
Retorna um período específico pelo ID. Substitua ID pelo ID do período.
URL
https://api.grupoadvis.com.br/go/periodoGo/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/periodoGo/getById/ID", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/periodoGo/getById/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_processo": 1, "nome": "1º Semestre 2026", "data_inicio": "2026-01-01 00:00:00", "data_fim": "2026-06-30 00:00:00" }
]
}
insert — Período
/go/periodoGo
POST
Cria um novo período para um processo orçamentário. Retorna 409 se o intervalo de datas se sobrepuser a um período já existente no mesmo processo.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "id_go_processo" | Integer | ID do processo pai. Deve pertencer à empresa do token. |
| "nome" | String | Nome do período. |
| "data_inicio" | String | Formato YYYY-MM-DD ou YYYY-MM-DD HH:MM:SS. |
| "data_fim" | String | Formato YYYY-MM-DD ou YYYY-MM-DD HH:MM:SS. Deve ser posterior a data_inicio. |
URL
https://api.grupoadvis.com.br/go/periodoGo/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/periodoGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo": 1,
"nome": "1º Semestre 2026",
"data_inicio": "2026-01-01",
"data_fim": "2026-06-30"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/periodoGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"id_go_processo": 1,
"nome": "1º Semestre 2026",
"data_inicio": "2026-01-01",
"data_fim": "2026-06-30"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 5
}
}
update — Período
/go/periodoGo
PUT
Atualiza um período existente. Substitua ID pelo ID do período. Envie apenas os campos que deseja alterar. Retorna 409 se o novo intervalo sobrepuser outro período do mesmo processo.
| Campo | Tipo | Observação |
| "nome" | String | Opcional. Novo nome do período. |
| "data_inicio" | String | Opcional. Formato YYYY-MM-DD ou YYYY-MM-DD HH:MM:SS. |
| "data_fim" | String | Opcional. Formato YYYY-MM-DD ou YYYY-MM-DD HH:MM:SS. Deve ser posterior a data_inicio. |
URL
https://api.grupoadvis.com.br/go/periodoGo/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/periodoGo/update/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "1º Semestre 2026 (revisado)",
"data_fim": "2026-07-31"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/periodoGo/update/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "1º Semestre 2026 (revisado)",
"data_fim": "2026-07-31"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
delete — Período
/go/periodoGo
DELETE
Exclui um período. Substitua ID pelo ID do período. Retorna 409 se o período possuir lançamentos de planejamento ou resultado vinculados — remova-os antes.
URL
https://api.grupoadvis.com.br/go/periodoGo/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/periodoGo/delete/ID", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/periodoGo/delete/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
getAll — Conta
/go/contaGo
GET
Retorna todas as contas não bloqueadas da empresa vinculada ao token em formato de árvore hierárquica, ordenadas por ID. Cada nó contém o campo filhos com as contas filhas aninhadas. Suporta paginação via parâmetros limit e offset na URL.
URL
https://api.grupoadvis.com.br/go/contaGo/getAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/getAll", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/contaGo/getAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 10, "id_go_conta": null, "nome": "Receita Operacional", "codigo": "1.0", "observacao": null, "tipo": 0, "bloqueada": 0,
"filhos": [
{ "id": 15, "id_go_conta": 10, "nome": "Receita de Vendas", "codigo": "1.1", "observacao": "Vendas do período", "tipo": 0, "bloqueada": 0, "filhos": [] }
]
}
]
}
getById — Conta
/go/contaGo
GET
Retorna uma conta específica pelo ID, incluindo contas bloqueadas. Substitua ID pelo ID da conta. O parâmetro withChildren=true retorna a conta e todos os seus descendentes em formato de árvore hierárquica com o campo filhos, utilizando uma única query WITH RECURSIVE. Sem o parâmetro, retorna apenas o nó raiz.
URL
https://api.grupoadvis.com.br/go/contaGo/getById/ID?withChildren=true
JavaScript
// withChildren=true retorna árvore hierárquica com campo 'filhos'
// Remova o parâmetro para retornar apenas o nó raiz (lista simples)
fetch("https://api.grupoadvis.com.br/go/contaGo/getById/ID?withChildren=true", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/contaGo/getById/ID?withChildren=true' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON — com withChildren=true
{
"response": [
{
"id": 10, "id_go_conta": null, "nome": "Receita Operacional", "codigo": "1.0", "observacao": null, "tipo": 0, "bloqueada": 0,
"filhos": [
{ "id": 15, "id_go_conta": 10, "nome": "Receita de Vendas", "codigo": "1.1", "observacao": null, "tipo": 0, "bloqueada": 0, "filhos": [] }
]
}
]
}
getByCodigo — Conta
/go/contaGo
GET
Idêntico ao getById, mas identifica a conta pelo código. Substitua CODIGO pelo código da conta. O parâmetro withChildren=true retorna a conta e todos os seus descendentes em formato de árvore hierárquica com o campo filhos.
URL
https://api.grupoadvis.com.br/go/contaGo/getByCodigo/CODIGO?withChildren=true
JavaScript
// withChildren=true retorna árvore hierárquica com campo 'filhos'
// Remova o parâmetro para retornar apenas o nó raiz (lista simples)
fetch("https://api.grupoadvis.com.br/go/contaGo/getByCodigo/CODIGO?withChildren=true", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/contaGo/getByCodigo/CODIGO?withChildren=true' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON — com withChildren=true
{
"response": [
{
"id": 10, "id_go_conta": null, "nome": "Receita Operacional", "codigo": "1.0", "observacao": null, "tipo": 0, "bloqueada": 0,
"filhos": [
{ "id": 15, "id_go_conta": 10, "nome": "Receita de Vendas", "codigo": "1.1", "observacao": null, "tipo": 0, "bloqueada": 0, "filhos": [] }
]
}
]
}
getWithoutGroup — Conta
/go/contaGo
GET
Retorna todas as contas não bloqueadas que não estão associadas a nenhum grupo de contas, ordenadas por ID. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/contaGo/getWithoutGroup
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/getWithoutGroup", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/contaGo/getWithoutGroup' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 30, "id_go_conta": null, "nome": "Despesa Administrativa", "codigo": "3.0", "observacao": null, "tipo": 1, "bloqueada": 0 },
{ "id": 35, "id_go_conta": 30, "nome": "Despesa com Pessoal", "codigo": "3.1", "observacao": null, "tipo": 1, "bloqueada": 0 }
]
}
getByGroup — Conta
/go/contaGo
GET
Retorna as contas não bloqueadas de um grupo específico, ordenadas por ID. Substitua ID_GRUPO pelo ID do grupo, os quais você pode obter em /go/grupoContaGo/getAll. O campo adicional ordem indica a posição de cadastro da conta no grupo.
URL
https://api.grupoadvis.com.br/go/contaGo/getByGroup/ID_GRUPO
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/getByGroup/ID_GRUPO", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/contaGo/getByGroup/ID_GRUPO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 10, "id_go_conta": null, "nome": "Receita Operacional", "codigo": "1.0", "observacao": null, "tipo": 0, "bloqueada": 0, "ordem": 1 },
{ "id": 15, "id_go_conta": 10, "nome": "Receita de Vendas", "codigo": "1.1", "observacao": null, "tipo": 0, "bloqueada": 0, "ordem": 2 }
]
}
getByGroupCodigo — Conta
/go/contaGo
GET
Idêntico ao getByGroup, mas identifica o grupo pelo código. Substitua CODIGO_GRUPO pelo código do grupo.
URL
https://api.grupoadvis.com.br/go/contaGo/getByGroupCodigo/CODIGO_GRUPO
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/getByGroupCodigo/CODIGO_GRUPO", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/contaGo/getByGroupCodigo/CODIGO_GRUPO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 10, "id_go_conta": null, "nome": "Receita Operacional", "codigo": "1.0", "observacao": null, "tipo": 0, "bloqueada": 0, "ordem": 1 },
{ "id": 15, "id_go_conta": 10, "nome": "Receita de Vendas", "codigo": "1.1", "observacao": null, "tipo": 0, "bloqueada": 0, "ordem": 2 }
]
}
getBlocked — Conta
/go/contaGo
GET
Retorna todas as contas bloqueadas (lixeira) da empresa, ordenadas por ID. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/contaGo/getBlocked
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/getBlocked", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/contaGo/getBlocked' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 20, "id_go_conta": null, "nome": "Conta Obsoleta", "codigo": "9.0", "observacao": null, "tipo": 1, "bloqueada": 1 },
{ "id": 21, "id_go_conta": 20, "nome": "Sub-conta Obsoleta", "codigo": "9.1", "observacao": null, "tipo": 1, "bloqueada": 1 }
]
}
insert — Conta
/go/contaGo
POST
Cria uma nova conta para a empresa vinculada ao token. Contas filhas herdam automaticamente os grupos da conta pai. O histórico de criação é registrado.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "nome" | String | Máximo 255 caracteres. |
| "codigo" | String | Máximo 255 caracteres. Único por empresa. |
| "tipo" | Integer | Opcional. 0 = credora, 1 = devedora. Padrão: 0. |
| "id_go_conta" | Integer | Opcional. ID da conta pai. Deve pertencer à empresa. |
| "observacao" | String | Opcional. Texto livre. |
| "id_go_grupo" | Integer | Opcional. Associa automaticamente ao grupo informado. |
URL
https://api.grupoadvis.com.br/go/contaGo/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Receita Operacional",
"codigo": "1.0",
"tipo": 0,
"observacao": "Conta principal de receitas"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/contaGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Receita Operacional",
"codigo": "1.0",
"tipo": 0,
"observacao": "Conta principal de receitas"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 10
}
}
update — Conta
/go/contaGo
PUT
Atualiza uma conta existente não bloqueada. Substitua ID pelo ID da conta. Envie apenas os campos que deseja alterar. Defina id_go_conta como null para remover a conta pai. Valida contra loops hierárquicos. O histórico de alterações é registrado.
| Campo | Tipo | Observação |
| "nome" | String | Opcional. Máximo 255 caracteres. |
| "codigo" | String | Opcional. Máximo 255 caracteres. Único por empresa. |
| "tipo" | Integer | Opcional. 0 = credora, 1 = devedora. |
| "id_go_conta" | Integer|null | Opcional. ID da conta pai ou null para remover. |
| "observacao" | String|null | Opcional. Texto livre. |
URL
https://api.grupoadvis.com.br/go/contaGo/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/update/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Receita Operacional (revisada)",
"tipo": 0
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/contaGo/update/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Receita Operacional (revisada)",
"tipo": 0
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
updateByCodigo — Conta
/go/contaGo
PUT
Idêntico ao update por ID, mas identifica a conta pelo código. Substitua CODIGO pelo código atual da conta. Aceita os mesmos campos no body.
URL
https://api.grupoadvis.com.br/go/contaGo/updateByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/updateByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Receita Operacional (revisada)"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/contaGo/updateByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Receita Operacional (revisada)"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
block — Conta
/go/contaGo
PUT
Bloqueia (exclusão lógica) uma conta e todas as suas contas filhas recursivamente. Substitua ID pelo ID da conta. Retorna 409 se a conta já estiver bloqueada.
URL
https://api.grupoadvis.com.br/go/contaGo/block/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/block/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/contaGo/block/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
blockByCodigo — Conta
/go/contaGo
PUT
Idêntico ao block por ID, mas identifica a conta pelo código. Substitua CODIGO pelo código da conta.
URL
https://api.grupoadvis.com.br/go/contaGo/blockByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/blockByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/contaGo/blockByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblock — Conta
/go/contaGo
PUT
Desbloqueia uma conta. Substitua ID pelo ID da conta. Envie includeChildren: true no body para desbloquear também as contas filhas. Retorna 409 se a conta não estiver bloqueada.
| Campo | Tipo | Observação |
| "includeChildren" | Boolean | Opcional. Padrão: false. Se true, desbloqueia também as filhas. |
URL
https://api.grupoadvis.com.br/go/contaGo/unblock/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/unblock/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"includeChildren": true
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/contaGo/unblock/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"includeChildren": true
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblockByCodigo — Conta
/go/contaGo
PUT
Idêntico ao unblock por ID, mas identifica a conta pelo código. Substitua CODIGO pelo código da conta. Aceita os mesmos campos no body.
URL
https://api.grupoadvis.com.br/go/contaGo/unblockByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/unblockByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"includeChildren": true
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/contaGo/unblockByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"includeChildren": true
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
delete — Conta
/go/contaGo
DELETE
Exclui permanentemente uma conta. Somente contas bloqueadas podem ser excluídas. Substitua ID pelo ID da conta. Retorna 409 se a conta possuir contas filhas, associações com grupos ou referências em planejamentos.
URL
https://api.grupoadvis.com.br/go/contaGo/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/delete/ID", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/contaGo/delete/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
deleteByCodigo — Conta
/go/contaGo
DELETE
Idêntico ao delete por ID, mas identifica a conta pelo código. Substitua CODIGO pelo código da conta.
URL
https://api.grupoadvis.com.br/go/contaGo/deleteByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/deleteByCodigo/CODIGO", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/contaGo/deleteByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
clearTrash — Conta
/go/contaGo
DELETE
Exclui permanentemente todas as contas bloqueadas que podem ser excluídas. Contas com dependências (filhas, grupos ou planejamentos) são ignoradas e contabilizadas em skipped.
URL
https://api.grupoadvis.com.br/go/contaGo/clearTrash
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/clearTrash", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/contaGo/clearTrash' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"deleted": 3,
"skipped": 1
}
}
unblockAll — Conta
/go/contaGo
PUT
Desbloqueia todas as contas bloqueadas da empresa de uma vez, restaurando-as da lixeira. O campo restored na resposta indica quantas contas foram restauradas.
URL
https://api.grupoadvis.com.br/go/contaGo/unblockAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/unblockAll", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/contaGo/unblockAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"restored": 5
}
}
addToGroup — Conta
/go/contaGo
POST
Associa uma conta a um grupo. As contas filhas são automaticamente adicionadas ao grupo. Se uma conta já estiver associada ao grupo, a duplicação é ignorada.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "id_go_grupo" | Integer | ID do grupo. Deve pertencer à empresa. |
| "id_go_conta" | Integer | ID da conta. Deve pertencer à empresa. |
URL
https://api.grupoadvis.com.br/go/contaGo/addToGroup
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/addToGroup", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_grupo": 1,
"id_go_conta": 10
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/contaGo/addToGroup' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"id_go_grupo": 1,
"id_go_conta": 10
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success"
}
}
removeFromGroup — Conta
/go/contaGo
POST
Remove uma conta de um grupo. Retorna 409 se a conta pai ainda estiver associada ao grupo. Envie includeChildren: true para remover também as contas filhas.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "id_go_grupo" | Integer | ID do grupo. |
| "id_go_conta" | Integer | ID da conta. |
| "includeChildren" | Boolean | Opcional. Padrão: false. Se true, remove também as filhas. |
URL
https://api.grupoadvis.com.br/go/contaGo/removeFromGroup
JavaScript
fetch("https://api.grupoadvis.com.br/go/contaGo/removeFromGroup", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_grupo": 1,
"id_go_conta": 10,
"includeChildren": true
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/contaGo/removeFromGroup' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"id_go_grupo": 1,
"id_go_conta": 10,
"includeChildren": true
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success"
}
}
getAll — Grupo de Conta
/go/grupoContaGo
GET
Retorna todos os grupos de contas da empresa vinculada ao token, ordenados por código. Suporta paginação via parâmetros limit e offset na URL.
URL
https://api.grupoadvis.com.br/go/grupoContaGo/getAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/grupoContaGo/getAll", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/grupoContaGo/getAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "nome": "Receitas", "codigo": "GRP-01" },
{ "id": 2, "nome": "Despesas Fixas", "codigo": "GRP-02" }
]
}
getById — Grupo de Conta
/go/grupoContaGo
GET
Retorna um grupo de contas pelo ID. Substitua ID pelo ID do grupo, os quais você pode obter em /go/grupoContaGo/getAll.
URL
https://api.grupoadvis.com.br/go/grupoContaGo/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/grupoContaGo/getById/ID", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/grupoContaGo/getById/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "nome": "Receitas", "codigo": "GRP-01" }
]
}
getByCodigo — Grupo de Conta
/go/grupoContaGo
GET
Retorna um grupo de contas pelo código. Substitua CODIGO pelo código do grupo.
URL
https://api.grupoadvis.com.br/go/grupoContaGo/getByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/grupoContaGo/getByCodigo/CODIGO", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/grupoContaGo/getByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "nome": "Receitas", "codigo": "GRP-01" }
]
}
insert — Grupo de Conta
/go/grupoContaGo
POST
Cria um novo grupo de contas para a empresa vinculada ao token.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "nome" | String | Máximo 255 caracteres. |
| "codigo" | String | Máximo 50 caracteres. Único por empresa. |
URL
https://api.grupoadvis.com.br/go/grupoContaGo/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/grupoContaGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Receitas",
"codigo": "GRP-01"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/grupoContaGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Receitas",
"codigo": "GRP-01"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 1
}
}
update — Grupo de Conta
/go/grupoContaGo
PUT
Atualiza um grupo de contas existente. Substitua ID pelo ID do grupo. Envie apenas os campos que deseja alterar.
| Campo | Tipo | Observação |
| "nome" | String | Opcional. Máximo 255 caracteres. |
| "codigo" | String | Opcional. Máximo 50 caracteres. Único por empresa. |
URL
https://api.grupoadvis.com.br/go/grupoContaGo/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/grupoContaGo/update/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Receitas Operacionais",
"codigo": "GRP-01A"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/grupoContaGo/update/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Receitas Operacionais",
"codigo": "GRP-01A"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
updateByCodigo — Grupo de Conta
/go/grupoContaGo
PUT
Idêntico ao update por ID, mas identifica o grupo pelo código. Substitua CODIGO pelo código atual do grupo. Aceita os mesmos campos no body.
URL
https://api.grupoadvis.com.br/go/grupoContaGo/updateByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/grupoContaGo/updateByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Receitas Operacionais"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/grupoContaGo/updateByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Receitas Operacionais"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
delete — Grupo de Conta
/go/grupoContaGo
DELETE
Exclui um grupo de contas e remove automaticamente todas as associações entre o grupo e as contas (registros da tabela de junção). Substitua ID pelo ID do grupo.
URL
https://api.grupoadvis.com.br/go/grupoContaGo/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/grupoContaGo/delete/ID", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/grupoContaGo/delete/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
Centro de Resultado e Dimensão adicional
/go/centroResultadoGo
O centro de resultado (CR) é o eixo organizacional do orçamento: toda configuração de planejamento (orçado) e todo lançamento de resultado (realizado) é gravado por conta × centro de resultado, mês a mês. É um cadastro plano (sem hierarquia), com código único por empresa, filial e departamento opcionais e a mesma lixeira de Conta e Produto.
A dimensão adicional é uma granularidade opcional que acompanha o mesmo fato, ao lado da conta e do CR. Tem o mesmo formato de cadastro do CR (nome, código único por empresa, filial, departamento, observação e lixeira) e vínculo opcional N:N com os centros de resultado — um CR com dimensões vinculadas é dito dimensionado. No fato, dimensão vazia significa "sem dimensão", e não "todas".
| Nesta API | Centro de Resultado | Dimensão adicional |
| Cadastro | Endpoints abaixo | /go/dimensaoResultadoGo — cadastro, lixeira e o vínculo N:N com o CR |
| Planejamento e Importação de Resultados | Obrigatório: id_go_centro_resultado / centro_codigo e o segmento centro/CENTRO das URLs | Opcional: sufixo /dimensao/DIMENSAO na URL ou dimensao_codigo / id_go_dimensao_resultado no corpo. Ausente = fatia sem dimensão. As leituras devolvem dimensao_codigo e dimensao_nome |
| Indicadores Fórmula | go_config.centrosResultado | go_config.dimensoesResultado — lista vazia ou ausente = sem filtro |
Centros de resultado dimensionados
Num CR dimensionado a fatia sem dimensão é o Acumulado somente-leitura, que prevalece sobre a soma das dimensões nos totais: escrever sem informar dimensão nesse centro é recusado com 409 (sem_dimensao_nao_editavel) em vez de gravar no Acumulado. Toda operação alcança exatamente uma fatia — a informada, ou a fatia sem dimensão quando nada é informado — e nunca "todas". A dimensão precisa existir na empresa e estar disponível naquele centro pela regra vínculo ∪ metodologia, senão a resposta é 412. Quais centros são dimensionados você consulta em vinculos ou no SIG, em Gestão Orçamentária > Cadastros.
getAll — Centro de Resultado
/go/centroResultadoGo
GET
Retorna todos os centros de resultado não bloqueados da empresa vinculada ao token, ordenados por ID. Suporta paginação via parâmetros limit e offset na URL. Os campos id_filial e id_departamento referenciam os registros de /company/getBranches e /company/getDepartments e podem ser null.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/getAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/getAll", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/getAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "id_filial": 1, "id_departamento": 3, "nome": "Comercial", "codigo": "CR-001", "observacao": "Centro de resultado da área comercial", "bloqueada": 0 },
{ "id": 6, "id_filial": 1, "id_departamento": null, "nome": "Administrativo", "codigo": "CR-002", "observacao": null, "bloqueada": 0 }
]
}
getAllIncludingBlocked — Centro de Resultado
/go/centroResultadoGo
GET
Retorna todos os centros de resultado da empresa, incluindo os bloqueados (lixeira), ordenados por ID. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/getAllIncludingBlocked
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/getAllIncludingBlocked", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/getAllIncludingBlocked' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "id_filial": 1, "id_departamento": 3, "nome": "Comercial", "codigo": "CR-001", "observacao": "Centro de resultado da área comercial", "bloqueada": 0 },
{ "id": 6, "id_filial": 1, "id_departamento": null, "nome": "Administrativo", "codigo": "CR-002", "observacao": null, "bloqueada": 0 },
{ "id": 7, "id_filial": null, "id_departamento": null, "nome": "Logística (desativado)", "codigo": "CR-003", "observacao": null, "bloqueada": 1 }
]
}
getById — Centro de Resultado
/go/centroResultadoGo
GET
Retorna um centro de resultado específico pelo ID, incluindo bloqueados. Substitua ID pelo ID do centro de resultado. Retorna 422 se o ID não for um inteiro e 412 se ele não existir ou não pertencer à sua empresa.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/getById/ID", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/getById/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "id_filial": 1, "id_departamento": 3, "nome": "Comercial", "codigo": "CR-001", "observacao": "Centro de resultado da área comercial", "bloqueada": 0 }
]
}
getByCodigo — Centro de Resultado
/go/centroResultadoGo
GET
Idêntico ao getById, mas identifica o centro de resultado pelo código. Substitua CODIGO pelo código do centro de resultado (único por empresa).
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/getByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/getByCodigo/CODIGO", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/getByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "id_filial": 1, "id_departamento": 3, "nome": "Comercial", "codigo": "CR-001", "observacao": "Centro de resultado da área comercial", "bloqueada": 0 }
]
}
getBlocked — Centro de Resultado
/go/centroResultadoGo
GET
Retorna todos os centros de resultado bloqueados (lixeira) da empresa, ordenados por ID. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/getBlocked
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/getBlocked", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/getBlocked' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 7, "id_filial": null, "id_departamento": null, "nome": "Logística (desativado)", "codigo": "CR-003", "observacao": null, "bloqueada": 1 }
]
}
getByFilial — Centro de Resultado
/go/centroResultadoGo
GET
Retorna os centros de resultado não bloqueados vinculados a uma filial. Substitua ID_FILIAL pelo ID da filial, que você obtém em /company/getBranches. Retorna 412 se a filial não existir ou não pertencer à sua empresa. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/getByFilial/ID_FILIAL
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/getByFilial/ID_FILIAL", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/getByFilial/ID_FILIAL' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "id_filial": 1, "id_departamento": 3, "nome": "Comercial", "codigo": "CR-001", "observacao": "Centro de resultado da área comercial", "bloqueada": 0 },
{ "id": 6, "id_filial": 1, "id_departamento": null, "nome": "Administrativo", "codigo": "CR-002", "observacao": null, "bloqueada": 0 }
]
}
getByDepartamento — Centro de Resultado
/go/centroResultadoGo
GET
Retorna os centros de resultado não bloqueados vinculados a um departamento. Substitua ID_DEPARTAMENTO pelo ID do departamento, que você obtém em /company/getDepartments. Retorna 412 se o departamento não existir ou não pertencer à sua empresa. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/getByDepartamento/ID_DEPARTAMENTO
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/getByDepartamento/ID_DEPARTAMENTO", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/getByDepartamento/ID_DEPARTAMENTO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "id_filial": 1, "id_departamento": 3, "nome": "Comercial", "codigo": "CR-001", "observacao": "Centro de resultado da área comercial", "bloqueada": 0 }
]
}
insert — Centro de Resultado
/go/centroResultadoGo
POST
Cria um novo centro de resultado para a empresa vinculada ao token. O registro nasce desbloqueado e a criação é registrada no histórico do centro de resultado com o responsável API.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "nome" | String | Obrigatório. Máximo 255 caracteres. |
| "codigo" | String | Obrigatório. Máximo 255 caracteres. Único por empresa — retorna 409 se já existir um centro de resultado com o mesmo código. |
| "observacao" | String | Opcional. Texto livre. |
| "id_filial" | Integer | Opcional. ID de uma filial da empresa (/company/getBranches). Retorna 412 se não existir ou pertencer a outra empresa. |
| "id_departamento" | Integer | Opcional. ID de um departamento da empresa (/company/getDepartments). Retorna 412 se não existir ou pertencer a outra empresa. |
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Comercial",
"codigo": "CR-001",
"observacao": "Centro de resultado da área comercial",
"id_filial": 1,
"id_departamento": 3
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Comercial",
"codigo": "CR-001",
"observacao": "Centro de resultado da área comercial",
"id_filial": 1,
"id_departamento": 3
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 5
}
}
update — Centro de Resultado
/go/centroResultadoGo
PUT
Atualiza um centro de resultado existente não bloqueado. Substitua ID pelo ID do centro de resultado. Envie apenas os campos que deseja alterar; pelo menos um campo deve ser informado (422). Cada campo alterado gera uma entrada no histórico do centro de resultado.
| Campo | Tipo | Observação |
| "nome" | String | Opcional. Máximo 255 caracteres. Não pode ser vazio. |
| "codigo" | String | Opcional. Máximo 255 caracteres. Único por empresa (409 se já usado por outro centro). |
| "observacao" | String|null | Opcional. Texto livre; null limpa o campo. |
| "id_filial" | Integer|null | Opcional. ID de uma filial da empresa; null remove o vínculo. |
| "id_departamento" | Integer|null | Opcional. ID de um departamento da empresa; null remove o vínculo. |
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/update/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Comercial (revisado)",
"id_departamento": null
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/update/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Comercial (revisado)",
"id_departamento": null
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
updateByCodigo — Centro de Resultado
/go/centroResultadoGo
PUT
Idêntico ao update por ID, mas identifica o centro de resultado pelo código. Substitua CODIGO pelo código atual do centro de resultado. Aceita os mesmos campos no body — inclusive um novo codigo.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/updateByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/updateByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Comercial (revisado)"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/updateByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Comercial (revisado)"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
block — Centro de Resultado
/go/centroResultadoGo
PUT
Bloqueia (exclusão lógica, lixeira) um centro de resultado. Substitua ID pelo ID do centro de resultado. Retorna 409 se ele já estiver bloqueado. O bloqueio não apaga nada: planejamentos, lançamentos e vínculos com dimensões adicionais são preservados e o centro deixa de ser oferecido nas telas e nos endpoints que listam apenas registros ativos.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/block/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/block/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/block/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
blockByCodigo — Centro de Resultado
/go/centroResultadoGo
PUT
Idêntico ao block por ID, mas identifica o centro de resultado pelo código. Substitua CODIGO pelo código do centro de resultado.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/blockByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/blockByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/blockByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblock — Centro de Resultado
/go/centroResultadoGo
PUT
Desbloqueia (restaura da lixeira) um centro de resultado. Substitua ID pelo ID do centro de resultado. Retorna 409 se ele não estiver bloqueado.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/unblock/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/unblock/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/unblock/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblockByCodigo — Centro de Resultado
/go/centroResultadoGo
PUT
Idêntico ao unblock por ID, mas identifica o centro de resultado pelo código. Substitua CODIGO pelo código do centro de resultado.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/unblockByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/unblockByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/unblockByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblockAll — Centro de Resultado
/go/centroResultadoGo
PUT
Desbloqueia todos os centros de resultado bloqueados da empresa de uma vez, restaurando-os da lixeira. O campo restored na resposta indica quantos registros foram restaurados (0 quando a lixeira está vazia).
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/unblockAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/unblockAll", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/unblockAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"restored": 2
}
}
delete — Centro de Resultado
/go/centroResultadoGo
DELETE
Exclui permanentemente um centro de resultado. Somente registros bloqueados podem ser excluídos (409 caso contrário — bloqueie primeiro). Substitua ID pelo ID do centro de resultado. Retorna 409 se ele for referenciado por participantes da matriz de responsabilidade, por configurações de planejamento ou por lançamentos de resultado. Vínculos com dimensões adicionais não impedem a exclusão e são removidos junto. A exclusão é registrada no histórico.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/delete/ID", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/delete/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
deleteByCodigo — Centro de Resultado
/go/centroResultadoGo
DELETE
Idêntico ao delete por ID, mas identifica o centro de resultado pelo código. Substitua CODIGO pelo código do centro de resultado.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/deleteByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/deleteByCodigo/CODIGO", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/deleteByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
clearTrash — Centro de Resultado
/go/centroResultadoGo
DELETE
Exclui permanentemente todos os centros de resultado bloqueados que podem ser excluídos. Registros com dependências (participantes, planejamento ou lançamentos de resultado) são ignorados e contabilizados em skipped; os excluídos, em deleted.
URL
https://api.grupoadvis.com.br/go/centroResultadoGo/clearTrash
JavaScript
fetch("https://api.grupoadvis.com.br/go/centroResultadoGo/clearTrash", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/centroResultadoGo/clearTrash' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"deleted": 2,
"skipped": 1
}
}
getAll — Produto / Serviço
/go/produtoGo
GET
Retorna todos os produtos e serviços não bloqueados da empresa vinculada ao token, ordenados por ID. Suporta paginação via parâmetros limit e offset na URL.
URL
https://api.grupoadvis.com.br/go/produtoGo/getAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getAll", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_conta": null, "nome": "Produto A", "codigo": "PROD-001", "tipo": 0, "metodologia": 0, "unidade_medida": "kg", "observacao": null, "bloqueada": 0 },
{ "id": 2, "id_go_conta": 10, "nome": "Serviço B", "codigo": "SERV-001", "tipo": 1, "metodologia": 1, "unidade_medida": "h", "observacao": "Consultoria", "bloqueada": 0 }
]
}
getAllIncludingBlocked — Produto / Serviço
/go/produtoGo
GET
Retorna todos os produtos e serviços da empresa, incluindo bloqueados, ordenados por ID. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/produtoGo/getAllIncludingBlocked
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getAllIncludingBlocked", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getAllIncludingBlocked' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_conta": null, "nome": "Produto A", "codigo": "PROD-001", "tipo": 0, "metodologia": 0, "unidade_medida": "kg", "observacao": null, "bloqueada": 0 },
{ "id": 3, "id_go_conta": null, "nome": "Produto Inativo", "codigo": "PROD-002", "tipo": 0, "metodologia": 0, "unidade_medida": "", "observacao": null, "bloqueada": 1 }
]
}
getById — Produto / Serviço
/go/produtoGo
GET
Retorna um produto ou serviço específico pelo ID, incluindo bloqueados. Substitua ID pelo ID do produto.
URL
https://api.grupoadvis.com.br/go/produtoGo/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getById/ID", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getById/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_conta": null, "nome": "Produto A", "codigo": "PROD-001", "tipo": 0, "metodologia": 0, "unidade_medida": "kg", "observacao": null, "bloqueada": 0 }
]
}
getByCodigo — Produto / Serviço
/go/produtoGo
GET
Retorna um produto ou serviço específico pelo código, incluindo bloqueados. Substitua CODIGO pelo código do produto.
URL
https://api.grupoadvis.com.br/go/produtoGo/getByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getByCodigo/CODIGO", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_conta": null, "nome": "Produto A", "codigo": "PROD-001", "tipo": 0, "metodologia": 0, "unidade_medida": "kg", "observacao": null, "bloqueada": 0 }
]
}
getBlocked — Produto / Serviço
/go/produtoGo
GET
Retorna todos os produtos e serviços bloqueados (lixeira) da empresa, ordenados por ID. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/produtoGo/getBlocked
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getBlocked", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getBlocked' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 3, "id_go_conta": null, "nome": "Produto Inativo", "codigo": "PROD-002", "tipo": 0, "metodologia": 0, "unidade_medida": "", "observacao": null, "bloqueada": 1 }
]
}
getByTipo — Produto / Serviço
/go/produtoGo
GET
Retorna produtos ou serviços não bloqueados filtrados pelo tipo. Substitua TIPO por 0 (produto) ou 1 (serviço). Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/produtoGo/getByTipo/TIPO
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getByTipo/0", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getByTipo/0' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_conta": null, "nome": "Produto A", "codigo": "PROD-001", "tipo": 0, "metodologia": 0, "unidade_medida": "kg", "observacao": null, "bloqueada": 0 }
]
}
getByConta — Produto / Serviço
/go/produtoGo
GET
Retorna produtos e serviços não bloqueados vinculados a uma conta específica. Substitua ID_CONTA pelo ID da conta. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/produtoGo/getByConta/ID_CONTA
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getByConta/ID_CONTA", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getByConta/ID_CONTA' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 2, "id_go_conta": 10, "nome": "Serviço B", "codigo": "SERV-001", "tipo": 1, "metodologia": 1, "unidade_medida": "h", "observacao": "Consultoria", "bloqueada": 0 }
]
}
getWithoutConta — Produto / Serviço
/go/produtoGo
GET
Retorna todos os produtos e serviços não bloqueados que não estão vinculados a nenhuma conta, ordenados por ID. Suporta paginação via limit e offset.
URL
https://api.grupoadvis.com.br/go/produtoGo/getWithoutConta
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/getWithoutConta", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/produtoGo/getWithoutConta' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_conta": null, "nome": "Produto A", "codigo": "PROD-001", "tipo": 0, "metodologia": 0, "unidade_medida": "kg", "observacao": null, "bloqueada": 0 }
]
}
insert — Produto / Serviço
/go/produtoGo
POST
Cria um novo produto ou serviço para a empresa vinculada ao token.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "nome" | String | Obrigatório. Máximo 255 caracteres. |
| "codigo" | String | Obrigatório. Máximo 255 caracteres. Único por empresa. |
| "tipo" | Integer | Opcional. 0 = produto, 1 = serviço. Padrão: 0. |
| "metodologia" | Integer | Opcional. 0 ou 1. Padrão: 0. |
| "unidade_medida" | String | Opcional. Valores aceitos: '', 'g', 'kg', 'ton', 'm', 'm²', 'm³', 'l', 'd', 'h', 'min'. |
| "id_go_conta" | Integer | Opcional. FK para conta. A conta deve existir e não estar bloqueada. |
| "observacao" | String | Opcional. Texto livre. |
URL
https://api.grupoadvis.com.br/go/produtoGo/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Produto A",
"codigo": "PROD-001",
"tipo": 0,
"metodologia": 0,
"unidade_medida": "kg",
"observacao": "Produto principal"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/produtoGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Produto A",
"codigo": "PROD-001",
"tipo": 0,
"metodologia": 0,
"unidade_medida": "kg",
"observacao": "Produto principal"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 1
}
}
update — Produto / Serviço
/go/produtoGo
PUT
Atualiza um produto ou serviço existente não bloqueado. Substitua ID pelo ID do produto. Envie apenas os campos que deseja alterar. Pelo menos um campo deve ser informado.
| Campo | Tipo | Observação |
| "nome" | String | Opcional. Máximo 255 caracteres. |
| "codigo" | String | Opcional. Máximo 255 caracteres. Único por empresa. |
| "tipo" | Integer | Opcional. 0 = produto, 1 = serviço. |
| "metodologia" | Integer | Opcional. 0 ou 1. |
| "unidade_medida" | String | Opcional. Valores aceitos: '', 'g', 'kg', 'ton', 'm', 'm²', 'm³', 'l', 'd', 'h', 'min'. |
| "id_go_conta" | Integer|null | Opcional. FK para conta ou null para remover. |
| "observacao" | String|null | Opcional. Texto livre. |
URL
https://api.grupoadvis.com.br/go/produtoGo/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/update/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Produto A (revisado)",
"unidade_medida": "ton"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/produtoGo/update/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Produto A (revisado)",
"unidade_medida": "ton"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
updateByCodigo — Produto / Serviço
/go/produtoGo
PUT
Idêntico ao update por ID, mas identifica o produto pelo código. Substitua CODIGO pelo código atual do produto. Aceita os mesmos campos no body.
URL
https://api.grupoadvis.com.br/go/produtoGo/updateByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/updateByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Produto A (revisado)"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/produtoGo/updateByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Produto A (revisado)"
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
block — Produto / Serviço
/go/produtoGo
PUT
Bloqueia (exclusão lógica) um produto ou serviço. Substitua ID pelo ID do produto. Retorna 409 se o produto já estiver bloqueado.
URL
https://api.grupoadvis.com.br/go/produtoGo/block/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/block/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/produtoGo/block/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
blockByCodigo — Produto / Serviço
/go/produtoGo
PUT
Idêntico ao block por ID, mas identifica o produto pelo código. Substitua CODIGO pelo código do produto.
URL
https://api.grupoadvis.com.br/go/produtoGo/blockByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/blockByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/produtoGo/blockByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblock — Produto / Serviço
/go/produtoGo
PUT
Desbloqueia um produto ou serviço. Substitua ID pelo ID do produto. Retorna 409 se o produto não estiver bloqueado.
URL
https://api.grupoadvis.com.br/go/produtoGo/unblock/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/unblock/ID", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/produtoGo/unblock/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblockByCodigo — Produto / Serviço
/go/produtoGo
PUT
Idêntico ao unblock por ID, mas identifica o produto pelo código. Substitua CODIGO pelo código do produto.
URL
https://api.grupoadvis.com.br/go/produtoGo/unblockByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/unblockByCodigo/CODIGO", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/produtoGo/unblockByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
unblockAll — Produto / Serviço
/go/produtoGo
PUT
Desbloqueia todos os produtos e serviços bloqueados da empresa de uma vez, restaurando-os da lixeira. O campo restored na resposta indica quantos registros foram restaurados.
URL
https://api.grupoadvis.com.br/go/produtoGo/unblockAll
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/unblockAll", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/produtoGo/unblockAll' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"restored": 3
}
}
delete — Produto / Serviço
/go/produtoGo
DELETE
Exclui permanentemente um produto ou serviço. Somente registros bloqueados podem ser excluídos. Substitua ID pelo ID do produto. Retorna 409 se o produto possuir dependências vinculadas.
URL
https://api.grupoadvis.com.br/go/produtoGo/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/delete/ID", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/produtoGo/delete/ID' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
deleteByCodigo — Produto / Serviço
/go/produtoGo
DELETE
Idêntico ao delete por ID, mas identifica o produto pelo código. Substitua CODIGO pelo código do produto.
URL
https://api.grupoadvis.com.br/go/produtoGo/deleteByCodigo/CODIGO
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/deleteByCodigo/CODIGO", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/produtoGo/deleteByCodigo/CODIGO' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
clearTrash — Produto / Serviço
/go/produtoGo
DELETE
Exclui permanentemente todos os produtos e serviços bloqueados que podem ser excluídos. Registros com dependências são ignorados e contabilizados em skipped.
URL
https://api.grupoadvis.com.br/go/produtoGo/clearTrash
JavaScript
fetch("https://api.grupoadvis.com.br/go/produtoGo/clearTrash", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/produtoGo/clearTrash' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"deleted": 2,
"skipped": 1
}
}
Dimensão Adicional — visão geral e cadastro
/go/dimensaoResultadoGo
GET
POST
PUT
DELETE
A Dimensão adicional é uma granularidade opcional que acompanha o fato do GO ao lado da conta e do centro de resultado. O cadastro é independente por empresa (código único), com filial e departamento próprios, e o vínculo com centro de resultado é opcional e N:N.
A regra que tudo depende: id_go_dimensao_resultado IS NULL significa
"sem dimensão". Não significa "todas", não é uma dimensão padrão e nunca é deduzida a partir do centro de resultado.
- Em planejamento e resultados, não informar dimensão alcança exatamente a fatia sem dimensão.
- Num centro de resultado que usa dimensões, essa fatia é o Acumulado somente-leitura: a escrita nela é recusada com
409.
- Uma dimensão só pode receber fato num centro em que esteja disponível: vínculo ativo ou metodologia já existente naquele período.
Endpoints de cadastro
Seguem exatamente o mesmo contrato dos demais cadastros do GO (produtos, contas): bloquear é a lixeira, unblock restaura e delete é permanente e só aceita registro bloqueado.
| Método | URL | Descrição |
| GET | /getAll | Dimensões ativas, ordenadas por código |
| GET | /getAllIncludingBlocked | Ativas e bloqueadas |
| GET | /getById/ID | Por ID (mesmo bloqueada) |
| GET | /getByCodigo/CODIGO | Por código (mesmo bloqueada) |
| GET | /getBlocked | Lixeira |
| GET | /getByFilial/ID_FILIAL | Ativas de uma filial |
| GET | /getByDepartamento/ID_DEPARTAMENTO | Ativas de um departamento |
| POST | /insert | Cria uma dimensão (ver abaixo) |
| PUT | /update/ID · /updateByCodigo/CODIGO | Atualiza nome, codigo, observacao, id_filial, id_departamento |
| PUT | /block/ID · /blockByCodigo/CODIGO | Envia para a lixeira |
| PUT | /unblock/ID · /unblockByCodigo/CODIGO · /unblockAll | Restaura |
| DELETE | /delete/ID · /deleteByCodigo/CODIGO | Exclusão permanente (só bloqueada) |
| DELETE | /clearTrash | Exclui da lixeira tudo que não tem dependência |
Exclusão permanente é recusada (409) enquanto a dimensão tiver vínculo com centro de resultado, metodologia de planejamento ou lançamento de resultado. Remova o vínculo e a metodologia antes; resultado real nunca é apagado por esse caminho.
insert — Dimensão Adicional
/go/dimensaoResultadoGo
POST
Cria uma dimensão adicional na empresa. O código é único por empresa (409 em caso de duplicidade).
O campo opcional centros vincula centros de resultado na mesma transação da criação, como faz a tela de cadastro: sem ele o consumidor precisa de um segundo PUT, e uma falha entre as duas chamadas deixaria a dimensão criada sem vínculo nenhum. Cada vínculo criado clona a metodologia da fatia sem dimensão daquele centro, e quando centros é enviado a resposta ganha a chave vinculos com created, removed e planejamentosClonados. Um centro inexistente ou bloqueado recusa a requisição inteira (412 / 409) sem criar a dimensão.
O mesmo campo é aceito no update, com a semântica da tela: ausente mantém os vínculos atuais, presente substitui o conjunto, e um array vazio limpa todos.
URL
https://api.grupoadvis.com.br/go/dimensaoResultadoGo/insert
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| nome | String | Sim | Máximo 255 caracteres |
| codigo | String | Sim | Máximo 255 caracteres, único na empresa |
| observacao | String | Não | Observação livre |
| id_filial | Integer | Não | Filial da empresa |
| id_departamento | Integer | Não | Departamento da empresa |
| centros | Array | Não | Centros de resultado a vincular, por código ou ID. Aplicado na mesma transação da criação. Ausente = nenhum vínculo |
JavaScript
fetch("https://api.grupoadvis.com.br/go/dimensaoResultadoGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Região Norte",
"codigo": "NORTE",
"centros": ["CR-001", "CR-002"]
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/dimensaoResultadoGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"nome":"Região Norte","codigo":"NORTE","centros":["CR-001","CR-002"]}'
vinculos — Dimensão Adicional
/go/dimensaoResultadoGo
GET
Lista o vínculo N:N entre centro de resultado e dimensão adicional, pelos dois lados. O parâmetro na URL aceita código ou ID numérico. A resposta inclui os relacionados bloqueados, para que a lista possa ser devolvida no PUT sem perda.
Variantes de URL
GET .../vinculos/dimensao/DIMENSAO — centros de resultado vinculados à dimensão
GET .../vinculos/centro/CENTRO — dimensões vinculadas ao centro de resultado
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "codigo": "NORTE", "nome": "Região Norte", "bloqueada": 0 },
{ "id": 6, "codigo": "SUL", "nome": "Região Sul", "bloqueada": 0 }
]
}
vinculos — Dimensão Adicional
/go/dimensaoResultadoGo
PUT
O conjunto informado substitui o atual, dos dois lados: só o que mudou é escrito, e um array vazio limpa todos os vínculos daquele dono. É a mesma semântica da tela de cadastro.
Criar um vínculo clona a metodologia. Ao vincular uma dimensão a um centro de resultado, a metodologia de planejamento do nível do centro (a fatia sem dimensão) é replicada para aquela dimensão em todos os períodos do processo, junto com os produtos — sem copiar valores. É idempotente: onde a dimensão já tem metodologia, nada é feito. Um PUT com muitos vínculos novos pode portanto gerar muitas escritas numa transação só.
Variantes de URL
PUT .../vinculos/dimensao/DIMENSAO — corpo { "centros": [...] }
PUT .../vinculos/centro/CENTRO — corpo { "dimensoes": [...] }
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| centros | Array | Sim* | Na variante /vinculos/dimensao/. Códigos ou IDs de centro de resultado. Array vazio limpa todos. |
| dimensoes | Array | Sim* | Na variante /vinculos/centro/. Códigos ou IDs de dimensão. Array vazio limpa todos. |
Erros
412 — dono ou relacionado inexistente na empresa. Nada é escrito: o conjunto inteiro é resolvido antes da primeira escrita.
409 — dono bloqueado recebendo vínculo novo, ou relacionado bloqueado sendo vinculado. Remover vínculo nunca é barrado por bloqueio.
JavaScript
fetch("https://api.grupoadvis.com.br/go/dimensaoResultadoGo/vinculos/dimensao/NORTE", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({ "centros": ["CR-001", "CR-002"] })
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/dimensaoResultadoGo/vinculos/centro/CR-001' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"dimensoes":["NORTE","SUL"]}'
Exemplo de Resposta JSON
{
"response": { "created": 2, "removed": 0, "planejamentosClonados": 24 }
}
getByPeriod — Estrutura Orçamentária
/go/estruturaGo
GET
Retorna todas as estruturas orçamentárias de um período, ordenadas por drag_index crescente. Cada estrutura inclui a lista de operadores (operadores) com JOIN de contas e estruturas referenciadas.
URL
https://api.grupoadvis.com.br/go/estruturaGo/getByPeriod/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/getByPeriod/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/getByPeriod/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 1, "nome": "Receita Bruta", "id_go_processo_periodo": 1, "id_clone": null, "drag_index": 0,
"operadores": [
{ "id": 1, "id_go_periodo_estrutura": 1, "operador": 1, "tipo": 1, "id_go_conta": 10, "id_estrutura": null, "operador_id_clone": null, "drag_index": 0, "conta_codigo": "1.1.01", "conta_nome": "Vendas", "conta_tipo": 0, "estrutura_ref_nome": null }
]
},
{ "id": 2, "nome": "Deduções", "id_go_processo_periodo": 1, "id_clone": null, "drag_index": 1, "operadores": [] }
]
}
getById — Estrutura Orçamentária
/go/estruturaGo
GET
Retorna uma estrutura orçamentária pelo ID com todos os seus operadores. Substitua ID pelo ID da estrutura.
URL
https://api.grupoadvis.com.br/go/estruturaGo/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/getById/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/getById/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 1, "nome": "Receita Bruta", "id_go_processo_periodo": 1, "id_clone": null, "drag_index": 0,
"operadores": [
{ "id": 1, "id_go_periodo_estrutura": 1, "operador": 1, "tipo": 1, "id_go_conta": 10, "id_estrutura": null, "operador_id_clone": null, "drag_index": 0, "conta_codigo": "1.1.01", "conta_nome": "Vendas", "conta_tipo": 0, "estrutura_ref_nome": null }
]
}
]
}
insert — Estrutura Orçamentária
/go/estruturaGo
POST
Cria uma nova estrutura orçamentária vinculada a um período.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "id_go_processo_periodo" | Integer | ID do período ao qual a estrutura pertence. |
| "nome" | String | Máximo 255 caracteres. |
Campos Opcionais
| Campo | Tipo | Observação |
| "drag_index" | Integer | Posição de inserção (base 0). Se omitido ou maior que o máximo disponível, insere no final. |
URL
https://api.grupoadvis.com.br/go/estruturaGo/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo_periodo": 1,
"nome": "Receita Bruta",
"drag_index": 0
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"id_go_processo_periodo": 1,
"nome": "Receita Bruta",
"drag_index": 0
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 5
}
}
update — Estrutura Orçamentária
/go/estruturaGo
PUT
Atualiza uma estrutura existente. Substitua ID pelo ID da estrutura. Pelo menos um campo deve ser informado.
| Campo | Tipo | Observação |
| "nome" | String | Opcional. Máximo 255 caracteres. |
| "drag_index" | Integer | Opcional. Nova posição (base 0). Valores maiores que o máximo são limitados automaticamente ao final. |
URL
https://api.grupoadvis.com.br/go/estruturaGo/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/update/1", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"nome": "Receita Líquida",
"drag_index": 1
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/update/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"nome": "Receita Líquida",
"drag_index": 1
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
delete — Estrutura Orçamentária
/go/estruturaGo
DELETE
Exclui uma estrutura e todos os seus operadores (cascade). Substitua ID pelo ID da estrutura. Retorna 409 se a estrutura for referenciada por linhas de planejamento.
URL
https://api.grupoadvis.com.br/go/estruturaGo/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/delete/1", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/delete/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
operador/insert — Estrutura Orçamentária
/go/estruturaGo
POST
Adiciona um operador a uma estrutura. O operador pode referenciar uma conta (tipo=1) ou outra estrutura (tipo=2). Valida duplicidade, hierarquia de contas e dependência circular.
Campos Obrigatórios
| Campo | Tipo | Observação |
| "id_go_periodo_estrutura" | Integer | ID da estrutura que receberá o operador. |
| "operador" | Integer | 1 (+), 2 (-), 3 (×), 4 (÷). |
| "tipo" | Integer | 1 = Conta, 2 = Estrutura. |
| "id_go_conta" | Integer | Obrigatório quando tipo=1. ID da conta. |
| "id_estrutura" | Integer | Obrigatório quando tipo=2. ID da estrutura referenciada. |
Campos Opcionais
| Campo | Tipo | Observação |
| "drag_index" | Integer | Posição de inserção (base 0). Se omitido ou maior que o máximo disponível, insere no final. |
URL
https://api.grupoadvis.com.br/go/estruturaGo/operador/insert
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/operador/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_periodo_estrutura": 1,
"operador": 1,
"tipo": 1,
"id_go_conta": 10,
"drag_index": 0
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/operador/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"id_go_periodo_estrutura": 1,
"operador": 1,
"tipo": 1,
"id_go_conta": 10,
"drag_index": 0
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1,
"insertId": 7
}
}
operador/update — Estrutura Orçamentária
/go/estruturaGo
PUT
Atualiza um operador existente. Substitua ID pelo ID do operador. É possível alterar o operador, o tipo, a referência (conta ou estrutura) e a posição. Ao alterar o tipo, o campo de referência correspondente é obrigatório. Pelo menos um campo deve ser informado.
| Campo | Tipo | Observação |
| "operador" | Integer | Opcional. 1 (+), 2 (-), 3 (×), 4 (÷). |
| "tipo" | Integer | Opcional. 1 = Conta, 2 = Estrutura. |
| "id_go_conta" | Integer | Obrigatório se tipo mudar para 1. |
| "id_estrutura" | Integer | Obrigatório se tipo mudar para 2. |
| "drag_index" | Integer | Opcional. Nova posição (base 0). Valores maiores que o máximo são limitados automaticamente ao final. |
URL
https://api.grupoadvis.com.br/go/estruturaGo/operador/update/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/operador/update/7", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"operador": 2,
"drag_index": 0
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/operador/update/7' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{
"operador": 2,
"drag_index": 0
}'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
operador/delete — Estrutura Orçamentária
/go/estruturaGo
DELETE
Remove um operador de uma estrutura. Substitua ID pelo ID do operador. Os índices de ordenação dos demais operadores serão renormalizados.
URL
https://api.grupoadvis.com.br/go/estruturaGo/operador/delete/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/operador/delete/7", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/operador/delete/7' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"status": "success",
"affectedRows": 1
}
}
availableContas — Estrutura Orçamentária
/go/estruturaGo
GET
Retorna as contas disponíveis para adicionar como operador a uma estrutura, excluindo contas já utilizadas ou com conflito hierárquico. O parâmetro idOperadorAtual na query string é opcional e serve para ignorar o operador sendo editado.
URL
https://api.grupoadvis.com.br/go/estruturaGo/availableContas/ID?idOperadorAtual=OPERADOR_ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/availableContas/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/availableContas/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 11, "codigo": "1.1.02", "nome": "Devoluções", "tipo": 1, "id_go_conta": 10 },
{ "id": 12, "codigo": "1.1.03", "nome": "Abatimentos", "tipo": 1, "id_go_conta": 10 }
]
}
availableEstruturas — Estrutura Orçamentária
/go/estruturaGo
GET
Retorna as estruturas disponíveis para adicionar como operador a uma estrutura, excluindo a própria estrutura e aquelas que causariam dependência circular. O parâmetro idOperadorAtual na query string é opcional e serve para ignorar o operador sendo editado.
URL
https://api.grupoadvis.com.br/go/estruturaGo/availableEstruturas/ID?idOperadorAtual=OPERADOR_ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/availableEstruturas/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/availableEstruturas/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 2, "nome": "Deduções", "id_go_processo_periodo": 1, "id_clone": null, "drag_index": 1 },
{ "id": 3, "nome": "Receita Líquida", "id_go_processo_periodo": 1, "id_clone": null, "drag_index": 2 }
]
}
history — Estrutura Orçamentária
/go/estruturaGo
GET
Retorna o histórico de alterações das estruturas de um período, incluindo criações, atualizações e exclusões de estruturas e operadores. Substitua ID pelo ID do período.
URL
https://api.grupoadvis.com.br/go/estruturaGo/history/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/estruturaGo/history/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/estruturaGo/history/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 1, "id_go_periodo_estrutura": 1, "id_go_processo_periodo": 1, "responsavel": "API",
"data": "2026-04-10 17:00:00", "campo": "insert_estrutura", "valor": "Receita Bruta",
"valor_anterior": null, "campo_secundario": "Estrutura criada: Receita Bruta",
"icone": "insert", "operacao": "Estrutura criada: Receita Bruta", "estrutura_nome": null
}
]
}
getResultados — Importação de Resultados
/go/importacaoResultadosGo
GET
Lista os resultados importados. Escolha a variante de URL conforme a chave disponível. Opcionalmente filtre por periodoInicio e periodoFim (query params, formato YYYY-MM-DD).
Variantes de URL
GET .../getByPeriod/ID_PERIODO — resultados de um período GO específico
GET .../getByProcess/ID_PROCESSO — resultados de todos os períodos de um processo GO
Parâmetros (Query String)
| Nome | Tipo | Obrigatório | Descrição |
| periodoInicio | String | Não | Filtro de data inicial (YYYY-MM-DD) |
| periodoFim | String | Não | Filtro de data final (YYYY-MM-DD) |
JavaScript
// Variante: por processo (substitua por getByPeriod/ID_PERIODO para filtrar por período)
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/getByProcess/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/getByProcess/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_processo_periodo": 1, "periodo": "2025-01-01 00:00:00", "data_importacao": "2025-01-15 10:30:00", "id_colaborador": null, "periodo_nome": "2025", "periodo_data_inicio": "2025-01-01", "periodo_data_fim": "2025-12-31", "total_lancamentos": 5 },
{ "id": 2, "id_go_processo_periodo": 1, "periodo": "2025-02-01 00:00:00", "data_importacao": "2025-02-10 14:00:00", "id_colaborador": null, "periodo_nome": "2025", "periodo_data_inicio": "2025-01-01", "periodo_data_fim": "2025-12-31", "total_lancamentos": 3 }
]
}
getById — Importação de Resultados
/go/importacaoResultadosGo
GET
Retorna um resultado importado pelo seu ID. Substitua ID pelo ID do resultado.
URL
https://api.grupoadvis.com.br/go/importacaoResultadosGo/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/getById/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/getById/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_processo_periodo": 1, "periodo": "2025-01-01 00:00:00", "data_importacao": "2025-01-15 10:30:00", "id_colaborador": null, "total_lancamentos": 5 }
]
}
getLancamentos — Importação de Resultados
/go/importacaoResultadosGo
GET
Lista todos os lançamentos de um resultado importado. Escolha a variante de URL conforme a chave disponível.
Variantes de URL
GET .../getLancamentos/ID — por ID direto do resultado
GET .../getLancamentos/periodo/ID_PERIODO/mes/REF — por ID do período + mês de referência (YYYY-MM)
GET .../getLancamentos/processo/ID_PROCESSO/mes/REF — por ID do processo + mês de referência (YYYY-MM)
JavaScript
// Variante: por processo (substitua pela URL adequada à chave disponível)
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/getLancamentos/processo/1/mes/2025-01", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/getLancamentos/processo/1/mes/2025-01' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "valor_debito": "15000.00000", "valor_credito": "5000.00000", "valor_movimentacao": "10000.00000", "conta_id": 10, "conta_codigo": "1.01.001", "conta_nome": "Caixa Geral", "centro_id": 5, "centro_codigo": "CR-001", "centro_nome": "Administração" },
{ "id": 2, "valor_debito": "0.00000", "valor_credito": "25000.00000", "valor_movimentacao": "25000.00000", "conta_id": 11, "conta_codigo": "1.02.001", "conta_nome": "Receita Vendas", "centro_id": 6, "centro_codigo": "CR-002", "centro_nome": "Comercial" }
]
}
importBatch — Importação de Resultados
/go/importacaoResultadosGo
POST
Endpoint principal de importação B2B. Aceita lançamentos em JSON estruturado para um mês específico. Cria o resultado automaticamente se necessário. Suporta modos upsert (padrão) e replace. O contexto é resolvido por id_go_processo_periodo ou por id_go_processo + periodoReferencia (o processo deve conter um período que cubra o mês informado).
Dimensão adicional (fatia). A identidade de um lançamento é conta + centro + fatia. Sem informar dimensão a operação alcança exatamente a fatia sem dimensão (id_go_dimensao_resultado IS NULL) — nunca "todas". Num centro de resultado que usa dimensões essa fatia é o Acumulado somente-leitura, e a escrita nela é recusada com 409. A dimensão informada precisa existir na empresa (412) e estar disponível naquele centro pela regra vínculo ∪ metodologia (412).
Modo replace e dimensão. A exclusão dos lançamentos ausentes do payload fica restrita às fatias declaradas nele. Um payload sem nenhuma dimensão alcança somente a fatia sem dimensão e não apaga o que está nas dimensões — é o que mantém segura a integração que já existia antes da dimensão.
Reconciliação pelos contadores. Vale added + updated + kept = total, onde total é a contagem real de lançamentos do mês depois da operação. O deleted é contador de saída e não entra nessa soma. No modo replace, a linha que sobrevive por estar em uma fatia que o payload não declarou é reportada em kept.
Lançamentos repetidos no mesmo payload. Dois itens com conta + centro + fatia iguais gravam uma linha só (o último vence), acompanhados de um warning. O added conta as linhas efetivamente gravadas, não os itens enviados.
URL
https://api.grupoadvis.com.br/go/importacaoResultadosGo/importBatch
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| id_go_processo_periodo | Integer | Sim* | ID do período (* ou id_go_processo) |
| id_go_processo | Integer | Sim* | ID do processo (* ou id_go_processo_periodo). O período é resolvido automaticamente pelo mês de periodoReferencia. |
| periodoReferencia | String | Sim | Formato YYYY-MM ou YYYY-MM-DD, normalizado para 1º do mês |
| mode | String | Não | Padrão "upsert". Valores: "upsert" ou "replace" |
| lancamentos | Array | Sim | Máximo 5000 itens. Cada: {conta_codigo, centro_codigo, valor_debito, valor_credito, valor_movimentacao}. Alternativas: conta_id (int) no lugar de conta_codigo, centro_id (int) no lugar de centro_codigo. Opcional: dimensao_codigo (ou dimensao_id) para gravar numa dimensão adicional; ausente = fatia sem dimensão. |
JavaScript
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/importBatch", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo_periodo": 1,
"periodoReferencia": "2025-01",
"mode": "upsert",
"lancamentos": [
{ "conta_codigo": "1.01.001", "centro_codigo": "CR-001", "valor_debito": 15000, "valor_credito": 5000, "valor_movimentacao": 10000 },
{ "conta_codigo": "1.01.001", "centro_codigo": "CR-002", "dimensao_codigo": "NORTE", "valor_debito": 8000, "valor_credito": 0, "valor_movimentacao": 8000 }
]
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/importBatch' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"id_go_processo":1,"periodoReferencia":"2025-01","mode":"upsert","lancamentos":[{"conta_codigo":"1.01.001","centro_codigo":"CR-001","valor_debito":15000,"valor_credito":5000,"valor_movimentacao":10000}]}'
Exemplo de Resposta JSON
{
"response": {
"error": false,
"successCount": 1,
"stats": { "added": 1, "updated": 0, "kept": 0, "deleted": 0, "errors": 0, "total": 1 },
"warnings": [],
"resultadoId": 1,
"resultado": { "id": 1, "id_go_processo_periodo": 1, "periodo": "2025-01-01 00:00:00", "data_importacao": "2025-01-15 10:30:00", "total_lancamentos": 1 },
"isUpdate": false,
"mode": "upsert"
}
}
createResultado — Importação de Resultados
/go/importacaoResultadosGo
POST
Cria um cabeçalho de resultado vazio para um período/mês. Retorna 409 se já existir resultado para o mesmo mês. O contexto é resolvido por id_go_processo_periodo ou por id_go_processo.
URL
https://api.grupoadvis.com.br/go/importacaoResultadosGo/resultado
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| id_go_processo_periodo | Integer | Sim* | ID do período (* ou id_go_processo) |
| id_go_processo | Integer | Sim* | ID do processo (* ou id_go_processo_periodo) |
| periodoReferencia | String | Sim | Formato YYYY-MM ou YYYY-MM-DD |
JavaScript
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/resultado", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo": 1,
"periodoReferencia": "2025-06"
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/resultado' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"id_go_processo":1,"periodoReferencia":"2025-06"}'
Exemplo de Resposta JSON
{
"response": { "id": 10, "id_go_processo_periodo": 1, "periodo": "2025-06-01 00:00:00", "data_importacao": "2025-06-15 09:00:00", "total_lancamentos": 0 }
}
upsertLancamento — Importação de Resultados
/go/importacaoResultadosGo
PUT
Insere ou atualiza um lançamento individual pela chave composta (conta + centro de resultado + fatia). O resultado é criado automaticamente caso não exista. Os parâmetros conta, centro e dimensão na URL aceitam código ou ID numérico. Escolha a variante de URL conforme a chave disponível para identificar o resultado.
Dimensão adicional (fatia). A identidade de um lançamento é
conta + centro + fatia (veja
Centro de Resultado e Dimensão adicional).
Sem informar dimensão a operação alcança exatamente a fatia sem dimensão (
id_go_dimensao_resultado IS NULL) — nunca "todas". Num centro de resultado que usa dimensões essa fatia é o
Acumulado somente-leitura, e a escrita nela é recusada com
409. A dimensão informada precisa existir na empresa (
412) e estar disponível naquele centro pela regra vínculo ∪ metodologia (
412).
Variantes de URL
PUT .../lancamento/resultado/ID_RESULTADO/conta/CONTA/centro/CENTRO — por ID direto do resultado
PUT .../lancamento/periodo/ID_PERIODO/mes/REF/conta/CONTA/centro/CENTRO — por ID do período + mês de referência (YYYY-MM)
PUT .../lancamento/processo/ID_PROCESSO/mes/REF/conta/CONTA/centro/CENTRO — por ID do processo + mês de referência (YYYY-MM)
Cada variante aceita o sufixo opcional /dimensao/DIMENSAO para endereçar uma dimensão adicional — por exemplo PUT .../lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001/dimensao/NORTE. A dimensão também pode vir no corpo, em dimensao_codigo ou dimensao_id; o sufixo da URL tem prioridade.
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| valor_debito | Decimal | Sim | Valor de débito (aceita formato BR ou US) |
| valor_credito | Decimal | Sim | Valor de crédito (aceita formato BR ou US) |
| valor_movimentacao | Decimal | Sim | Valor de movimentação (aceita formato BR ou US) |
| dimensao_codigo | String | Não | Código da dimensão adicional. Ignorado quando a URL traz o sufixo /dimensao/. Ausente = fatia sem dimensão. |
| dimensao_id | Integer | Não | Alternativa a dimensao_codigo |
JavaScript
// Variante: por processo (substitua pela URL adequada à chave disponível)
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"valor_debito": 15000,
"valor_credito": 5000,
"valor_movimentacao": 10000
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"valor_debito":15000,"valor_credito":5000,"valor_movimentacao":10000}'
Exemplo de Resposta JSON
{
"response": { "id": 5, "id_go_periodo_resultado": 1, "conta_codigo": "1.01.001", "centro_codigo": "CR-001", "valor_debito": "15000.00000", "valor_credito": "5000.00000", "valor_movimentacao": "10000.00000", "isUpdate": false }
}
getLancamento — Importação de Resultados
/go/importacaoResultadosGo
GET
Retorna um lançamento individual pela chave composta (conta + centro + fatia). Os parâmetros conta, centro e dimensão na URL aceitam código ou ID numérico. Retorna 404 se não encontrado. Escolha a variante de URL conforme a chave disponível para identificar o resultado.
Dimensão adicional (fatia). Sem o sufixo /dimensao/ a busca alcança exatamente a fatia sem dimensão (id_go_dimensao_resultado IS NULL) — nunca "todas". Para listar todas as fatias de um resultado use getLancamentos.
Variantes de URL
GET .../lancamento/resultado/ID_RESULTADO/conta/CONTA/centro/CENTRO — por ID direto do resultado
GET .../lancamento/periodo/ID_PERIODO/mes/REF/conta/CONTA/centro/CENTRO — por ID do período + mês de referência (YYYY-MM)
GET .../lancamento/processo/ID_PROCESSO/mes/REF/conta/CONTA/centro/CENTRO — por ID do processo + mês de referência (YYYY-MM)
Cada variante aceita o sufixo opcional /dimensao/DIMENSAO, como em GET .../lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001/dimensao/NORTE.
JavaScript
// Variante: por processo (substitua pela URL adequada à chave disponível)
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 5, "valor_debito": "15000.00000", "valor_credito": "5000.00000", "valor_movimentacao": "10000.00000", "conta_id": 10, "conta_codigo": "1.01.001", "conta_nome": "Caixa Geral", "centro_id": 5, "centro_codigo": "CR-001", "centro_nome": "Administração" }
]
}
deleteLancamento — Importação de Resultados
/go/importacaoResultadosGo
DELETE
Exclui um lançamento individual. Pode ser identificado pela chave primária (ID) ou pela chave composta (conta + centro + fatia). Os parâmetros conta, centro e dimensão na URL aceitam código ou ID numérico.
Dimensão adicional (fatia). Sem o sufixo /dimensao/ a exclusão alcança exatamente a fatia sem dimensão. Diferente da escrita, aqui isso é permitido mesmo num centro que usa dimensões: é justamente como se limpa o valor legado que alimenta o Acumulado.
Variantes de URL
DELETE .../lancamento/ID — por ID direto do lançamento (chave primária)
DELETE .../lancamento/resultado/ID_RESULTADO/conta/CONTA/centro/CENTRO — por chave composta com ID do resultado
DELETE .../lancamento/periodo/ID_PERIODO/mes/REF/conta/CONTA/centro/CENTRO — por chave composta com ID do período + mês
DELETE .../lancamento/processo/ID_PROCESSO/mes/REF/conta/CONTA/centro/CENTRO — por chave composta com ID do processo + mês
As três variantes por chave composta aceitam o sufixo opcional /dimensao/DIMENSAO.
JavaScript
// Variante: por processo (substitua pela URL adequada à chave disponível)
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/processo/1/mes/2025-01/conta/1.01.001/centro/CR-001' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": { "message": "Lancamento deleted.", "id": 5 }
}
batch — Importação de Resultados
/go/importacaoResultadosGo
POST
Executa operações em lote (upsert e/ou delete) sobre lançamentos de um resultado existente. O resultado é resolvido por id_go_periodo_resultado ou por id_go_processo_periodo+periodoReferencia ou por id_go_processo+periodoReferencia.
Dimensão adicional (fatia). A identidade de cada operação é conta + centro + fatia, e operação sem dimensão alcança exatamente a fatia sem dimensão. Em acao: "upsert" a escrita na fatia sem dimensão de um centro que usa dimensões é recusada (sem_dimensao_nao_editavel); em acao: "delete" ela é permitida, porque é assim que se limpa o valor legado que alimenta o Acumulado.
Mesma identidade repetida no lote. Duas operações sobre conta + centro + fatia iguais resolvem para um único lançamento: a última manda, e a anterior volta em results com status: "superseded" (não conta em stats.upserted). Um delete sobre uma identidade que um upsert anterior do mesmo lote tocou cancela essa operação pendente: se o lançamento estava sendo criado, o par se anula e nada é gravado; se já existia, ele é apagado e a atualização é descartada.
Atomicidade. Cada operação é validada isoladamente: um item inválido volta com status: "error" e não impede os demais. Já a gravação é atômica — se o banco falhar durante a escrita, nenhuma operação do lote é aplicada e a requisição devolve erro.
URL
https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/batch
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| id_go_periodo_resultado | Integer | Sim* | ID direto do resultado (* ou uma das alternativas abaixo) |
| id_go_processo_periodo | Integer | Sim* | ID do período com periodoReferencia (* alternativa) |
| id_go_processo | Integer | Sim* | ID do processo com periodoReferencia (* alternativa) |
| periodoReferencia | String | Condicional | Obrigatório ao usar id_go_processo_periodo ou id_go_processo |
| operacoes | Array | Sim | Máximo 1000 itens. Cada: {acao: "upsert"|"delete", conta_codigo, centro_codigo, valor_debito*, valor_credito*, valor_movimentacao*} (* obrigatório para upsert). Alternativas: conta_id (int) no lugar de conta_codigo, centro_id (int) no lugar de centro_codigo. Opcional: dimensao_codigo (ou dimensao_id); ausente = fatia sem dimensão. |
JavaScript
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/batch", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo": 1,
"periodoReferencia": "2025-01",
"operacoes": [
{ "acao": "upsert", "conta_codigo": "1.01.001", "centro_codigo": "CR-001", "valor_debito": 15000, "valor_credito": 5000, "valor_movimentacao": 10000 },
{ "acao": "upsert", "conta_codigo": "1.01.001", "centro_codigo": "CR-002", "dimensao_codigo": "NORTE", "valor_debito": 8000, "valor_credito": 0, "valor_movimentacao": 8000 },
{ "acao": "delete", "conta_codigo": "1.02.001", "centro_codigo": "CR-002" }
]
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/lancamento/batch' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"id_go_processo":1,"periodoReferencia":"2025-01","operacoes":[{"acao":"upsert","conta_codigo":"1.01.001","centro_codigo":"CR-001","valor_debito":15000,"valor_credito":5000,"valor_movimentacao":10000},{"acao":"delete","conta_codigo":"1.02.001","centro_codigo":"CR-002"}]}'
Exemplo de Resposta JSON
{
"response": {
"resultadoId": 1,
"stats": { "upserted": 1, "deleted": 1, "errors": 0, "total_lancamentos": 1 },
"results": [
{ "index": 0, "status": "ok", "id": 5, "conta_codigo": "1.01.001", "centro_codigo": "CR-001" },
{ "index": 1, "status": "ok", "id": 6, "conta_codigo": "1.02.001", "centro_codigo": "CR-002", "message": "deleted" }
]
}
}
deleteResultado — Importação de Resultados
/go/importacaoResultadosGo
DELETE
Exclui um resultado importado e todos os seus lançamentos em cascata. Escolha a variante de URL conforme a chave disponível.
Variantes de URL
DELETE .../delete/ID — por ID direto do resultado
DELETE .../delete/periodo/ID_PERIODO/mes/REF — por ID do período + mês de referência (YYYY-MM)
DELETE .../delete/processo/ID_PROCESSO/mes/REF — por ID do processo + mês de referência (YYYY-MM)
JavaScript
// Variante: por processo (substitua pela URL adequada à chave disponível)
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/delete/processo/1/mes/2025-01", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/delete/processo/1/mes/2025-01' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplos de Resposta JSON
// Variantes por período e por processo:
{ "response": { "affectedRows": 1 } }
// Variante por ID direto (retorna detalhes adicionais):
{ "response": { "message": "Result deleted with all lancamentos.", "id": 1, "lancamentosRemovidos": 5 } }
getHistorico — Importação de Resultados
/go/importacaoResultadosGo
GET
Retorna o histórico de auditoria das operações de importação. Escolha a variante de URL conforme a chave disponível. Opcionalmente filtre por idResultado ou use apenasNivelPeriodo=true.
Variantes de URL
GET .../getHistorico/ID_PERIODO — histórico de um período GO específico
GET .../getHistoricoByProcess/ID_PROCESSO — histórico de todos os períodos de um processo GO
Parâmetros (Query String)
| Nome | Tipo | Obrigatório | Descrição |
| idResultado | Integer | Não | Filtrar por ID do resultado |
| apenasNivelPeriodo | Boolean | Não | Se "true", retorna apenas entradas de nível período |
JavaScript
// Variante: por processo (substitua por getHistorico/ID_PERIODO para filtrar por período específico)
fetch("https://api.grupoadvis.com.br/go/importacaoResultadosGo/getHistoricoByProcess/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/importacaoResultadosGo/getHistoricoByProcess/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 1, "id_go_processo_periodo": 1, "id_go_periodo_resultado": 1, "responsavel": "API",
"data": "2025-01-15 10:30:00", "campo": "insert_periodo", "valor": "2025-01-01 00:00:00",
"valor_anterior": null, "campo_secundario": "{\"total\":1,\"added\":1}", "periodo_referencia": "2025-01-01 00:00:00"
}
]
}
configuracao/getByPeriod — Planejamento Orçamentário
/go/planejamentoGo
GET
Retorna todas as configurações de planejamento orçamentário de um período. Cada registro inclui dados da conta (conta_codigo, conta_nome) e do centro de resultado (centro_codigo, centro_nome). Quando o registro pertence a uma fatia, também vêm id_go_dimensao_resultado, dimensao_codigo e dimensao_nome — há uma linha por fatia, e a fatia sem dimensão vem com esses campos null. Veja Centro de Resultado e Dimensão adicional.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByPeriod/ID_PERIODO
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByPeriod/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByPeriod/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 1, "id_go_processo_periodo": 1, "id_go_conta": 10, "id_go_centro_resultado": 5,
"tipo": 0, "data_inicio": "2026-01-01 00:00:00", "data_fim": "2026-12-01 00:00:00",
"moeda": "BRL", "teto": "100000.00000",
"conta_codigo": "1.01.001", "conta_nome": "Receita Bruta",
"centro_codigo": "CR-001", "centro_nome": "Unidade SP"
}
]
}
configuracao/getById — Planejamento Orçamentário
/go/planejamentoGo
GET
Retorna uma configuração de planejamento pelo seu ID. Inclui dados de conta, centro de resultado e, quando aplicável, conta de origem.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getById/ID
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getById/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getById/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": {
"id": 1, "id_go_processo_periodo": 1, "id_go_conta": 10, "id_go_centro_resultado": 5,
"tipo": 0, "data_inicio": "2026-01-01 00:00:00", "data_fim": "2026-12-01 00:00:00",
"moeda": "BRL", "teto": "100000.00000", "id_go_conta_origem": null,
"id_go_periodo_estrutura_origem": null, "data_inicio_historico": null,
"data_fim_historico": null, "subtipo_historico": null, "id_clone": null,
"conta_codigo": "1.01.001", "conta_nome": "Receita Bruta",
"centro_codigo": "CR-001", "centro_nome": "Unidade SP"
}
}
configuracao/getByComposite — Planejamento Orçamentário
/go/planejamentoGo
GET
Busca uma configuração pela chave composta: ID do período + ID da conta + ID do centro de resultado + fatia.
Dimensão adicional (fatia). Com a dimensão adicional, (período, conta, centro) deixou de ser único: existe uma linha por fatia. Sem o sufixo /dimensao/ a busca devolve exatamente a fatia sem dimensão (id_go_dimensao_resultado IS NULL) — nunca "todas". Para ver todas as fatias do período use configuracao/getByPeriod, cuja resposta traz id_go_dimensao_resultado, dimensao_codigo e dimensao_nome.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByComposite/ID_PERIODO/ID_CONTA/ID_CENTRO
Variante por fatia: .../getByComposite/ID_PERIODO/ID_CONTA/ID_CENTRO/dimensao/ID_DIMENSAO. ID_DIMENSAO aceita 0 como a própria fatia sem dimensão.
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByComposite/1/10/5", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByComposite/1/10/5' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
configuracao/getByCompositeCode — Planejamento Orçamentário
/go/planejamentoGo
GET
Busca uma configuração pela chave composta usando códigos textuais: ID do período + código da conta + código do centro de resultado + fatia.
Dimensão adicional (fatia). Sem o sufixo /dimensao/ a busca devolve exatamente a fatia sem dimensão — nunca "todas".
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByCompositeCode/ID_PERIODO/CODIGO_CONTA/CODIGO_CENTRO
Variante por fatia: .../getByCompositeCode/ID_PERIODO/CODIGO_CONTA/CODIGO_CENTRO/dimensao/CODIGO_DIMENSAO. O parâmetro da dimensão aceita código ou ID numérico, e aceita dimensão bloqueada (na leitura).
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByCompositeCode/1/1.01.001/CR-001", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/getByCompositeCode/1/1.01.001/CR-001' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
configuracao/insert — Planejamento Orçamentário
/go/planejamentoGo
POST
Cria ou atualiza (upsert) uma configuração de planejamento. Se já existir configuração para a mesma conta + centro + fatia no período, atualiza. Caso contrário, insere nova. Gera automaticamente os slots de lançamento (meses × produtos).
Dimensão adicional (fatia). A fatia faz parte da chave do upsert: sem informar dimensão a operação alcança exatamente a fatia sem dimensão, e num centro que usa dimensões isso é recusado com 409 (sem_dimensao_nao_editavel), porque ali essa fatia é o Acumulado somente-leitura. A dimensão informada precisa existir na empresa e estar disponível naquele centro pela regra vínculo ∪ metodologia.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/insert
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| id_go_processo_periodo | Integer | Sim | ID do período GO |
| id_go_conta | Integer/String | Sim | ID ou código da conta |
| id_go_centro_resultado | Integer/String | Sim | ID ou código do centro de resultado (ativo) |
| dimensao_codigo | String | Não | Código da dimensão adicional (aceita também ID). Ausente = fatia sem dimensão. |
| id_go_dimensao_resultado | Integer | Não | Alternativa a dimensao_codigo |
| tipo | Integer | Sim | 0 = Absoluto, 1 = Percentual, 2 = Qtd×Valor |
| data_inicio | String | Não | Data início personalizada (YYYY-MM ou YYYY-MM-DD) |
| data_fim | String | Não | Data fim personalizada |
| teto | Decimal | Não | Valor teto para o planejamento |
| produto_ids | Array | Não | IDs ou códigos dos produtos (tipos 0 e 2) |
| id_go_conta_origem | Integer/String | Não | Conta de origem (tipo 1) |
| id_go_periodo_estrutura_origem | Integer | Não | Estrutura de origem (tipo 1) |
| subtipo_historico | Integer | Não | 0, 1 ou 2 — subtipo histórico (tipo 1) |
| data_inicio_historico | String | Não | Data início do histórico |
| data_fim_historico | String | Não | Data fim do histórico |
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/insert", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo_periodo": 1,
"id_go_conta": 10,
"id_go_centro_resultado": 5,
"tipo": 0,
"teto": 100000,
"produto_ids": [1, 2]
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/insert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"id_go_processo_periodo":1,"id_go_conta":10,"id_go_centro_resultado":5,"tipo":0,"teto":100000,"produto_ids":[1,2]}'
Exemplo de Resposta JSON
{
"response": {
"id": 1, "id_go_processo_periodo": 1, "id_go_conta": 10,
"id_go_centro_resultado": 5, "tipo": 0, "moeda": "BRL", "teto": "100000.00000"
},
"isUpdate": false
}
configuracao/insertBulk — Planejamento Orçamentário
/go/planejamentoGo
POST
Cria múltiplas configurações de planejamento em uma única requisição. Suporta modo sobrescrever para atualizar configurações existentes.
Dimensão adicional (fatia). Cada item pode declarar dimensao_codigo (ou id_go_dimensao_resultado); ausente = fatia sem dimensão. A existência é avaliada por fatia: com sobrescrever: 0, um item de nível de centro não é mais pulado só porque aquele centro já tem configuração em alguma dimensão. Item cuja fatia é inválida é reportado em errors e os demais seguem.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/insertBulk
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| id_go_processo_periodo | Integer | Sim | ID do período GO |
| sobrescrever | Integer | Não | 0 = pular existentes (padrão), 1 = sobrescrever |
| itens | Array | Sim | Array de objetos com os mesmos campos do insert individual (id_go_conta, id_go_centro_resultado, dimensao_codigo, tipo, etc.) |
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/insertBulk", {
"method": "POST",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo_periodo": 1,
"sobrescrever": 0,
"itens": [
{ "id_go_conta": 10, "id_go_centro_resultado": 5, "tipo": 0 },
{ "id_go_conta": 10, "id_go_centro_resultado": 6, "dimensao_codigo": "NORTE", "tipo": 0 },
{ "id_go_conta": 11, "id_go_centro_resultado": 5, "tipo": 1, "id_go_conta_origem": 10 }
]
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request POST \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/insertBulk' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"id_go_processo_periodo":1,"sobrescrever":0,"itens":[{"id_go_conta":10,"id_go_centro_resultado":5,"tipo":0}]}'
Exemplo de Resposta JSON
{
"response": {
"successCount": 2, "updatedCount": 0, "skippedCount": 0,
"errorCount": 0, "errors": []
}
}
configuracao/update — Planejamento Orçamentário
/go/planejamentoGo
PUT
Atualização parcial de uma configuração existente. Envie apenas os campos que deseja alterar. Se o tipo mudar, os valores de lançamento são automaticamente limpos.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/update/ID
Parâmetros (Body JSON — todos opcionais)
| Nome | Tipo | Descrição |
| tipo | Integer | 0 = Absoluto, 1 = Percentual, 2 = Qtd×Valor |
| data_inicio | String | Data início personalizada |
| data_fim | String | Data fim personalizada |
| teto | Decimal | Valor teto |
| produto_ids | Array | IDs ou códigos dos produtos |
| id_go_conta_origem | Integer/String | Conta de origem |
| subtipo_historico | Integer | Subtipo histórico (0, 1, 2) |
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/update/1", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"teto": 150000
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/update/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"teto":150000}'
configuracao/delete — Planejamento Orçamentário
/go/planejamentoGo
DELETE
Remove uma configuração e todos os seus lançamentos e produtos vinculados (cascade). Se existirem lançamentos com valores preenchidos, retorna requiresConfirmation: true — adicione ?confirmar=true para confirmar a exclusão.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/delete/ID
https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/delete/ID?confirmar=true
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/delete/1?confirmar=true", {
"method": "DELETE",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request DELETE \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/configuracao/delete/1?confirmar=true' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON (com confirmação necessária)
{
"response": {
"requiresConfirmation": true,
"filledLancamentos": 3,
"message": "This configuration has filled lancamento values. Add ?confirmar=true to confirm deletion."
}
}
Exemplo de Resposta JSON (exclusão confirmada)
{
"response": { "deleted": true, "id": 1 }
}
lancamento/getByConfig — Planejamento Orçamentário
/go/planejamentoGo
GET
Retorna todos os lançamentos (slots mensais) de uma configuração de planejamento específica. Inclui dados do produto vinculado quando aplicável.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/getByConfig/ID_PLANEJAMENTO
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/getByConfig/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/getByConfig/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 1, "periodo": "2026-01-01 00:00:00", "id_go_periodo_planejamento": 1,
"id_go_periodo_planejamento_produto": 1, "quantidade": null, "valor": "5000.00000",
"produto_codigo": "PROD-001", "produto_nome": "Produto A"
}
]
}
lancamento/getByPeriod — Planejamento Orçamentário
/go/planejamentoGo
GET
Retorna todos os lançamentos de todas as configurações de um período. Opcionalmente filtre por centro de resultado.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/getByPeriod/ID_PERIODO
Parâmetros (Query String)
| Nome | Tipo | Obrigatório | Descrição |
| id_go_centro_resultado | Integer | Não | Filtrar por centro de resultado |
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/getByPeriod/1?id_go_centro_resultado=5", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/getByPeriod/1?id_go_centro_resultado=5' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
lancamento/upsert — Planejamento Orçamentário
/go/planejamentoGo
PUT
Salva, atualiza ou remove lançamentos em lote. Envie um array de entradas. Se valor e quantidade forem ambos null, o lançamento é removido. Máximo de 5000 entradas por requisição.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/upsert
Parâmetros (Body JSON)
| Nome | Tipo | Obrigatório | Descrição |
| id_go_processo_periodo | Integer | Sim | ID do período GO |
| lancamentos | Array | Sim | Array de objetos de lançamento |
Campos de cada lançamento
| Nome | Tipo | Obrigatório | Descrição |
| id_go_periodo_planejamento | Integer | Sim | ID da configuração |
| periodo | String | Sim | Mês do lançamento (YYYY-MM ou YYYY-MM-DD) |
| valor | Decimal | Não | Valor monetário |
| quantidade | Integer | Não | Quantidade (tipo 2) |
| id_go_periodo_planejamento_produto | Integer | Não | ID do vínculo de produto |
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/upsert", {
"method": "PUT",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
},
"body": JSON.stringify({
"id_go_processo_periodo": 1,
"lancamentos": [
{ "id_go_periodo_planejamento": 1, "periodo": "2026-01", "valor": 5000 },
{ "id_go_periodo_planejamento": 1, "periodo": "2026-02", "valor": 7500 },
{ "id_go_periodo_planejamento": 1, "periodo": "2026-03", "valor": null, "quantidade": null }
]
})
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request PUT \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/lancamento/upsert' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI' \
--data '{"id_go_processo_periodo":1,"lancamentos":[{"id_go_periodo_planejamento":1,"periodo":"2026-01","valor":5000}]}'
Exemplo de Resposta JSON
{
"response": { "savedCount": 2, "deletedCount": 1, "errors": [] }
}
produto/getByConfig — Planejamento Orçamentário
/go/planejamentoGo
GET
Retorna os produtos vinculados a uma configuração de planejamento. Inclui código, nome e ordem de cada produto.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/produto/getByConfig/ID_PLANEJAMENTO
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/produto/getByConfig/1", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/produto/getByConfig/1' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{ "id": 1, "id_go_periodo_planejamento": 1, "id_go_produto": 10, "ordem": 0, "codigo": "PROD-001", "nome": "Produto A" },
{ "id": 2, "id_go_periodo_planejamento": 1, "id_go_produto": 11, "ordem": 1, "codigo": "PROD-002", "nome": "Produto B" }
]
}
historico/getByPeriod — Planejamento Orçamentário
/go/planejamentoGo
GET
Retorna o histórico de auditoria de todas as operações de planejamento de um período. Suporta paginação.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/historico/getByPeriod/ID_PERIODO
Parâmetros (Query String)
| Nome | Tipo | Obrigatório | Descrição |
| page | Integer | Não | Página (padrão: 1) |
| limit | Integer | Não | Itens por página (padrão: 50, máx: 200) |
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/historico/getByPeriod/1?page=1&limit=50", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/historico/getByPeriod/1?page=1&limit=50' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'
Exemplo de Resposta JSON
{
"response": [
{
"id": 1, "id_go_processo_periodo": 1, "id_go_periodo_planejamento": 1,
"id_go_periodo_planejamento_lancamento": null, "responsavel": "API",
"data": "2026-01-15 10:30:00", "campo": "insert_Planejamento",
"valor_anterior": null, "valor": null, "campo_secundario": "1.01.001/CR-001"
}
],
"total": 25, "page": 1, "limit": 50, "hasMore": false
}
historico/getByConfig — Planejamento Orçamentário
/go/planejamentoGo
GET
Retorna o histórico de auditoria filtrado por uma configuração de planejamento específica. Suporta paginação.
URL
https://api.grupoadvis.com.br/go/planejamentoGo/historico/getByConfig/ID_PLANEJAMENTO
Parâmetros (Query String)
| Nome | Tipo | Obrigatório | Descrição |
| page | Integer | Não | Página (padrão: 1) |
| limit | Integer | Não | Itens por página (padrão: 50, máx: 200) |
JavaScript
fetch("https://api.grupoadvis.com.br/go/planejamentoGo/historico/getByConfig/1?page=1&limit=50", {
"method": "GET",
"headers": {
"token": "SEU_TOKEN_AQUI",
"Content-Type": "application/json",
"Accept-Encoding": "gzip,deflate"
}
})
.then(response => { console.log(response); })
.catch(err => { console.error(err); });
CURL
curl --request GET \
--url 'https://api.grupoadvis.com.br/go/planejamentoGo/historico/getByConfig/1?page=1&limit=50' \
--header 'Accept-Encoding: gzip,deflate' \
--header 'Content-Type: application/json' \
--header 'token: SEU_TOKEN_AQUI'