Sample XML Payloads for Events in the Orders Class
This article provides sample XML payloads for each event in the Orders Event Class. Use these samples as a reference when configuring your endpoint to receive and process Order Class event notifications from Aria Billing Cloud.
All payloads in this class use schema version 3.0. The <request> and <account> elements are required. The <item> element is optional and appears when the event involves a specific order item.
Event 801: Order Entered, Not Processed
Aria sends this notification when a new order is submitted for an account but has not yet been processed. The <action> value is A (add), indicating the creation of a new order record. The <item> element is included when the order contains a specific item with a defined SKU and unit rate.
<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
<request>
<version>3.0</version>
<sender>A</sender>
<transaction_id>10000001</transaction_id>
<action>A</action>
<class>O</class>
<auth_key>a1b2c3d4e5f6g7h8</auth_key>
</request>
<account>
<client_no>1001</client_no>
<acct_no>50001</acct_no>
<client_acct_id>ACCT-001</client_acct_id>
<userid>jsmith</userid>
<resp_level_cd>1</resp_level_cd>
<resp_plan_instance_no>60001</resp_plan_instance_no>
<order_no>80001</order_no>
<order_status>1</order_status>
<order_fulfill_date></order_fulfill_date>
<plan_instance_no>60001</plan_instance_no>
<client_plan_instance_id>MPI-001</client_plan_instance_id>
</account>
<item>
<sku>WIDGET-A</sku>
<units>1</units>
<unit_rate>49.99</unit_rate>
</item>
<event_data>
<event>
<event_id>801</event_id>
<event_label>Order Entered Not Processed</event_label>
</event>
</event_data>
</apf2doc>
Note: When you receive an event 801 payload, provision the account for the ordered item and hold fulfillment until Aria sends a subsequent event (802 or 803) confirming billing eligibility or successful billing. The <order_fulfill_date> field is empty at this stage because the order has not yet been fulfilled.
Event 802: Order Marked Eligible for Billing
Aria sends this notification when an existing order transitions to a billing-eligible state. The <action> value is M (modify), reflecting a status change on the order record. No fulfillment date is set at this stage because billing has not yet completed.
<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
<request>
<version>3.0</version>
<sender>A</sender>
<transaction_id>10000002</transaction_id>
<action>M</action>
<class>O</class>
<auth_key>a1b2c3d4e5f6g7h8</auth_key>
</request>
<account>
<client_no>1001</client_no>
<acct_no>50001</acct_no>
<client_acct_id>ACCT-001</client_acct_id>
<userid>jsmith</userid>
<resp_level_cd>1</resp_level_cd>
<resp_plan_instance_no>60001</resp_plan_instance_no>
<order_no>80001</order_no>
<order_status>2</order_status>
<order_fulfill_date></order_fulfill_date>
<plan_instance_no>60001</plan_instance_no>
<client_plan_instance_id>MPI-001</client_plan_instance_id>
</account>
<item>
<sku>WIDGET-A</sku>
<units>1</units>
<unit_rate>49.99</unit_rate>
</item>
<event_data>
<event>
<event_id>802</event_id>
<event_label>Order Marked Eligible for Billing</event_label>
</event>
</event_data>
</apf2doc>
Note: Event 802 signals that Aria has evaluated the order and determined it is ready for billing. At this point you can begin preparing fulfillment workflows in your system, but wait for event 803 before confirming that billing has completed.
Event 803: Order Billed
Aria sends this notification when an order has been successfully billed. The <action> value is M (modify). The <order_fulfill_date> field is populated with the date the billing was completed, and <order_status> is updated to reflect the billed state.
<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
<request>
<version>3.0</version>
<sender>A</sender>
<transaction_id>10000003</transaction_id>
<action>M</action>
<class>O</class>
<auth_key>a1b2c3d4e5f6g7h8</auth_key>
</request>
<account>
<client_no>1001</client_no>
<acct_no>50001</acct_no>
<client_acct_id>ACCT-001</client_acct_id>
<userid>jsmith</userid>
<resp_level_cd>1</resp_level_cd>
<resp_plan_instance_no>60001</resp_plan_instance_no>
<order_no>80001</order_no>
<order_status>4</order_status>
<order_fulfill_date>2026-06-15</order_fulfill_date>
<plan_instance_no>60001</plan_instance_no>
<client_plan_instance_id>MPI-001</client_plan_instance_id>
</account>
<item>
<sku>WIDGET-A</sku>
<units>1</units>
<unit_rate>49.99</unit_rate>
</item>
<event_data>
<event>
<event_id>803</event_id>
<event_label>Order Billed</event_label>
</event>
</event_data>
</apf2doc>
Note: Event 803 confirms that the order charge has been applied to the account. Use <order_fulfill_date> to record the billing date in your system and trigger any downstream fulfillment or provisioning actions.
Event 804: Order Paid
Aria sends this notification when payment for a billed order is received. The <action> value is M (modify). The <order_status> is updated to 3 (Order Filled), reflecting that the order lifecycle is complete, and <order_fulfill_date> retains the date from the billing event.
<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
<request>
<version>3.0</version>
<sender>A</sender>
<transaction_id>10000004</transaction_id>
<action>M</action>
<class>O</class>
<auth_key>a1b2c3d4e5f6g7h8</auth_key>
</request>
<account>
<client_no>1001</client_no>
<acct_no>50001</acct_no>
<client_acct_id>ACCT-001</client_acct_id>
<userid>jsmith</userid>
<resp_level_cd>1</resp_level_cd>
<resp_plan_instance_no>60001</resp_plan_instance_no>
<order_no>80001</order_no>
<order_status>3</order_status>
<order_fulfill_date>2026-06-15</order_fulfill_date>
<plan_instance_no>60001</plan_instance_no>
<client_plan_instance_id>MPI-001</client_plan_instance_id>
</account>
<item>
<sku>WIDGET-A</sku>
<units>1</units>
<unit_rate>49.99</unit_rate>
</item>
<event_data>
<event>
<event_id>804</event_id>
<event_label>Order Paid</event_label>
</event>
</event_data>
</apf2doc>
Note: Event 804 confirms successful payment. If your fulfillment workflow is gated on payment confirmation rather than billing, use this event as the trigger to activate the ordered item or service for the customer.
Event 805: Order Canceled
Aria sends this notification when an order is canceled before or during processing. The <action> value is M (modify). The <order_status> is updated to reflect the canceled state. The <order_fulfill_date> field is empty because the order was not fulfilled. The <item> element is omitted in this example because no item-level change is associated with a cancellation.
<?xml version="1.0" encoding="UTF-8"?>
<apf2doc>
<request>
<version>3.0</version>
<sender>A</sender>
<transaction_id>10000005</transaction_id>
<action>M</action>
<class>O</class>
<auth_key>a1b2c3d4e5f6g7h8</auth_key>
</request>
<account>
<client_no>1001</client_no>
<acct_no>50001</acct_no>
<client_acct_id>ACCT-001</client_acct_id>
<userid>jsmith</userid>
<resp_level_cd>1</resp_level_cd>
<resp_plan_instance_no>60001</resp_plan_instance_no>
<order_no>80001</order_no>
<order_status>-2</order_status>
<order_fulfill_date></order_fulfill_date>
<plan_instance_no>60001</plan_instance_no>
<client_plan_instance_id>MPI-001</client_plan_instance_id>
</account>
<event_data>
<event>
<event_id>805</event_id>
<event_label>Order Canceled</event_label>
</event>
</event_data>
</apf2doc>
Note: Event 805 signals that the order will not proceed. If your system provisioned resources in response to event 801, reverse those actions upon receiving this event. The <item> element is omitted here because cancellation does not carry item-level changes; however, your endpoint must handle its absence gracefully.
General Notes for System Integrators
The following notes apply to all events in the Orders Class.
Schema version. All Orders Class payloads use <version>3.0</version>. Validate this value on ingest and reject payloads with unexpected version numbers to prevent processing mismatches.
Action values. The <action> field uses two values in this class: A (add) for new order creation (event 801) and M (modify) for all subsequent status transitions (events 802–805). Do not rely on the action value alone to determine event type; always inspect <event_id>.
Order status codes. The <order_status> field carries a numeric code from the table below. A typical successful order advances from Order Entered (1) through Order Placed (2) to Order Billed (4), then Order Filled (3) when payment is received. An order can be cancelled at any point, setting status to –2. Your integration should handle out-of-order or repeated event delivery.
| STATUS_CD | Label |
|---|---|
| 0 | Order Entry in Progress |
| 1 | Order Entered |
| 2 | Order Placed |
| 3 | Order Filled |
| 4 | Order Billed |
| 5 | Order Held |
| –1 | Order Rejected |
| –2 | Order Cancelled |
The item element. The <item> element is optional and is present when the event involves a specific item with a defined SKU, unit count, and unit rate. Your endpoint must handle payloads that omit this element. Event 805 (Order Canceled) commonly omits <item>.
Authentication. The <auth_key> field contains your client-specific authentication key. Verify this value on every inbound request before processing the payload.
Idempotency. Aria may deliver the same event more than once in some circumstances. Design your endpoint to process duplicate payloads without creating duplicate records or triggering duplicate fulfillment actions. Use <transaction_id> as a correlation key to detect and discard duplicates.
Blurring sensitive values. The <auth_key> value in these sample payloads is a placeholder. Do not expose your actual authentication key in documentation, logs, or support tickets.