Operation Event FAQ

Overview

Operation events record operational revenue/cost data and optional asset source fields against a disbursement. When asset_condition is present, the Worker creates an asset_status history row. asset_status itself is not an /ingest category.

Required Fields

operation_id (string)

Question: What is the operation_id?

Answer: A unique identifier for this operation record.

Example: "OP-2024-001"

step (string, enum)

Question: What are the valid values for step?

Answer:

• create: Create a new operation
• update: Update existing operation information
• delete: Delete an operation

disbursement_id (string)

Question: Which disbursement does this operation belong to?

Answer: The parent disbursement id. The backend requires this field on create and checks that the disbursement exists.

Example: "DSB-2024-001"

operation_name (string)

Question: What should operation_name contain?

Answer: A short business name for the operation.

Example: "Asset-backed revenue operation"

Optional Fields

operation_description (string)

Question: Can I provide more context?

Answer: Optional longer text describing the operation.

operation_start_date and operation_end_date (date-time)

Question: What date format should I use?

Answer: ISO 8601 date-time strings.

operation_revenue and operation_cost (number)

Question: What amounts should these store?

Answer: Revenue and cost generated by the operation.

currency (string)

Question: What currency is used?

Answer: ISO 4217 currency code. It should match related disbursement amounts.

Asset fields

Question: Which asset fields can operation carry?

Answer: Use asset_id, asset_type, asset_value, asset_description, asset_purchase_date, and asset_condition when operation has an asset component.

Depreciation fields

Question: How do depreciation fields work?

Answer: depreciation_amount, depreciation_period, and depreciation_method are optional. If any depreciation field is provided, also provide asset_id or asset_value.

Allowed values:

• depreciation_period: daily, monthly, quarterly, yearly
• depreciation_method: straight_line, amortization

info (object)

Question: Can I store additional custom information?

Answer: A flexible object for custom key-value metadata.

Common Questions

Q: Is asset still an ingest category?

A: No. Send asset source fields through operation; the Worker writes status history to asset_status when relevant.

Q: Can I update an operation without disbursement_id?

A: Yes. Updates require operation_id; include disbursement_id only when changing or clarifying parent linkage.

Field Dependencies

• disbursement_id must reference an existing disbursement on create.
• Depreciation fields require either asset_id or asset_value.
• asset_condition creates an asset_status history row.