Skip to content

Reimbursements API Overview — Proposed Guide

Planned API — Reference Only

Reimbursements API Overview: A reimbursement record would connect an approved business expense to an intended repayment process. Recording that…

Overview

A reimbursement record would connect an approved business expense to an intended repayment process. Recording that relationship is not the same as initiating or completing a payment.

Key concepts

Separate review eligibility, reimbursement state and provider settlement state. Retain the source expense references.

Implementation considerations

Every payment-related example is conceptual. No payment rail, bank connection or money movement is configured by this documentation.

Proposed API behavior

GET /v1/reimbursements is an illustrative design for this topic. Path and field names may change before implementation. Access would require an authorized organization context and operation-specific permission; no public API or authorization grant is available here.

Illustrative query parameters
NameTypeDescription
statusstringProposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success.

Static example requests

Proposed, non-executing request examples
# Proposed request text only; this reserved host is not a live API.
curl -X GET 'https://api.remizen.example/v1/reimbursements?status=draft' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Fictional response example

200 (proposed example)Static response fixture

Fictional documentation data only. No request was sent, record created, review performed, payment initiated or provider connection activated.

JSON
{
  "data": [
    {
      "reimbursement_id": "reimb_example_123",
      "expense_id": "exp_example_123",
      "amount_minor": 12550,
      "currency": "USD",
      "id": "reimb_example_123",
      "organization_id": "org_example_123",
      "expense_ids": [
        "exp_example_123"
      ],
      "status": "draft"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: Every payment-related example is conceptual. No payment rail, bank connection or money movement is configured by this documentation.

422 (illustrative; final error contracts are undecided)Proposed error fixture

Synthetic diagnostic example. Human-readable messages must not be used as stable programmatic contracts.

JSON
{
  "error": {
    "code": "validation_error",
    "message": "The proposed reimbursements api overview operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
NameTypeDescription
reimbursement_idstringStable fictional reimbursement reference; not a secret and not evidence that a resource exists.
expense_idstringStable fictional expense reference; not a secret and not evidence that a resource exists.
amount_minorintegerMonetary amount in the documented currency minor unit; 12550 represents USD 125.50, not USD 12,550.
currencystringUppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
statusstringProposed lifecycle value. Its meaning depends on the resource and must not be inferred from HTTP success.