InventoryJournalHandler

api
package simPROAPI
subpackage Inventory
author Nathan Muir, Michael West, Daniel Sanders [add other contributors]
version 2011-07-18, 2013-01-09

 Methods

InventoryJournalFlag

Flag(int $CompanyID, int $InventoryJournalID) : bool
Static

This function flags a particular inventory journal as exported

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InventoryJournalID

int

The inventory journal to flag as exported

Returns

bool

InventoryJournalFlagList

FlagList(int $CompanyID, array $InventoryJournalIDs) : bool
Static

This function flags particular inventory journals as exported

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InventoryJournalIDs

array

The inventory journals list to flag as exported

Returns

bool

InventoryJournalRetrieve

Retrieve(int $CompanyID, mixed $InventoryJournalID) : array
Static

This function retrieves details for a specific details id

uses \InventoryJournalHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InventoryJournalID

mixed

the Inventory Journal id to retrieve details for

Returns

array

InventoryJournalRetrieveExport

RetrieveExport(int $CompanyID) : array
Static

This function retrieves a list of inventory journals that are ready for export

uses \ContractorHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

Returns

array

InventoryJournalRetrieveList

RetrieveList(int $CompanyID, array $InventoryJournalIDs) : array
Static

This function retrieves details on the provided list of Inventory Journal ids

used_by \InventoryJournalHandler::Search()
used_by \InventoryJournalHandler::Retrieve()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InventoryJournalIDs

array

the Inventory Journal ids to retrieve details for

Returns

array

InventoryJournalUnFlag

UnFlag(int $CompanyID, int $InventoryJournalID) : bool
Static

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InventoryJournalID

int

The inventory journal to Unflag as exported

Returns

bool

InventoryJournalUnFlagList

UnFlagList(int $CompanyID, array $InventoryJournalIDs) : bool
Static

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InventoryJournalIDs

array

The inventory journals list to Unflag as exported

Returns

bool