Send invoice

The send invoice transaction publishes invoice data that can be directed to an external accounts receivable system.

In environments that require an interface with accounts receivable systems, this transaction needs to be scheduled. This transaction raises an event for an invoice based on the following configuration at the following times in the order lifecycle:

Publish invoice at shipment creation - This implies that your accounts payable system takes care of payment collection. Invoices can be published as soon as they are created.
Publish invoice after payment collection - This implies that the Console take care of the payment collection. When payment is in the AT_COLLECT status and the payment is not from an external system, an invoice is published only if the entire payment amount is collected. If the payment is in the AT_CREATE status or the payment is from an external system, the invoice is published unconditionally.

Many of this transaction's elements and attributes are template driven. Refer to the XML for element level details.

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Send invoice attributes
Attribute	Value
Base Transaction ID	SEND_INVOICE
Base Document Type	Order
Base Process Type	Order Fulfillment
Abstract Transaction	No
APIs Called	`getOrderInvoiceDetails()`

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Send invoice criteria parameters
Parameter	Description
Action	Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer	Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
ColonyID	Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Send invoice statistics
Statistic Name	Description
NumInvoicesSent	Number of invoices sent.

Pending job count

For this transaction the pending job count is the number of order invoices in created (“00”) status.

Events raised

The following events are raised by this time-triggered transaction:

Table 4. Events raised by the send invoice transaction
Transaction/Event	Key Data	Data Published	Template Support?
PUBLISH_INVOICE_ DETAIL	modifyOrder_dbd. txt and sendInvoice_dbd .txt	YFS_getOrderInvoice Details_output.xml	Yes

Additional events may be raised by the getOrderInvoiceDetails() API. For detailed information about the events, see the details provided under this API in the IBM Sterling Order Management: Javadoc.