Seus dados da GAP BI no seu sistema
Leve pedidos, itens, produtos, custos e notas da sua conta para o seu ERP, BI ou planilhas. Só de leitura, com o dado como foi coletado e os valores calculados de cada pedido (custo, impostos e margem), iguais aos da tela de Pedidos.
curl "https://api.gapbi.com.br/v1/pedidos?data_inicio=2026-10-01&data_fim=2026-10-31" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 9182736,
"canal": "Mercado Livre",
"total_pedido": 200.00,
"calculado": {
"custo_produtos": 80.00,
"impostos": 12.00,
"margem_valor": 64.00,
"margem_percentual": 32.00
}
}
],
"paginacao": {
"pagina": 1,
"proxima_pagina": 2
}
}Introdução
URL base
https://api.gapbi.com.br/v1
Formato
JSON · UTF-8 · horário de Brasília · valores em reais
Atualização dos dados
a cada 3 ou 6 horas, conforme o plano
Só de leitura: não cria, altera nem apaga nada
Dado bruto + bloco calculado com a margem
Um token para todas as empresas da conta
Primeiros passos
- 1
Peça a liberação
A API é um adicional da GAP BI. Peça a liberação ao usuário master.
- 2
Gere o token
O titular da conta gera o token em Minha Conta › API.
- 3
Envie em cada requisição
Mande o token em todas as requisições, no cabeçalho
Authorization. - 4
Carregue e sincronize
Faça a primeira carga por período (até 3 meses por consulta) e depois sincronize só o que mudou com
alterados_desde.
Autenticação
Cada requisição precisa do token no cabeçalho Authorization: Bearer <token>. O token dá acesso a todas as empresas da conta.
- Até 3 tokens ativos por conta, com validade de 90 dias ou 1 ano.
- O token aparece completo uma única vez, na criação. Guarde-o num local seguro. Se perder, gere outro.
- Faltando 15 dias para vencer, o token aparece como "Vence em breve". Gere um novo e troque no seu sistema antes do vencimento.
- Token cancelado ou vencido para na hora.
- Se a conta estiver bloqueada (trial vencido, atraso, cancelamento etc.), a API recusa com
acesso_suspenso. Liberada a conta, o mesmo token volta a funcionar.
curl "https://api.gapbi.com.br/v1/pedidos?data_inicio=2026-10-01&data_fim=2026-10-31" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"erro": {
"codigo": "acesso_suspenso",
"mensagem": "O acesso à API está suspenso para esta conta. Entre em contato com a GAP BI."
}
}Limites de uso
2 / s
requisições por segundo, com rajada de até 10
10.000 / dia
de 00:00 a 23:59, horário de Brasília
100
registros por página, no máximo
Os limites valem por conta, somando todos os tokens. Cada resposta informa o uso nos cabeçalhos:
| Cabeçalho | O que é |
|---|---|
| X-Limite-Dia | limite de requisições do dia |
| X-Restante-Dia | quantas ainda restam hoje |
| Retry-After | só nas respostas 429 e 503: quantos segundos esperar |
Passou do limite? A resposta é 429 limite_excedido. O token não é bloqueado: basta esperar o tempo indicado. Se precisar de mais, fale com o seu consultor.
Paginação e filtros
| Parâmetro | O que faz |
|---|---|
| pagina | página desejada, começando em 1 |
| por_pagina | registros por página, de 1 a 100 (padrão 100) |
| empresa_id | só uma empresa da conta (sem ele, vêm todas) |
| data_inicio · data_fim | período (AAAA-MM-DD), até 3 meses por consulta. Em Pedidos, Itens e Notas fiscais, informe o período ou alterados_desde |
| competencia_inicio · competencia_fim | meses (AAAA-MM) da DRE e das taxas, até 3 meses por consulta |
| alterados_desde | só registros criados ou alterados a partir dessa data e hora (inclusive). Aceita data (AAAA-MM-DD) ou data e hora; sem fuso, vale o horário de Brasília |
Cada tema tem também os filtros próprios, descritos nele. Parâmetro desconhecido na rota, ou valor fora da lista de um filtro, responde 400 parametro_invalido dizendo o que corrigir. Nos filtros com lista de valores, maiúsculas e acentos não importam.
Toda lista vem ordenada por alterado_em, do mais antigo para o mais novo, e traz o bloco paginacao. Campos sem informação na origem vêm como null: nada é preenchido com zero.
curl "https://api.gapbi.com.br/v1/pedidos?alterados_desde=2026-10-20T08%3A00%3A00-03%3A00&pagina=1" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
"…até 100 registros…"
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1342,
"total_paginas": 14,
"proxima_pagina": 2
}
}Como sincronizar
Primeira carga
Busque cada tema por períodos de até 3 meses, cobrindo toda a janela de histórico do seu plano.
Dia a dia
Guarde o maior alterado_em que você recebeu e use-o como alterados_desde na próxima consulta. O filtro inclui o próprio horário, então um registro pode vir de novo: atualize pelo id. Uma vez por hora é suficiente: a API reflete as mudanças da GAP BI em até cerca de 1 hora, e a GAP BI atualiza os dados a cada 3 ou 6 horas.
Margem que muda sozinha
Quando você altera um custo (inclusive com data retroativa), uma taxa do canal, a alíquota do Simples ou o imposto de um produto, todos os pedidos afetados voltam em alterados_desde, já com os valores novos.
Dados apagados não são avisados
Se uma integração for excluída ou um custo apagado, o registro some da API. Recarregue o período de tempos em tempos (por exemplo, o último mês toda semana) para limpar o que não existe mais.
Janela do plano
Só aparece o que está dentro da janela de histórico do plano e o que não está oculto nas telas.
Erros
| Status | Código | Quando |
|---|---|---|
| 400 | parametro_invalido | parâmetro desconhecido, valor inválido (fora da lista do filtro, data fora do formato, página fora do limite), período maior que 3 meses, ou Pedidos, Itens e Notas sem período nem alterados_desde |
| 401 | token_invalido | token ausente, errado, vencido ou cancelado |
| 403 | acesso_suspenso | conta bloqueada ou adicional da API desligado |
| 404 | nao_encontrado | empresa ou registro que não existe nesta conta |
| 405 | — | método diferente de GET: a API é só de leitura |
| 429 | limite_excedido | passou do limite por segundo ou do dia |
| 503 | sistema_ocupado | o sistema está priorizando as telas, ou os dados da conta ainda estão sendo preparados (logo depois de a API ser liberada, por alguns minutos); tente de novo depois do Retry-After. Não conta no limite do dia |
{
"erro": {
"codigo": "limite_excedido",
"mensagem": "Limite de 2 requisições por segundo excedido. Tente de novo em 4 segundos.",
"tentar_novamente_em_segundos": 4
}
}Os 9 temas
Cada tema é uma rota GET em https://api.gapbi.com.br/v1. Clique para ver filtros, campos e exemplo.
Um registro por pedido, com os valores brutos do canal/ERP e o bloco calculado, igual à tela de Pedidos.
Filtros
| Parâmetro | O que faz |
|---|---|
| data_inicio · data_fim | período pela data do pedido |
| canal | ex.: Mercado Livre |
| situacao | ex.: Cancelado |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| id | número | identificação do pedido na GAP BI |
| canal | texto | canal de venda |
| integracao_apelido | texto | apelido da integração que trouxe o pedido |
| numero_pedido_canal | texto | número no marketplace |
| numero_pedido_canal_alternativo | texto | outro número informado pelo canal (ex.: carrinho do ML) |
| numero_pedido_erp | texto | número no ERP (null sem ERP) |
| situacao | texto | situação como na GAP BI |
| situacao_original | texto | situação como veio da origem |
| data_pedido | data e hora | data do pedido |
| data_prevista · data_faturamento · data_envio · data_entrega | data e hora | como informadas pela origem |
| total_produtos | valor | soma dos itens |
| total_pedido | valor | total do pedido |
| total_pedido_canal | valor | total informado pelo marketplace |
| desconto | valor | desconto do pedido |
| outras_despesas | valor | outras despesas |
| frete_comprador | valor | frete pago pelo comprador |
| frete_vendedor | valor | frete pago pelo vendedor |
| comissao_canal | valor | comissão cobrada pelo marketplace |
| valores_definitivos | sim/não | os valores do marketplace já são os definitivos |
| logistica | texto | Full, Flex, Entrega Direta, Coleta... |
| forma_envio · transportadora · codigo_rastreio · url_rastreio | texto | envio |
| forma_pagamento · meio_pagamento · condicao_pagamento | texto | pagamento, como no ERP |
| entrega_bairro · entrega_cidade · entrega_uf | texto | endereço do comprador informado no pedido |
| cliente_id | número | comprador (tema Clientes) |
| quantidade_itens | número | quantidade de itens |
| marcadores | lista | marcadores do ERP |
| observacao · observacao_interna | texto | observações do ERP |
| ajustes_manuais | objeto | valores corrigidos na GAP BI: null quando nada foi corrigido; cada valor null quando aquele não foi |
| calculadocalculado | objeto | valores como na tela de Pedidos |
| ↳valor_venda | valor | venda considerada |
| ↳custo_produtos | valor | custo vigente na data do pedido × quantidade |
| ↳comissao | valor | comissão usada no cálculo |
| ↳frete_vendedor · frete_comprador · diferenca_frete | valor | fretes usados e a diferença |
| ↳impostos · aliquota_impostos | valor · % | imposto do pedido e alíquota |
| ↳margem_valor · margem_percentual | valor · % | margem em R$ e em % |
| ↳origem_valores | texto | Definitivo · Estimado · Taxa cadastrada · Sem taxa · Não integrado |
| ↳avisos | lista | sem custo, sem taxa cadastrada, sem nota fiscal... |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/pedidos?data_inicio=2026-10-01&data_fim=2026-10-31" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 9182736,
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"canal": "Mercado Livre",
"integracao_apelido": "ML Principal",
"numero_pedido_canal": "2000009876543210",
"numero_pedido_canal_alternativo": null,
"numero_pedido_erp": null,
"situacao": "Entregue",
"situacao_original": "delivered",
"data_pedido": "2026-10-02T14:31:08-03:00",
"data_faturamento": "2026-10-02T16:00:00-03:00",
"data_envio": "2026-10-03T09:12:00-03:00",
"data_entrega": "2026-10-06T11:40:00-03:00",
"total_produtos": 200.00,
"total_pedido": 200.00,
"total_pedido_canal": 200.00,
"desconto": 0.00,
"outras_despesas": 0.00,
"frete_comprador": 0.00,
"frete_vendedor": 20.00,
"comissao_canal": 24.00,
"valores_definitivos": true,
"logistica": "Full",
"transportadora": "Mercado Envios",
"codigo_rastreio": "ME123456789BR",
"forma_pagamento": "Mercado Pago",
"entrega_cidade": "Curitiba",
"entrega_uf": "PR",
"cliente_id": 551203,
"quantidade_itens": 2,
"marcadores": [],
"ajustes_manuais": null,
"calculado": {
"valor_venda": 200.00,
"custo_produtos": 80.00,
"comissao": 24.00,
"frete_vendedor": 20.00,
"frete_comprador": 0.00,
"diferenca_frete": 20.00,
"impostos": 12.00,
"aliquota_impostos": 6.00,
"margem_valor": 64.00,
"margem_percentual": 32.00,
"origem_valores": "Definitivo",
"avisos": []
},
"criado_em": "2026-10-02T15:05:44-03:00",
"alterado_em": "2026-10-07T03:10:21-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1,
"total_paginas": 1,
"proxima_pagina": null
}
}Um registro por item. Kit vem em uma linha; a composição está em Produtos. O desconto existe só no pedido.
Filtros
| Parâmetro | O que faz |
|---|---|
| data_inicio · data_fim | período pela data do pedido |
| pedido_id | itens de um pedido (dispensa o período) |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| id | número | identificação do item |
| pedido_id | número | pedido a que pertence |
| sku | texto | SKU vendido (com o Mapeamento SKU aplicado) |
| produto_id | número | produto cadastrado |
| anuncio_codigo | texto | código do anúncio no canal (null quando a origem não informa) |
| descricao · unidade | texto | descrição e unidade |
| quantidade | número | quantidade |
| valor_unitario · valor_total | valor | preço unitário e total |
| comissao_canal · frete | valor | quando o canal informa por item (senão null) |
| kit | sim/não | item é um kit |
| calculadocalculado | objeto | valores do item como na tela |
| ↳custo_unitario · custo_total | valor | custo vigente na data do pedido |
| ↳comissao · frete · impostos | valor | divididos pela venda do item quando o canal não informa por item |
| ↳margem_valor · margem_percentual | valor · % | margem do item; desconta a diferença de frete (o pago menos o recebido do comprador) |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/itens-pedido?data_inicio=2026-10-01&data_fim=2026-10-31" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 9182736001,
"pedido_id": 9182736,
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"sku": "CAM-001-P-AZ",
"produto_id": 70211,
"anuncio_codigo": "MLB3456789012",
"descricao": "Camiseta Básica Azul P",
"unidade": "UN",
"quantidade": 2,
"valor_unitario": 100.00,
"valor_total": 200.00,
"comissao_canal": null,
"frete": null,
"kit": false,
"calculado": {
"custo_unitario": 40.00,
"custo_total": 80.00,
"comissao": 24.00,
"frete": 20.00,
"impostos": 12.00,
"margem_valor": 64.00,
"margem_percentual": 32.00
},
"criado_em": "2026-10-02T15:05:44-03:00",
"alterado_em": "2026-10-07T03:10:21-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1,
"total_paginas": 1,
"proxima_pagina": null
}
}Cadastro de produtos: simples, pai com variações, variação e kit.
Filtros
| Parâmetro | O que faz |
|---|---|
| tipo | Simples · Pai · Variação · Kit |
| situacao | Ativo · Inativo · Excluído no ERP |
| sku | um SKU |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| id | número | identificação do produto |
| sku · nome · gtin · marca · categoria · unidade | texto | cadastro |
| tipo | texto | Simples · Pai · Variação · Kit |
| produto_pai_id | número | pai da variação |
| kit_composicao | lista | componentes do kit: produto_id, sku e quantidade |
| preco · preco_promocional | valor | preço de venda no ERP |
| situacao | texto | Ativo · Inativo · Excluído no ERP |
| atualiza_custo_pelo_erp | sim/não | chave do produto |
| custo_kit_manual | sim/não | custo do kit digitado (não = soma da composição) |
| estoque_minimo · estoque_maximo · dias_preparacao | número | dados do ERP |
| url_imagem | texto | imagem |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/produtos?empresa_id=12" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 70300,
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"sku": "KIT-CAM-3",
"nome": "Kit 3 Camisetas Básicas",
"gtin": "7890000000017",
"marca": "Marca Exemplo",
"categoria": "Vestuário",
"unidade": "UN",
"tipo": "Kit",
"produto_pai_id": null,
"kit_composicao": [
{
"produto_id": 70211,
"sku": "CAM-001-P-AZ",
"quantidade": 1
},
{
"produto_id": 70212,
"sku": "CAM-001-P-PT",
"quantidade": 2
}
],
"preco": 249.90,
"preco_promocional": null,
"situacao": "Ativo",
"atualiza_custo_pelo_erp": true,
"custo_kit_manual": false,
"estoque_minimo": null,
"estoque_maximo": null,
"dias_preparacao": 1,
"url_imagem": "https://exemplo.com/kit-cam-3.jpg",
"criado_em": "2026-06-11T10:00:00-03:00",
"alterado_em": "2026-09-30T18:22:10-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1,
"total_paginas": 1,
"proxima_pagina": null
}
}Anúncios dos marketplaces conectados e o produto ligado pelo Mapeamento SKU.
Filtros
| Parâmetro | O que faz |
|---|---|
| canal | ex.: Shopee |
| situacao | Ativo · Não permitido · Não listado · Em análise · Excluído |
| vinculado | sim / não |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| id | número | identificação do anúncio |
| canal · integracao_apelido | texto | onde está o anúncio |
| anuncio_codigo | texto | código no canal |
| titulo · sku | texto | título e SKU do anúncio |
| tipo | texto | Simples · Pai · Variação · Kit |
| anuncio_pai_id | número | pai da variação |
| preco · preco_promocional | valor | preço no canal |
| situacao | texto | Ativo · Não permitido · Não listado · Em análise · Excluído |
| produto_vinculado_id · produto_vinculado_sku | número · texto | produto ligado (null = sem vínculo) |
| url_imagem | texto | imagem |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/anuncios?empresa_id=12" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 88001,
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"canal": "Mercado Livre",
"integracao_apelido": "ML Principal",
"anuncio_codigo": "MLB3456789012",
"titulo": "Camiseta Básica Algodão Azul",
"sku": "CAM-001-P-AZ",
"tipo": "Variação",
"anuncio_pai_id": 88000,
"preco": 99.90,
"preco_promocional": null,
"situacao": "Ativo",
"produto_vinculado_id": 70211,
"produto_vinculado_sku": "CAM-001-P-AZ",
"url_imagem": null,
"criado_em": "2026-06-11T10:05:00-03:00",
"alterado_em": "2026-10-15T07:40:00-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1,
"total_paginas": 1,
"proxima_pagina": null
}
}Uma linha por vigência, com o histórico completo de cada produto.
Filtros
| Parâmetro | O que faz |
|---|---|
| produto_id · sku | um produto |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| produto_id · sku | número · texto | produto |
| tipo_custo | texto | Custo · Custo médio |
| custo | valor | valor |
| inicio_vigencia | data | a partir de quando vale |
| fim_vigencia | data | véspera do próximo custo (null = vigente) |
| origem | texto | ERP · Cadastrado na GAP |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/custos?empresa_id=12" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"produto_id": 70211,
"sku": "CAM-001-P-AZ",
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"tipo_custo": "Custo",
"custo": 38.00,
"inicio_vigencia": "2026-05-01",
"fim_vigencia": "2026-07-31",
"origem": "ERP",
"criado_em": "2026-05-01T06:00:00-03:00",
"alterado_em": "2026-05-01T06:00:00-03:00"
},
{
"produto_id": 70211,
"sku": "CAM-001-P-AZ",
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"tipo_custo": "Custo",
"custo": 40.00,
"inicio_vigencia": "2026-08-01",
"fim_vigencia": null,
"origem": "Cadastrado na GAP",
"criado_em": "2026-10-20T09:14:00-03:00",
"alterado_em": "2026-10-20T09:14:00-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 2,
"total_paginas": 1,
"proxima_pagina": null
}
}Compradores dos seus pedidos, com os dados completos (exceto RG).
Filtros
| Parâmetro | O que faz |
|---|---|
| cpf_cnpj | um comprador, com o documento como está no cadastro (com a pontuação) |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| id | número | identificação do comprador |
| nome · nome_fantasia | texto | nome |
| tipo_pessoa | texto | Física · Jurídica |
| cpf_cnpjdado pessoal | texto | documento completo |
| inscricao_estadual | texto | IE |
| email · telefonedado pessoal | texto | contato (o corrigido na GAP BI, se houver) |
| endereco · numero · complemento · bairro · cidade · uf · cepdado pessoal | texto | endereço |
| primeira_compra · ultima_compra | data | dentro da janela do plano |
| quantidade_pedidos | número | dentro da janela do plano |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/clientes?empresa_id=12" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 551203,
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"nome": "Maria Exemplo",
"nome_fantasia": null,
"tipo_pessoa": "Física",
"cpf_cnpj": "000.000.000-00",
"inscricao_estadual": null,
"email": "maria@exemplo.com",
"telefone": "(41) 90000-0000",
"endereco": "Rua Exemplo",
"numero": "100",
"complemento": null,
"bairro": "Centro",
"cidade": "Curitiba",
"uf": "PR",
"cep": "80000-000",
"primeira_compra": "2026-08-14",
"ultima_compra": "2026-10-02",
"quantidade_pedidos": 3,
"criado_em": "2026-08-14T12:00:00-03:00",
"alterado_em": "2026-10-02T15:05:44-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1,
"total_paginas": 1,
"proxima_pagina": null
}
}Notas coletadas do ERP, com tributos por nota e por item. Sem notas na conta, a lista vem vazia.
Filtros
| Parâmetro | O que faz |
|---|---|
| data_inicio · data_fim | período pela data de emissão |
| pedido_id | notas de um pedido (dispensa o período) |
| situacao | Autorizada · Cancelada · Denegada · Sem protocolo · Outra |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| id | número | identificação da nota |
| pedido_id | número | pedido ligado (null = não ligada) |
| numero · serie · chave_acesso | texto | identificação fiscal |
| tipo | texto | Saída · Entrada |
| situacao | texto | Autorizada · Cancelada · Denegada · Sem protocolo · Outra |
| natureza_operacao | texto | natureza da operação |
| data_emissao · data_autorizacao | data e hora | datas |
| cnpj_emitente | texto | CNPJ da sua empresa |
| destinatario_nome · destinatario_cpf_cnpjdado pessoal | texto | destinatário |
| valor_produtos · valor_frete · valor_seguro · valor_desconto · valor_outras_despesas · valor_total | valor | valores da nota |
| tributos | objeto | totais: icms, icms_st, fcp, difal, ipi, pis, cofins, ibs, cbs, is, total |
| itens | lista | por item: item_pedido_id, sku, ncm, cfop, cest, origem, quantidade, valor e base/aliquota/valor de cada tributo |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/notas-fiscais?data_inicio=2026-10-01&data_fim=2026-10-31" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 301877,
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"pedido_id": 9182736,
"numero": "18734",
"serie": "1",
"chave_acesso": "41261000000000000000550010000187341000000000",
"tipo": "Saída",
"situacao": "Autorizada",
"natureza_operacao": "Venda de mercadoria",
"data_emissao": "2026-10-02T15:58:00-03:00",
"data_autorizacao": "2026-10-02T15:58:40-03:00",
"cnpj_emitente": "00.000.000/0001-00",
"destinatario_nome": "Maria Exemplo",
"destinatario_cpf_cnpj": "000.000.000-00",
"valor_produtos": 200.00,
"valor_frete": 0.00,
"valor_seguro": 0.00,
"valor_desconto": 0.00,
"valor_outras_despesas": 0.00,
"valor_total": 200.00,
"tributos": {
"icms": 24.00,
"icms_st": 0.00,
"fcp": 0.00,
"difal": 0.00,
"ipi": 0.00,
"pis": 3.30,
"cofins": 15.20,
"ibs": null,
"cbs": null,
"is": null,
"total": 42.50
},
"itens": [
{
"item_pedido_id": 9182736001,
"sku": "CAM-001-P-AZ",
"ncm": "61091000",
"cfop": "5102",
"cest": null,
"origem": "0",
"quantidade": 2,
"valor": 200.00,
"icms": {
"base": 200.00,
"aliquota": 12.00,
"valor": 24.00
},
"pis": {
"base": 200.00,
"aliquota": 1.65,
"valor": 3.30
},
"cofins": {
"base": 200.00,
"aliquota": 7.60,
"valor": 15.20
}
}
],
"criado_em": "2026-10-02T18:00:00-03:00",
"alterado_em": "2026-10-02T18:00:00-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1,
"total_paginas": 1,
"proxima_pagina": null
}
}Lançamentos manuais que você cadastra na DRE (receitas, custos e despesas).
Filtros
| Parâmetro | O que faz |
|---|---|
| competencia_inicio · competencia_fim | mês/ano (ex.: 2026-09) |
| tipo | Receita · Custo · Despesa |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| id | número | identificação do lançamento |
| tipo | texto | Receita · Custo · Despesa |
| categoria · descricao | texto | como cadastrado |
| competencia | mês/ano | mês de competência |
| valor | valor | valor |
| recorrente · parcela · total_parcelas | sim/não · número | repetição |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/dre-lancamentos?empresa_id=12" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"id": 7781,
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"tipo": "Despesa",
"categoria": "Aluguel",
"descricao": "Galpão",
"competencia": "2026-09",
"valor": 4500.00,
"recorrente": true,
"parcela": 4,
"total_parcelas": 12,
"criado_em": "2026-06-01T09:00:00-03:00",
"alterado_em": "2026-06-01T09:00:00-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 1,
"total_paginas": 1,
"proxima_pagina": null
}
}O que você cadastrou para o cálculo: taxa manual do canal, alíquota do Simples, valor de entrega (Flex/entrega própria) e imposto por produto.
Filtros
| Parâmetro | O que faz |
|---|---|
| tipo_cadastro | Taxa do canal · Alíquota do Simples · Valor de entrega · Imposto por produto |
| competencia_inicio · competencia_fim | mês/ano (ex.: 2026-09) |
| empresa_id · alterados_desde | ver Paginação e filtros |
Campos
| Campo | Tipo | O que é |
|---|---|---|
| tipo_cadastro | texto | tipo do cadastro |
| canal · integracao_apelido | texto | taxa do canal e valor de entrega |
| produto_id · sku | número · texto | imposto por produto |
| competencia | mês/ano | taxa do canal, Simples, valor de entrega |
| inicio_vigencia | data | imposto por produto |
| comissao_percentual · taxa_fixa · comissao_sobre_frete | % · valor · sim/não | taxa do canal |
| aliquota | % | Simples ou imposto por produto |
| valor | valor | valor de entrega |
+ 4 campos comuns a todos os temas (empresa e datas)
| Campo | Tipo | O que é |
|---|---|---|
| empresa_id | número | empresa da conta |
| empresa_nome | texto | apelido da empresa (ou o nome, se não houver apelido) |
| criado_em | data e hora | quando o registro entrou na GAP BI |
| alterado_em | data e hora | última alteração (use com alterados_desde) |
curl "https://api.gapbi.com.br/v1/taxas-impostos?empresa_id=12" \
-H "Authorization: Bearer gap_live_xxxxxxxxxxxxxxxxxxxx"{
"dados": [
{
"tipo_cadastro": "Taxa do canal",
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"canal": "Americanas",
"integracao_apelido": null,
"competencia": "2026-10",
"comissao_percentual": 16.00,
"taxa_fixa": 5.00,
"comissao_sobre_frete": false,
"criado_em": "2026-10-01T08:00:00-03:00",
"alterado_em": "2026-10-01T08:00:00-03:00"
},
{
"tipo_cadastro": "Alíquota do Simples",
"empresa_id": 12,
"empresa_nome": "Loja Exemplo",
"competencia": "2026-10",
"aliquota": 6.00,
"criado_em": "2026-10-01T08:00:00-03:00",
"alterado_em": "2026-10-01T08:00:00-03:00"
}
],
"paginacao": {
"pagina": 1,
"por_pagina": 100,
"total_registros": 2,
"total_paginas": 1,
"proxima_pagina": null
}
}Quer a API na sua conta?
A API é um adicional da GAP BI. Fale com a gente para liberar.