get_order_m Guide

The get_order_m API returns information about the orders associated with a specified account.

API Specification:	get_order_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id>

Field Name

Notes

<status_filter_cd>

<details_flag>

Values	Description
0	Do not return order line items. (default)
1	Return order line items.

Field Name

Notes

<status_label>

<transaction_id>

Deprecated

<invoice_status_cd>

Status code of the invoice.

Datatype: long

<invoice_status_text>

Description of the invoice status.

Datatype: string

<master_plan_name>

Name of the master plan.

Datatype: string

<item_svc_location_name>

The origin location name for the specified service associated with the plan.

Datatype: string

<nso_rate_schedule_name>

The rate schedule name used for pricing this NSO.

Datatype: string

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error	<auth_key>, <client_no>
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)	<acct_no>, <client_acct_id>
1016: invalid input Additional Comments: This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.	<client_plan_instance_id>, <invoice_no>, <limit>, <limit_records>, <offset>, <status_cd>, <acct_no>, <status_filter_cd>
3024: Invalid reason code	<reason_code>
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id". Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.	<master_plan_instance_id>, <master_plan_instance_no>
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".	<client_master_plan_instance_id>