Allowance Requests — Proposed Guide

Planned API — Reference Only

Allowance Requests: A request would ask for an allocation or exception under a defined policy. Submission creates review work, not an entitlement or…

Overview

A request would ask for an allocation or exception under a defined policy. Submission creates review work, not an entitlement or reimbursement.

Key concepts

Record requester, policy, period and justification. Keep requested amount separate from approved amount.

Implementation considerations

No request is submitted here. A future service must verify eligibility and avoid granting an allowance merely because creation succeeded.

Proposed API behavior

POST /v1/allowance-requests 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 request fields
Name	Type	Description
user_id	string	Stable fictional user reference; not a secret and not evidence that a resource exists.
policy_id	string	Stable fictional policy reference; not a secret and not evidence that a resource exists.
period_id	string	Stable fictional period reference; not a secret and not evidence that a resource exists.
amount_minor	integer	Monetary amount in the documented currency minor unit; 12550 represents USD 125.50, not USD 12,550.
reason	string	Synthetic structured justification, not a real reviewer note.

Static example requests

Proposed, non-executing request examples

# Proposed request text only; this reserved host is not a live API.
curl -X POST 'https://api.remizen.example/v1/allowance-requests' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "user_id": "usr_example_123",
  "policy_id": "policy_example_123",
  "period_id": "period_example_123",
  "amount_minor": 12550,
  "reason": "Example review explanation"
}'

Fictional response example

201 (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": {
    "policy_id": "policy_example_123",
    "amount_minor": 12550,
    "reason": "Example review explanation",
    "id": "allowance_requests_example_123",
    "organization_id": "org_example_123"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: No request is submitted here. A future service must verify eligibility and avoid granting an allowance merely because creation succeeded.

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 allowance requests operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
Name	Type	Description
user_id	string	Stable fictional user reference; not a secret and not evidence that a resource exists.
policy_id	string	Stable fictional policy reference; not a secret and not evidence that a resource exists.
period_id	string	Stable fictional period reference; not a secret and not evidence that a resource exists.
amount_minor	integer	Monetary amount in the documented currency minor unit; 12550 represents USD 125.50, not USD 12,550.
reason	string	Synthetic structured justification, not a real reviewer note.

Update Allowance

Allowances & Fleet

Allowance Approvals