{ "info": { "name": "GAS4US — APIs de terceiro", "_postman_id": "gas4us-gas4us-apis-de-terceiro", "description": "Coleção gerada da documentação oficial (https://wiki.txfuel.com.br/pt-br/gas4us/api). Preencha as variáveis da coleção: base_url, tipo_identificador (APP, REDE, CNPJ ou CPF), valor_identificador, identificador e app_id. A senha do dia é calculada automaticamente.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Autenticação das APIs de terceiro do GAS4US: acrescenta APP|REDE|CNPJ|CPF, SENHA (do dia) e A em todo pedido.", "// SENHA = md5(identificador + AAAA-MM-DD + valor enviado em APP/REDE/CNPJ/CPF), data de Brasília.", "const tipo = pm.variables.get('tipo_identificador') || 'APP';", "const valor = pm.variables.get('valor_identificador') || '';", "const identificador = pm.variables.get('identificador') || '';", "const hoje = new Date(Date.now() - 3 * 3600 * 1000).toISOString().slice(0, 10);", "const chave = (tipo === 'CNPJ' || tipo === 'CPF') ? valor.replace(/\\D/g, '') : valor;", "const senha = CryptoJS.MD5(identificador + hoje + chave).toString();", "['APP', 'REDE', 'CNPJ', 'CPF', 'SENHA', 'A'].forEach(k => pm.request.url.query.remove(k));", "pm.request.url.query.add({ key: tipo, value: chave });", "pm.request.url.query.add({ key: 'SENHA', value: senha });", "pm.request.url.query.add({ key: 'A', value: pm.variables.get('app_id') });" ] } } ], "variable": [ { "key": "base_url", "value": "https://gas4us1.txfuel.com.br/api" }, { "key": "tipo_identificador", "value": "APP" }, { "key": "valor_identificador", "value": "NOME DO APP" }, { "key": "identificador", "value": "" }, { "key": "app_id", "value": "0" } ], "item": [ { "name": "Vendas e abastecimento", "description": "Abastecimento com o token do app do cliente: validar, registrar, consultar e cancelar vendas no posto.", "item": [ { "name": "GET venda — Vendas confirmadas do posto (paginada)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/venda?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "venda" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita também id_estabelecimento ou id_posto). No acesso de posto (CNPJ do posto) é fixado pelo acesso e não precisa ser enviado; nos acessos de app e rede é obrigatório na prática (sem ele não há resultado).", "disabled": true }, { "key": "id_venda", "value": "", "description": "Uma venda.", "disabled": true }, { "key": "id_comb", "value": "", "description": "Vendas com esse combustível em qualquer dos 5 itens (aceita id_produto).", "disabled": true }, { "key": "data_inicial", "value": "", "description": "Data da venda, AAAA-MM-DD (aceita data_inicio/data_ini). Padrão 1980-01-01.", "disabled": true }, { "key": "data_final", "value": "", "description": "AAAA-MM-DD (aceita data_fim). Padrão 2099-12-31.", "disabled": true }, { "key": "cpf_caixa", "value": "", "description": "Filtra pelo CPF do caixa.", "disabled": true }, { "key": "cpf_frentista", "value": "", "description": "Filtra pelo CPF do frentista.", "disabled": true }, { "key": "recebimento", "value": "", "description": "caixa, app ou * (padrão, todas).", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Lista as vendas do posto em situação confirmada ou liberada (C/L). Sem posto não há resultado.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "POST venda — Valida (padrão) ou registra a venda", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/venda?token=123456789012", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "venda" ], "query": [ { "key": "token", "value": "123456789012", "description": "Token do app (12 dígitos; aceita também base64 ou o JSON do QR, ver acima).", "disabled": false }, { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita também id_estabelecimento ou id_posto). No acesso de posto (CNPJ do posto) é fixado pelo acesso e não precisa ser enviado; nos acessos de app e rede é obrigatório na prática (sem ele não há resultado).", "disabled": true }, { "key": "id_comb1", "value": "1", "description": "Combustível 1 (id de tabelas?id_tabela=1). Aceita também id_comb ou id_produto.", "disabled": true }, { "key": "total_abast1", "value": "120.0", "description": "Valor do abastecimento do combustível 1 a preço de bomba (R$, até 15.000). Aceita também total_abast.", "disabled": true }, { "key": "litros_abast1", "value": "", "description": "Litros do combustível 1. Sem ele, a quantidade é calculada por total_abast1 / preço de bomba. Aceita também litros_abast.", "disabled": true }, { "key": "id_comb2..5 / total_abast2..5 / litros_abast2..5", "value": "", "description": "Demais combustíveis da mesma venda (até 5).", "disabled": true }, { "key": "total_outros", "value": "", "description": "Outros produtos (sem desconto do app), R$.", "disabled": true }, { "key": "acao", "value": "registrar", "description": "validar (padrão: só simula) ou registrar (grava a venda).", "disabled": true }, { "key": "recebimento", "value": "", "description": "app (padrão: saldo + cartão favorito do cliente) ou caixa (saldo + restante pago no caixa do posto).", "disabled": true }, { "key": "placa", "value": "", "description": "Placa do veículo (validada quando enviada).", "disabled": true }, { "key": "quilometragem", "value": "", "description": "Hodômetro; só com placa.", "disabled": true }, { "key": "cpf_caixa", "value": "", "description": "CPF do operador de caixa (validado quando enviado).", "disabled": true }, { "key": "cpf_frentista", "value": "", "description": "CPF do frentista (validado quando enviado).", "disabled": true }, { "key": "observacao", "value": "", "description": "Texto livre gravado na venda.", "disabled": true }, { "key": "gerar_pontos / gerar_cashback / gerar_sorte / gerar_cupom", "value": "", "description": "Só desligam benefícios que o app já daria para o cliente (false); não ligam o que o app não dá.", "disabled": true } ] }, "description": "Sem acao=registrar a chamada só VALIDA: calcula descontos e forma de pagamento e devolve os valores, sem gravar nada (o token não é consumido). Com acao=registrar grava a venda: usa primeiro o saldo do cliente e o resto vai para o cartão favorito (recebimento=app) ou fica para o caixa (recebimento=caixa). Proteções ao registrar: o mesmo token não registra duas vezes (nem em reenvios até 6 h depois), e a mesma pessoa fica travada por 15 s durante a venda (\"Em uso… aguarde 15 segundos\"). Fora de produção (ambiente de testes) os tokens 100100100100, 200200200200 e 300300300300 passam pela validação do token (sandbox).\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "DELETE venda — Cancela uma venda (até 30 minutos)", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/venda?id_venda=123456", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "venda" ], "query": [ { "key": "id_venda", "value": "123456", "description": "Id da venda (id_venda devolvido no registro).", "disabled": false } ] }, "description": "Cancela (situação X) a venda feita há no máximo 30 minutos, desde que o posto da venda seja do app e, nos acessos de rede/posto, da rede/posto do acesso.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } } ] }, { "name": "Preços e promoções", "description": "Preço de bomba, preço do app (promoção vigente) e agenda semanal de descontos por posto e combustível.", "item": [ { "name": "GET precoBomba — Preço de bomba atual por combustível", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/precoBomba?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "precoBomba" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita também id_estabelecimento ou id_posto). No acesso de posto (CNPJ do posto) é fixado pelo acesso e não precisa ser enviado; nos acessos de app e rede é obrigatório na prática (sem ele não há resultado).", "disabled": true }, { "key": "id_comb", "value": "", "description": "Um combustível (aceita id_produto). Sem ele, todos os combustíveis ativos.", "disabled": true } ] }, "description": "Consulta e atualiza o preço de bomba (sem desconto) por combustível do posto. É a base dos descontos do app: as promoções da agenda são calculadas sobre ele.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "PUT precoBomba — Atualiza o preço de bomba de um combustível", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/precoBomba?id_comb=1&valor=6.09", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "precoBomba" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita também id_estabelecimento ou id_posto). No acesso de posto (CNPJ do posto) é fixado pelo acesso e não precisa ser enviado; nos acessos de app e rede é obrigatório na prática (sem ele não há resultado).", "disabled": true }, { "key": "id_comb", "value": "1", "description": "Combustível (aceita id_produto).", "disabled": false }, { "key": "valor", "value": "6.09", "description": "Novo preço por litro (aceita preco_bomba). Ponto como separador decimal.", "disabled": false } ] }, "description": "Grava um novo preço de bomba quando o valor é diferente do atual. Com posto ou combustível ausente, valor negativo ou valor igual ao atual, nada é feito e a resposta é ok mesmo assim.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET precoAplicativo — Promoções vigentes do posto", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/precoAplicativo?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "precoAplicativo" ], "query": [ { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita também id_estabelecimento ou id_posto). No acesso de posto (CNPJ do posto) é fixado pelo acesso e não precisa ser enviado; nos acessos de app e rede é obrigatório na prática (sem ele não há resultado).", "disabled": true }, { "key": "id_comb", "value": "", "description": "Um combustível (aceita id_produto).", "disabled": true } ] }, "description": "Preço com desconto do app que vale agora no posto (promoção ativa no momento). Não mostra o desconto extra por limite de litros nem o preço de convênio.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET agendaPosto — Agenda da semana (7 dias × 6 faixas)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/agendaPosto?id_posto=10&id_comb=1", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "agendaPosto" ], "query": [ { "key": "id_posto", "value": "10", "description": "Posto, ou lista de postos separados por vírgula (ex.: 10,11). Com vários postos, um valor só aparece quando é igual em todos (senão 0). No acesso de posto, sem ele vale o posto do acesso.", "disabled": false }, { "key": "id_comb", "value": "1", "description": "Combustível (aceita id_produto).", "disabled": false } ] }, "description": "A agenda define o desconto do app por posto, combustível, dia da semana e faixa de 4 horas (00:00, 04:00, 08:00, 12:00, 16:00 e 20:00). Uma rotina cria a promoção de cada faixa uns 10 minutos antes de ela começar, com preço = preço de bomba − desconto, e só para postos com a agenda ligada (cadastro do posto); alteração feita durante uma faixa vale a partir da próxima. dia_da_semana: 0 = domingo … 6 = sábado. Escopo pelo acesso: posto, só o próprio; rede, os postos da rede; app, os postos do app. Posto fora do escopo: o GET volta vazio e o PUT recebe 403.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "PUT agendaPosto — Grava o desconto normal", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/agendaPosto?id_posto=10&id_comb=1&valor=0.2", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "agendaPosto" ], "query": [ { "key": "id_posto", "value": "10", "description": "Posto ou lista separada por vírgula (grava em todos). No acesso de posto, sem ele vale o posto do acesso.", "disabled": false }, { "key": "id_comb", "value": "1", "description": "Combustível (aceita id_produto).", "disabled": false }, { "key": "valor", "value": "0.2", "description": "Desconto normal em R$ por litro (0 ou mais; 0 = sem desconto).", "disabled": false }, { "key": "dia_da_semana", "value": "", "description": "0 (domingo) a 6 (sábado). Ausente = a semana inteira (todas as faixas).", "disabled": true }, { "key": "hora", "value": "", "description": "Início da faixa: 00:00, 04:00, 08:00, 12:00, 16:00 ou 20:00. Obrigatório com dia_da_semana.", "disabled": true } ] }, "description": "Grava o desconto normal (R$ por litro) de um dia + faixa, ou, sem dia_da_semana, de todas as 42 faixas da semana. Não mexe no desconto extra.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET agendaPostoExtra — Agenda da semana (a mesma consulta de agendaPosto)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/agendaPostoExtra?id_posto=10&id_comb=1", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "agendaPostoExtra" ], "query": [ { "key": "id_posto", "value": "10", "description": "Posto, ou lista de postos separados por vírgula (ex.: 10,11). Com vários postos, um valor só aparece quando é igual em todos (senão 0). No acesso de posto, sem ele vale o posto do acesso.", "disabled": false }, { "key": "id_comb", "value": "1", "description": "Combustível (aceita id_produto).", "disabled": false } ] }, "description": "A agenda define o desconto do app por posto, combustível, dia da semana e faixa de 4 horas (00:00, 04:00, 08:00, 12:00, 16:00 e 20:00). Uma rotina cria a promoção de cada faixa uns 10 minutos antes de ela começar, com preço = preço de bomba − desconto, e só para postos com a agenda ligada (cadastro do posto); alteração feita durante uma faixa vale a partir da próxima. dia_da_semana: 0 = domingo … 6 = sábado. O desconto extra (valor_secundario) vale para os primeiros limite_litros do abastecimento; acima do limite vale o desconto normal. Escopo pelo acesso: posto, só o próprio; rede, os postos da rede; app, os postos do app. Posto fora do escopo: o GET volta vazio e o PUT recebe 403.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "PUT agendaPostoExtra — Grava o desconto extra e o limite de litros", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/agendaPostoExtra?id_posto=10&id_comb=1&valor_secundario=0.3", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "agendaPostoExtra" ], "query": [ { "key": "id_posto", "value": "10", "description": "Posto ou lista separada por vírgula. No acesso de posto, sem ele vale o posto do acesso.", "disabled": false }, { "key": "id_comb", "value": "1", "description": "Combustível (aceita id_produto).", "disabled": false }, { "key": "valor_secundario", "value": "0.3", "description": "Desconto extra em R$ por litro (0 = sem desconto extra).", "disabled": false }, { "key": "limite_litros", "value": "50", "description": "Litros com o desconto extra; obrigatório (> 0) quando valor_secundario > 0.", "disabled": true }, { "key": "dia_da_semana", "value": "", "description": "0 (domingo) a 6 (sábado). Ausente = a semana inteira.", "disabled": true }, { "key": "hora", "value": "", "description": "00:00, 04:00, 08:00, 12:00, 16:00 ou 20:00. Obrigatório com dia_da_semana.", "disabled": true } ] }, "description": "Grava o desconto extra e o limite de litros de um dia + faixa, ou, sem dia_da_semana, de todas as faixas da semana. Não mexe no desconto normal.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } } ] }, { "name": "Financeiro e relatórios", "description": "Faturamento, créditos, movimento e saldo dos clientes, repasses aos postos e situação de boleto.", "item": [ { "name": "GET faturamento — Vendas do período com resumo (paginada)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/faturamento?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "faturamento" ], "query": [ { "key": "data_inicial", "value": "", "description": "Data da venda, AAAA-MM-DD (aceita data_inicio/data_ini). Padrão 1980-01-01.", "disabled": true }, { "key": "data_final", "value": "", "description": "AAAA-MM-DD (aceita data_fim). Padrão 2099-12-31.", "disabled": true }, { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita id_estabelecimento/id_posto). Fixo no acesso de posto.", "disabled": true }, { "key": "id_tx_rede", "value": "", "description": "Rede. Fixa no acesso de rede.", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "Cliente (consumidor). Fixo no acesso de pessoa.", "disabled": true }, { "key": "id_comb", "value": "", "description": "Vendas com esse combustível (aceita id_produto).", "disabled": true }, { "key": "valor_inicial / valor_final", "value": "", "description": "Faixa do total com desconto (padrão 0 a 999999999,99).", "disabled": true }, { "key": "caixa_app", "value": "", "description": "S = recebidas no caixa, N = pagas no app, * (padrão) = todas.", "disabled": true }, { "key": "id_posto_convenio", "value": "", "description": "Vendas com esse convênio.", "disabled": true }, { "key": "fraude", "value": "", "description": "S, N ou * (padrão).", "disabled": true }, { "key": "id_pessoa_caixa / id_pessoa_frentista", "value": "", "description": "Caixa ou frentista (pessoa).", "disabled": true }, { "key": "tem_caixa / tem_frentista", "value": "", "description": "S (com CPF informado), N (sem) ou * (padrão).", "disabled": true }, { "key": "funcionario", "value": "", "description": "S = só vendas a funcionários ativos, N = sem elas, * (padrão) = todas.", "disabled": true }, { "key": "somente_usuarios_novos", "value": "", "description": "S = só clientes cadastrados dentro do período.", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Relatório de faturamento (vendas confirmadas) do app, com resumo. O escopo segue o acesso: rede, posto e pessoa ficam fixos no acesso desses tipos; o acesso de cliente não restringe (vê o app inteiro). A ordem das linhas não é garantida entre páginas.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET faturamentoApp — Vendas do período com resumo (paginada)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/faturamentoApp?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "faturamentoApp" ], "query": [ { "key": "data_inicial", "value": "", "description": "Data da venda, AAAA-MM-DD (aceita data_inicio/data_ini). Padrão 1980-01-01.", "disabled": true }, { "key": "data_final", "value": "", "description": "AAAA-MM-DD (aceita data_fim). Padrão 2099-12-31.", "disabled": true }, { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita id_estabelecimento/id_posto). Fixo no acesso de posto.", "disabled": true }, { "key": "id_tx_rede", "value": "", "description": "Rede. Fixa no acesso de rede.", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "Cliente (consumidor). Fixo no acesso de pessoa.", "disabled": true }, { "key": "id_comb", "value": "", "description": "Vendas com esse combustível (aceita id_produto).", "disabled": true }, { "key": "valor_inicial / valor_final", "value": "", "description": "Faixa do total com desconto (padrão 0 a 999999999,99).", "disabled": true }, { "key": "caixa_app", "value": "", "description": "S = recebidas no caixa, N = pagas no app, * (padrão) = todas.", "disabled": true }, { "key": "id_posto_convenio", "value": "", "description": "Vendas com esse convênio.", "disabled": true }, { "key": "fraude", "value": "", "description": "S, N ou * (padrão).", "disabled": true }, { "key": "id_pessoa_caixa / id_pessoa_frentista", "value": "", "description": "Caixa ou frentista (pessoa).", "disabled": true }, { "key": "tem_caixa / tem_frentista", "value": "", "description": "S (com CPF informado), N (sem) ou * (padrão).", "disabled": true }, { "key": "funcionario", "value": "", "description": "S = só vendas a funcionários ativos, N = sem elas, * (padrão) = todas.", "disabled": true }, { "key": "somente_usuarios_novos", "value": "", "description": "S = só clientes cadastrados dentro do período.", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Outro endereço do mesmo serviço de faturamento (mesmo código, parâmetros e resposta). Relatório de faturamento (vendas confirmadas) do app, com resumo. O escopo segue o acesso: rede, posto e pessoa ficam fixos no acesso desses tipos; o acesso de cliente não restringe (vê o app inteiro). A ordem das linhas não é garantida entre páginas.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET credito — Créditos do período (paginada)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/credito?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "credito" ], "query": [ { "key": "data_operacao_inicial / data_operacao_final", "value": "", "description": "Data da operação, AAAA-MM-DD (padrão 1980-01-01 a 2099-12-31).", "disabled": true }, { "key": "data_situacao_inicial / data_situacao_final", "value": "", "description": "Data da última situação (padrão 1980-01-01 a 2099-12-31).", "disabled": true }, { "key": "valor_inicial / valor_final", "value": "", "description": "Faixa de valor (padrão 0 a 999999999,99).", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "Cliente. Fixo no acesso de pessoa.", "disabled": true }, { "key": "tipo", "value": "", "description": "E (entrada), S (saída) ou * (padrão).", "disabled": true }, { "key": "parcelado", "value": "", "description": "S (com parcelas), N (sem) ou * (padrão).", "disabled": true }, { "key": "meio_pagamento", "value": "", "description": "Grupo do meio de pagamento, como aparece em meio_pagamento (ex.: CARTÃO DE CRÉDITO, BOLETO, TRANSFERÊNCIA, DEPÓSITO, CAIXA).", "disabled": true }, { "key": "fraude", "value": "", "description": "Filtra pelo campo fraude; * (padrão) = todos.", "disabled": true }, { "key": "faturamento", "value": "", "description": "S = já ligados a um faturamento, N = ainda não, * (padrão).", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Lista os créditos (entradas e saídas de saldo, por meio de pagamento) do app, com resumo. Escopo pelo acesso: app vê o app inteiro; rede, os clientes que abasteceram nos postos da rede; posto, os que abasteceram no posto; cliente, as pessoas do cliente; pessoa, só ela.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET movimento — Movimento paginado", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/movimento?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "movimento" ], "query": [ { "key": "data_operacao_inicial / data_operacao_final", "value": "", "description": "Data da operação (padrão 1980-01-01 a 2099-12-31).", "disabled": true }, { "key": "data_situacao_inicial / data_situacao_final", "value": "", "description": "Data da situação (padrão 1980-01-01 a 2099-12-31).", "disabled": true }, { "key": "id_operacao", "value": "", "description": "Uma operação.", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "Pessoa. Fixa no acesso de pessoa.", "disabled": true }, { "key": "id_tx_estabelecimento / id_tx_rede", "value": "", "description": "Posto / rede. Fixos nos acessos de posto e rede.", "disabled": true }, { "key": "operacao", "value": "", "description": "Código do tipo de operação (ex.: O = abastecimento, C = compra de crédito); * (padrão) = todos.", "disabled": true }, { "key": "valor_inicial / valor_final", "value": "", "description": "Faixa de valor (padrão -999999999,99 a 999999999,99).", "disabled": true }, { "key": "litros_inicial / litros_final", "value": "", "description": "Faixa de litros (padrão 0 a 999999999,99).", "disabled": true }, { "key": "id_comb", "value": "", "description": "Combustível (aceita id_produto).", "disabled": true }, { "key": "id_meio_pagamento", "value": "", "description": "Meio de pagamento.", "disabled": true }, { "key": "placa, bandeira, cashback, caixa, meio_pagamento_proprio, limite, fraude, manual, meio_pagamento_id", "value": "", "description": "Filtros por igualdade (S/N nos indicadores); * (padrão) = todos.", "disabled": true }, { "key": "id_posto_convenio / operacao_contrapartida_id", "value": "", "description": "Convênio / operação de contrapartida.", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Extrato das operações por pessoa (compras de crédito, abastecimentos, transferências…), com o saldo acumulado. Lê a tabela de movimento que uma rotina do servidor mantém atualizada (não é em tempo real). Rede, posto e pessoa ficam fixos no acesso desses tipos.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET financeiroRelatorioSaldo — Saldos (paginada) com total", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/financeiroRelatorioSaldo?data_operacao_final=2026-11-12", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "financeiroRelatorioSaldo" ], "query": [ { "key": "data_operacao_final", "value": "2026-11-12", "description": "Saldo até esta data (AAAA-MM-DD). Sem ela não há resultado.", "disabled": false }, { "key": "data_operacao_inicial", "value": "", "description": "Padrão 1980-01-01.", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "Um cliente. Fixo no acesso de pessoa.", "disabled": true }, { "key": "saldo_inicial / saldo_final", "value": "", "description": "Faixa de saldo (padrão 0 a 999999999,99; saldos zerados nunca aparecem).", "disabled": true }, { "key": "situacao", "value": "", "description": "B = só bloqueados; qualquer outro valor diferente de * = só não bloqueados; * (padrão) = todos.", "disabled": true }, { "key": "tipo_ordem", "value": "", "description": "ABASTECIMENTO (pelo último abastecimento), COMPRA_CREDITO (pela última compra) ou vazio (padrão: maior saldo primeiro).", "disabled": true }, { "key": "ordem", "value": "", "description": "ASC (padrão) ou DESC, com tipo_ordem.", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Saldo de cada cliente (soma das operações confirmadas pagas pelo app até a data), com última compra de crédito e último abastecimento; CPF/CNPJ, celular e e-mail vêm mascarados. Escopo pelo acesso: app vê o app inteiro; rede, os clientes que abasteceram nos postos da rede; posto, os que abasteceram no posto; cliente, as pessoas do cliente; pessoa, só ela. Atenção: data_operacao_final não tem valor padrão; sem ela a lista vem vazia.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET transferencia — Repasses do período (paginada)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/transferencia?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "transferencia" ], "query": [ { "key": "data_transferencia_inicial / data_transferencia_final", "value": "", "description": "Data do repasse (padrão 1980-01-01 a 2099-12-31).", "disabled": true }, { "key": "valor_inicial / valor_final", "value": "", "description": "Faixa de valor (padrão 0 a 999999999,99).", "disabled": true }, { "key": "id_tx_estabelecimento", "value": "", "description": "Posto (aceita id_estabelecimento/id_posto). Fixo no acesso de posto.", "disabled": true }, { "key": "situacao", "value": "", "description": "Situação do repasse, como vem do meio de pagamento; * (padrão) = todas.", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Lista os repasses feitos pelo meio de pagamento para a conta bancária dos postos, com resumo. Escopo pelo acesso: app vê todos os postos; rede, os postos da rede; posto, só o próprio; cliente e pessoa recebem 403.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET transferenciaCredito — Transações do repasse (paginada)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/transferenciaCredito?meio_pagamento_id=tf_000000", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "transferenciaCredito" ], "query": [ { "key": "meio_pagamento_id", "value": "tf_000000", "description": "Id do repasse no meio de pagamento (campo meio_pagamento_id de transferencia).", "disabled": false }, { "key": "id_tx_estabelecimento", "value": "", "description": "Posto. Fixo no acesso de posto.", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão e máximo 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Detalha um repasse (transferencia.meio_pagamento_id): cada transação do meio de pagamento, o crédito do cliente e o faturamento do posto ligados a ela.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET boletoSituacao — Situação pelo par linha digitável + valor", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/boletoSituacao?linha_digitavel=00000000000000000000000000000000000000000000000&valor=100.0", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "boletoSituacao" ], "query": [ { "key": "linha_digitavel", "value": "00000000000000000000000000000000000000000000000", "description": "47 dígitos (pontos e espaços são ignorados).", "disabled": false }, { "key": "valor", "value": "100.0", "description": "Valor do boleto (> 0), igual ao gravado.", "disabled": false } ] }, "description": "Consulta a situação da compra de crédito paga por boleto, pela linha digitável e pelo valor. Sempre responde 200.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } } ] }, { "name": "Clientes e fidelidade", "description": "Exportação do cadastro de clientes para o sistema do posto e programa de fidelidade (cupons, extrato, parceiros).", "item": [ { "name": "GET ediClientes — Exportação conforme a ação", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/ediClientes?acao=EI", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "ediClientes" ], "query": [ { "key": "acao", "value": "EI", "description": "EI (identificação: código EAN-13 por cliente), CADPES (cadastro de pessoas) ou EAN13 (código de um cliente, por id_tx_pessoa).", "disabled": false }, { "key": "data_range", "value": "", "description": "EI/CADPES: horas para trás (criados ou alterados). Padrão 24.", "disabled": true }, { "key": "pagina", "value": "", "description": "EI/CADPES: 0 (padrão) = tudo de uma vez; n = página n de 50.", "disabled": true }, { "key": "codigo_pj / codigo_pf", "value": "", "description": "CADPES: código da classe para PJ e PF (padrão 71 e 61).", "disabled": true }, { "key": "tipo_pj / tipo_pf", "value": "", "description": "CADPES: nome da classe para PJ e PF (padrão CLIENTE FIEL PJ e CLIENTE FIEL).", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "EAN13: cliente. Fixo no acesso de pessoa.", "disabled": true } ] }, "description": "Exporta os clientes do app para o sistema de frente de caixa do posto: identificação (código EAN-13 de cada cliente), cadastro completo ou o código de um cliente. Lista só clientes ativos, com cadastro completo e nome, criados ou alterados nas últimas data_range horas. CADPES (CPF/CNPJ, endereço, telefones e e-mail) respeita o escopo do acesso: app vê os clientes do app; rede, os que abasteceram nos postos da rede; posto, os que abasteceram no posto; cliente e pessoa recebem 403.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET fidelidadeCupom — Lista de cupons do app (paginada)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/fidelidadeCupom?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "fidelidadeCupom" ], "query": [ { "key": "id_fidelidade_parceiro", "value": "", "description": "Só cupons ativos desse parceiro (ausente = todos os cupons do app).", "disabled": true }, { "key": "ativo", "value": "", "description": "S, N ou * (padrão).", "disabled": true }, { "key": "valor_troca_inicial / valor_troca_final", "value": "", "description": "Faixa (padrão 0 a 999999999,99).", "disabled": true }, { "key": "valor_custo_inicial / valor_custo_final", "value": "", "description": "Faixa.", "disabled": true }, { "key": "valor_credito_inicial / valor_credito_final", "value": "", "description": "Faixa.", "disabled": true }, { "key": "data_troca_inicial / data_troca_final", "value": "", "description": "Período de troca contido no intervalo.", "disabled": true }, { "key": "data_consumo_inicial / data_consumo_final", "value": "", "description": "Período de consumo contido no intervalo.", "disabled": true }, { "key": "limite__inicial / _final", "value": "", "description": "Faixas dos limites.", "disabled": true }, { "key": "size", "value": "", "description": "Tamanho da página (padrão 50).", "disabled": true }, { "key": "page", "value": "", "description": "Página (padrão 1).", "disabled": true } ] }, "description": "Para o parceiro do programa de fidelidade (loja/serviço conveniado) consultar os cupons e dar baixa no cupom que o cliente apresenta. A fidelidade é recurso do GAS4US (pontos, cupons, parceiros). Permitido para todos os tipos de terceiro. O POST identifica o parceiro pela pessoa (id_tx_pessoa do escopo; num terceiro rede/estabelecimento vem do parâmetro id_tx_pessoa).\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "POST fidelidadeCupom — Consulta (e com acao=REGISTRAR, consome) o cupom pelo token de 9 dígitos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/fidelidadeCupom?token=", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "fidelidadeCupom" ], "query": [ { "key": "token", "value": "", "description": "Token de 9 dígitos que o cliente mostra (válido só no dia; gerado a partir da operação de troca).", "disabled": false }, { "key": "acao", "value": "", "description": "REGISTRAR = marca o cupom como consumido por este parceiro; ausente = só consulta.", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "Pessoa do parceiro (já fixada quando o terceiro é do tipo pessoa).", "disabled": true } ] }, "description": "Para o parceiro do programa de fidelidade (loja/serviço conveniado) consultar os cupons e dar baixa no cupom que o cliente apresenta. A fidelidade é recurso do GAS4US (pontos, cupons, parceiros). Permitido para todos os tipos de terceiro. O POST identifica o parceiro pela pessoa (id_tx_pessoa do escopo; num terceiro rede/estabelecimento vem do parâmetro id_tx_pessoa).\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET fidelidadeExtrato — Extrato paginado", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/fidelidadeExtrato?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "fidelidadeExtrato" ], "query": [ { "key": "id_fidelidade_parceiro", "value": "", "description": "Parceiro que consumiu.", "disabled": true }, { "key": "id_fidelidade_cupom", "value": "", "description": "Cupom.", "disabled": true }, { "key": "id_tx_pessoa", "value": "", "description": "Cliente da operação (fixo no escopo para terceiro pessoa).", "disabled": true }, { "key": "data_troca_inicial / data_troca_final", "value": "", "description": "", "disabled": true }, { "key": "data_consumo_inicial / data_consumo_final", "value": "", "description": "Só consumo informado = ordena por consumo.", "disabled": true }, { "key": "trocado", "value": "", "description": "S/N", "disabled": true }, { "key": "consumido", "value": "", "description": "S/N", "disabled": true }, { "key": "expirado", "value": "", "description": "S = não consumido e vencido; N = consumido ou ainda no prazo", "disabled": true }, { "key": "size", "value": "", "description": "padrão 50", "disabled": true }, { "key": "page", "value": "", "description": "padrão 1", "disabled": true } ] }, "description": "Lista as operações de cupom (troca e consumo) do app com resumo (quantidade e soma do custo). Atenção ao filtro de pessoa: id_tx_pessoa filtra o CLIENTE da operação; num terceiro do tipo pessoa ele fica fixo na pessoa do terceiro, então para um parceiro use um terceiro rede/estabelecimento com id_fidelidade_parceiro. Permitido para todos os tipos de terceiro.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET fidelidadeParceiro — Lista paginada de parceiros", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/fidelidadeParceiro?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "fidelidadeParceiro" ], "query": [ { "key": "id_tx_pessoa", "value": "", "description": "Pessoa do parceiro (fixa para terceiro pessoa).", "disabled": true }, { "key": "ativo", "value": "", "description": "S, N ou * (padrão).", "disabled": true }, { "key": "size", "value": "", "description": "padrão 50", "disabled": true }, { "key": "page", "value": "", "description": "padrão 1", "disabled": true } ] }, "description": "Lista os parceiros do programa de fidelidade do app (lojas/serviços onde o cupom é consumido). Terceiro do tipo pessoa vê só o próprio parceiro (id_tx_pessoa fixo). Permitido para todos os tipos de terceiro.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } } ] }, { "name": "Geral", "description": "Teste de credencial, tabelas de códigos (combustíveis) e observações livres.", "item": [ { "name": "GET status — Responde ok se a credencial é válida", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/status", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "status" ], "query": [] }, "description": "Não consulta nada: só confirma que a autenticação (APP/REDE/CNPJ/CPF + SENHA + A) e a permissão do terceiro estão corretas. Útil para testar a conexão da integração. Vale para todos os tipos de terceiro.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET tabelas — Conteúdo da tabela pedida", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/tabelas?id_tabela=1", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "tabelas" ], "query": [ { "key": "id_tabela", "value": "1", "description": "1 = combustíveis ativos.", "disabled": false } ] }, "description": "Tabelas de códigos para usar nos outros endpoints. Hoje só existe a tabela 1 (combustíveis: os id_comb de venda, preços e agenda).\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "GET txObservacao — Consulta uma observação ou as de um registro", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao?", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [ { "key": "id_tx_observacao", "value": "", "description": "Id da observação (tem prioridade).", "disabled": true }, { "key": "tabela", "value": "", "description": "Tabela (usar junto com id quando não houver id_tx_observacao).", "disabled": true }, { "key": "id", "value": "", "description": "Id do registro na tabela.", "disabled": true } ] }, "description": "Por id_tx_observacao a resposta é um objeto plano (sem data[]): {status, id_tx_observacao, tabela, id, observacao, data_hora, ativo}.\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } }, { "name": "POST txObservacao — Cria uma observação", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [] }, "description": "Grava e consulta observações (texto) ligadas a qualquer registro do sistema, identificado por tabela + id. GET por id_tx_observacao devolve uma; por tabela + id devolve a lista. DELETE desativa (ativo = N). A API não verifica se a tabela e o id existem e não restringe pelo escopo do acesso (só pelo app).\n\nPerfis: App, Rede, Posto, Cliente, Pessoa.", "body": { "mode": "raw", "raw": "{\n \"tabela\": \"operacao\",\n \"id\": 9001,\n \"observacao\": \"Cliente pediu conferência\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT txObservacao — Altera uma observação (parcial)", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao?id_tx_observacao=", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [ { "key": "id_tx_observacao", "value": "", "description": "Id da observação", "disabled": false } ] }, "description": "Grava e consulta observações (texto) ligadas a qualquer registro do sistema, identificado por tabela + id. GET por id_tx_observacao devolve uma; por tabela + id devolve a lista. DELETE desativa (ativo = N). A API não verifica se a tabela e o id existem e não restringe pelo escopo do acesso (só pelo app).\n\nPerfis: App, Rede, Posto, Cliente, Pessoa.", "body": { "mode": "raw", "raw": "{\n \"observacao\": \"Texto corrigido\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE txObservacao — Desativa uma observação", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/terceiro/txObservacao?id_tx_observacao=", "host": [ "{{base_url}}" ], "path": [ "v1", "terceiro", "txObservacao" ], "query": [ { "key": "id_tx_observacao", "value": "", "description": "Id da observação", "disabled": false } ] }, "description": "Grava e consulta observações (texto) ligadas a qualquer registro do sistema, identificado por tabela + id. GET por id_tx_observacao devolve uma; por tabela + id devolve a lista. DELETE desativa (ativo = N). A API não verifica se a tabela e o id existem e não restringe pelo escopo do acesso (só pelo app).\n\nPerfis: App, Rede, Posto, Cliente, Pessoa." } } ] } ] }