Sail

Get Reimbursement

GET/users/{user_id}/reimbursements/{reimbursement_id}

Full reimbursement with expense breakdown. receipt_url is populated once completed.

Path Parameters

user_idstringrequired

The Sail user id.

reimbursement_idstringrequired

The Sail reimbursement id.

Response

Reimbursement details.

idstring

The Sail reimbursement id.

status"pending" | "submitted" | "processing" | "completed" | "failed"

The reimbursement’s current processing status.

amountnumber<float>

Sum of the included expenses, USD.

account_idstring

The funding account. Join to /accounts/{account_id} for provider and balance context.

expensesobject[]

The expenses included in this reimbursement.

Show expenses properties
idstring

The Sail expense id.

namestring

The expense’s display name.

amountnumber<float>

The expense’s amount, USD.

datestring<date>

The expense’s transaction date.

receipt_urlstring

Reimbursement receipt document. Populated once completed; present on the single-resource GET only.

submitted_atstring<date-time>

When the reimbursement was submitted for processing.

completed_atstring<date-time>

When the reimbursement completed. Null while still in progress.

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.

Request
curl -X GET "https://live.savewithsail.com/api/v1/users/<user_id>/reimbursements/<reimbursement_id>" \
  -H "Authorization: Bearer <token>"
Response
{
  "id": "reimb_8c1f",
  "status": "pending",
  "amount": 0,
  "account_id": "string",
  "expenses": [
    {
      "id": "string",
      "name": "string",
      "amount": 0,
      "date": "2024-01-01"
    }
  ],
  "receipt_url": "string",
  "submitted_at": "1970-01-01T00:00:00.000Z",
  "completed_at": "1970-01-01T00:00:00.000Z"
}