API do Nota de Serviço Nacional
A mesma API que as telas do sistema usam, aberta para os seus sistemas: clientes, serviços, ordens de serviço, contratos, financeiro e notas de serviço. As respostas são JSON, em português, e o endereço é o mesmo para todas as empresas (o token diz de qual empresa são os dados):
Esta referência é montada das rotas do próprio sistema: o que aparece aqui é o que existe agora. Os campos do corpo vêm das mesmas regras que conferem a gravação.
# Quem é o usuário do token
curl https://hubintegrado.com/api/v1/eu \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json"SDKs oficiais
Clientes prontos da API, sem dependências, com código aberto (MIT): listam página por página, transformam os erros em exceções com a mensagem em português e esperam sozinhos quando chegam ao limite de chamadas.
| Node.js 18+ | npm install @ebitsistemas/gestor-sdkCódigo e exemplos no GitHub |
| PHP 8.1+ | composer require ebitsistemas/gestor-sdkCódigo e exemplos no GitHub |
Os exemplos cobrem parceiros, produtos, serviços, vendas, financeiro e NF-e. Qualquer endpoint desta referência funciona pelo SDK: cliente.vendas.acao('status', 15, {...}) ou cliente.get('caminho').
import { Cliente } from '@ebitsistemas/gestor-sdk';
const cliente = new Cliente({ token: process.env.GESTOR_TOKEN });
for await (const produto of cliente.produtos.todos({ ativo: true })) {
console.log(produto.nome);
}use GestorIntegrado\Sdk\Cliente;
$cliente = new Cliente(getenv('GESTOR_TOKEN'));
foreach ($cliente->produtos->todos(['ativo' => true]) as $produto) {
echo $produto['nome'], PHP_EOL;
}Autenticação
Crie um token em Configurações › Integrações › API do sistema, só de leitura ou de leitura e escrita, com vencimento se quiser. Ele aparece uma vez só: guarde-o como uma senha.
O token vai no cabeçalho Authorization: Bearer e age como o usuário que o criou: vê e grava só o que esse usuário pode. Para de funcionar se o usuário for inativado, se a licença da empresa for suspensa ou se o token for revogado.
Authorization: Bearer SEU_TOKEN Accept: application/json Content-Type: application/json
Listagens e paginação
| buscatexto | Procura nos campos principais (nome, código, documento...). |
| paginainteiro | A página (começa em 1). |
| por_paginainteiro | 10, 25, 50 ou 100. |
| ordem e direcao | O campo da ordenação e asc ou desc. |
Cada recurso aceita os próprios filtros na mesma consulta (ex.: ativo=true). A resposta traz data e meta.
{
"data": [
{
"id": 1,
"nome": "Arroz"
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Respostas de erro
| 401 | Token inválido, vencido ou revogado. |
| 403 | Sem permissão, token só de leitura gravando ou licença suspensa. |
| 404 | Registro não encontrado. |
| 409 | Regra do negócio (ex.: remover algo em uso). |
| 422 | Campos recusados, em errors, por campo. |
| 429 | Muitas chamadas: aguarde o Retry-After. |
{
"message": "O campo nome é obrigatório.",
"errors": {
"nome": [
"O campo nome é obrigatório."
]
}
}Limites
Até 120 chamadas por minuto por usuário; as consultas a serviços de fora (CEP, CNPJ, notas fiscais) têm limite menor. Até 10 tokens ativos por usuário.
HTTP/1.1 429 Too Many Requests Retry-After: 30
API do contador
Para o escritório de contabilidade parceiro: registrar as guias (DAS e DARF) e os honorários das empresas que ele atende e pedir o lançamento nas contas a pagar delas. Nada entra no financeiro da empresa sem a aprovação dela.
Crie o token no painel do contador, em Integrações, só de leitura ou de leitura e escrita. Ele é do escritório, aparece uma vez só e alcança apenas as empresas atendidas. Um token revogado ou de escritório inativo recebe 401; o de leitura recebe 403 ao gravar.
GET /empresas | As empresas que o escritório atende: id, nome, razão social, CPF/CNPJ e cidade. |
GET /guias | Lista as guias e os honorários. Filtros: empresa, tipo (das, darf, honorario), competencia (AAAA-MM), situacao, busca, pagina, por_pagina, ordem e direcao. |
GET /guias/{id} | Uma guia, com o histórico (quem registrou, pediu, aprovou ou recusou). |
GET /guias/sugestao-das?empresa=&competencia= | O DAS estimado pelo cálculo do Simples Nacional da empresa, com o vencimento no dia 20 do mês seguinte. |
POST /guias | Registra a guia ou o honorário: empresa, tipo, competencia, vencimento e valor; opcionais codigo_barras, pix_copia_cola, codigo_receita (só DARF) e descricao. |
PUT /guias/{id} | Corrige a guia antes de ela ir para a empresa (registrada ou recusada). |
DELETE /guias/{id} | Cancela. Já lançada nas contas a pagar, vira um pedido de cancelamento para a empresa aprovar (motivo opcional). |
POST /guias/{id}/anexo | Envia o PDF da guia (multipart, campo arquivo, até 10 MB). |
GET /guias/{id}/arquivo | Baixa o PDF da guia. |
POST /guias/{id}/solicitar | Pede o lançamento nas contas a pagar da empresa, que aprova ou recusa (observacao opcional). |
Situações da guia: registrado, aguardando_aprovacao, lancado, recusado (com motivo_recusa) e cancelado. As respostas e os erros seguem o mesmo formato do restante da API.
curl -X POST https://notadeserviconacional.com.br/api/v1/contador/guias \
-H "Authorization: Bearer ctd_SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"empresa":"id-da-empresa","tipo":"das","competencia":"2026-10","vencimento":"2026-11-20","valor":512.3}'curl -X POST https://notadeserviconacional.com.br/api/v1/contador/guias/12/solicitar \ -H "Authorization: Bearer ctd_SEU_TOKEN" \ -H "Accept: application/json"
Parceiros (clientes e fornecedores)
9 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/parceiros/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Opcao
Parâmetros do caminho
| listainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/parceiros/opcoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros/opcoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Historico
Parâmetros do caminho
| parceirointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/parceiros/1/historico \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros/1/historico', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/parceiros?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| statustexto · obrigatório | Statusativo inativo suspenso |
| origemtexto · obrigatório | Origemnacional estrangeiro |
| documento_estrangeirotexto | Documento Estrangeiro |
| tipo_pessoatexto · obrigatório | Tipo Pessoafisica juridica |
| tiposlista · obrigatório | Tipo de parceiro |
| cpftexto | CPF |
| cnpjtexto | CNPJ |
| nome_completotexto | Nome Completo |
| razao_socialtexto | Razão Social |
| rgtexto | RG |
| nome_fantasiatexto | Nome Fantasia |
| indicacao_inscricao_estadualtexto · obrigatório | Indicação Inscrição Estadual1 2 9 |
| inscricao_estadualtexto | Inscrição Estadual |
| enquadramentotexto | Enquadramento1 2 3 4 |
| inscricao_municipaltexto | Inscrição Municipal |
| suframatexto | Suframa |
| renda_mensalnúmero | Renda Mensal |
| limite_credito_compranúmero | Limite de Crédito/Compra |
| grupo_idinteiro | Grupo |
| receber_emailsim/não | Receber Email |
| senhatexto | Senha |
| anotacoestexto | Anotações |
| enderecoslista · obrigatório | Endereços |
| contatoslista | Contatos |
Respostas
curl -X POST https://hubintegrado.com/api/v1/parceiros \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"status":"ativo","origem":"nacional","tipo_pessoa":"fisica","tipos":[],"indicacao_inscricao_estadual":"1","enderecos":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"status":"ativo","origem":"nacional","tipo_pessoa":"fisica","tipos":[],"indicacao_inscricao_estadual":"1","enderecos":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| parceirointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/parceiros/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| parceirointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| statustexto · obrigatório | Statusativo inativo suspenso |
| origemtexto · obrigatório | Origemnacional estrangeiro |
| documento_estrangeirotexto | Documento Estrangeiro |
| tipo_pessoatexto · obrigatório | Tipo Pessoafisica juridica |
| tiposlista · obrigatório | Tipo de parceiro |
| cpftexto | CPF |
| cnpjtexto | CNPJ |
| nome_completotexto | Nome Completo |
| razao_socialtexto | Razão Social |
| rgtexto | RG |
| nome_fantasiatexto | Nome Fantasia |
| indicacao_inscricao_estadualtexto · obrigatório | Indicação Inscrição Estadual1 2 9 |
| inscricao_estadualtexto | Inscrição Estadual |
| enquadramentotexto | Enquadramento1 2 3 4 |
| inscricao_municipaltexto | Inscrição Municipal |
| suframatexto | Suframa |
| renda_mensalnúmero | Renda Mensal |
| limite_credito_compranúmero | Limite de Crédito/Compra |
| grupo_idinteiro | Grupo |
| receber_emailsim/não | Receber Email |
| senhatexto | Senha |
| anotacoestexto | Anotações |
| enderecoslista · obrigatório | Endereços |
| contatoslista | Contatos |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/parceiros/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"status":"ativo","origem":"nacional","tipo_pessoa":"fisica","tipos":[],"indicacao_inscricao_estadual":"1","enderecos":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"status":"ativo","origem":"nacional","tipo_pessoa":"fisica","tipos":[],"indicacao_inscricao_estadual":"1","enderecos":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| parceirointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| statustexto · obrigatório | Statusativo inativo suspenso |
| origemtexto · obrigatório | Origemnacional estrangeiro |
| documento_estrangeirotexto | Documento Estrangeiro |
| tipo_pessoatexto · obrigatório | Tipo Pessoafisica juridica |
| tiposlista · obrigatório | Tipo de parceiro |
| cpftexto | CPF |
| cnpjtexto | CNPJ |
| nome_completotexto | Nome Completo |
| razao_socialtexto | Razão Social |
| rgtexto | RG |
| nome_fantasiatexto | Nome Fantasia |
| indicacao_inscricao_estadualtexto · obrigatório | Indicação Inscrição Estadual1 2 9 |
| inscricao_estadualtexto | Inscrição Estadual |
| enquadramentotexto | Enquadramento1 2 3 4 |
| inscricao_municipaltexto | Inscrição Municipal |
| suframatexto | Suframa |
| renda_mensalnúmero | Renda Mensal |
| limite_credito_compranúmero | Limite de Crédito/Compra |
| grupo_idinteiro | Grupo |
| receber_emailsim/não | Receber Email |
| senhatexto | Senha |
| anotacoestexto | Anotações |
| enderecoslista · obrigatório | Endereços |
| contatoslista | Contatos |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/parceiros/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"status":"ativo","origem":"nacional","tipo_pessoa":"fisica","tipos":[],"indicacao_inscricao_estadual":"1","enderecos":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"status":"ativo","origem":"nacional","tipo_pessoa":"fisica","tipos":[],"indicacao_inscricao_estadual":"1","enderecos":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| parceirointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/parceiros/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/parceiros/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Serviços
9 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/servicos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Historico
Parâmetros do caminho
| servicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/servicos/1/historico \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos/1/historico', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Historico precos
Parâmetros do caminho
| servicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/servicos/1/historico-precos \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos/1/historico-precos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/servicos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| nometexto · obrigatório | Nome |
| ativosim/não | Status |
| grupo_idinteiro | Grupo |
| codigo_referenciatexto | Código Interno/Referência |
| garantiasim/não | Garantia |
| periodo_garantiainteiro | Período de Garantia |
| emitir_notasim/não | Emissão Nota Fiscal |
| codigo_servicotexto | Código Serviço (LC 116) |
| codigo_nbstexto | Código NBS |
| aliquota_issnúmero | Alíquota do ISS |
| ibs_cbs_situacao_tributariatexto | CST do IBS/CBS |
| ibs_cbs_classificacao_tributariatexto | Classificação tributária (cClassTrib) |
| ibs_cbs_codigo_fornecimentotexto | Indicador da operação (cIndOp) |
| ibs_cbs_percentual_reducaonúmero | Redução da alíquota |
| retencoessim/não | Retenções |
| aliquota_pisnúmero | Alíquota do PIS |
| aliquota_cofinsnúmero | Alíquota do COFINS |
| aliquota_inssnúmero | Alíquota do INSS |
| aliquota_irnúmero | Alíquota do IR |
| aliquota_csllnúmero | Alíquota do CSLL |
| preco_custonúmero | Preço de Custo |
| custos_adicionaisnúmero | Custos Adicionais |
| margem_lucronúmero | Margem de Lucro |
| comissao_vendanúmero | Comissão de Venda |
| descontosnúmero | Descontos |
| preco_venda_sugeridonúmero | Preço de Venda Sugerido |
| preco_vendanúmero · obrigatório | Preço de Venda |
| descricaotexto | Descrição do Serviço |
| duracao_minutosinteiro | Duração na agenda (minutos) |
| agendamento_onlinesim/não | Agendamento online |
Respostas
curl -X POST https://hubintegrado.com/api/v1/servicos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","preco_venda":10.5}'
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","preco_venda":10.5})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| servicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/servicos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| servicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| ativosim/não | Status |
| grupo_idinteiro | Grupo |
| codigo_referenciatexto | Código Interno/Referência |
| garantiasim/não | Garantia |
| periodo_garantiainteiro | Período de Garantia |
| emitir_notasim/não | Emissão Nota Fiscal |
| codigo_servicotexto | Código Serviço (LC 116) |
| codigo_nbstexto | Código NBS |
| aliquota_issnúmero | Alíquota do ISS |
| ibs_cbs_situacao_tributariatexto | CST do IBS/CBS |
| ibs_cbs_classificacao_tributariatexto | Classificação tributária (cClassTrib) |
| ibs_cbs_codigo_fornecimentotexto | Indicador da operação (cIndOp) |
| ibs_cbs_percentual_reducaonúmero | Redução da alíquota |
| retencoessim/não | Retenções |
| aliquota_pisnúmero | Alíquota do PIS |
| aliquota_cofinsnúmero | Alíquota do COFINS |
| aliquota_inssnúmero | Alíquota do INSS |
| aliquota_irnúmero | Alíquota do IR |
| aliquota_csllnúmero | Alíquota do CSLL |
| preco_custonúmero | Preço de Custo |
| custos_adicionaisnúmero | Custos Adicionais |
| margem_lucronúmero | Margem de Lucro |
| comissao_vendanúmero | Comissão de Venda |
| descontosnúmero | Descontos |
| preco_venda_sugeridonúmero | Preço de Venda Sugerido |
| preco_vendanúmero · obrigatório | Preço de Venda |
| descricaotexto | Descrição do Serviço |
| duracao_minutosinteiro | Duração na agenda (minutos) |
| agendamento_onlinesim/não | Agendamento online |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/servicos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","preco_venda":10.5}'
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","preco_venda":10.5})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| servicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| ativosim/não | Status |
| grupo_idinteiro | Grupo |
| codigo_referenciatexto | Código Interno/Referência |
| garantiasim/não | Garantia |
| periodo_garantiainteiro | Período de Garantia |
| emitir_notasim/não | Emissão Nota Fiscal |
| codigo_servicotexto | Código Serviço (LC 116) |
| codigo_nbstexto | Código NBS |
| aliquota_issnúmero | Alíquota do ISS |
| ibs_cbs_situacao_tributariatexto | CST do IBS/CBS |
| ibs_cbs_classificacao_tributariatexto | Classificação tributária (cClassTrib) |
| ibs_cbs_codigo_fornecimentotexto | Indicador da operação (cIndOp) |
| ibs_cbs_percentual_reducaonúmero | Redução da alíquota |
| retencoessim/não | Retenções |
| aliquota_pisnúmero | Alíquota do PIS |
| aliquota_cofinsnúmero | Alíquota do COFINS |
| aliquota_inssnúmero | Alíquota do INSS |
| aliquota_irnúmero | Alíquota do IR |
| aliquota_csllnúmero | Alíquota do CSLL |
| preco_custonúmero | Preço de Custo |
| custos_adicionaisnúmero | Custos Adicionais |
| margem_lucronúmero | Margem de Lucro |
| comissao_vendanúmero | Comissão de Venda |
| descontosnúmero | Descontos |
| preco_venda_sugeridonúmero | Preço de Venda Sugerido |
| preco_vendanúmero · obrigatório | Preço de Venda |
| descricaotexto | Descrição do Serviço |
| duracao_minutosinteiro | Duração na agenda (minutos) |
| agendamento_onlinesim/não | Agendamento online |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/servicos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","preco_venda":10.5}'
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","preco_venda":10.5})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| servicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/servicos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/servicos/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Grupos
7 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/grupos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/grupos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/grupos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/grupos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| nometexto · obrigatório | Nome |
| tipotexto · obrigatório | Tipoparceiros produtos servicos faturamentos |
| grupo_pai_idinteiro | Grupo Pai |
| descricaotexto | Descrição |
| ativosim/não | Status |
Respostas
curl -X POST https://hubintegrado.com/api/v1/grupos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo":"parceiros"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/grupos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo":"parceiros"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| grupointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/grupos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/grupos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| grupointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| tipotexto · obrigatório | Tipoparceiros produtos servicos faturamentos |
| grupo_pai_idinteiro | Grupo Pai |
| descricaotexto | Descrição |
| ativosim/não | Status |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/grupos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo":"parceiros"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/grupos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo":"parceiros"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| grupointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| tipotexto · obrigatório | Tipoparceiros produtos servicos faturamentos |
| grupo_pai_idinteiro | Grupo Pai |
| descricaotexto | Descrição |
| ativosim/não | Status |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/grupos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo":"parceiros"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/grupos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo":"parceiros"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| grupointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/grupos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/grupos/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Ordens de serviço
23 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Opcao
Parâmetros do caminho
| listainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/opcoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/opcoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Kanban
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/kanban \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/kanban', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Equipamentos
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/equipamentos \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/equipamentos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Agenda
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/agenda \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/agenda', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Indicadores
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/indicadores \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/indicadores', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Calcular
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/calcular \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/calcular', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Aprovar
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/aprovar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/aprovar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Opções do formulário
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/1/nota-produto \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/nota-produto', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Nota produto
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/nota-produto \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/nota-produto', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Link
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/link \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/link', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Orcamento
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/orcamento \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/orcamento', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Status
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/status \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/status', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Impressao
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/1/impressao \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/impressao', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/ordens-servico?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| endereco_cliente_idinteiro | Endereço do Cliente |
| tecnico_idinteiro | Técnico |
| equipamento_idinteiro | Equipamento |
| ordem_origem_idinteiro | O.S. de origem (retorno em garantia) |
| agendado_iniciotexto | Agendado para |
| agendado_fimtexto | Agendado até |
| emite_nota_fiscalsim/não | Emissão Nota Fiscal |
| iss_retidosim/não | ISS retido pelo tomador |
| retencoes_federaissim/não | Retenções federais |
| data_ordem_servicodata · obrigatório | Data da O.S. |
| data_previstadata | Previsão de Entrega |
| descricao_servicostexto | Descrição dos Serviços |
| descricao_equipamentotexto | Descrição do Equipamento |
| laudo_tecnicotexto | Laudo Técnico |
| defeito_equipamentotexto | Defeito do Equipamento |
| entrada_acessoriostexto | Acessórios deixados |
| entrada_estadotexto | Estado do equipamento |
| entrada_senhatexto | Senha de desbloqueio |
| entrada_checklistlista | Checklist de entrada |
| observacaotexto | Observação |
| itenslista · obrigatório | Serviços |
| produtoslista | Produtos |
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"data_ordem_servico":"2026-10-19","itens":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"data_ordem_servico":"2026-10-19","itens":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| endereco_cliente_idinteiro | Endereço do Cliente |
| tecnico_idinteiro | Técnico |
| equipamento_idinteiro | Equipamento |
| ordem_origem_idinteiro | O.S. de origem (retorno em garantia) |
| agendado_iniciotexto | Agendado para |
| agendado_fimtexto | Agendado até |
| emite_nota_fiscalsim/não | Emissão Nota Fiscal |
| iss_retidosim/não | ISS retido pelo tomador |
| retencoes_federaissim/não | Retenções federais |
| data_ordem_servicodata · obrigatório | Data da O.S. |
| data_previstadata | Previsão de Entrega |
| descricao_servicostexto | Descrição dos Serviços |
| descricao_equipamentotexto | Descrição do Equipamento |
| laudo_tecnicotexto | Laudo Técnico |
| defeito_equipamentotexto | Defeito do Equipamento |
| entrada_acessoriostexto | Acessórios deixados |
| entrada_estadotexto | Estado do equipamento |
| entrada_senhatexto | Senha de desbloqueio |
| entrada_checklistlista | Checklist de entrada |
| observacaotexto | Observação |
| itenslista · obrigatório | Serviços |
| produtoslista | Produtos |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/ordens-servico/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"data_ordem_servico":"2026-10-19","itens":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"data_ordem_servico":"2026-10-19","itens":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| endereco_cliente_idinteiro | Endereço do Cliente |
| tecnico_idinteiro | Técnico |
| equipamento_idinteiro | Equipamento |
| ordem_origem_idinteiro | O.S. de origem (retorno em garantia) |
| agendado_iniciotexto | Agendado para |
| agendado_fimtexto | Agendado até |
| emite_nota_fiscalsim/não | Emissão Nota Fiscal |
| iss_retidosim/não | ISS retido pelo tomador |
| retencoes_federaissim/não | Retenções federais |
| data_ordem_servicodata · obrigatório | Data da O.S. |
| data_previstadata | Previsão de Entrega |
| descricao_servicostexto | Descrição dos Serviços |
| descricao_equipamentotexto | Descrição do Equipamento |
| laudo_tecnicotexto | Laudo Técnico |
| defeito_equipamentotexto | Defeito do Equipamento |
| entrada_acessoriostexto | Acessórios deixados |
| entrada_estadotexto | Estado do equipamento |
| entrada_senhatexto | Senha de desbloqueio |
| entrada_checklistlista | Checklist de entrada |
| observacaotexto | Observação |
| itenslista · obrigatório | Serviços |
| produtoslista | Produtos |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/ordens-servico/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"data_ordem_servico":"2026-10-19","itens":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"data_ordem_servico":"2026-10-19","itens":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ordens-servico/1/email \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/email', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/email \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/email', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Nfse
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/nfse \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/nfse', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Finalizar emitir
Parâmetros do caminho
| ordemServicointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ordens-servico/1/finalizar-emitir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ordens-servico/1/finalizar-emitir', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Financeiro: faturamentos e parcelas
14 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/faturamentos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Impressao
Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/faturamentos/1/impressao \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1/impressao', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Opcao
Parâmetros do caminho
| listainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/faturamentos/opcoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/opcoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Kanban
Respostas
curl https://hubintegrado.com/api/v1/faturamentos/kanban \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/kanban', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Status
Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/faturamentos/1/status \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1/status', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Cadastrar
Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
| pagamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| statustexto | Statusaguardando-pagamento pago bonificado cancelado |
| naturezatexto · obrigatório | Naturezaentrada saida |
| nometexto · obrigatório | Nome |
| parceiro_idinteiro | Cliente / Fornecedor |
| grupo_idinteiro | Grupo |
| data_lancamentodata · obrigatório | Data lançamento |
| valor_totalnúmero · obrigatório | Valor total |
| recorrencia_tipotexto | Recorrêncianenhuma semanal mensal anual |
| recorrencia_intervalointeiro | Intervalo recorrência |
| observacaotexto | Observação |
Respostas
curl -X POST https://hubintegrado.com/api/v1/faturamentos/1/pagamentos/1/baixas \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5}'
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1/pagamentos/1/baixas', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Estorno
Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
| pagamentointeiro · obrigatório | O código (id) do registro. |
| baixainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/faturamentos/1/pagamentos/1/baixas/1/estorno \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1/pagamentos/1/baixas/1/estorno', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/faturamentos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| statustexto | Statusaguardando-pagamento pago bonificado cancelado |
| naturezatexto · obrigatório | Naturezaentrada saida |
| nometexto · obrigatório | Nome |
| parceiro_idinteiro | Cliente / Fornecedor |
| grupo_idinteiro | Grupo |
| data_lancamentodata · obrigatório | Data lançamento |
| valor_totalnúmero · obrigatório | Valor total |
| recorrencia_tipotexto | Recorrêncianenhuma semanal mensal anual |
| recorrencia_intervalointeiro | Intervalo recorrência |
| observacaotexto | Observação |
Respostas
curl -X POST https://hubintegrado.com/api/v1/faturamentos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5}'
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/faturamentos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| statustexto | Statusaguardando-pagamento pago bonificado cancelado |
| naturezatexto · obrigatório | Naturezaentrada saida |
| nometexto · obrigatório | Nome |
| parceiro_idinteiro | Cliente / Fornecedor |
| grupo_idinteiro | Grupo |
| data_lancamentodata · obrigatório | Data lançamento |
| valor_totalnúmero · obrigatório | Valor total |
| recorrencia_tipotexto | Recorrêncianenhuma semanal mensal anual |
| recorrencia_intervalointeiro | Intervalo recorrência |
| observacaotexto | Observação |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/faturamentos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5}'
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| statustexto | Statusaguardando-pagamento pago bonificado cancelado |
| naturezatexto · obrigatório | Naturezaentrada saida |
| nometexto · obrigatório | Nome |
| parceiro_idinteiro | Cliente / Fornecedor |
| grupo_idinteiro | Grupo |
| data_lancamentodata · obrigatório | Data lançamento |
| valor_totalnúmero · obrigatório | Valor total |
| recorrencia_tipotexto | Recorrêncianenhuma semanal mensal anual |
| recorrencia_intervalointeiro | Intervalo recorrência |
| observacaotexto | Observação |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/faturamentos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5}'
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"natureza":"entrada","nome":"texto","data_lancamento":"2026-10-19","valor_total":10.5})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
| modelointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/faturamentos/1/email/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1/email/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| faturamentointeiro · obrigatório | O código (id) do registro. |
| modelointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/faturamentos/1/email/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/faturamentos/1/email/1', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Solicitações do contador
6 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/solicitacoes-contador?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/solicitacoes-contador', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Opcao
Parâmetros do caminho
| listainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/solicitacoes-contador/opcoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/solicitacoes-contador/opcoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Consultar um
Parâmetros do caminho
| solicitacaointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/solicitacoes-contador/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/solicitacoes-contador/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Arquivo
Parâmetros do caminho
| solicitacaointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/solicitacoes-contador/1/arquivo \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/solicitacoes-contador/1/arquivo', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Aprovar
Parâmetros do caminho
| solicitacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/solicitacoes-contador/1/aprovar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/solicitacoes-contador/1/aprovar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Recusar
Parâmetros do caminho
| solicitacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/solicitacoes-contador/1/recusar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/solicitacoes-contador/1/recusar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Boletos e PIX
8 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/boletos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Pendentes
Respostas
curl https://hubintegrado.com/api/v1/boletos/pendentes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos/pendentes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Enviar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/boletos/enviar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos/enviar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Nao enviar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/boletos/nao-enviar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos/nao-enviar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Reabrir
Parâmetros do caminho
| boletointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/boletos/1/reabrir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos/1/reabrir', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Cancelar
Parâmetros do caminho
| boletointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/boletos/1/cancelar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos/1/cancelar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Consultar
Parâmetros do caminho
| boletointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/boletos/1/consultar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos/1/consultar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/boletos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/boletos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Contas bancárias
7 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/contas-bancarias/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contas-bancarias/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/contas-bancarias?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contas-bancarias', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| ativosim/não | Status |
| nometexto · obrigatório | Nome |
| banco_idinteiro · obrigatório | Banco |
| tipo_contatexto · obrigatório | Tipo contacorrente poupanca salario investimento |
| agenciatexto · obrigatório | Agência |
| agencia_digitotexto | Dígito da agência |
| contatexto · obrigatório | Conta |
| conta_digitotexto | Dígito da conta |
| dados_cobrancaobjeto | Dados de cobrança |
Respostas
curl -X POST https://hubintegrado.com/api/v1/contas-bancarias \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","banco_id":1,"tipo_conta":"corrente","agencia":"texto","conta":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contas-bancarias', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","banco_id":1,"tipo_conta":"corrente","agencia":"texto","conta":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| contaBancariainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/contas-bancarias/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contas-bancarias/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| contaBancariainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| ativosim/não | Status |
| nometexto · obrigatório | Nome |
| banco_idinteiro · obrigatório | Banco |
| tipo_contatexto · obrigatório | Tipo contacorrente poupanca salario investimento |
| agenciatexto · obrigatório | Agência |
| agencia_digitotexto | Dígito da agência |
| contatexto · obrigatório | Conta |
| conta_digitotexto | Dígito da conta |
| dados_cobrancaobjeto | Dados de cobrança |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/contas-bancarias/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","banco_id":1,"tipo_conta":"corrente","agencia":"texto","conta":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contas-bancarias/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","banco_id":1,"tipo_conta":"corrente","agencia":"texto","conta":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| contaBancariainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| ativosim/não | Status |
| nometexto · obrigatório | Nome |
| banco_idinteiro · obrigatório | Banco |
| tipo_contatexto · obrigatório | Tipo contacorrente poupanca salario investimento |
| agenciatexto · obrigatório | Agência |
| agencia_digitotexto | Dígito da agência |
| contatexto · obrigatório | Conta |
| conta_digitotexto | Dígito da conta |
| dados_cobrancaobjeto | Dados de cobrança |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/contas-bancarias/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","banco_id":1,"tipo_conta":"corrente","agencia":"texto","conta":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contas-bancarias/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","banco_id":1,"tipo_conta":"corrente","agencia":"texto","conta":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| contaBancariainteiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/contas-bancarias/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contas-bancarias/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Calendário financeiro
1 endpoint.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/calendario?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/calendario', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Indicadores financeiros
1 endpoint.
Financeiro
Respostas
curl https://hubintegrado.com/api/v1/indicadores/financeiro \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/indicadores/financeiro', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Notas fiscais (NF-e, NFC-e e NFS-e)
22 endpoints.
Avaliar
Parâmetros do caminho
| errointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/notas-fiscais/erros/1/avaliacao \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/erros/1/avaliacao', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Listar
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/notas-fiscais/1?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Consultar um
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Transmitir
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/1/1/transmitir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/transmitir', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Consultar
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/1/1/consultar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/consultar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Cancelar
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/1/1/cancelar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/cancelar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Corrigir
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/1/1/corrigir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/corrigir', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Xml
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/xml \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/xml', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/pdf \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/pdf', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Cce
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
| eventointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/cce/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/cce/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/email \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/email', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/email \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/email', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/email \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/email', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/1/1/email \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/1/1/email', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Emitir
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/nfse/emitir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/emitir', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/notas-fiscais/nfse?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Consultar um
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Transmitir
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/transmitir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/transmitir', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Consultar
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/consultar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/consultar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Cancelar
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/cancelar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/cancelar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Xml
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/xml \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/xml', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/pdf \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/pdf', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Notas recebidas
11 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/notas-recebidas?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/notas-recebidas/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Importar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-recebidas/importar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/importar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Consultar um
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-recebidas/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Manifestar
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-recebidas/1/manifestar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1/manifestar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Relacionar
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
| iteminteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-recebidas/1/itens/1/relacionar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1/itens/1/relacionar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Aplicar regras cfop
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notas-recebidas/1/aplicar-regras-cfop \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1/aplicar-regras-cfop', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Compra
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-recebidas/1/compra \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1/compra', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Devolucao
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-recebidas/1/devolucao \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1/devolucao', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Xml
Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-recebidas/1/xml \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1/xml', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| notainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/notas-recebidas/1/pdf \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notas-recebidas/1/pdf', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Tributações
7 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/tributacoes/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/tributacoes/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/tributacoes?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/tributacoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| nometexto · obrigatório | Nome |
| observacoestexto | Observações |
| ativosim/não | Status |
| regraslista · obrigatório | Regras |
Respostas
curl -X POST https://hubintegrado.com/api/v1/tributacoes \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","regras":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/tributacoes', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","regras":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| tributacaointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/tributacoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/tributacoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| tributacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| observacoestexto | Observações |
| ativosim/não | Status |
| regraslista · obrigatório | Regras |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/tributacoes/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","regras":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/tributacoes/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","regras":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| tributacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| observacoestexto | Observações |
| ativosim/não | Status |
| regraslista · obrigatório | Regras |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/tributacoes/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","regras":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/tributacoes/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","regras":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| tributacaointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/tributacoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/tributacoes/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Classificações fiscais
6 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/classificacoes/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/classificacoes/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Status
Parâmetros do caminho
| classificacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/classificacoes/1/status \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/classificacoes/1/status', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/classificacoes?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/classificacoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Consultar um
Parâmetros do caminho
| classificacaointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/classificacoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/classificacoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| classificacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| descricaotexto · obrigatório | Descrição |
| origeminteiro · obrigatório | Origem |
| ibs_cbssim/não | IBS/CBS |
| monosim/não | Monofásica |
| transfsim/não | Transferência |
| estornosim/não | Estorno |
| presumidosim/não | Crédito presumido |
| zfmsim/não | Zona Franca de Manaus |
| ajustesim/não | Ajuste |
| ativosim/não | Status |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/classificacoes/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"descricao":"texto","origem":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/classificacoes/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"descricao":"texto","origem":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| classificacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| descricaotexto · obrigatório | Descrição |
| origeminteiro · obrigatório | Origem |
| ibs_cbssim/não | IBS/CBS |
| monosim/não | Monofásica |
| transfsim/não | Transferência |
| estornosim/não | Estorno |
| presumidosim/não | Crédito presumido |
| zfmsim/não | Zona Franca de Manaus |
| ajustesim/não | Ajuste |
| ativosim/não | Status |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/classificacoes/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"descricao":"texto","origem":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/classificacoes/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"descricao":"texto","origem":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Relatórios
3 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/relatorios?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/relatorios', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Filtros
Parâmetros do caminho
| sluginteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/relatorios/1/filtros \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/relatorios/1/filtros', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Gerar
Parâmetros do caminho
| sluginteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/relatorios/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/relatorios/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Dashboard
1 endpoint.
Dashboard
Respostas
curl https://hubintegrado.com/api/v1/dashboard \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/dashboard', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Configurações
43 endpoints.
Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/notafiscal \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/notafiscal', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/notafiscal \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/notafiscal', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Emitente
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/configuracoes/notafiscal/emitente \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/notafiscal/emitente', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Backup
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/configuracoes/notafiscal/backup \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/notafiscal/backup', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Baixar
Parâmetros do caminho
| arquivointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/notafiscal/backup/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/notafiscal/backup/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Certificado
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/notafiscal/certificado \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/notafiscal/certificado', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/pdv \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/pdv', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/pdv \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/pdv', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/comanda \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/comanda', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/comanda \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/comanda', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/autoatendimento \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/autoatendimento', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/autoatendimento \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/autoatendimento', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Impressao
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/comanda/impressao \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/comanda/impressao', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/comanda/impressao \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/comanda/impressao', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Geral
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/geral \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/geral', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/cardapio/geral \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/geral', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Layout
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/layout \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/layout', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/configuracoes/cardapio/layout \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/layout', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Imagem
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/layout/imagem \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/layout/imagem', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Imagem celular
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/layout/imagem-celular \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/layout/imagem-celular', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Horarios
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Cadastrar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Atualizar
Parâmetros do caminho
| horariointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| horariointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/entrega \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/entrega \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Bairros
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/entrega/bairros \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/bairros', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Cadastrar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/configuracoes/entrega/bairros \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/bairros', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| bairrointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| bairrointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| bairrointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Cidades
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/entrega/cidades \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/cidades', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Bairros
Parâmetros do caminho
| codigointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/entrega/cidades/1/bairros \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/cidades/1/bairros', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Importar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/importar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/importar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Situacao
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/situacao \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/situacao', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/sistema \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/sistema', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/sistema \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/sistema', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/impressao \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/impressao', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/impressao \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/impressao', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/ordem-servico \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/ordem-servico', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/ordem-servico \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/ordem-servico', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Consultar um
Respostas
curl https://hubintegrado.com/api/v1/configuracoes/agenda \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/agenda', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/configuracoes/agenda \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/configuracoes/agenda', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Usuários
6 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/usuarios?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/usuarios', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| nometexto · obrigatório | Nome |
| emailtexto · obrigatório | |
| senhatexto | Senha |
| cargo_idinteiro · obrigatório | Cargo |
| ativosim/não | Status |
| modo_acesso_iptexto | Controle de IPtodos lista_permitida lista_bloqueada |
| ips_permitidoslista | IPs permitidos |
| ips_bloqueadoslista | IPs bloqueados |
| modo_horario_acessotexto | Controle de horáriotodos personalizado |
| regras_horario_acessolista | Regras de horário |
| dois_fatorestexto | Verificação em duas etapasdesativada ativada reconfigurar |
Respostas
curl -X POST https://hubintegrado.com/api/v1/usuarios \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","email":"[email protected]","cargo_id":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/usuarios', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","email":"[email protected]","cargo_id":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| usuariointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/usuarios/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/usuarios/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| usuariointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| emailtexto · obrigatório | |
| senhatexto | Senha |
| cargo_idinteiro · obrigatório | Cargo |
| ativosim/não | Status |
| modo_acesso_iptexto | Controle de IPtodos lista_permitida lista_bloqueada |
| ips_permitidoslista | IPs permitidos |
| ips_bloqueadoslista | IPs bloqueados |
| modo_horario_acessotexto | Controle de horáriotodos personalizado |
| regras_horario_acessolista | Regras de horário |
| dois_fatorestexto | Verificação em duas etapasdesativada ativada reconfigurar |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/usuarios/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","email":"[email protected]","cargo_id":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/usuarios/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","email":"[email protected]","cargo_id":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| usuariointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| emailtexto · obrigatório | |
| senhatexto | Senha |
| cargo_idinteiro · obrigatório | Cargo |
| ativosim/não | Status |
| modo_acesso_iptexto | Controle de IPtodos lista_permitida lista_bloqueada |
| ips_permitidoslista | IPs permitidos |
| ips_bloqueadoslista | IPs bloqueados |
| modo_horario_acessotexto | Controle de horáriotodos personalizado |
| regras_horario_acessolista | Regras de horário |
| dois_fatorestexto | Verificação em duas etapasdesativada ativada reconfigurar |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/usuarios/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","email":"[email protected]","cargo_id":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/usuarios/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","email":"[email protected]","cargo_id":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| usuariointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/usuarios/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/usuarios/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Cargos
7 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/cargos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/cargos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/cargos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/cargos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| nometexto · obrigatório | Nome |
| descricaotexto | Descrição |
| administradorsim/não | Cargo Administrador |
| ativosim/não | Status |
| permissoeslista | Permissões |
Respostas
curl -X POST https://hubintegrado.com/api/v1/cargos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/cargos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| cargointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/cargos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/cargos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| cargointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| descricaotexto | Descrição |
| administradorsim/não | Cargo Administrador |
| ativosim/não | Status |
| permissoeslista | Permissões |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/cargos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/cargos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| cargointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| descricaotexto | Descrição |
| administradorsim/não | Cargo Administrador |
| ativosim/não | Status |
| permissoeslista | Permissões |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/cargos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/cargos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| cargointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/cargos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/cargos/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Status
7 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/status/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/status/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/status?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/status', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| nometexto · obrigatório | Nome |
| descricaotexto | Descrição |
| tipo_documentolista · obrigatório | Locais |
| cortexto | Cor |
| iconetexto | Ícone |
| ordeminteiro | Ordem |
| ativosim/não | Status |
| gera_conta_recebersim/não | Gera conta a receber |
| gera_conta_pagarsim/não | Gera conta a pagar |
| movimenta_estoquesim/não | Movimenta estoque |
| sentido_estoquetexto | Sentido do estoquenenhum entrada saida |
| finaliza_documentosim/não | Finaliza o documento |
| cancela_documentosim/não | Cancela o documento |
| bloqueia_edicaosim/não | Bloqueia a edição |
| emite_notasim/não | Emitir nota |
| transicoeslista | Transições |
Respostas
curl -X POST https://hubintegrado.com/api/v1/status \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo_documento":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/status', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo_documento":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| statusinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/status/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/status/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| statusinteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| descricaotexto | Descrição |
| tipo_documentolista · obrigatório | Locais |
| cortexto | Cor |
| iconetexto | Ícone |
| ordeminteiro | Ordem |
| ativosim/não | Status |
| gera_conta_recebersim/não | Gera conta a receber |
| gera_conta_pagarsim/não | Gera conta a pagar |
| movimenta_estoquesim/não | Movimenta estoque |
| sentido_estoquetexto | Sentido do estoquenenhum entrada saida |
| finaliza_documentosim/não | Finaliza o documento |
| cancela_documentosim/não | Cancela o documento |
| bloqueia_edicaosim/não | Bloqueia a edição |
| emite_notasim/não | Emitir nota |
| transicoeslista | Transições |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/status/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo_documento":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/status/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo_documento":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| statusinteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| descricaotexto | Descrição |
| tipo_documentolista · obrigatório | Locais |
| cortexto | Cor |
| iconetexto | Ícone |
| ordeminteiro | Ordem |
| ativosim/não | Status |
| gera_conta_recebersim/não | Gera conta a receber |
| gera_conta_pagarsim/não | Gera conta a pagar |
| movimenta_estoquesim/não | Movimenta estoque |
| sentido_estoquetexto | Sentido do estoquenenhum entrada saida |
| finaliza_documentosim/não | Finaliza o documento |
| cancela_documentosim/não | Cancela o documento |
| bloqueia_edicaosim/não | Bloqueia a edição |
| emite_notasim/não | Emitir nota |
| transicoeslista | Transições |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/status/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo_documento":[]}'
const resposta = await fetch('https://hubintegrado.com/api/v1/status/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo_documento":[]})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| statusinteiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/status/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/status/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Formas de pagamento
6 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/formas-pagamento?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/formas-pagamento', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| nometexto · obrigatório | Nome |
| tipotexto · obrigatório | Tipo01 02 03 04 05 10 11 12 13 14 15 16 |
| iconetexto | Ícone |
| cortexto | Corprimary secondary success info warning danger dark light |
| integracao_pagamentotexto | Integração de Pagamentomercado_pago pagseguro stone cielo rede integra_bancos_asaas integra_bancos_bancobrasil integra_bancos_banrisul integra_bancos_ailos integra_bancos_bradesco integra_bancos_cora integra_bancos_efi |
| modo_integracaotexto | Como cobrarpix cartao_online cartao_pos |
| possim/não | POS (pagamento com resposta rápida) |
| indicador_pagamentointeiro | Indicador de pagamento0 1 |
| prazo_liquidacao_diasinteiro | Prazo de liquidação |
| max_parcelasinteiro | Máximo de parcelas |
| taxa_percentualnúmero | Taxa |
| bandeiraslista | Bandeiras |
| ordeminteiro | Ordem de exibição |
| ativosim/não | Status |
| exibir_sistemasim/não | Sistema |
| exibir_mobilesim/não | Mobile |
| exibir_comandasim/não | Comanda |
| exibir_pdvsim/não | PDV |
| exibir_autoatendimentosim/não | Autoatendimento |
| exibir_cardapiosim/não | Cardápio |
| exibir_lojasim/não | Loja |
Respostas
curl -X POST https://hubintegrado.com/api/v1/formas-pagamento \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo":"01"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/formas-pagamento', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo":"01"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| formaPagamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/formas-pagamento/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/formas-pagamento/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| formaPagamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| tipotexto · obrigatório | Tipo01 02 03 04 05 10 11 12 13 14 15 16 |
| iconetexto | Ícone |
| cortexto | Corprimary secondary success info warning danger dark light |
| integracao_pagamentotexto | Integração de Pagamentomercado_pago pagseguro stone cielo rede integra_bancos_asaas integra_bancos_bancobrasil integra_bancos_banrisul integra_bancos_ailos integra_bancos_bradesco integra_bancos_cora integra_bancos_efi |
| modo_integracaotexto | Como cobrarpix cartao_online cartao_pos |
| possim/não | POS (pagamento com resposta rápida) |
| indicador_pagamentointeiro | Indicador de pagamento0 1 |
| prazo_liquidacao_diasinteiro | Prazo de liquidação |
| max_parcelasinteiro | Máximo de parcelas |
| taxa_percentualnúmero | Taxa |
| bandeiraslista | Bandeiras |
| ordeminteiro | Ordem de exibição |
| ativosim/não | Status |
| exibir_sistemasim/não | Sistema |
| exibir_mobilesim/não | Mobile |
| exibir_comandasim/não | Comanda |
| exibir_pdvsim/não | PDV |
| exibir_autoatendimentosim/não | Autoatendimento |
| exibir_cardapiosim/não | Cardápio |
| exibir_lojasim/não | Loja |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/formas-pagamento/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo":"01"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/formas-pagamento/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo":"01"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| formaPagamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| nometexto · obrigatório | Nome |
| tipotexto · obrigatório | Tipo01 02 03 04 05 10 11 12 13 14 15 16 |
| iconetexto | Ícone |
| cortexto | Corprimary secondary success info warning danger dark light |
| integracao_pagamentotexto | Integração de Pagamentomercado_pago pagseguro stone cielo rede integra_bancos_asaas integra_bancos_bancobrasil integra_bancos_banrisul integra_bancos_ailos integra_bancos_bradesco integra_bancos_cora integra_bancos_efi |
| modo_integracaotexto | Como cobrarpix cartao_online cartao_pos |
| possim/não | POS (pagamento com resposta rápida) |
| indicador_pagamentointeiro | Indicador de pagamento0 1 |
| prazo_liquidacao_diasinteiro | Prazo de liquidação |
| max_parcelasinteiro | Máximo de parcelas |
| taxa_percentualnúmero | Taxa |
| bandeiraslista | Bandeiras |
| ordeminteiro | Ordem de exibição |
| ativosim/não | Status |
| exibir_sistemasim/não | Sistema |
| exibir_mobilesim/não | Mobile |
| exibir_comandasim/não | Comanda |
| exibir_pdvsim/não | PDV |
| exibir_autoatendimentosim/não | Autoatendimento |
| exibir_cardapiosim/não | Cardápio |
| exibir_lojasim/não | Loja |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/formas-pagamento/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"nome":"texto","tipo":"01"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/formas-pagamento/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"nome":"texto","tipo":"01"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| formaPagamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/formas-pagamento/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/formas-pagamento/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Empresa
4 endpoints.
Consultar um
Respostas
curl https://hubintegrado.com/api/v1/empresa \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/empresa', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
| tipo_pessoatexto · obrigatório | Tipo Pessoajuridica fisica |
| cnpjtexto · obrigatório | CNPJ/CPF |
| razao_socialtexto · obrigatório | Razão Social |
| nome_fantasiatexto | Nome Fantasia |
| indicacao_inscricao_estadualtexto | Indicação Inscrição Estadual1 2 9 |
| inscricao_estadualtexto | Inscrição Estadual |
| enquadramentotexto | Enquadramento1 2 3 4 |
| inscricao_municipaltexto | Inscrição Municipal |
| suframatexto | Suframa |
| ceptexto | CEP |
| logradourotexto | Logradouro |
| numerotexto | Número |
| bairrotexto | Bairro |
| cidadetexto | Cidade |
| codigo_ibgetexto | Código IBGE |
| uftexto | UFAC AL AM AP BA CE DF ES GO MA MG MS |
| codigo_paistexto | Código País |
| complementotexto | Complemento |
| referenciatexto | Referência |
| emailtexto | |
| sitetexto | Site |
| celulartexto | Celular |
| telefonetexto | Telefone |
| rede_socialtexto | Rede Social |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/empresa \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"tipo_pessoa":"juridica","cnpj":"texto","razao_social":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/empresa', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"tipo_pessoa":"juridica","cnpj":"texto","razao_social":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Resumo
Respostas
curl https://hubintegrado.com/api/v1/empresa/resumo \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/empresa/resumo', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Logo
Respostas
curl https://hubintegrado.com/api/v1/empresa/logo \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/empresa/logo', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Integrações
32 endpoints.
Situacao
Respostas
curl https://hubintegrado.com/api/v1/integracoes/situacao \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/situacao', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Frete
Parâmetros do caminho
| provedorinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/integracoes/frete/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/frete/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| provedorinteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/integracoes/frete/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/frete/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Tray
Respostas
curl https://hubintegrado.com/api/v1/integracoes/tray \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Conectar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/tray/conectar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray/conectar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Desconectar
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/integracoes/tray \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Produtos
Respostas
curl https://hubintegrado.com/api/v1/integracoes/tray/produtos \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray/produtos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Publicar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/tray/produtos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray/produtos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Sincronizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/tray/sincronizar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray/sincronizar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Pedidos
Respostas
curl https://hubintegrado.com/api/v1/integracoes/tray/pedidos \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray/pedidos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Salvar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/integracoes/tray/pedidos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray/pedidos', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Conferir
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/tray/pedidos/conferir \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/tray/pedidos/conferir', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Orbizz
Respostas
curl https://hubintegrado.com/api/v1/integracoes/orbizz \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/orbizz', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/integracoes/orbizz \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/orbizz', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Testar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/orbizz/testar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/orbizz/testar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Status
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/orbizz/status \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/orbizz/status', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Qrcode
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/orbizz/qrcode \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/orbizz/qrcode', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Atual
Respostas
curl https://hubintegrado.com/api/v1/integracoes/orbizz/qrcode \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/orbizz/qrcode', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Pagbank
Respostas
curl https://hubintegrado.com/api/v1/integracoes/pagbank \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/pagbank', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/integracoes/pagbank \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/pagbank', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Testar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/pagbank/testar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/pagbank/testar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Stone
Respostas
curl https://hubintegrado.com/api/v1/integracoes/stone \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/stone', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/integracoes/stone \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/stone', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Testar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/stone/testar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/stone/testar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Mercado pago
Respostas
curl https://hubintegrado.com/api/v1/integracoes/mercado-pago \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/mercado-pago', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/integracoes/mercado-pago \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/mercado-pago', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Testar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/mercado-pago/testar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/mercado-pago/testar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Maquininhas
Respostas
curl https://hubintegrado.com/api/v1/integracoes/mercado-pago/maquininhas \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/mercado-pago/maquininhas', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/integracoes/bancos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/bancos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Consultar um
Parâmetros do caminho
| bancointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/integracoes/bancos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/bancos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| bancointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/integracoes/bancos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/bancos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Credenciais
Parâmetros do caminho
| bancointeiro · obrigatório | O código (id) do registro. |
| tipointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/integracoes/bancos/1/credenciais/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/integracoes/bancos/1/credenciais/1', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Anexos
5 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/anexos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/anexos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/anexos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/anexos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Principal
Parâmetros do caminho
| anexointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/anexos/1/principal \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/anexos/1/principal', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Remover
Parâmetros do caminho
| anexointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/anexos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/anexos/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Arquivo
Parâmetros do caminho
| anexointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/anexos/1/arquivo \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/anexos/1/arquivo', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Auditoria
3 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/auditoria/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/auditoria/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/auditoria?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/auditoria', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Consultar um
Parâmetros do caminho
| auditoriainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/auditoria/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/auditoria/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Notificações
4 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/notificacoes?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notificacoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Resumo
Respostas
curl https://hubintegrado.com/api/v1/notificacoes/resumo \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/notificacoes/resumo', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Lidas
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notificacoes/lidas \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notificacoes/lidas', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Lida
Parâmetros do caminho
| notificacaointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/notificacoes/1/lida \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/notificacoes/1/lida', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Consultas (CEP e CNPJ)
2 endpoints.
Cep
Parâmetros do caminho
| cepinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/consultas/cep/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/consultas/cep/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Cnpj
Parâmetros do caminho
| cnpjinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/consultas/cnpj/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/consultas/cnpj/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Ferramentas
3 endpoints.
Balanca
Respostas
curl https://hubintegrado.com/api/v1/ferramentas/balanca \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ferramentas/balanca', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Arquivo
Parâmetros do caminho
| modelointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ferramentas/balanca/arquivo/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ferramentas/balanca/arquivo/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Produtos
Respostas
curl https://hubintegrado.com/api/v1/ferramentas/etiquetas/produtos \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ferramentas/etiquetas/produtos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Ajuda
3 endpoints.
Faq
Respostas
curl https://hubintegrado.com/api/v1/ajuda/faq \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ajuda/faq', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Perguntas
Respostas
curl https://hubintegrado.com/api/v1/ajuda/perguntas \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ajuda/perguntas', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Iris
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ajuda/iris \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ajuda/iris', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Usuário do token
1 endpoint.
Eu
Respostas
curl https://hubintegrado.com/api/v1/eu \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/eu', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Permissoes
Respostas
curl https://hubintegrado.com/api/v1/permissoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/permissoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Contratos
12 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/contratos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Opcao
Parâmetros do caminho
| listainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/contratos/opcoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/opcoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Status
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/contratos/1/status \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1/status', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Documento
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/contratos/1/documento \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1/documento', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Assinatura
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/contratos/1/assinatura \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1/assinatura', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Remover
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
| assinanteinteiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/contratos/1/assinantes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1/assinantes/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/contratos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| modelo_idinteiro · obrigatório | Modelo |
| cliente_idinteiro · obrigatório | Cliente |
| ordem_servico_idinteiro | Ordem de serviço |
| titulotexto · obrigatório | Título |
| valornúmero | Valor |
| iniciodata | Início |
| fimdata | Término |
| observacoestexto | Observações |
Respostas
curl -X POST https://hubintegrado.com/api/v1/contratos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"modelo_id":1,"cliente_id":1,"titulo":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"modelo_id":1,"cliente_id":1,"titulo":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/contratos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| modelo_idinteiro · obrigatório | Modelo |
| cliente_idinteiro · obrigatório | Cliente |
| ordem_servico_idinteiro | Ordem de serviço |
| titulotexto · obrigatório | Título |
| valornúmero | Valor |
| iniciodata | Início |
| fimdata | Término |
| observacoestexto | Observações |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/contratos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"modelo_id":1,"cliente_id":1,"titulo":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"modelo_id":1,"cliente_id":1,"titulo":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| modelo_idinteiro · obrigatório | Modelo |
| cliente_idinteiro · obrigatório | Cliente |
| ordem_servico_idinteiro | Ordem de serviço |
| titulotexto · obrigatório | Título |
| valornúmero | Valor |
| iniciodata | Início |
| fimdata | Término |
| observacoestexto | Observações |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/contratos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"modelo_id":1,"cliente_id":1,"titulo":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"modelo_id":1,"cliente_id":1,"titulo":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| contratointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/contratos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Modelos de contrato
9 endpoints.
Gerar com ia
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/contratos-modelos/gerar-com-ia \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos/gerar-com-ia', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Cadastrar
Parâmetros do caminho
| contratoModelointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/contratos-modelos/1/arquivo \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos/1/arquivo', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Arquivo
Parâmetros do caminho
| contratoModelointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/contratos-modelos/1/arquivo \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos/1/arquivo', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/contratos-modelos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/contratos-modelos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| contratoModelointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/contratos-modelos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| contratoModelointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/contratos-modelos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| contratoModelointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/contratos-modelos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| contratoModelointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/contratos-modelos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/contratos-modelos/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Assinaturas (contratos)
3 endpoints.
Cadastrar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/assinaturas \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/assinaturas', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Imagem
Parâmetros do caminho
| assinaturainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/assinaturas/1/imagem \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/assinaturas/1/imagem', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Remover
Parâmetros do caminho
| assinaturainteiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/assinaturas/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/assinaturas/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Equipamentos (ordens de serviço)
9 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/equipamentos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Opcao
Parâmetros do caminho
| listainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/equipamentos/opcoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos/opcoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Historico
Parâmetros do caminho
| equipamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/equipamentos/1/historico \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos/1/historico', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/equipamentos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| descricaotexto · obrigatório | Equipamento |
| marcatexto | Marca |
| modelotexto | Modelo |
| numero_serietexto | Número de série |
| observacoestexto | Observações |
| ativosim/não | Status |
Respostas
curl -X POST https://hubintegrado.com/api/v1/equipamentos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"descricao":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"descricao":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| equipamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/equipamentos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| equipamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| descricaotexto · obrigatório | Equipamento |
| marcatexto | Marca |
| modelotexto | Modelo |
| numero_serietexto | Número de série |
| observacoestexto | Observações |
| ativosim/não | Status |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/equipamentos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"descricao":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"descricao":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| equipamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| descricaotexto · obrigatório | Equipamento |
| marcatexto | Marca |
| modelotexto | Modelo |
| numero_serietexto | Número de série |
| observacoestexto | Observações |
| ativosim/não | Status |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/equipamentos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"descricao":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"descricao":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| equipamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/equipamentos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/equipamentos/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}2 endpoints.
Destino
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| idinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/whatsapp/1/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/whatsapp/1/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Enviar
Parâmetros do caminho
| documentointeiro · obrigatório | O código (id) do registro. |
| idinteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/whatsapp/1/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/whatsapp/1/1', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Íris (assistente)
3 endpoints.
Mensagem
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/iris/mensagem \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/iris/mensagem', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Voz
Respostas
curl https://hubintegrado.com/api/v1/iris/voz \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/iris/voz', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Transcrever
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/iris/voz \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/iris/voz', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Documentos legais
1 endpoint.
Parâmetros do caminho
| tipointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/documentos-legais/1/pdf \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/documentos-legais/1/pdf', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Primeiro acesso
3 endpoints.
Consultar um
Respostas
curl https://hubintegrado.com/api/v1/primeiro-acesso \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/primeiro-acesso', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Aceitar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/primeiro-acesso/aceitar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/primeiro-acesso/aceitar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Configurar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/primeiro-acesso/configurar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/primeiro-acesso/configurar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Agenda
4 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/agenda?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/agenda/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Opcao
Parâmetros do caminho
| listainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/agenda/opcoes/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda/opcoes/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Horarios livres
Respostas
curl https://hubintegrado.com/api/v1/agenda/horarios-livres \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda/horarios-livres', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Agenda Bloqueios
6 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/agenda-bloqueios?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-bloqueios', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/agenda-bloqueios \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-bloqueios', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| bloqueiointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/agenda-bloqueios/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-bloqueios/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| bloqueiointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/agenda-bloqueios/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-bloqueios/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| bloqueiointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/agenda-bloqueios/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-bloqueios/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| bloqueiointeiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/agenda-bloqueios/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-bloqueios/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Agenda Profissionais
7 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/agenda-profissionais/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-profissionais/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/agenda-profissionais?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-profissionais', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/agenda-profissionais \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-profissionais', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| profissionalinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/agenda-profissionais/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-profissionais/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| profissionalinteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PUT https://hubintegrado.com/api/v1/agenda-profissionais/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-profissionais/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| profissionalinteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/agenda-profissionais/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-profissionais/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| profissionalinteiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/agenda-profissionais/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agenda-profissionais/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Agendamentos
10 endpoints.
Situacao
Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/agendamentos/1/situacao \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1/situacao', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Mover
Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/agendamentos/1/mover \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1/mover', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Atendimento
Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/agendamentos/1/atendimento \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1/atendimento', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/agendamentos/1/email \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1/email', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Link
Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/agendamentos/1/link \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1/link', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/agendamentos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| profissional_idinteiro · obrigatório | Profissional |
| iniciotexto · obrigatório | Início |
| fimtexto | Fim |
| encaixesim/não | Encaixe |
| observacaotexto | Observação |
| servicoslista | Serviços |
Respostas
curl -X POST https://hubintegrado.com/api/v1/agendamentos \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"profissional_id":1,"inicio":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"profissional_id":1,"inicio":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/agendamentos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| profissional_idinteiro · obrigatório | Profissional |
| iniciotexto · obrigatório | Início |
| fimtexto | Fim |
| encaixesim/não | Encaixe |
| observacaotexto | Observação |
| servicoslista | Serviços |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/agendamentos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"profissional_id":1,"inicio":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"profissional_id":1,"inicio":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| agendamentointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| cliente_idinteiro · obrigatório | Cliente |
| profissional_idinteiro · obrigatório | Profissional |
| iniciotexto · obrigatório | Início |
| fimtexto | Fim |
| encaixesim/não | Encaixe |
| observacaotexto | Observação |
| servicoslista | Serviços |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/agendamentos/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cliente_id":1,"profissional_id":1,"inicio":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/agendamentos/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cliente_id":1,"profissional_id":1,"inicio":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}App Servico
1 endpoint.
Inicio
Respostas
curl https://hubintegrado.com/api/v1/app-servico/inicio \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/app-servico/inicio', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}App Vendas
1 endpoint.
Inicio
Respostas
curl https://hubintegrado.com/api/v1/app-vendas/inicio \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/app-vendas/inicio', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Comunicados
3 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/comunicados?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/comunicados', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Pendentes
Respostas
curl https://hubintegrado.com/api/v1/comunicados/pendentes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/comunicados/pendentes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Lido
Parâmetros do caminho
| comunicadointeiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/comunicados/1/lido \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/comunicados/1/lido', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Ctes Recebidos
6 endpoints.
Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/ctes-recebidos?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ctes-recebidos', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/ctes-recebidos/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ctes-recebidos/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Importar
Corpo (JSON)
Os campos da tela correspondente do sistema; os recusados voltam em errors (422).
Respostas
curl -X POST https://hubintegrado.com/api/v1/ctes-recebidos/importar \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'
const resposta = await fetch('https://hubintegrado.com/api/v1/ctes-recebidos/importar', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Feito."
}Consultar um
Parâmetros do caminho
| cteinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ctes-recebidos/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ctes-recebidos/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Xml
Parâmetros do caminho
| cteinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ctes-recebidos/1/xml \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ctes-recebidos/1/xml', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Parâmetros do caminho
| cteinteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/ctes-recebidos/1/pdf \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/ctes-recebidos/1/pdf', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Regras Cfop
8 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/regras-cfop/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Previa
Respostas
curl https://hubintegrado.com/api/v1/regras-cfop/previa \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop/previa', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/regras-cfop?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| ativosim/não | Status |
| finalidadetexto · obrigatório | Finalidade01 02 03 04 05 06 07 20 30 90 |
| cfop_origemtexto · obrigatório | CFOP da nota |
| cfop_venda_estadualtexto · obrigatório | CFOP de venda dentro do estado |
| cfop_venda_interestadualtexto · obrigatório | CFOP de venda fora do estado |
| cfop_venda_exteriortexto | CFOP de venda para o exterior |
| cfop_entrada_estadualtexto | CFOP de entrada dentro do estado |
| cfop_entrada_interestadualtexto | CFOP de entrada fora do estado |
| cfop_uso_consumo_estadualtexto | CFOP de entrada de uso e consumo dentro do estado |
| cfop_uso_consumo_interestadualtexto | CFOP de entrada de uso e consumo fora do estado |
Respostas
curl -X POST https://hubintegrado.com/api/v1/regras-cfop \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"finalidade":"01","cfop_origem":"texto","cfop_venda_estadual":"texto","cfop_venda_interestadual":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"finalidade":"01","cfop_origem":"texto","cfop_venda_estadual":"texto","cfop_venda_interestadual":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/regras-cfop/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| ativosim/não | Status |
| finalidadetexto · obrigatório | Finalidade01 02 03 04 05 06 07 20 30 90 |
| cfop_origemtexto · obrigatório | CFOP da nota |
| cfop_venda_estadualtexto · obrigatório | CFOP de venda dentro do estado |
| cfop_venda_interestadualtexto · obrigatório | CFOP de venda fora do estado |
| cfop_venda_exteriortexto | CFOP de venda para o exterior |
| cfop_entrada_estadualtexto | CFOP de entrada dentro do estado |
| cfop_entrada_interestadualtexto | CFOP de entrada fora do estado |
| cfop_uso_consumo_estadualtexto | CFOP de entrada de uso e consumo dentro do estado |
| cfop_uso_consumo_interestadualtexto | CFOP de entrada de uso e consumo fora do estado |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/regras-cfop/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"finalidade":"01","cfop_origem":"texto","cfop_venda_estadual":"texto","cfop_venda_interestadual":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"finalidade":"01","cfop_origem":"texto","cfop_venda_estadual":"texto","cfop_venda_interestadual":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| ativosim/não | Status |
| finalidadetexto · obrigatório | Finalidade01 02 03 04 05 06 07 20 30 90 |
| cfop_origemtexto · obrigatório | CFOP da nota |
| cfop_venda_estadualtexto · obrigatório | CFOP de venda dentro do estado |
| cfop_venda_interestadualtexto · obrigatório | CFOP de venda fora do estado |
| cfop_venda_exteriortexto | CFOP de venda para o exterior |
| cfop_entrada_estadualtexto | CFOP de entrada dentro do estado |
| cfop_entrada_interestadualtexto | CFOP de entrada fora do estado |
| cfop_uso_consumo_estadualtexto | CFOP de entrada de uso e consumo dentro do estado |
| cfop_uso_consumo_interestadualtexto | CFOP de entrada de uso e consumo fora do estado |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/regras-cfop/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"finalidade":"01","cfop_origem":"texto","cfop_venda_estadual":"texto","cfop_venda_interestadual":"texto"}'
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"finalidade":"01","cfop_origem":"texto","cfop_venda_estadual":"texto","cfop_venda_interestadual":"texto"})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/regras-cfop/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-cfop/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Regras Reforma
7 endpoints.
Opções do formulário
Respostas
curl https://hubintegrado.com/api/v1/regras-reforma/opcoes \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-reforma/opcoes', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Listar
Consulta
busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).
Respostas
curl "https://hubintegrado.com/api/v1/regras-reforma?busca=&pagina=1&por_pagina=25" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-reforma', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": [
{
"id": 1
}
],
"meta": {
"pagina": 1,
"por_pagina": 25,
"total": 1,
"total_sem_filtro": 1
}
}Cadastrar
Corpo (JSON)
| ativosim/não | Status |
| cclasstrib_entradatexto · obrigatório | cClassTrib da nota |
| classificacao_idinteiro · obrigatório | Tributação |
| observacaotexto | Observação |
Respostas
curl -X POST https://hubintegrado.com/api/v1/regras-reforma \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cclasstrib_entrada":"texto","classificacao_id":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-reforma', {
method: 'POST',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cclasstrib_entrada":"texto","classificacao_id":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro cadastrado."
}Consultar um
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Respostas
curl https://hubintegrado.com/api/v1/regras-reforma/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-reforma/1', {
method: 'GET',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"data": {
"id": 1
}
}Atualizar
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| ativosim/não | Status |
| cclasstrib_entradatexto · obrigatório | cClassTrib da nota |
| classificacao_idinteiro · obrigatório | Tributação |
| observacaotexto | Observação |
Respostas
curl -X PUT https://hubintegrado.com/api/v1/regras-reforma/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cclasstrib_entrada":"texto","classificacao_id":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-reforma/1', {
method: 'PUT',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cclasstrib_entrada":"texto","classificacao_id":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Atualizar
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Corpo (JSON)
| ativosim/não | Status |
| cclasstrib_entradatexto · obrigatório | cClassTrib da nota |
| classificacao_idinteiro · obrigatório | Tributação |
| observacaotexto | Observação |
Respostas
curl -X PATCH https://hubintegrado.com/api/v1/regras-reforma/1 \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"cclasstrib_entrada":"texto","classificacao_id":1}'
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-reforma/1', {
method: 'PATCH',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json',
'Content-Type': 'application/json'
},
body: JSON.stringify({"cclasstrib_entrada":"texto","classificacao_id":1})
});
const dados = await resposta.json();
{
"data": {
"id": 1
},
"mensagem": "Registro atualizado."
}Remover
Parâmetros do caminho
| regrainteiro · obrigatório | O código (id) do registro. |
Respostas
curl -X DELETE https://hubintegrado.com/api/v1/regras-reforma/1 \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Accept: application/json"
const resposta = await fetch('https://hubintegrado.com/api/v1/regras-reforma/1', {
method: 'DELETE',
headers: {
Authorization: 'Bearer SEU_TOKEN',
Accept: 'application/json'
}
});
const dados = await resposta.json();
{
"mensagem": "Registro removido."
}Nenhum endpoint encontrado para essa busca.