Create Allowance — Proposed Guide

Planned API — Reference Only

Create Allowance: Creating an allowance would define a proposed allocation governed by a policy and validity period. It should not credit a bank account…

Overview

Creating an allowance would define a proposed allocation governed by a policy and validity period. It should not credit a bank account or issue a card.

Key concepts

Validate currency, employee eligibility and period identity. Use a replay key to prevent duplicate assignments.

Implementation considerations

An allocation is not an approved expense. Future financial effects require separate workflows and explicit authorization.

Proposed API behavior

POST /v1/allowances 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.
amount_minor	integer	Monetary amount in the documented currency minor unit; 12550 represents USD 125.50, not USD 12,550.
currency	string	Uppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
period_id	string	Stable fictional period 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.

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/allowances' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "user_id": "usr_example_123",
  "amount_minor": 12550,
  "currency": "USD",
  "period_id": "period_example_123",
  "policy_id": "policy_example_123"
}'

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": {
    "amount_minor": 12550,
    "currency": "USD",
    "policy_id": "policy_example_123",
    "id": "allowances_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: An allocation is not an approved expense. Future financial effects require separate workflows and explicit authorization.

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 create allowance 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.
amount_minor	integer	Monetary amount in the documented currency minor unit; 12550 represents USD 125.50, not USD 12,550.
currency	string	Uppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
period_id	string	Stable fictional period 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.

List Allowances

Allowances & Fleet

Update Allowance