Gestão completa para o seu negócio, em um único sistema Teste grátis por 15 dias →

Referência da API

v1 Visão geral

API do Gestor Integrado

A mesma API que as telas do sistema usam, aberta para os seus sistemas: cadastros, vendas, compras, ordens de serviço, financeiro, estoque e notas fiscais. 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):

BASEhttps://hubintegrado.com/api/v1

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.

Primeira chamada
# Quem é o usuário do token
curl https://hubintegrado.com/api/v1/eu \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"

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.

Cabeçalhos
Authorization: Bearer SEU_TOKEN
Accept: application/json
Content-Type: application/json

Listagens e paginação

buscatextoProcura nos campos principais (nome, código, documento...).
paginainteiroA página (começa em 1).
por_paginainteiro10, 25, 50 ou 100.
ordem e direcaoO 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.

Resposta
{
    "data": [
        {
            "id": 1,
            "nome": "Arroz"
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Respostas de erro

401Token inválido, vencido ou revogado.
403Sem permissão, token só de leitura gravando ou licença suspensa.
404Registro não encontrado.
409Regra do negócio (ex.: remover algo em uso).
422Campos recusados, em errors, por campo.
429Muitas chamadas: aguarde o Retry-After.
422
{
    "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.

429
HTTP/1.1 429 Too Many Requests
Retry-After: 30

Parceiros (clientes e fornecedores)

7 endpoints.

Opções do formulário

GET/api/v1/parceiros/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/parceiros/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/parceiros

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/parceiros?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/parceiros
Token com acesso de escrita

Corpo (JSON)

statustexto · obrigatório Status
ativo inativo suspenso
origemtexto · obrigatório Origem
nacional estrangeiro
documento_estrangeirotexto Documento Estrangeiro
tipo_pessoatexto · obrigatório Tipo Pessoa
fisica 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 Estadual
1 2 9
inscricao_estadualtexto Inscrição Estadual
enquadramentotexto Enquadramento
1 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

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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":[]}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/parceiros/{parceiro}

Parâmetros do caminho

parceirointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/parceiros/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/parceiros/{parceiro}
Token com acesso de escrita

Parâmetros do caminho

parceirointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

statustexto · obrigatório Status
ativo inativo suspenso
origemtexto · obrigatório Origem
nacional estrangeiro
documento_estrangeirotexto Documento Estrangeiro
tipo_pessoatexto · obrigatório Tipo Pessoa
fisica 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 Estadual
1 2 9
inscricao_estadualtexto Inscrição Estadual
enquadramentotexto Enquadramento
1 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/parceiros/{parceiro}
Token com acesso de escrita

Parâmetros do caminho

parceirointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

statustexto · obrigatório Status
ativo inativo suspenso
origemtexto · obrigatório Origem
nacional estrangeiro
documento_estrangeirotexto Documento Estrangeiro
tipo_pessoatexto · obrigatório Tipo Pessoa
fisica 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 Estadual
1 2 9
inscricao_estadualtexto Inscrição Estadual
enquadramentotexto Enquadramento
1 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/parceiros/{parceiro}
Token com acesso de escrita

Parâmetros do caminho

parceirointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/parceiros/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Produtos e estoque

9 endpoints.

Opções do formulário

GET/api/v1/produtos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/produtos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Insumos

GET/api/v1/produtos/insumos

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/produtos/insumos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Estoque

POST/api/v1/produtos/{produto}/estoque
Token com acesso de escrita

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/produtos/1/estoque \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/produtos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/produtos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/produtos
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/produtos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/produtos/{produto}

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/produtos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/produtos/{produto}
Token com acesso de escrita

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/produtos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/produtos/{produto}
Token com acesso de escrita

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/produtos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/produtos/{produto}
Token com acesso de escrita

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/produtos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Serviços

7 endpoints.

Opções do formulário

GET/api/v1/servicos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/servicos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/servicos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/servicos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/servicos
Token com acesso de escrita

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

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/servicos/{servico}

Parâmetros do caminho

servicointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/servicos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/servicos/{servico}
Token com acesso de escrita

Parâmetros do caminho

servicointeiro · obrigatórioO 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

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/servicos/{servico}
Token com acesso de escrita

Parâmetros do caminho

servicointeiro · obrigatórioO 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

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/servicos/{servico}
Token com acesso de escrita

Parâmetros do caminho

servicointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/servicos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Categorias

8 endpoints.

Opções do formulário

GET/api/v1/categorias/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/categorias/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Mover

POST/api/v1/categorias/{categoria}/mover
Token com acesso de escrita

Parâmetros do caminho

categoriainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/categorias/1/mover \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/categorias

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/categorias?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/categorias
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
categoria_pai_idinteiro Categoria Pai
ativosim/não Status

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/categorias \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/categorias/{categoria}

Parâmetros do caminho

categoriainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/categorias/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/categorias/{categoria}
Token com acesso de escrita

Parâmetros do caminho

categoriainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
categoria_pai_idinteiro Categoria Pai
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/categorias/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/categorias/{categoria}
Token com acesso de escrita

Parâmetros do caminho

categoriainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
categoria_pai_idinteiro Categoria Pai
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/categorias/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/categorias/{categoria}
Token com acesso de escrita

Parâmetros do caminho

categoriainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/categorias/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Grupos

7 endpoints.

Opções do formulário

GET/api/v1/grupos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/grupos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/grupos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/grupos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/grupos
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
tipotexto · obrigatório Tipo
parceiros produtos servicos faturamentos
grupo_pai_idinteiro Grupo Pai
descricaotexto Descrição
ativosim/não Status

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/grupos/{grupo}

Parâmetros do caminho

grupointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/grupos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/grupos/{grupo}
Token com acesso de escrita

Parâmetros do caminho

grupointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
tipotexto · obrigatório Tipo
parceiros produtos servicos faturamentos
grupo_pai_idinteiro Grupo Pai
descricaotexto Descrição
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/grupos/{grupo}
Token com acesso de escrita

Parâmetros do caminho

grupointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
tipotexto · obrigatório Tipo
parceiros produtos servicos faturamentos
grupo_pai_idinteiro Grupo Pai
descricaotexto Descrição
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/grupos/{grupo}
Token com acesso de escrita

Parâmetros do caminho

grupointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/grupos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Unidades

6 endpoints.

Listar

GET/api/v1/unidades

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/unidades?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/unidades
Token com acesso de escrita

Corpo (JSON)

siglatexto · obrigatório Sigla
nometexto · obrigatório Nome
descricaotexto Descrição
ativosim/não Status

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/unidades \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"sigla":"texto","nome":"texto"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/unidades/{unidade}

Parâmetros do caminho

unidadeinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/unidades/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/unidades/{unidade}
Token com acesso de escrita

Parâmetros do caminho

unidadeinteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

siglatexto · obrigatório Sigla
nometexto · obrigatório Nome
descricaotexto Descrição
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/unidades/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"sigla":"texto","nome":"texto"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/unidades/{unidade}
Token com acesso de escrita

Parâmetros do caminho

unidadeinteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

siglatexto · obrigatório Sigla
nometexto · obrigatório Nome
descricaotexto Descrição
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/unidades/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"sigla":"texto","nome":"texto"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/unidades/{unidade}
Token com acesso de escrita

Parâmetros do caminho

unidadeinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/unidades/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Variações

7 endpoints.

Opções do formulário

GET/api/v1/variacoes/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/variacoes/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/variacoes

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/variacoes?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/variacoes
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
descricaotexto Descrição
altera_valor_produtosim/não Altera valor do produto
obrigatoriosim/não Item obrigatório
ativosim/não Status
itenslista · obrigatório Itens da variação

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/variacoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","itens":[]}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/variacoes/{variacao}

Parâmetros do caminho

variacaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/variacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/variacoes/{variacao}
Token com acesso de escrita

Parâmetros do caminho

variacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
descricaotexto Descrição
altera_valor_produtosim/não Altera valor do produto
obrigatoriosim/não Item obrigatório
ativosim/não Status
itenslista · obrigatório Itens da variação

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/variacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","itens":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/variacoes/{variacao}
Token com acesso de escrita

Parâmetros do caminho

variacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
descricaotexto Descrição
altera_valor_produtosim/não Altera valor do produto
obrigatoriosim/não Item obrigatório
ativosim/não Status
itenslista · obrigatório Itens da variação

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/variacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","itens":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/variacoes/{variacao}
Token com acesso de escrita

Parâmetros do caminho

variacaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/variacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Grupos de impressão

7 endpoints.

Opções do formulário

GET/api/v1/grupos-impressao/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/grupos-impressao/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/grupos-impressao

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/grupos-impressao?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/grupos-impressao
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
impressoratexto Impressora
formatotexto · obrigatório Formato
padrao a4 cupom_80 cupom_58
viasinteiro · obrigatório Vias
descricaotexto Descrição
ativosim/não Status

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/grupos-impressao \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","formato":"padrao","vias":1}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/grupos-impressao/{grupoImpressao}

Parâmetros do caminho

grupoImpressaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/grupos-impressao/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/grupos-impressao/{grupoImpressao}
Token com acesso de escrita

Parâmetros do caminho

grupoImpressaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
impressoratexto Impressora
formatotexto · obrigatório Formato
padrao a4 cupom_80 cupom_58
viasinteiro · obrigatório Vias
descricaotexto Descrição
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/grupos-impressao/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","formato":"padrao","vias":1}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/grupos-impressao/{grupoImpressao}
Token com acesso de escrita

Parâmetros do caminho

grupoImpressaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
impressoratexto Impressora
formatotexto · obrigatório Formato
padrao a4 cupom_80 cupom_58
viasinteiro · obrigatório Vias
descricaotexto Descrição
ativosim/não Status

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/grupos-impressao/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","formato":"padrao","vias":1}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/grupos-impressao/{grupoImpressao}
Token com acesso de escrita

Parâmetros do caminho

grupoImpressaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/grupos-impressao/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Vendas

16 endpoints.

Opções do formulário

GET/api/v1/vendas/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/vendas/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Kanban

GET/api/v1/vendas/kanban

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/vendas/kanban \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Frete

POST/api/v1/vendas/frete
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/vendas/frete \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Calcular

POST/api/v1/vendas/calcular
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/vendas/calcular \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Aprovar

POST/api/v1/vendas/{venda}/aprovar
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/vendas/1/aprovar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Status

POST/api/v1/vendas/{venda}/status
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/vendas/1/status \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Comprovante entrega

GET/api/v1/vendas/{venda}/comprovante-entrega

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/vendas/1/comprovante-entrega \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cupom

GET/api/v1/vendas/{venda}/cupom

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/vendas/1/cupom \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/vendas

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/vendas?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/vendas
Token com acesso de escrita

Corpo (JSON)

cliente_idinteiro · obrigatório Cliente
vendedor_idinteiro Vendedor
tipo_endereco_clientetexto Tipo Endereço
mesmo entrega
endereco_cliente_idinteiro Endereço do Cliente
endereco_entrega_idinteiro Endereço de Entrega
emite_nota_fiscalsim/não Emissão Nota Fiscal
operacao_idinteiro Operação
notas_referenciadaslista Notas Referenciadas
data_vendadata · obrigatório Data da Venda
desconto_geralnúmero Desconto da Venda
outras_despesasnúmero Total de outras despesas
aliquota_mvanúmero Alíquota MVA
aliquotasobjeto Alíquotas
nota_fiscal_info_complementartexto Informações complementares
nota_fiscal_info_fiscotexto Informações para o Fisco
nota_fiscal_autorizacao_cpftexto CPF
nota_fiscal_autorizacao_cnpjtexto CNPJ
anotacoestexto Anotações do pedido
itenslista · obrigatório Produtos
transporteobjeto Transporte

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/vendas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"cliente_id":1,"data_venda":"2026-10-19","itens":[]}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/vendas/{venda}

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/vendas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/vendas/{venda}
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

cliente_idinteiro · obrigatório Cliente
vendedor_idinteiro Vendedor
tipo_endereco_clientetexto Tipo Endereço
mesmo entrega
endereco_cliente_idinteiro Endereço do Cliente
endereco_entrega_idinteiro Endereço de Entrega
emite_nota_fiscalsim/não Emissão Nota Fiscal
operacao_idinteiro Operação
notas_referenciadaslista Notas Referenciadas
data_vendadata · obrigatório Data da Venda
desconto_geralnúmero Desconto da Venda
outras_despesasnúmero Total de outras despesas
aliquota_mvanúmero Alíquota MVA
aliquotasobjeto Alíquotas
nota_fiscal_info_complementartexto Informações complementares
nota_fiscal_info_fiscotexto Informações para o Fisco
nota_fiscal_autorizacao_cpftexto CPF
nota_fiscal_autorizacao_cnpjtexto CNPJ
anotacoestexto Anotações do pedido
itenslista · obrigatório Produtos
transporteobjeto Transporte

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/vendas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"cliente_id":1,"data_venda":"2026-10-19","itens":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/vendas/{venda}
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

cliente_idinteiro · obrigatório Cliente
vendedor_idinteiro Vendedor
tipo_endereco_clientetexto Tipo Endereço
mesmo entrega
endereco_cliente_idinteiro Endereço do Cliente
endereco_entrega_idinteiro Endereço de Entrega
emite_nota_fiscalsim/não Emissão Nota Fiscal
operacao_idinteiro Operação
notas_referenciadaslista Notas Referenciadas
data_vendadata · obrigatório Data da Venda
desconto_geralnúmero Desconto da Venda
outras_despesasnúmero Total de outras despesas
aliquota_mvanúmero Alíquota MVA
aliquotasobjeto Alíquotas
nota_fiscal_info_complementartexto Informações complementares
nota_fiscal_info_fiscotexto Informações para o Fisco
nota_fiscal_autorizacao_cpftexto CPF
nota_fiscal_autorizacao_cnpjtexto CNPJ
anotacoestexto Anotações do pedido
itenslista · obrigatório Produtos
transporteobjeto Transporte

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/vendas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"cliente_id":1,"data_venda":"2026-10-19","itens":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Notafiscal

POST/api/v1/vendas/{venda}/notafiscal
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/vendas/1/notafiscal \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Email

GET/api/v1/vendas/{venda}/email

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/vendas/1/email \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Email

POST/api/v1/vendas/{venda}/email
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/vendas/1/email \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Compras

13 endpoints.

Opções do formulário

GET/api/v1/compras/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/compras/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Kanban

GET/api/v1/compras/kanban

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/compras/kanban \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Calcular

POST/api/v1/compras/calcular
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/compras/calcular \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Aprovar

POST/api/v1/compras/{compra}/aprovar
Token com acesso de escrita

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/compras/1/aprovar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Status

POST/api/v1/compras/{compra}/status
Token com acesso de escrita

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/compras/1/status \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/compras

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/compras?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/compras
Token com acesso de escrita

Corpo (JSON)

fornecedor_idinteiro · obrigatório Fornecedor
tipo_endereco_fornecedortexto Tipo Endereço
mesmo entrega
endereco_fornecedor_idinteiro Endereço do Fornecedor
endereco_entrega_idinteiro Endereço de Entrega
emite_nota_fiscalsim/não Emissão Nota Fiscal
operacao_idinteiro Operação
notas_referenciadaslista Notas Referenciadas
data_compradata · obrigatório Data da Compra
desconto_geralnúmero Desconto da Compra
outras_despesasnúmero Total de outras despesas
aliquota_mvanúmero Alíquota MVA
aliquotasobjeto Alíquotas
nota_fiscal_info_complementartexto Informações complementares
nota_fiscal_info_fiscotexto Informações para o Fisco
nota_fiscal_autorizacao_cpftexto CPF
nota_fiscal_autorizacao_cnpjtexto CNPJ
anotacoestexto Anotações do pedido
itenslista · obrigatório Produtos
transporteobjeto Transporte

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/compras \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"fornecedor_id":1,"data_compra":"2026-10-19","itens":[]}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/compras/{compra}

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/compras/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/compras/{compra}
Token com acesso de escrita

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

fornecedor_idinteiro · obrigatório Fornecedor
tipo_endereco_fornecedortexto Tipo Endereço
mesmo entrega
endereco_fornecedor_idinteiro Endereço do Fornecedor
endereco_entrega_idinteiro Endereço de Entrega
emite_nota_fiscalsim/não Emissão Nota Fiscal
operacao_idinteiro Operação
notas_referenciadaslista Notas Referenciadas
data_compradata · obrigatório Data da Compra
desconto_geralnúmero Desconto da Compra
outras_despesasnúmero Total de outras despesas
aliquota_mvanúmero Alíquota MVA
aliquotasobjeto Alíquotas
nota_fiscal_info_complementartexto Informações complementares
nota_fiscal_info_fiscotexto Informações para o Fisco
nota_fiscal_autorizacao_cpftexto CPF
nota_fiscal_autorizacao_cnpjtexto CNPJ
anotacoestexto Anotações do pedido
itenslista · obrigatório Produtos
transporteobjeto Transporte

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/compras/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"fornecedor_id":1,"data_compra":"2026-10-19","itens":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/compras/{compra}
Token com acesso de escrita

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

fornecedor_idinteiro · obrigatório Fornecedor
tipo_endereco_fornecedortexto Tipo Endereço
mesmo entrega
endereco_fornecedor_idinteiro Endereço do Fornecedor
endereco_entrega_idinteiro Endereço de Entrega
emite_nota_fiscalsim/não Emissão Nota Fiscal
operacao_idinteiro Operação
notas_referenciadaslista Notas Referenciadas
data_compradata · obrigatório Data da Compra
desconto_geralnúmero Desconto da Compra
outras_despesasnúmero Total de outras despesas
aliquota_mvanúmero Alíquota MVA
aliquotasobjeto Alíquotas
nota_fiscal_info_complementartexto Informações complementares
nota_fiscal_info_fiscotexto Informações para o Fisco
nota_fiscal_autorizacao_cpftexto CPF
nota_fiscal_autorizacao_cnpjtexto CNPJ
anotacoestexto Anotações do pedido
itenslista · obrigatório Produtos
transporteobjeto Transporte

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/compras/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"fornecedor_id":1,"data_compra":"2026-10-19","itens":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Notafiscal

POST/api/v1/compras/{compra}/notafiscal
Token com acesso de escrita

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/compras/1/notafiscal \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Email

GET/api/v1/compras/{compra}/email

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/compras/1/email \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Email

POST/api/v1/compras/{compra}/email
Token com acesso de escrita

Parâmetros do caminho

comprainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/compras/1/email \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Ordens de serviço

20 endpoints.

Opções do formulário

GET/api/v1/ordens-servico/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Kanban

GET/api/v1/ordens-servico/kanban

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/kanban \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Equipamentos

GET/api/v1/ordens-servico/equipamentos

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/equipamentos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Agenda

GET/api/v1/ordens-servico/agenda

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/agenda \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Indicadores

GET/api/v1/ordens-servico/indicadores

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/indicadores \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Calcular

POST/api/v1/ordens-servico/calcular
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Aprovar

POST/api/v1/ordens-servico/{ordemServico}/aprovar
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Opções do formulário

GET/api/v1/ordens-servico/{ordemServico}/nota-produto

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/1/nota-produto \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Nota produto

POST/api/v1/ordens-servico/{ordemServico}/nota-produto
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Link

POST/api/v1/ordens-servico/{ordemServico}/link
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Orcamento

POST/api/v1/ordens-servico/{ordemServico}/orcamento
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Status

POST/api/v1/ordens-servico/{ordemServico}/status
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/ordens-servico

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/ordens-servico?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/ordens-servico
Token com acesso de escrita

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
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

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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":[]}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/ordens-servico/{ordemServico}

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/ordens-servico/{ordemServico}
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO 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
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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/ordens-servico/{ordemServico}
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO 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
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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Email

GET/api/v1/ordens-servico/{ordemServico}/email

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ordens-servico/1/email \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Email

POST/api/v1/ordens-servico/{ordemServico}/email
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Nfse

POST/api/v1/ordens-servico/{ordemServico}/nfse
Token com acesso de escrita

Parâmetros do caminho

ordemServicointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Descontos

7 endpoints.

Opções do formulário

GET/api/v1/descontos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/descontos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/descontos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/descontos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/descontos
Token com acesso de escrita

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome
descricaotexto Descrição
tipotexto · obrigatório Tipo de desconto
valor percentual
valornúmero · obrigatório Valor
data_inicialdata · obrigatório Validade inicial
data_finaldata · obrigatório Validade final
dias_semanalista Dias da semana
hora_inicialtexto Horário inicial
hora_finaltexto Horário final
canaislista Canais
todos_os_produtossim/não Todos os produtos
categoriaslista Categorias
produtoslista Produtos
servicoslista Serviços

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/descontos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","tipo":"valor","valor":10.5,"data_inicial":"2026-10-19","data_final":"2026-10-19"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/descontos/{desconto}

Parâmetros do caminho

descontointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/descontos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/descontos/{desconto}
Token com acesso de escrita

Parâmetros do caminho

descontointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome
descricaotexto Descrição
tipotexto · obrigatório Tipo de desconto
valor percentual
valornúmero · obrigatório Valor
data_inicialdata · obrigatório Validade inicial
data_finaldata · obrigatório Validade final
dias_semanalista Dias da semana
hora_inicialtexto Horário inicial
hora_finaltexto Horário final
canaislista Canais
todos_os_produtossim/não Todos os produtos
categoriaslista Categorias
produtoslista Produtos
servicoslista Serviços

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/descontos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","tipo":"valor","valor":10.5,"data_inicial":"2026-10-19","data_final":"2026-10-19"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/descontos/{desconto}
Token com acesso de escrita

Parâmetros do caminho

descontointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome
descricaotexto Descrição
tipotexto · obrigatório Tipo de desconto
valor percentual
valornúmero · obrigatório Valor
data_inicialdata · obrigatório Validade inicial
data_finaldata · obrigatório Validade final
dias_semanalista Dias da semana
hora_inicialtexto Horário inicial
hora_finaltexto Horário final
canaislista Canais
todos_os_produtossim/não Todos os produtos
categoriaslista Categorias
produtoslista Produtos
servicoslista Serviços

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/descontos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","tipo":"valor","valor":10.5,"data_inicial":"2026-10-19","data_final":"2026-10-19"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/descontos/{desconto}
Token com acesso de escrita

Parâmetros do caminho

descontointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/descontos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Financeiro: faturamentos e parcelas

10 endpoints.

Opções do formulário

GET/api/v1/faturamentos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/faturamentos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Kanban

GET/api/v1/faturamentos/kanban

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/faturamentos/kanban \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Status

POST/api/v1/faturamentos/{faturamento}/status
Token com acesso de escrita

Parâmetros do caminho

faturamentointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cadastrar

POST/api/v1/faturamentos/{faturamento}/pagamentos/{pagamento}/baixas
Token com acesso de escrita

Parâmetros do caminho

faturamentointeiro · obrigatórioO código (id) do registro.
pagamentointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

statustexto Status
aguardando-pagamento pago bonificado cancelado
naturezatexto · obrigatório Natureza
entrada 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ência
nenhuma semanal mensal anual
recorrencia_intervalointeiro Intervalo recorrência
observacaotexto Observação

Respostas

201 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Estorno

POST/api/v1/faturamentos/{faturamento}/pagamentos/{pagamento}/baixas/{baixa}/estorno
Token com acesso de escrita

Parâmetros do caminho

faturamentointeiro · obrigatórioO código (id) do registro.
pagamentointeiro · obrigatórioO código (id) do registro.
baixainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/faturamentos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/faturamentos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/faturamentos
Token com acesso de escrita

Corpo (JSON)

statustexto Status
aguardando-pagamento pago bonificado cancelado
naturezatexto · obrigatório Natureza
entrada 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ência
nenhuma semanal mensal anual
recorrencia_intervalointeiro Intervalo recorrência
observacaotexto Observação

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/faturamentos/{faturamento}

Parâmetros do caminho

faturamentointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/faturamentos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/faturamentos/{faturamento}
Token com acesso de escrita

Parâmetros do caminho

faturamentointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

statustexto Status
aguardando-pagamento pago bonificado cancelado
naturezatexto · obrigatório Natureza
entrada 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ência
nenhuma semanal mensal anual
recorrencia_intervalointeiro Intervalo recorrência
observacaotexto Observação

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/faturamentos/{faturamento}
Token com acesso de escrita

Parâmetros do caminho

faturamentointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

statustexto Status
aguardando-pagamento pago bonificado cancelado
naturezatexto · obrigatório Natureza
entrada 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ência
nenhuma semanal mensal anual
recorrencia_intervalointeiro Intervalo recorrência
observacaotexto Observação

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Boletos e PIX

8 endpoints.

Opções do formulário

GET/api/v1/boletos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/boletos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Pendentes

GET/api/v1/boletos/pendentes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/boletos/pendentes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Enviar

POST/api/v1/boletos/enviar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Nao enviar

POST/api/v1/boletos/nao-enviar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Reabrir

POST/api/v1/boletos/{boleto}/reabrir
Token com acesso de escrita

Parâmetros do caminho

boletointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cancelar

POST/api/v1/boletos/{boleto}/cancelar
Token com acesso de escrita

Parâmetros do caminho

boletointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Consultar

POST/api/v1/boletos/{boleto}/consultar
Token com acesso de escrita

Parâmetros do caminho

boletointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/boletos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/boletos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "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

GET/api/v1/contas-bancarias/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/contas-bancarias/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/contas-bancarias

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/contas-bancarias?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/contas-bancarias
Token com acesso de escrita

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome
banco_idinteiro · obrigatório Banco
tipo_contatexto · obrigatório Tipo conta
corrente 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

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/contas-bancarias/{contaBancaria}

Parâmetros do caminho

contaBancariainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/contas-bancarias/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/contas-bancarias/{contaBancaria}
Token com acesso de escrita

Parâmetros do caminho

contaBancariainteiro · obrigatórioO 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 conta
corrente 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

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/contas-bancarias/{contaBancaria}
Token com acesso de escrita

Parâmetros do caminho

contaBancariainteiro · obrigatórioO 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 conta
corrente 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

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/contas-bancarias/{contaBancaria}
Token com acesso de escrita

Parâmetros do caminho

contaBancariainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/contas-bancarias/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Caixas

6 endpoints.

Listar

GET/api/v1/caixas

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/caixas?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/caixas
Token com acesso de escrita

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/caixas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/caixas/{caixa}

Parâmetros do caminho

caixainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/caixas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/caixas/{caixa}
Token com acesso de escrita

Parâmetros do caminho

caixainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/caixas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/caixas/{caixa}
Token com acesso de escrita

Parâmetros do caminho

caixainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/caixas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/caixas/{caixa}
Token com acesso de escrita

Parâmetros do caminho

caixainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/caixas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Fechamentos de caixa

4 endpoints.

Opções do formulário

GET/api/v1/fechamentos-caixa/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/fechamentos-caixa/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/fechamentos-caixa

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/fechamentos-caixa?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/fechamentos-caixa/{abertura}

Parâmetros do caminho

aberturainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/fechamentos-caixa/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Fechar

POST/api/v1/fechamentos-caixa/{abertura}/fechar
Token com acesso de escrita

Parâmetros do caminho

aberturainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/fechamentos-caixa/1/fechar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Calendário financeiro

1 endpoint.

Listar

GET/api/v1/calendario

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/calendario?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Indicadores financeiros

1 endpoint.

Financeiro

GET/api/v1/indicadores/financeiro

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/indicadores/financeiro \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Notas fiscais (NF-e, NFC-e e NFS-e)

20 endpoints.

Listar

GET/api/v1/notas-fiscais/{documento}

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/notas-fiscais/1?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/notas-fiscais/{documento}/{nota}

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Transmitir

POST/api/v1/notas-fiscais/{documento}/{nota}/transmitir
Token com acesso de escrita

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Consultar

POST/api/v1/notas-fiscais/{documento}/{nota}/consultar
Token com acesso de escrita

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cancelar

POST/api/v1/notas-fiscais/{documento}/{nota}/cancelar
Token com acesso de escrita

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Corrigir

POST/api/v1/notas-fiscais/{documento}/{nota}/corrigir
Token com acesso de escrita

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Xml

GET/api/v1/notas-fiscais/{documento}/{nota}/xml

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/xml \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Pdf

GET/api/v1/notas-fiscais/{documento}/{nota}/pdf

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/pdf \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cce

GET/api/v1/notas-fiscais/{documento}/{nota}/cce/{evento}

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.
eventointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/cce/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Email

GET/api/v1/notas-fiscais/nfse/{nota}/email

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/email \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Email

POST/api/v1/notas-fiscais/nfse/{nota}/email
Token com acesso de escrita

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Email

GET/api/v1/notas-fiscais/{documento}/{nota}/email

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/1/1/email \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Email

POST/api/v1/notas-fiscais/{documento}/{nota}/email
Token com acesso de escrita

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/notas-fiscais/nfse

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/notas-fiscais/nfse?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/notas-fiscais/nfse/{nota}

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Transmitir

POST/api/v1/notas-fiscais/nfse/{nota}/transmitir
Token com acesso de escrita

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Consultar

POST/api/v1/notas-fiscais/nfse/{nota}/consultar
Token com acesso de escrita

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cancelar

POST/api/v1/notas-fiscais/nfse/{nota}/cancelar
Token com acesso de escrita

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Xml

GET/api/v1/notas-fiscais/nfse/{nota}/xml

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/xml \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Pdf

GET/api/v1/notas-fiscais/nfse/{nota}/pdf

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-fiscais/nfse/1/pdf \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Notas recebidas

11 endpoints.

Listar

GET/api/v1/notas-recebidas

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/notas-recebidas?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Opções do formulário

GET/api/v1/notas-recebidas/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-recebidas/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Importar

POST/api/v1/notas-recebidas/importar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Buscar nfse

POST/api/v1/notas-recebidas/buscar-nfse
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/notas-recebidas/buscar-nfse \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Consultar um

GET/api/v1/notas-recebidas/{nota}

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-recebidas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Manifestar

POST/api/v1/notas-recebidas/{nota}/manifestar
Token com acesso de escrita

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Relacionar

POST/api/v1/notas-recebidas/{nota}/itens/{item}/relacionar
Token com acesso de escrita

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.
iteminteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Compra

GET/api/v1/notas-recebidas/{nota}/compra

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-recebidas/1/compra \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Devolucao

GET/api/v1/notas-recebidas/{nota}/devolucao

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-recebidas/1/devolucao \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Xml

GET/api/v1/notas-recebidas/{nota}/xml

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-recebidas/1/xml \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Pdf

GET/api/v1/notas-recebidas/{nota}/pdf

Parâmetros do caminho

notainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notas-recebidas/1/pdf \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Tributações

7 endpoints.

Opções do formulário

GET/api/v1/tributacoes/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/tributacoes/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/tributacoes

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/tributacoes?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/tributacoes
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
observacoestexto Observações
ativosim/não Status
regraslista · obrigatório Regras

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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":[]}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/tributacoes/{tributacao}

Parâmetros do caminho

tributacaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/tributacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/tributacoes/{tributacao}
Token com acesso de escrita

Parâmetros do caminho

tributacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
observacoestexto Observações
ativosim/não Status
regraslista · obrigatório Regras

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/tributacoes/{tributacao}
Token com acesso de escrita

Parâmetros do caminho

tributacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
observacoestexto Observações
ativosim/não Status
regraslista · obrigatório Regras

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/tributacoes/{tributacao}
Token com acesso de escrita

Parâmetros do caminho

tributacaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/tributacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Operações fiscais

7 endpoints.

Opções do formulário

GET/api/v1/operacoes/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/operacoes/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/operacoes

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/operacoes?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/operacoes
Token com acesso de escrita

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome
modelo_documentotexto · obrigatório Modelo do Documento
55 65
tipo_documentotexto · obrigatório Tipo de Documento
0 1
finalidade_operacaotexto · obrigatório Finalidade da Operação
01 02 03 04 05 06 07 20 30 90
consumidor_finaltexto · obrigatório Consumidor Final
0 1
presenca_consumidortexto · obrigatório Presença do Consumidor
0 1 2 3 4 9
cfop_dentro_estadotexto CFOP dentro do estado
cfop_fora_estadotexto CFOP fora do estado
cfop_exteriortexto CFOP exterior

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/operacoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","modelo_documento":"55","tipo_documento":"0","finalidade_operacao":"01","consumidor_final":"0","presenca_consumidor":"0"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/operacoes/{operacao}

Parâmetros do caminho

operacaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/operacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/operacoes/{operacao}
Token com acesso de escrita

Parâmetros do caminho

operacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome
modelo_documentotexto · obrigatório Modelo do Documento
55 65
tipo_documentotexto · obrigatório Tipo de Documento
0 1
finalidade_operacaotexto · obrigatório Finalidade da Operação
01 02 03 04 05 06 07 20 30 90
consumidor_finaltexto · obrigatório Consumidor Final
0 1
presenca_consumidortexto · obrigatório Presença do Consumidor
0 1 2 3 4 9
cfop_dentro_estadotexto CFOP dentro do estado
cfop_fora_estadotexto CFOP fora do estado
cfop_exteriortexto CFOP exterior

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/operacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","modelo_documento":"55","tipo_documento":"0","finalidade_operacao":"01","consumidor_final":"0","presenca_consumidor":"0"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/operacoes/{operacao}
Token com acesso de escrita

Parâmetros do caminho

operacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

ativosim/não Status
nometexto · obrigatório Nome
modelo_documentotexto · obrigatório Modelo do Documento
55 65
tipo_documentotexto · obrigatório Tipo de Documento
0 1
finalidade_operacaotexto · obrigatório Finalidade da Operação
01 02 03 04 05 06 07 20 30 90
consumidor_finaltexto · obrigatório Consumidor Final
0 1
presenca_consumidortexto · obrigatório Presença do Consumidor
0 1 2 3 4 9
cfop_dentro_estadotexto CFOP dentro do estado
cfop_fora_estadotexto CFOP fora do estado
cfop_exteriortexto CFOP exterior

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PATCH https://hubintegrado.com/api/v1/operacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"nome":"texto","modelo_documento":"55","tipo_documento":"0","finalidade_operacao":"01","consumidor_final":"0","presenca_consumidor":"0"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/operacoes/{operacao}
Token com acesso de escrita

Parâmetros do caminho

operacaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/operacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Classificações fiscais

6 endpoints.

Opções do formulário

GET/api/v1/classificacoes/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/classificacoes/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Status

POST/api/v1/classificacoes/{classificacao}/status
Token com acesso de escrita

Parâmetros do caminho

classificacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/classificacoes

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/classificacoes?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/classificacoes/{classificacao}

Parâmetros do caminho

classificacaointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/classificacoes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/classificacoes/{classificacao}
Token com acesso de escrita

Parâmetros do caminho

classificacaointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/classificacoes/{classificacao}
Token com acesso de escrita

Parâmetros do caminho

classificacaointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Relatórios

3 endpoints.

Listar

GET/api/v1/relatorios

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/relatorios?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Filtros

GET/api/v1/relatorios/{slug}/filtros

Parâmetros do caminho

sluginteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/relatorios/1/filtros \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Gerar

GET/api/v1/relatorios/{slug}

Parâmetros do caminho

sluginteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/relatorios/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Dashboard

1 endpoint.

Dashboard

GET/api/v1/dashboard

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/dashboard \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Comanda

46 endpoints.

Inicio

GET/api/v1/comanda/inicio

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/inicio \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Consultar um

GET/api/v1/comanda/produtos/{produto}

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/produtos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Imagem

GET/api/v1/comanda/produtos/{produto}/imagem

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/produtos/1/imagem \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Clientes

GET/api/v1/comanda/clientes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/clientes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Consultar um

GET/api/v1/comanda/clientes/{cliente}

Parâmetros do caminho

clienteinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/clientes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cadastrar

POST/api/v1/comanda/vendas
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/vendas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Cobranca

GET/api/v1/comanda/vendas/{venda}/cobranca

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/vendas/1/cobranca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Iniciar

POST/api/v1/comanda/vendas/{venda}/cobranca
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/vendas/1/cobranca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Confirmar

POST/api/v1/comanda/vendas/{venda}/cobranca/{parcela}/confirmar
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.
parcelainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/vendas/1/cobranca/1/confirmar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cancelar

POST/api/v1/comanda/vendas/{venda}/cobranca/cancelar-venda
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/vendas/1/cobranca/cancelar-venda \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Ultima

GET/api/v1/comanda/vendas/ultima

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/vendas/ultima \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Consultar um

GET/api/v1/comanda/vendas/{venda}

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/vendas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cupom

GET/api/v1/comanda/vendas/{venda}/cupom

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/vendas/1/cupom \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Nota

GET/api/v1/comanda/vendas/{venda}/notafiscal

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/vendas/1/notafiscal \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Emitir

POST/api/v1/comanda/vendas/{venda}/notafiscal
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/vendas/1/notafiscal \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Pdf

GET/api/v1/comanda/vendas/{venda}/notafiscal/pdf

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/vendas/1/notafiscal/pdf \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Caixa

GET/api/v1/comanda/caixa

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/caixa \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Abrir

POST/api/v1/comanda/caixa/abrir
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/caixa/abrir \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Fechar

POST/api/v1/comanda/caixa/fechar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/caixa/fechar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Movimento

POST/api/v1/comanda/caixa/{tipo}
Token com acesso de escrita

Parâmetros do caminho

tipointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/caixa/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/comanda/pedidos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/comanda/pedidos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/comanda/pedidos/{pedido}

Parâmetros do caminho

pedidointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/pedidos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Status

POST/api/v1/comanda/pedidos/{pedido}/status
Token com acesso de escrita

Parâmetros do caminho

pedidointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/pedidos/1/status \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cozinha

GET/api/v1/comanda/pedidos/{pedido}/cozinha

Parâmetros do caminho

pedidointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/pedidos/1/cozinha \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/comanda/cozinha

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/comanda/cozinha?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Avancar

POST/api/v1/comanda/cozinha/{pedido}/avancar
Token com acesso de escrita

Parâmetros do caminho

pedidointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/cozinha/1/avancar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Item

POST/api/v1/comanda/cozinha/{pedido}/item
Token com acesso de escrita

Parâmetros do caminho

pedidointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/cozinha/1/item \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/comanda/painel

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/comanda/painel?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Mapa

GET/api/v1/comanda/entregas/mapa

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/entregas/mapa \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Chamar

POST/api/v1/comanda/painel/{pedido}/chamar
Token com acesso de escrita

Parâmetros do caminho

pedidointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/painel/1/chamar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Voz

GET/api/v1/comanda/painel/voz/{chamada}

Parâmetros do caminho

chamadainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/painel/voz/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Reservar

POST/api/v1/comanda/mesas/reservar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/mesas/reservar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/comanda/mesas

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/comanda/mesas?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/comanda/mesas
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/mesas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Buscar

GET/api/v1/comanda/mesas/buscar

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/mesas/buscar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Selecionar

POST/api/v1/comanda/mesas/selecionar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/mesas/selecionar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Liberar

POST/api/v1/comanda/mesas/liberar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/mesas/liberar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Atualizar

PUT/api/v1/comanda/mesas/{id}
Token com acesso de escrita

Parâmetros do caminho

idinteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/comanda/mesas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/comanda/mesas/{id}
Token com acesso de escrita

Parâmetros do caminho

idinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/comanda/mesas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Listar

GET/api/v1/comanda/comandas

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/comanda/comandas?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/comanda/comandas
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/comandas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Buscar

GET/api/v1/comanda/comandas/buscar

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/comanda/comandas/buscar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Selecionar

POST/api/v1/comanda/comandas/selecionar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/comandas/selecionar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Liberar

POST/api/v1/comanda/comandas/liberar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/comanda/comandas/liberar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Atualizar

PUT/api/v1/comanda/comandas/{id}
Token com acesso de escrita

Parâmetros do caminho

idinteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X PUT https://hubintegrado.com/api/v1/comanda/comandas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/comanda/comandas/{id}
Token com acesso de escrita

Parâmetros do caminho

idinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/comanda/comandas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

PDV (frente de caixa)

24 endpoints.

Inicio

GET/api/v1/pdv/inicio

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/inicio \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Produtos

GET/api/v1/pdv/produtos

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/produtos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Codigo

GET/api/v1/pdv/produtos/codigo/{codigo}

Parâmetros do caminho

codigointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/produtos/codigo/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Clientes

GET/api/v1/pdv/clientes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/clientes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cadastrar

POST/api/v1/pdv/vendas
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/vendas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Cobranca

GET/api/v1/pdv/vendas/{venda}/cobranca

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/vendas/1/cobranca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Iniciar

POST/api/v1/pdv/vendas/{venda}/cobranca
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/vendas/1/cobranca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Confirmar

POST/api/v1/pdv/vendas/{venda}/cobranca/{parcela}/confirmar
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.
parcelainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/vendas/1/cobranca/1/confirmar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cancelar

POST/api/v1/pdv/vendas/{venda}/cobranca/cancelar-venda
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/vendas/1/cobranca/cancelar-venda \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Salvar

POST/api/v1/pdv/vendas/salvar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/vendas/salvar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Listar

GET/api/v1/pdv/abertas

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/pdv/abertas?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/pdv/abertas/{venda}

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/abertas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Ultima

GET/api/v1/pdv/vendas/ultima

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/vendas/ultima \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Buscar

GET/api/v1/pdv/comandas/buscar

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/comandas/buscar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Receber

POST/api/v1/pdv/comandas/{venda}/receber
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/comandas/1/receber \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Salvar

POST/api/v1/pdv/comandas/{venda}/salvar
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/comandas/1/salvar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Consultar um

GET/api/v1/pdv/vendas/{venda}

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/vendas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Nota

GET/api/v1/pdv/vendas/{venda}/notafiscal

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/vendas/1/notafiscal \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Pdf

GET/api/v1/pdv/vendas/{venda}/notafiscal/pdf

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/vendas/1/notafiscal/pdf \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Emitir

POST/api/v1/pdv/vendas/{venda}/notafiscal
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/vendas/1/notafiscal \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Caixa

GET/api/v1/pdv/caixa

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/pdv/caixa \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Abrir

POST/api/v1/pdv/caixa/abrir
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/caixa/abrir \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Fechar

POST/api/v1/pdv/caixa/fechar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/caixa/fechar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Movimento

POST/api/v1/pdv/caixa/{tipo}
Token com acesso de escrita

Parâmetros do caminho

tipointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/pdv/caixa/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

App do entregador

7 endpoints.

Entregas

GET/api/v1/entregador/entregas

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/entregador/entregas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Posicao

POST/api/v1/entregador/posicao
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/entregador/posicao \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Posicao

POST/api/v1/entregador/entregas/{codigo}/posicao
Token com acesso de escrita

Parâmetros do caminho

codigointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/entregador/entregas/1/posicao \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Acao

POST/api/v1/entregador/entregas/{codigo}/{acao}
Token com acesso de escrita

Parâmetros do caminho

codigointeiro · obrigatórioO código (id) do registro.
acaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/entregador/entregas/1/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Relatorio

GET/api/v1/entregador/relatorio

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/entregador/relatorio \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Previa

POST/api/v1/entregador/rota/previa
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/entregador/rota/previa \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Iniciar

POST/api/v1/entregador/rota/iniciar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/entregador/rota/iniciar \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Auto atendimento (totem)

8 endpoints.

Inicio

GET/api/v1/autoatendimento/inicio

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/autoatendimento/inicio \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Consultar um

GET/api/v1/autoatendimento/produtos/{produto}

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/autoatendimento/produtos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Imagem

GET/api/v1/autoatendimento/produtos/{produto}/imagem

Parâmetros do caminho

produtointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/autoatendimento/produtos/1/imagem \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cadastrar

POST/api/v1/autoatendimento/pedidos
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/autoatendimento/pedidos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Cupom

GET/api/v1/autoatendimento/pedidos/{venda}/cupom

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/autoatendimento/pedidos/1/cupom \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Iniciar

POST/api/v1/autoatendimento/pedidos/{venda}/cobranca
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/autoatendimento/pedidos/1/cobranca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Cobranca

GET/api/v1/autoatendimento/pedidos/{venda}/cobranca

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/autoatendimento/pedidos/1/cobranca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cancelar

DELETE/api/v1/autoatendimento/pedidos/{venda}/cobranca
Token com acesso de escrita

Parâmetros do caminho

vendainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/autoatendimento/pedidos/1/cobranca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Configurações

36 endpoints.

Consultar um

GET/api/v1/configuracoes/notafiscal

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/notafiscal \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/notafiscal
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Emitente

POST/api/v1/configuracoes/notafiscal/emitente
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Backup

GET/api/v1/configuracoes/notafiscal/backup

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/notafiscal/backup \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Certificado

GET/api/v1/configuracoes/notafiscal/certificado

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/notafiscal/certificado \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Consultar um

GET/api/v1/configuracoes/pdv

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/pdv \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/pdv
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Consultar um

GET/api/v1/configuracoes/comanda

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/comanda \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/comanda
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Consultar um

GET/api/v1/configuracoes/autoatendimento

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/autoatendimento \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/autoatendimento
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Impressao

GET/api/v1/configuracoes/comanda/impressao

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/comanda/impressao \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/comanda/impressao
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Geral

GET/api/v1/configuracoes/cardapio/geral

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/geral \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/cardapio/geral
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Layout

GET/api/v1/configuracoes/cardapio/layout

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/layout \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

POST/api/v1/configuracoes/cardapio/layout
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Imagem

GET/api/v1/configuracoes/cardapio/layout/imagem

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/layout/imagem \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Horarios

GET/api/v1/configuracoes/cardapio/horarios

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cadastrar

POST/api/v1/configuracoes/cardapio/horarios
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Atualizar

PUT/api/v1/configuracoes/cardapio/horarios/{horario}
Token com acesso de escrita

Parâmetros do caminho

horariointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/configuracoes/cardapio/horarios/{horario}
Token com acesso de escrita

Parâmetros do caminho

horariointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/configuracoes/cardapio/horarios/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Consultar um

GET/api/v1/configuracoes/entrega

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/entrega \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/entrega
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Bairros

GET/api/v1/configuracoes/entrega/bairros

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/entrega/bairros \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cadastrar

POST/api/v1/configuracoes/entrega/bairros
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/configuracoes/entrega/bairros/{bairro}

Parâmetros do caminho

bairrointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/entrega/bairros/{bairro}
Token com acesso de escrita

Parâmetros do caminho

bairrointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/configuracoes/entrega/bairros/{bairro}
Token com acesso de escrita

Parâmetros do caminho

bairrointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/configuracoes/entrega/bairros/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Cidades

GET/api/v1/configuracoes/entrega/cidades

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/entrega/cidades \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Bairros

GET/api/v1/configuracoes/entrega/cidades/{codigo}/bairros

Parâmetros do caminho

codigointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/entrega/cidades/1/bairros \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Importar

POST/api/v1/configuracoes/entrega/bairros/importar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Consultar um

GET/api/v1/configuracoes/sistema

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/sistema \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/sistema
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Consultar um

GET/api/v1/configuracoes/ordem-servico

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/configuracoes/ordem-servico \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/configuracoes/ordem-servico
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Usuários

6 endpoints.

Listar

GET/api/v1/usuarios

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/usuarios?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/usuarios
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
emailtexto · obrigatório E-mail
senhatexto Senha
cargo_idinteiro · obrigatório Cargo
ativosim/não Status
modo_acesso_iptexto Controle de IP
todos lista_permitida lista_bloqueada
ips_permitidoslista IPs permitidos
ips_bloqueadoslista IPs bloqueados
modo_horario_acessotexto Controle de horário
todos personalizado
regras_horario_acessolista Regras de horário
dois_fatorestexto Verificação em duas etapas
desativada ativada reconfigurar

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/usuarios/{usuario}

Parâmetros do caminho

usuariointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/usuarios/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/usuarios/{usuario}
Token com acesso de escrita

Parâmetros do caminho

usuariointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
emailtexto · obrigatório E-mail
senhatexto Senha
cargo_idinteiro · obrigatório Cargo
ativosim/não Status
modo_acesso_iptexto Controle de IP
todos lista_permitida lista_bloqueada
ips_permitidoslista IPs permitidos
ips_bloqueadoslista IPs bloqueados
modo_horario_acessotexto Controle de horário
todos personalizado
regras_horario_acessolista Regras de horário
dois_fatorestexto Verificação em duas etapas
desativada ativada reconfigurar

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/usuarios/{usuario}
Token com acesso de escrita

Parâmetros do caminho

usuariointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
emailtexto · obrigatório E-mail
senhatexto Senha
cargo_idinteiro · obrigatório Cargo
ativosim/não Status
modo_acesso_iptexto Controle de IP
todos lista_permitida lista_bloqueada
ips_permitidoslista IPs permitidos
ips_bloqueadoslista IPs bloqueados
modo_horario_acessotexto Controle de horário
todos personalizado
regras_horario_acessolista Regras de horário
dois_fatorestexto Verificação em duas etapas
desativada ativada reconfigurar

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/usuarios/{usuario}
Token com acesso de escrita

Parâmetros do caminho

usuariointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/usuarios/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Cargos

7 endpoints.

Opções do formulário

GET/api/v1/cargos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/cargos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/cargos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/cargos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/cargos
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
descricaotexto Descrição
administradorsim/não Cargo Administrador
ativosim/não Status
permissoeslista Permissões

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/cargos/{cargo}

Parâmetros do caminho

cargointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/cargos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/cargos/{cargo}
Token com acesso de escrita

Parâmetros do caminho

cargointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/cargos/{cargo}
Token com acesso de escrita

Parâmetros do caminho

cargointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/cargos/{cargo}
Token com acesso de escrita

Parâmetros do caminho

cargointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/cargos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Status

7 endpoints.

Opções do formulário

GET/api/v1/status/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/status/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/status

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/status?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/status
Token com acesso de escrita

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 estoque
nenhum entrada saida
finaliza_documentosim/não Finaliza o documento
cancela_documentosim/não Cancela o documento
bloqueia_edicaosim/não Bloqueia a edição
transicoeslista Transições

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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":[]}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/status/{status}

Parâmetros do caminho

statusinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/status/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/status/{status}
Token com acesso de escrita

Parâmetros do caminho

statusinteiro · obrigatórioO 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 estoque
nenhum entrada saida
finaliza_documentosim/não Finaliza o documento
cancela_documentosim/não Cancela o documento
bloqueia_edicaosim/não Bloqueia a edição
transicoeslista Transições

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/status/{status}
Token com acesso de escrita

Parâmetros do caminho

statusinteiro · obrigatórioO 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 estoque
nenhum entrada saida
finaliza_documentosim/não Finaliza o documento
cancela_documentosim/não Cancela o documento
bloqueia_edicaosim/não Bloqueia a edição
transicoeslista Transições

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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":[]}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/status/{status}
Token com acesso de escrita

Parâmetros do caminho

statusinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/status/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Formas de pagamento

6 endpoints.

Listar

GET/api/v1/formas-pagamento

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/formas-pagamento?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/formas-pagamento
Token com acesso de escrita

Corpo (JSON)

nometexto · obrigatório Nome
tipotexto · obrigatório Tipo
01 02 03 04 05 10 11 12 13 14 15 16
iconetexto Ícone
cortexto Cor
primary secondary success info warning danger dark light
integracao_pagamentotexto Integração de Pagamento
mercado_pago pagseguro stone cielo rede integra_bancos_asaas integra_bancos_bancobrasil integra_bancos_cora integra_bancos_efi integra_bancos_inter integra_bancos_itau integra_bancos_santander
modo_integracaotexto Como cobrar
pix cartao_online cartao_pos
possim/não POS (pagamento com resposta rápida)
indicador_pagamentointeiro Indicador de pagamento
0 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 Auto Atendimento
exibir_cardapiosim/não Cardápio
exibir_lojasim/não Loja

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/formas-pagamento/{formaPagamento}

Parâmetros do caminho

formaPagamentointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/formas-pagamento/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/formas-pagamento/{formaPagamento}
Token com acesso de escrita

Parâmetros do caminho

formaPagamentointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
tipotexto · obrigatório Tipo
01 02 03 04 05 10 11 12 13 14 15 16
iconetexto Ícone
cortexto Cor
primary secondary success info warning danger dark light
integracao_pagamentotexto Integração de Pagamento
mercado_pago pagseguro stone cielo rede integra_bancos_asaas integra_bancos_bancobrasil integra_bancos_cora integra_bancos_efi integra_bancos_inter integra_bancos_itau integra_bancos_santander
modo_integracaotexto Como cobrar
pix cartao_online cartao_pos
possim/não POS (pagamento com resposta rápida)
indicador_pagamentointeiro Indicador de pagamento
0 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 Auto Atendimento
exibir_cardapiosim/não Cardápio
exibir_lojasim/não Loja

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/formas-pagamento/{formaPagamento}
Token com acesso de escrita

Parâmetros do caminho

formaPagamentointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

nometexto · obrigatório Nome
tipotexto · obrigatório Tipo
01 02 03 04 05 10 11 12 13 14 15 16
iconetexto Ícone
cortexto Cor
primary secondary success info warning danger dark light
integracao_pagamentotexto Integração de Pagamento
mercado_pago pagseguro stone cielo rede integra_bancos_asaas integra_bancos_bancobrasil integra_bancos_cora integra_bancos_efi integra_bancos_inter integra_bancos_itau integra_bancos_santander
modo_integracaotexto Como cobrar
pix cartao_online cartao_pos
possim/não POS (pagamento com resposta rápida)
indicador_pagamentointeiro Indicador de pagamento
0 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 Auto Atendimento
exibir_cardapiosim/não Cardápio
exibir_lojasim/não Loja

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/formas-pagamento/{formaPagamento}
Token com acesso de escrita

Parâmetros do caminho

formaPagamentointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/formas-pagamento/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Empresa

4 endpoints.

Consultar um

GET/api/v1/empresa

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/empresa \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/empresa
Token com acesso de escrita

Corpo (JSON)

tipo_pessoatexto · obrigatório Tipo Pessoa
juridica fisica
cnpjtexto · obrigatório CNPJ/CPF
razao_socialtexto · obrigatório Razão Social
nome_fantasiatexto Nome Fantasia
indicacao_inscricao_estadualtexto Indicação Inscrição Estadual
1 2 9
inscricao_estadualtexto Inscrição Estadual
enquadramentotexto Enquadramento
1 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 UF
AC AL AM AP BA CE DF ES GO MA MG MS
codigo_paistexto Código País
complementotexto Complemento
referenciatexto Referência
emailtexto E-mail
sitetexto Site
celulartexto Celular
telefonetexto Telefone
rede_socialtexto Rede Social

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Resumo

GET/api/v1/empresa/resumo

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/empresa/resumo \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Integrações

32 endpoints.

Situacao

GET/api/v1/integracoes/situacao

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/situacao \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Frete

GET/api/v1/integracoes/frete/{provedor}

Parâmetros do caminho

provedorinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/frete/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/integracoes/frete/{provedor}
Token com acesso de escrita

Parâmetros do caminho

provedorinteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Tray

GET/api/v1/integracoes/tray

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/tray \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Conectar

POST/api/v1/integracoes/tray/conectar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Desconectar

DELETE/api/v1/integracoes/tray
Token com acesso de escrita

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/integracoes/tray \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Produtos

GET/api/v1/integracoes/tray/produtos

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/tray/produtos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Publicar

POST/api/v1/integracoes/tray/produtos
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Sincronizar

POST/api/v1/integracoes/tray/sincronizar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Pedidos

GET/api/v1/integracoes/tray/pedidos

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/tray/pedidos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Salvar

PUT/api/v1/integracoes/tray/pedidos
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Conferir

POST/api/v1/integracoes/tray/pedidos/conferir
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Orbizz

GET/api/v1/integracoes/orbizz

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/orbizz \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/integracoes/orbizz
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Testar

POST/api/v1/integracoes/orbizz/testar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Status

POST/api/v1/integracoes/orbizz/status
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Qrcode

POST/api/v1/integracoes/orbizz/qrcode
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Atual

GET/api/v1/integracoes/orbizz/qrcode

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/orbizz/qrcode \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Pagbank

GET/api/v1/integracoes/pagbank

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/pagbank \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/integracoes/pagbank
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Testar

POST/api/v1/integracoes/pagbank/testar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Stone

GET/api/v1/integracoes/stone

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/stone \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/integracoes/stone
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Testar

POST/api/v1/integracoes/stone/testar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Mercado pago

GET/api/v1/integracoes/mercado-pago

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/mercado-pago \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/integracoes/mercado-pago
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Testar

POST/api/v1/integracoes/mercado-pago/testar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Maquininhas

GET/api/v1/integracoes/mercado-pago/maquininhas

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/mercado-pago/maquininhas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/integracoes/bancos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/integracoes/bancos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/integracoes/bancos/{banco}

Parâmetros do caminho

bancointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/integracoes/bancos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/integracoes/bancos/{banco}
Token com acesso de escrita

Parâmetros do caminho

bancointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Credenciais

POST/api/v1/integracoes/bancos/{banco}/credenciais/{tipo}
Token com acesso de escrita

Parâmetros do caminho

bancointeiro · obrigatórioO código (id) do registro.
tipointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Anexos

5 endpoints.

Listar

GET/api/v1/anexos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/anexos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/anexos
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/anexos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Principal

PUT/api/v1/anexos/{anexo}/principal
Token com acesso de escrita

Parâmetros do caminho

anexointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Remover

DELETE/api/v1/anexos/{anexo}
Token com acesso de escrita

Parâmetros do caminho

anexointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/anexos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Arquivo

GET/api/v1/anexos/{anexo}/arquivo

Parâmetros do caminho

anexointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/anexos/1/arquivo \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Auditoria

3 endpoints.

Opções do formulário

GET/api/v1/auditoria/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/auditoria/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/auditoria

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/auditoria?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Consultar um

GET/api/v1/auditoria/{auditoria}

Parâmetros do caminho

auditoriainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/auditoria/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Notificações

4 endpoints.

Listar

GET/api/v1/notificacoes

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/notificacoes?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Resumo

GET/api/v1/notificacoes/resumo

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/notificacoes/resumo \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Lidas

POST/api/v1/notificacoes/lidas
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Lida

POST/api/v1/notificacoes/{notificacao}/lida
Token com acesso de escrita

Parâmetros do caminho

notificacaointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Consultas (CEP e CNPJ)

2 endpoints.

Cep

GET/api/v1/consultas/cep/{cep}

Parâmetros do caminho

cepinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/consultas/cep/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Cnpj

GET/api/v1/consultas/cnpj/{cnpj}

Parâmetros do caminho

cnpjinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/consultas/cnpj/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Ferramentas

3 endpoints.

Balanca

GET/api/v1/ferramentas/balanca

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ferramentas/balanca \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Arquivo

GET/api/v1/ferramentas/balanca/arquivo/{modelo}

Parâmetros do caminho

modelointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ferramentas/balanca/arquivo/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Produtos

GET/api/v1/ferramentas/etiquetas/produtos

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ferramentas/etiquetas/produtos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Ajuda

3 endpoints.

Faq

GET/api/v1/ajuda/faq

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ajuda/faq \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Perguntas

GET/api/v1/ajuda/perguntas

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/ajuda/perguntas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Iris

POST/api/v1/ajuda/iris
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Usuário do token

1 endpoint.

Eu

GET/api/v1/eu

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/eu \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Menu e permissões

3 endpoints.

Menu

GET/api/v1/menu

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/menu \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Acessos

POST/api/v1/menu/acessos
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/menu/acessos \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Permissoes

GET/api/v1/permissoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/permissoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Assinaturas

3 endpoints.

Cadastrar

POST/api/v1/assinaturas
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
curl -X POST https://hubintegrado.com/api/v1/assinaturas \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Imagem

GET/api/v1/assinaturas/{assinatura}/imagem

Parâmetros do caminho

assinaturainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/assinaturas/1/imagem \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Remover

DELETE/api/v1/assinaturas/{assinatura}
Token com acesso de escrita

Parâmetros do caminho

assinaturainteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/assinaturas/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Contratos

11 endpoints.

Opções do formulário

GET/api/v1/contratos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/contratos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Status

POST/api/v1/contratos/{contrato}/status
Token com acesso de escrita

Parâmetros do caminho

contratointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Documento

GET/api/v1/contratos/{contrato}/documento

Parâmetros do caminho

contratointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/contratos/1/documento \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Assinatura

POST/api/v1/contratos/{contrato}/assinatura
Token com acesso de escrita

Parâmetros do caminho

contratointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Remover

DELETE/api/v1/contratos/{contrato}/assinantes/{assinante}
Token com acesso de escrita

Parâmetros do caminho

contratointeiro · obrigatórioO código (id) do registro.
assinanteinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/contratos/1/assinantes/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Listar

GET/api/v1/contratos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/contratos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/contratos
Token com acesso de escrita

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

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/contratos/{contrato}

Parâmetros do caminho

contratointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/contratos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/contratos/{contrato}
Token com acesso de escrita

Parâmetros do caminho

contratointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/contratos/{contrato}
Token com acesso de escrita

Parâmetros do caminho

contratointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/contratos/{contrato}
Token com acesso de escrita

Parâmetros do caminho

contratointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/contratos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Contratos Modelos

8 endpoints.

Cadastrar

POST/api/v1/contratos-modelos/{contratoModelo}/arquivo
Token com acesso de escrita

Parâmetros do caminho

contratoModelointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Arquivo

GET/api/v1/contratos-modelos/{contratoModelo}/arquivo

Parâmetros do caminho

contratoModelointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/contratos-modelos/1/arquivo \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/contratos-modelos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/contratos-modelos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/contratos-modelos
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/contratos-modelos/{contratoModelo}

Parâmetros do caminho

contratoModelointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/contratos-modelos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/contratos-modelos/{contratoModelo}
Token com acesso de escrita

Parâmetros do caminho

contratoModelointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/contratos-modelos/{contratoModelo}
Token com acesso de escrita

Parâmetros do caminho

contratoModelointeiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/contratos-modelos/{contratoModelo}
Token com acesso de escrita

Parâmetros do caminho

contratoModelointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/contratos-modelos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Documentos Legais

1 endpoint.

Pdf

GET/api/v1/documentos-legais/{tipo}/pdf

Parâmetros do caminho

tipointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/documentos-legais/1/pdf \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Equipamentos

7 endpoints.

Opções do formulário

GET/api/v1/equipamentos/opcoes

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/equipamentos/opcoes \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Listar

GET/api/v1/equipamentos

Consulta

busca, pagina, por_pagina, ordem, direcao e os filtros do recurso (veja Listagens).

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl "https://hubintegrado.com/api/v1/equipamentos?busca=&pagina=1&por_pagina=25" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": [
        {
            "id": 1
        }
    ],
    "meta": {
        "pagina": 1,
        "por_pagina": 25,
        "total": 1,
        "total_sem_filtro": 1
    }
}

