ePages 6.11.0 - DE_EPAGES/Order/API/OrderDocument.pm

Package DE_EPAGES::Order::API::OrderDocument

object interface for Order Documents.

Base
DE_EPAGES::Object::API::Object::Object
@EXPORT_OK
CreateOrderDocument

Functions

CreateOrderDocument

CreateOrderDocument

Creates a new packing slip object for the given Order object.

Syntax
$Document = CreateOrderDocument( $Order, $DocumentTypeName, $DocumentTypePlural);
$Document = CreateOrderDocument( $Order, $DocumentTypeName, $DocumentTypePlural, $hValues );
Example
my $Invoice = CreateOrderDocument($Order, 'Invoice', 'Invoices');
my $Invoice = CreateOrderDocument(
    $Order,
    'Invoice,
    'Invoices',
    {
        'DeliveryDate' => $DeliveryDate,
        'IssueDate' => $IssueDate
    }
);
Input
$Order (object)
order object
$DocumentTypeName (string)
class package name of the document type, i.e.
'Invoice'
$DocumentTypePlural (string)
"plural" class package name of the document type,
i.e. 'Invoices'
$hOptions
optional attributes of new object
  • DeliveryDate - datetime object for delivery date - object
  • IssueDate - datetime object for issue date - object
Return
$PackingSlip (object)
packing slip object