{"openapi":"3.1.0","info":{"title":"Volta API","version":"1.0.0","description":"API de leitura do Volta (reembolsos de despesas). Cada chave de API enxerga apenas os dados da própria empresa. Para receber avisos em tempo real, use webhooks (veja a documentação em /desenvolvedores)."},"servers":[{"url":"https://voltareembolso.com.br/api/v1"}],"security":[{"chave":[]}],"paths":{"/me":{"get":{"summary":"Quem sou eu: empresa e chave","operationId":"me","responses":{"200":{"description":"OK"},"401":{"description":"Erro","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/reembolsos":{"get":{"summary":"Lista reembolsos (mais recentes primeiro)","operationId":"listarReembolsos","parameters":[{"name":"status","in":"query","schema":{"type":"string","enum":["pendente","em_analise","aprovado","recusado","pago","cancelado"]}},{"name":"desde","in":"query","schema":{"type":"string","format":"date"},"description":"Criados a partir desta data (AAAA-MM-DD)."},{"name":"ate","in":"query","schema":{"type":"string","format":"date"},"description":"Criados até esta data, inclusive."},{"name":"pago_desde","in":"query","schema":{"type":"string","format":"date"}},{"name":"pago_ate","in":"query","schema":{"type":"string","format":"date"}},{"name":"centro_de_custo","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"categoria","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"colaborador","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"limite","in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"description":"Quantos itens por página (máximo 200)."},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Valor de `proximo_cursor` da resposta anterior."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/Reembolso"}},"proximo_cursor":{"type":["string","null"]}}}}}},"400":{"description":"Erro","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"Erro","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Erro","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/reembolsos/{id}":{"get":{"summary":"Busca um reembolso","operationId":"buscarReembolso","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Erro","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/colaboradores":{"get":{"summary":"Lista colaboradores","operationId":"listarColaboradores","responses":{"200":{"description":"OK"}}}},"/categorias":{"get":{"summary":"Lista categorias","operationId":"listarCategorias","responses":{"200":{"description":"OK"}}}},"/centros-de-custo":{"get":{"summary":"Lista centros de custo","operationId":"listarCentrosDeCusto","responses":{"200":{"description":"OK"}}}}},"components":{"securitySchemes":{"chave":{"type":"http","scheme":"bearer","bearerFormat":"vlt_live_…","description":"Chave criada em Integrações, no painel."}},"schemas":{"Erro":{"type":"object","properties":{"erro":{"type":"object","properties":{"codigo":{"type":"string"},"mensagem":{"type":"string"}}}}},"Reembolso":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"codigo":{"type":"string","examples":["R-0004"]},"status":{"type":"string","enum":["pendente","em_analise","aprovado","recusado","pago","cancelado"]},"valor":{"type":"number"},"valor_adiantamento_abatido":{"type":"number"},"valor_a_pagar":{"type":"number"},"data_despesa":{"type":"string","format":"date"},"criado_em":{"type":"string","format":"date-time"},"pago_em":{"type":["string","null"],"format":"date-time"},"estabelecimento":{"type":["string","null"]},"cnpj_estabelecimento":{"type":["string","null"]},"descricao":{"type":["string","null"]},"politica":{"type":"string","description":"ok, acima_limite, duplicada ou sem_nota"},"avisos":{"type":"array","items":{"type":"string"}},"categoria":{"type":["object","null"]},"centro_de_custo":{"type":["object","null"]},"colaborador":{"type":["object","null"],"description":"id e nome; com a chave de dados pessoais, também email, whatsapp e chave_pix."},"comprovante_url":{"type":["string","null"],"description":"Só com a chave de dados pessoais: link temporário (1 hora) do comprovante."}}},"Evento":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tipo":{"type":"string","enum":["reembolso.criado","reembolso.em_analise","reembolso.aprovado","reembolso.recusado","reembolso.pago","reembolso.cancelado","teste.ping"]},"criado_em":{"type":"string","format":"date-time"},"dados":{"type":"object","properties":{"reembolso":{"$ref":"#/components/schemas/Reembolso"}}}}}}}}