Module "invoice_queue"
Description
Invoice Queue Module
This module allows you to see what is or has been in queue for
your user. You can then link these items to regular orders to
get more detailed information, such as the product types.
Available methods
- array get_by_id
- array get_by_processed_to_order_item
- array get_by_reseller
- array get_by_user
- array search
Details
array get_by_id
Retrieve all information associated to an item in the invoice
queue by supplying its ID
Parameters
- int $id The ID of the invoice queue item to retrieve
Returns
- array $details The details of the invoice queue item
array get_by_processed_to_order_item
Retrieve all information associated to an item in the invoice
queue by supplying its processed_to_order_item
Parameters
- int $processed_to_order_item_id
Returns
- array $details
array get_by_reseller
Retrieve all information associated to an item in the invoice
queue by supplying the reseller they belong to
Parameters
- int $user_id The reseller ID to fetch invoice queue items for
Returns
- array $details The details of the invoice queue item
array get_by_user
Retrieve all information associated to an item in the invoice
queue by supplying the user they belong to
Parameters
- int $user_id The user ID to fetch invoice queue items for
Returns
- array $details The details of the invoice queue item
array search
Search for invoice queue items by supplying a user ID,
reseller or invoice contact ID. This call will result in a
list of queue items matching your search. This can be useful
to generate short overviews.
Parameters
- int $user_id The user ID to search for
- int $reseller_id The reseller ID to search for
- int $invoice_contact_id The invoice contact ID to search for
- int $processed Flag (1 or 0) for processed or not
Returns
- array $queue An array containing all the matching queue items