Generic ReturnsStatus business object

The generic ReturnsStatus business object, which is one of the generic business objects that work with the Order Status collaboration template, is independent of the other status objects. It is used to capture the state of a return sales order whenever that state changes.

For example, the return order triggers the creation of a corresponding ReturnsStatus business object with a status of "Incomplete". Getting approvals for a return item triggers creation of a new ReturnsStatus business object, this time with a status of "Partially Complete".

Business object structure

The ReturnsStatus business object is hierarchical. One of its attributes references the ReturnsStatusLine child business object, which contains status information about a line item in the associated return order.

Each ReturnsStatus business object matches the structure of its associated return order. If the return order has two line items, ReturnsStatus has a header and two ReturnsStatusLine business objects. Even if the triggering event reflects a change of status for only one line item, ReturnsStatus references separate child business objects for each line item in the return order.

For example, assume a return order has two line items, only one of which has been returned. Sending the status for the returned line item triggers creation of a ReturnsStatus business object with two ReturnsStatusLine business objects.

ReturnsStatus: Reporting summary status changes

ReturnsStatus contains such header information as the identifiers of the return order and its associated customer and purchase order, the reason for the return, and the person who last changed the order as well as the date of the change. In addition, it uses five header attributes to summarize the status of all line items in the return order, as described in Table 1.

Table 1: Status attributes in the ReturnsStatus business object

Attribute name Value reported
ProcessingStatusHeader The status of the physical state of the entire return order; for example, values might include "Incomplete", "Open", "Partially Complete", "Complete", and "Canceled".
ApprovalStatusHeader The status for the approvals of the return order; for example, values might include "Not Approved", "Level 1 Approved", "Level 2 Approved", and "Complete".
CreditStatus The status of the customer's credit standing or credit check; for example, values might include "Not Checked", "Approved", and "Not Approved".
RejectionStatusHeader The order's rejection status if its fulfillment was rejected for any reason; for example, values might include "Not Rejected", "Rejected Customer", and "Rejected Part".
ReturnDeliverySchHeader Whether the return deliveries have been scheduled in the shipping application; that is, whether return deliveries have been created. It does not mean that the deliveries have been shipped; for example, values might include "Not Scheduled", "Partially Scheduled", and "Fully Scheduled".

ReturnsStatusLine: Reporting line item status changes

ReturnsStatusLine contains such line item information as the identifiers of the return order line item and its associated reason for return, delivery and billing block data, and the person who last changed the line item as well as the date of the change. It uses the ReturnsStatusLine attribute to contain the line item status of the return order, as described in Table 2.

Table 2: Status attributes in the ReturnsStatusLine business object

Attribute name Value reported
ProcessingStatusLine The status of the physical state of the return order line item
ApprovalStatusLine The stage of the approvals of the return order line item
RejectionStatusLine The rejection status of the return order line item if its fulfillment was rejected for any reason
ReturnDeliverySchLineStatus Whether the return deliveries for the return line item have been scheduled

For information on handling the status of complex sales orders, such as a single sales order with multiple line items and delivery dates, see the generic OrderDeliveryStatus business object.

Supported verbs

ReturnsStatus supports the following verbs:

Examining the object

To examine the attributes of the generic ReturnsStatus business object, use System Manager or Process Designer Express.

Related References

Copyright IBM Corp. 1997, 2004