Get Expense Summary

GET/users/{user_id}/expenses/summary

Returns aggregate expense statistics for the user, including totals and counts by status.

Path Parameters

user_idstringrequired

The Sail user id.

Response

Aggregate expense statistics.

expenses_scannedinteger

Total number of expenses included in this summary.

eligible_totalnumber<float>

Sum of amounts for eligible expenses.

reimbursed_totalnumber<float>

Sum of amounts for reimbursed expenses.

currencystring

ISO 4217 currency code.

countsobject

Expense counts broken down by status.

Show counts properties

eligibleinteger

Number of eligible expenses.

needs_reviewinteger

Number of needs_review expenses.

ineligibleinteger

Number of ineligible expenses.

reimbursedinteger

Number of reimbursed expenses.

archivedinteger

Number of archived expenses.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties

codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

const response = await fetch(`https://live.savewithsail.com/api/v1/users/${user_id}/expenses/summary`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>' } }); const data = await response.json();

import requests response = requests.request( "GET", "https://live.savewithsail.com/api/v1/users/{user_id}/expenses/summary", headers={ "Authorization": "Bearer <token>" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://live.savewithsail.com/api/v1/users/<user_id>/expenses/summary"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://live.savewithsail.com/api/v1/users/<user_id>/expenses/summary", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://live.savewithsail.com/api/v1/users/<user_id>/expenses/summary")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://live.savewithsail.com/api/v1/users/<user_id>/expenses/summary") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

{ "expenses_scanned": 0, "eligible_total": 0, "reimbursed_total": 0, "currency": "string", "counts": { "eligible": 0, "needs_review": 0, "ineligible": 0, "reimbursed": 0, "archived": 0 } }