Create shipment invoice

Invoicing is mandatory if an order requires payment processing. Invoicing occurs if the following conditions are met:

Invoicing is enabled at the document parameter level.
The Seller requires payment processing.

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.

Attributes

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

Table 1. Create shipment invoice attributes
Attribute	Value
Base Transaction ID	CREATE_SHIPMENT_INVOICE
Base Document Type	Order
Base Process Type	Order Delivery
Abstract Transaction	Yes
APIs Called	`createShipmentInvoice()`

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Create shipment 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 sharded deployment where a table may exist in multiple schemas. Runs the agent for the colony.
Task Queue Filter Criteria	Optional. Determines the jobs to be fetched by the agent. The value assigned to this parameter is matched against the custom value stored in the `FILTER_CRITERIA` column of `YFS_TASK_Q` table, while fetching the jobs. Note: `VOID` is a valid task queue filter criteria value which is used to match records with NULL value in the `FILTER_CRITERIA` column of `YFS_TASK_Q` table. For more information, see Workload segregation for task queue agents.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Create shipment invoice statistics
Statistic Name	Description
NumShipmentInvoicesCreated	Number of shipment invoices created.

Pending job count

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.

Events raised

This transaction raises events as specified under the createShipmentInvoice() API in the Javadoc.