Invoicing is mandatory if an order requires payment processing. Invoicing occurs if the following conditions are met:
This transaction creates one or more invoices for the shipment whose ShipmentKey is stored in the task queue object. The createShipmentInvoice() API is called for the ShipmentHeaderKey.
This transaction should be configured in the shipment pipeline only after the shipment has reached a shipped status.
Both the Create Order Invoice and Create Shipment Invoice can create invoices for an order. When configuring your pipeline, ensure that only one of these two transactions is configured to create invoices for a particular order line. See Create order invoice.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | CREATE_SHIPMENT_INVOICE |
Base Document Type | Order |
Base Process Type | Order Delivery |
Abstract Transaction | Yes |
APIs Called | createShipmentInvoice() |
The following are the criteria parameters for this transaction:
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. |
The following statistics are tracked for this transaction:
Statistic Name | Description |
---|---|
NumShipmentInvoicesCreated | Number of shipment invoices created. |
For this transaction the pending job count is the number of records available to be processed by the transaction with the AVAILABLE_DATE value less than or equal to (<=) the current date value in the YFS_Task_Q table.
This transaction raises events as specified under the createShipmentInvoice() API in the Sterling Selling and Fulfillment Foundation: Javadocs.