Cadastrar

POST/api/v1/equipamentos
Token com acesso de escrita

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

201 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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"}'
Resposta 201
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro cadastrado."
}

Consultar um

GET/api/v1/equipamentos/{equipamento}

Parâmetros do caminho

equipamentointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/equipamentos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Atualizar

PUT/api/v1/equipamentos/{equipamento}
Token com acesso de escrita

Parâmetros do caminho

equipamentointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Atualizar

PATCH/api/v1/equipamentos/{equipamento}
Token com acesso de escrita

Parâmetros do caminho

equipamentointeiro · obrigatórioO 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

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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"}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Registro atualizado."
}

Remover

DELETE/api/v1/equipamentos/{equipamento}
Token com acesso de escrita

Parâmetros do caminho

equipamentointeiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
curl -X DELETE https://hubintegrado.com/api/v1/equipamentos/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "mensagem": "Registro removido."
}

Iris

3 endpoints.

Mensagem

POST/api/v1/iris/mensagem
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Voz

GET/api/v1/iris/voz

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/iris/voz \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Transcrever

POST/api/v1/iris/voz
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Primeiro Acesso

3 endpoints.

Consultar um

GET/api/v1/primeiro-acesso

Respostas

200 sucesso 401 token403 permissão 429 limite
Requisição
curl https://hubintegrado.com/api/v1/primeiro-acesso \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Aceitar

POST/api/v1/primeiro-acesso/aceitar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Configurar

POST/api/v1/primeiro-acesso/configurar
Token com acesso de escrita

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Whatsapp

2 endpoints.

Destino

GET/api/v1/whatsapp/{documento}/{id}

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
idinteiro · obrigatórioO código (id) do registro.

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 429 limite
Requisição
curl https://hubintegrado.com/api/v1/whatsapp/1/1 \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"
Resposta 200
{
    "data": {
        "id": 1
    }
}

Enviar

POST/api/v1/whatsapp/{documento}/{id}
Token com acesso de escrita

Parâmetros do caminho

documentointeiro · obrigatórioO código (id) do registro.
idinteiro · obrigatórioO código (id) do registro.

Corpo (JSON)

Os campos da tela correspondente do sistema; os recusados voltam em errors (422).

Respostas

200 sucesso 401 token403 permissão 404 não encontrado 422 campos 429 limite
Requisição
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 '{}'
Resposta 200
{
    "data": {
        "id": 1
    },
    "mensagem": "Feito."
}

Nenhum endpoint encontrado para essa busca.