Class Connection

This object establishes and maintains a connection with a JobTracker instance.

When updating an object derived from HasCustomFieldValues, the custom fields will only be updated if the CustomFieldValues property is set.

Also, only those fields explicitly included in the collection will be updated.

Inheritance

System.Object

Connection

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Moraware.JobTrackerAPI5

Assembly: JobTrackerAPI5.dll

Syntax

public class Connection

Constructors

Connection(String, String, String, ICommandTracer, Boolean, Boolean, String)

Declaration

public Connection(string url_ = "", string userName_ = "", string password_ = "", ICommandTracer commandTracer_ = null, bool compressRequests_ = true, bool compressResponses_ = true, string applicationName_ = "")

Parameters

Type	Name	Description
System.String	url_	url at which the JobTracker instance may be found.
System.String	userName_	Username to be used when establishing a connection to the service.
System.String	password_	Password to be used when establishing a connection to the service.
ICommandTracer	commandTracer_	If included, this object will be used to trace the commands and responses issued and received through this connection.
System.Boolean	compressRequests_	Will compress requests sent to the server if the server permits request compression.
System.Boolean	compressResponses_	Will request that the server compress its responses.
System.String	applicationName_	This string is included in the USER-AGENT HTTP Header sent to the JobTracker instance.

Fields

JobProcessId

Process Id of the "Job" Process. The only process (implicitly) supported before api version 2.

Declaration

public const int JobProcessId = 1

Field Value

Type	Description
System.Int32

Properties

ApplicationName

This string is included in the USER-AGENT HTTP Header sent to the JobTracker instance.

Declaration

public string ApplicationName { get; set; }

Property Value

Type	Description
System.String

AutoRefreshOnTimeout

When this property is set, if a SessionTimedOut exception occurs while executing a command, the connection will automatically be reestablished.

Declaration

public bool AutoRefreshOnTimeout { get; set; }

Property Value

Type	Description
System.Boolean

CommandTracer

If this property is set, the CommandTracer will be called with the actual commands and responses passed between the connection object and the JobTracker instance.

Declaration

public ICommandTracer CommandTracer { get; set; }

Property Value

Type	Description
ICommandTracer

CompressRequests

If True, requests sent to the server will be gzip'ed.

Declaration

public bool CompressRequests { get; set; }

Property Value

Type	Description
System.Boolean

CompressResponses

If True, the connection will indicate to the server that it would like the responses gzip'ed.

Declaration

public bool CompressResponses { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

The server may choose to ignore the request for gzip'ed responses.

Connected

Indicates whether or not this object has connected to a JobTracker instance.

Declaration

public bool Connected { get; }

Property Value

Type	Description
System.Boolean

Remarks

It is possible for a Connection to time out and yet still have this property return True. It won't be until the next interaction with the server that a SessionTimedOut exception will be thrown.

IncludeStackTraceInDescription

If this property is set, any exceptions that are thrown will include the stack trace information provided by the server (if there was any).

Declaration

public bool IncludeStackTraceInDescription { get; set; }

Property Value

Type	Description
System.Boolean

Password

Password to be used when establishing a connection to the service.

Declaration

public string Password { set; }

Property Value

Type	Description
System.String

Url

url at which the JobTracker instance may be found.

Declaration

public string Url { get; set; }

Property Value

Type	Description
System.String

UserName

Username to be used when establishing a connection to the service.

Declaration

public string UserName { get; set; }

Property Value

Type	Description
System.String

Methods

AddJobsToPurchaseOrder(IEnumerable<Int32>, Int32)

Links the given Jobs to the given Purchase Order.

Declaration

public void AddJobsToPurchaseOrder(IEnumerable<int> jobIds_, int purchaseOrderId_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	jobIds_	Identifies the jobs to use.
System.Int32	purchaseOrderId_	Identifies the purchase order to use

AddJobToPurchaseOrder(Int32, Int32)

Links the given Job to the given Purchase Order.

Declaration

public void AddJobToPurchaseOrder(int jobId_, int purchaseOrderId_)

Parameters

Type	Name	Description
System.Int32	jobId_	Identifies the job to use.
System.Int32	purchaseOrderId_	Identifies the purchase order to use

AddPurchaseOrdersToJob(IEnumerable<Int32>, Int32)

Links the given Purchase Orders to the given Job.

Declaration

public void AddPurchaseOrdersToJob(IEnumerable<int> purchaseOrderIds_, int jobId_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderIds_	Identifies the purchase orders to use.
System.Int32	jobId_	Identifies the job to use

AddPurchaseOrderToJob(Int32, Int32)

Links the given Purchase Order to the given Job.

Declaration

public void AddPurchaseOrderToJob(int purchaseOrderId_, int jobId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	Identifies the Purchase Order to use.
System.Int32	jobId_	Identifies the job to use

Connect()

Attempts to establish a connection with a JobTracker instance.

Declaration

public void Connect()

ConvertJob(Int32, Int32)

Converts the given job to the given process.

Declaration

public void ConvertJob(int jobId_, int processId_)

Parameters

Type	Name	Description
System.Int32	jobId_	Identifies the Job to be converted.
System.Int32	processId_	Identifies the target JTProcess. Must be an active process.

CreateAccount(Account, IEnumerable<AccountContact>, Boolean)

Creates an account, optionally including a set of contacts to be associated with the account and indicating whether an exception should be raised if an account with the same name already exists. (By default, creating a duplicate will result in an exception.)

Declaration

public int CreateAccount(Account account_, IEnumerable<AccountContact> contacts_ = null, bool allowDuplicates_ = false)

Parameters

Type	Name	Description
Account	account_	Account to be created.
System.Collections.Generic.IEnumerable<AccountContact>	contacts_	A list of contacts to be created on the account.
System.Boolean	allowDuplicates_	If True, you will be able to set the name of the account to be the same as another account without an error.

Returns

Type	Description
System.Int32	The new account's id.

Remarks

On successful creation, account_'s AccountId property will be assigned the id of the newly created account. If contacts have been provided, their AccountId and ContactId properties will also be updated.

CreateAccountContact(AccountContact)

Creates the given AccountContact.

Declaration

public int CreateAccountContact(AccountContact accountContact_)

Parameters

Type	Name	Description
AccountContact	accountContact_	The AccountContact to create.

Returns

Type	Description
System.Int32	The new account contact's id.

Remarks

On successful creation, accountContact_'s ContactId property will be assigned the id of the newly created account contact.

CreateAccountPriceList(AccountPriceList)

Adds a price list to an account.

Declaration

public void CreateAccountPriceList(AccountPriceList accountPriceList_)

Parameters

Type	Name	Description
AccountPriceList	accountPriceList_	The account price list to be created.

CreateAssignee(Assignee)

Creates the given assignee.

Declaration

public int CreateAssignee(Assignee assignee_)

Parameters

Type	Name	Description
Assignee	assignee_	Assignee to be created.

Returns

Type	Description
System.Int32	The new assignee's id.

Remarks

On successful creation, assignee_'s AssigneeId property will be assigned the id of the newly created assignee.

CreateCommandDocument(String, String)

Creates the stub of a command document, adorning it with the version strings and the current SessionId (unless it's a 'sessionCreate' command, in which case the UserName and Password are set).

Declaration

public XmlElement CreateCommandDocument(string commandName_, string apiVersion_ = "5")

Parameters

Type	Name	Description
System.String	commandName_	Command document to create.
System.String	apiVersion_	Version of document to generate.

Returns

Type	Description
System.Xml.XmlElement	A command document built using the given command name and versions along with the current session id.

CreateCommandDocument(String, String, Nullable<Int32>)

Creates the stub of a command document, adorning it with the version strings and the current SessionId (unless it's a 'sessionCreate' command, in which case the UserName and Password are set).

Declaration

public XmlElement CreateCommandDocument(string commandName_, string apiVersion_, int? prereleaseVersion_)

Parameters

Type	Name	Description
System.String	commandName_	Command document to create.
System.String	apiVersion_	Version of document to generate.
System.Nullable<System.Int32>	prereleaseVersion_	Indicates the prerelease version (if any) of the document to generate.

Returns

Type	Description
System.Xml.XmlElement	A command document built using the given command name and versions along with the current session id.

CreateInventoryCount(InventoryCount)

Creates an inventory count.

Declaration

public int CreateInventoryCount(InventoryCount inventoryCount_)

Parameters

Type	Name	Description
InventoryCount	inventoryCount_	The inventory count to create.

Returns

Type	Description
System.Int32	Id of the newly created inventory count.

CreateInventoryCountDetail(InventoryCountDetail)

Creates an inventory count detail.

Declaration

public Guid CreateInventoryCountDetail(InventoryCountDetail inventoryCountDetail_)

Parameters

Type	Name	Description
InventoryCountDetail	inventoryCountDetail_	The inventory count detail to create. Will be based on either a serial number or product variant.

Returns

Type	Description
System.Guid	Id of the new inventory count detail.

CreateInventoryLocation(InventoryLocation)

Creates the given InventoryLocation.

Declaration

public int CreateInventoryLocation(InventoryLocation inventoryLocation_)

Parameters

Type	Name	Description
InventoryLocation	inventoryLocation_	Inventory location to be created.

Returns

Type	Description
System.Int32	The new inventory location's id.

Remarks

On successful creation, inventoryLocation_'s InventoryLocationId property will be assigned the id of the newly created inventory location.

CreateJob(Job)

Creates a job. (Setting the creation date to 'today', using no template initializing the job and not permitting duplicate job names).

Declaration

public int CreateJob(Job job_)

Parameters

Type	Name	Description
Job	job_	Job to be created.

Returns

Type	Description
System.Int32	Returns the new job's id.

Remarks

On successful creation, job_'s JobId property will be assigned the id of the newly created job.

CreateJob(Job, Boolean)

Creates a job, indicating whether an exception should be thrown if a job with the same name already exists. (Setting the creation date to 'today').

Declaration

public int CreateJob(Job job_, bool allowDuplicates_)

Parameters

Type	Name	Description
Job	job_	Job to be created.
System.Boolean	allowDuplicates_	If True, you will be able to set the name of the job to be the same as another job within the same account without an error.

Returns

Type	Description
System.Int32	Returns the new job's id.

Remarks

On successful creation, job_'s JobId property will be assigned the id of the newly created job.

CreateJob(Job, Boolean, Nullable<Int32>)

Creates a job, indicating whether an exception should be thrown if a job with the same name already exists and providing an optional template to be used to initialize the job. (Setting the creation date to 'today').

Declaration

public int CreateJob(Job job_, bool allowDuplicates_, int? jobTemplateId_)

Parameters

Type	Name	Description
Job	job_	Job to be created.
System.Boolean	allowDuplicates_	If True, you will be able to set the name of the job to be the same as another job within the same account without an error.
System.Nullable<System.Int32>	jobTemplateId_	Optional job template to be used when the job is created.

Returns

Type	Description
System.Int32	Returns the new job's id.

Remarks

On successful creation, job_'s JobId property will be assigned the id of the newly created job.

CreateJob(Job, Boolean, Nullable<Int32>, Boolean)

Creates a job, indicating whether an exception should be thrown if a job with the same name already exists, providing an optional template to be used to initialize the job and indicating if the creation date assigned to the job object or the default creation date of 'today' should be used.

Declaration

public int CreateJob(Job job_, bool allowDuplicates_, int? jobTemplateId_, bool useSpecifiedCreationDate_)

Parameters

Type	Name	Description
Job	job_	Job to be created.
System.Boolean	allowDuplicates_	If True, you will be able to set the name of the job to be the same as another job within the same account without an error.
System.Nullable<System.Int32>	jobTemplateId_	Optional job template to be used when the job is created.
System.Boolean	useSpecifiedCreationDate_	If set, the creation date in the job_ will be used rather than the default creation date of 'today'.

Returns

Type	Description
System.Int32	Returns the new job's id.

Remarks

On successful creation, job_'s JobId property will be assigned the id of the newly created job.

CreateJobActivity(JobActivity)

Creates a new Job Activity.

Declaration

public int CreateJobActivity(JobActivity jobActivity_)

Parameters

Type	Name	Description
JobActivity	jobActivity_	Job activity to be created.

Returns

Type	Description
System.Int32	Returns the new job activity's id.

Remarks

On successful creation, jobActivity_'s JobActivityId property will be assigned the id of the newly created job activity.

CreateJobActivitySeries(JobActivity, Int32, String)

Creates a series of Job Activities with the given number of activities in the series and the given series name.

Declaration

public int CreateJobActivitySeries(JobActivity jobActivity_, int newSeriesLength_, string newSeriesName_ = "")

Parameters

Type	Name	Description
JobActivity	jobActivity_	Job activity to be created.
System.Int32	newSeriesLength_	Number of job activities to include in the series.
System.String	newSeriesName_	(Optional) name of the new job activity series.

Returns

Type	Description
System.Int32	The new id of the last job activity in the series.

Remarks

On successful creation, jobActivity_'s JobActivityId property will be assigned the id of the last of the newly created job activities.

CreateJobActivitySeriesMember(JobActivity, Int32)

Creates a Job Activity as part of an existing series.

Declaration

public int CreateJobActivitySeriesMember(JobActivity jobActivity_, int existingJobActivitySeriesId_)

Parameters

Type	Name	Description
JobActivity	jobActivity_	Job activity to be created.
System.Int32	existingJobActivitySeriesId_	Identifies an existing series.

Returns

Type	Description
System.Int32	The new job activity's id.

Remarks

On successful creation, jobActivity_'s JobActivityId property will be assigned the id of the newly created job activity.

CreateJobForm(JobForm)

Creates a new instance of a Job Form.

Declaration

public int CreateJobForm(JobForm jobForm_)

Parameters

Type	Name	Description
JobForm	jobForm_	Describes the job form to be created.

Returns

Type	Description
System.Int32	The new job form's id.

Remarks

On successful creation, jobForm_'s JobFormId property will be assigned the id of the newly created job form.

CreateJobPhase(JobPhase)

Creates a job phase.

Declaration

public int CreateJobPhase(JobPhase jobPhase_)

Parameters

Type	Name	Description
JobPhase	jobPhase_	Job phase to be created.

Returns

Type	Description
System.Int32	The new job phase's id.

Remarks

On successful creation, jobPhase_'s JobPhaseId property will be assigned the id of the newly created job phase.

CreatePurchaseOrder(PurchaseOrder)

Creates the given purchase order.

Declaration

public int CreatePurchaseOrder(PurchaseOrder purchaseOrder_)

Parameters

Type	Name	Description
PurchaseOrder	purchaseOrder_	Purchase order to be created.

Returns

Type	Description
System.Int32	The new purchase order's id.

Remarks

On successful creation, purchaseOrder_'s PurchaseOrderId property will be assigned the id of the newly created purchase order.

CreatePurchaseOrderLines(PurchaseOrderSplitLine)

Creates a set of purchase order lines by splitting an existing purchase order line.

Declaration

public void CreatePurchaseOrderLines(PurchaseOrderSplitLine purchaseOrderSplitLine_)

Parameters

Type	Name	Description
PurchaseOrderSplitLine	purchaseOrderSplitLine_	Describes how the existing purchase order line is to be split.

CreatePurchaseOrderLines(IEnumerable<PurchaseOrderSplitLine>)

Creates a set of purchase order lines by splitting a set of existing purchase order lines.

Declaration

public void CreatePurchaseOrderLines(IEnumerable<PurchaseOrderSplitLine> purchaseOrderSplitLines_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PurchaseOrderSplitLine>	purchaseOrderSplitLines_	Describes how the existing purchase order lines are to be split.

CreatePurchaseOrderMiscellaneousLine(PurchaseOrderMiscellaneousLine)

Creates a purchase order miscellaneous line.

Declaration

public int CreatePurchaseOrderMiscellaneousLine(PurchaseOrderMiscellaneousLine purchaseOrderMiscellaneousLine_)

Parameters

Type	Name	Description
PurchaseOrderMiscellaneousLine	purchaseOrderMiscellaneousLine_	Defines the line to be created.

Returns

Type	Description
System.Int32	Id of the new PurchaseOrderMiscellaneousLine.

CreatePurchaseOrderProductLine(PurchaseOrderProductLine)

Creates a purchase order product line.

Declaration

public int CreatePurchaseOrderProductLine(PurchaseOrderProductLine purchaseOrderProductLine_)

Parameters

Type	Name	Description
PurchaseOrderProductLine	purchaseOrderProductLine_	Defines the line to be created.

Returns

Type	Description
System.Int32	Id of the new PurchaseOrderProductLine.

CreatePurchaseOrderReceipts(PurchaseOrderReceipt)

Creates receipts based on a single PurchaseOrderReceipt object.

Declaration

public List<PurchaseOrderReceipt> CreatePurchaseOrderReceipts(PurchaseOrderReceipt purchaseOrderReceipt_)

Parameters

Type	Name	Description
PurchaseOrderReceipt	purchaseOrderReceipt_	Describes the receipt to be created.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	A list of objects representing the receipts that have been created.

CreatePurchaseOrderReceipts(IEnumerable<PurchaseOrderReceipt>)

Creates a set of PurchaseOrderReceipts.

Declaration

public List<PurchaseOrderReceipt> CreatePurchaseOrderReceipts(IEnumerable<PurchaseOrderReceipt> purchaseOrderReceipts_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PurchaseOrderReceipt>	purchaseOrderReceipts_	On return, the ids of these PurchaseOrderReceipts, and those of any SerialNumber objects they may include will be set to the ids of the new receipts. However, it is possible that a given argument PurchaseOrderReceipt object may result in multiple receipts being created (e.g. creating receipts for a serializable purchase order product line with a quantity > 1) in which case, obviously only one of the resulting receipt ids can be used for the original object.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	A list of objects representing the receipts that have been created. The receipt id and (if applicable) the associated serial number's id will be set.

CreatePurchaseOrderReceiptsForPurchaseOrder(Int32)

Creates PurchaseOrderReceipts for a given PurchaseOrder.

Declaration

public List<PurchaseOrderReceipt> CreatePurchaseOrderReceiptsForPurchaseOrder(int purchaseOrderId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	The purchase order to be received.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	A list of objects representing the receipts that have been created. (Only the receipt ids and if applicable, the serial number ids, will be set.

CreatePurchaseOrderReceiptsForPurchaseOrderLine(Int32)

Creates PurchaseOrderReceipts for a given PurchaseOrderLine.

Declaration

public List<PurchaseOrderReceipt> CreatePurchaseOrderReceiptsForPurchaseOrderLine(int purchaseOrderLineId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderLineId_	The line to be received.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	A list of objects representing the receipts that have been created. (Only the receipt ids and if applicable, the serial number ids, will be set.

CreatePurchaseOrderReceiptsForPurchaseOrderLines(IEnumerable<Int32>)

Creates PurchaseOrderReceipts for a specific set of PurchaseOrderLines.

Declaration

public List<PurchaseOrderReceipt> CreatePurchaseOrderReceiptsForPurchaseOrderLines(IEnumerable<int> purchaseOrderLineIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderLineIds_	Identifies the PurchaseOrderLines to be received.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	A list of objects representing the receipts that have been created. (Only the receipt ids and if applicable, the serial number ids, will be set.

CreatePurchaseOrderReceiptsForUnreceivedSerialNumbers(IEnumerable<Int32>)

Creates PurchaseOrderReceipts for a specific set of UnreceivedSerialNumbers.

Declaration

public List<PurchaseOrderReceipt> CreatePurchaseOrderReceiptsForUnreceivedSerialNumbers(IEnumerable<int> unreceivedSerialNumberIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	unreceivedSerialNumberIds_	Identifies the UnreceivedSerialNumbers to be received.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	A list of objects representing the receipts that have been created. (Only the receipt ids and if applicable, the serial number ids, will be set.

CreatePurchaseProductVariantInventoryAdjustment(PurchaseProductVariantInventoryAdjustment)

Creates a purchase product variant inventory adjustment.

Declaration

public int CreatePurchaseProductVariantInventoryAdjustment(PurchaseProductVariantInventoryAdjustment purchaseProductVariantInventoryAdjustment_)

Parameters

Type	Name	Description
PurchaseProductVariantInventoryAdjustment	purchaseProductVariantInventoryAdjustment_	Purchase product variant inventory adjustment to be created.

Returns

Type	Description
System.Int32	Id of the new purchase product variant inventory adjustment.

CreateSalesperson(Salesperson)

Creates the given Salesperson.

Declaration

public int CreateSalesperson(Salesperson salesperson_)

Parameters

Type	Name	Description
Salesperson	salesperson_	Salesperson to be created.

Returns

Type	Description
System.Int32	The new salesperson's id.

Remarks

On successful creation, salesperson_'s SalespersonId property will be assigned the id of the newly created salesperson.

CreateSerialNumberImport(SerialNumberImport)

Creates a new serial number import.

Declaration

public int CreateSerialNumberImport(SerialNumberImport serialNumberImport_)

Parameters

Type	Name	Description
SerialNumberImport	serialNumberImport_	Serial number import to be created.

Returns

Type	Description
System.Int32	Id of the new serial number import.

CreateSerialNumberInventoryAdjustment(SerialNumberInventoryAdjustment)

Creates a serial number inventory adjustment.

Declaration

public int CreateSerialNumberInventoryAdjustment(SerialNumberInventoryAdjustment serialNumberInventoryAdjustment_)

Parameters

Type	Name	Description
SerialNumberInventoryAdjustment	serialNumberInventoryAdjustment_	Serial number inventory adjustment to be created.

Returns

Type	Description
System.Int32	Id of the new serial number inventory adjustment.

CreateSerialNumberRemnant(SerialNumberRemnant)

Creates a new serial number remnant.

Declaration

public int CreateSerialNumberRemnant(SerialNumberRemnant serialNumberRemnant_)

Parameters

Type	Name	Description
SerialNumberRemnant	serialNumberRemnant_	Serial number remnant to be created.

Returns

Type	Description
System.Int32	Id of the new serial number remnant.

CreateSupplier(Supplier)

Creates the given supplier.

Declaration

public int CreateSupplier(Supplier supplier_)

Parameters

Type	Name	Description
Supplier	supplier_	Supplier to be created.

Returns

Type	Description
System.Int32	The new supplier's id.

Remarks

On successful creation, supplier_'s SupplierId property will be assigned the id of the newly created supplier.

CreateUnreceivedSerialNumbers(UnreceivedSerialNumber)

Creates one or more UnreceivedSerialNumbers.

Declaration

public List<UnreceivedSerialNumber> CreateUnreceivedSerialNumbers(UnreceivedSerialNumber unreceivedSerialNumber_)

Parameters

Type	Name	Description
UnreceivedSerialNumber	unreceivedSerialNumber_	Describes the UnreceivedSerialNumber to be created.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	The newly created UnreceivedSerialNumbers. The original UnreceivedSerialNumber will be updated with the id and SerialNumber of the newly created object. If the given UnreceivedSerialNumber resulted in the creation of multiple UnreceivedSerialNumber, it will have its id and SerialNumber set to that of the last one created.

CreateUnreceivedSerialNumbers(IEnumerable<UnreceivedSerialNumber>)

Creates a set of UnreceivedSerialNumbers. i.e. a set of SerialNumbers will be assigned to PurchaseOrderLines without those lines being received.

Declaration

public List<UnreceivedSerialNumber> CreateUnreceivedSerialNumbers(IEnumerable<UnreceivedSerialNumber> unreceivedSerialNumbers_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UnreceivedSerialNumber>	unreceivedSerialNumbers_	Describes the UnreceivedSerialNumbers to be created. If no SerialNumber is specified, this may result in more unreceived serial numbers being created than have been specified if the indicated purchase order line(s) have a quantity greater than 1.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	The newly created UnreceivedSerialNumbers. Each of the original UnreceivedSerialNumbers will be updated with the id and SerialNumber of the newly created object. Single UnreceivedSerialNumbers that resulted in the creation of multiple UnreceivedSerialNumbers will have there id and SerialNumber set to that of the last one created.

CreateUnreceivedSerialNumbers(Int32)

Creates one or more UnreceivedSerialNumbers for the given line.

Declaration

public List<UnreceivedSerialNumber> CreateUnreceivedSerialNumbers(int purchaseOrderProductLineId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderProductLineId_	The PurchaseOrderProductLinefor which the UnreceivedSerialNumbers should be created.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	The newly created UnreceivedSerialNumbers.

DeleteAccount(Int32)

Deletes the given account.

Declaration

public void DeleteAccount(int accountId_)

Parameters

Type	Name	Description
System.Int32	accountId_	Account to be deleted.

DeleteAccountContact(Int32)

Deletes a specific account contact.

Declaration

public void DeleteAccountContact(int contactId_)

Parameters

Type	Name	Description
System.Int32	contactId_	Contact to be deleted.

DeleteAccountContacts(IEnumerable<Int32>)

Deletes the given account contacts.

Declaration

public void DeleteAccountContacts(IEnumerable<int> contactIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	contactIds_	Account contacts to be deleted.

DeleteAccountFile(Int32)

Deletes the given Account file.

Declaration

public void DeleteAccountFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	File to be deleted.

DeleteAccountPriceList(AccountPriceList)

Deletes the given accountPriceList_.

Declaration

public void DeleteAccountPriceList(AccountPriceList accountPriceList_)

Parameters

Type	Name	Description
AccountPriceList	accountPriceList_	Account price list to be deleted.

DeleteAccountPriceList(Int32, Int32)

Deletes the given account price list.

Declaration

public void DeleteAccountPriceList(int accountId_, int priceListId_)

Parameters

Type	Name	Description
System.Int32	accountId_	Account.
System.Int32	priceListId_	Price list.

DeleteAccountPriceLists(IEnumerable<AccountPriceList>)

Removes a set of price lists from their corresponding accounts.

Declaration

public void DeleteAccountPriceLists(IEnumerable<AccountPriceList> accountPriceLists_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<AccountPriceList>	accountPriceLists_	Price lists to be deleted.

DeleteAssignee(Int32)

Deletes the given assignee.

Declaration

public void DeleteAssignee(int assigneeId_)

Parameters

Type	Name	Description
System.Int32	assigneeId_	Assignee to be deleted.

DeleteInventoryCount(Int32)

Deletes a specific inventory count.

Declaration

public void DeleteInventoryCount(int inventoryCountId_)

Parameters

Type	Name	Description
System.Int32	inventoryCountId_	The inventory count to be deleted.

DeleteInventoryCountDetail(Guid)

Deletes the given inventory count detail.

Declaration

public void DeleteInventoryCountDetail(Guid inventoryCountDetailId_)

Parameters

Type	Name	Description
System.Guid	inventoryCountDetailId_	The inventory count detail to be deleted.

DeleteInventoryCountDetails(IEnumerable<Guid>)

Deletes the given inventory count details.

Declaration

public void DeleteInventoryCountDetails(IEnumerable<Guid> inventoryCountDetailIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Guid>	inventoryCountDetailIds_	The inventory count details to be deleted.

DeleteInventoryCounts(IEnumerable<Int32>)

Deletes the given set of inventory counts.

Declaration

public void DeleteInventoryCounts(IEnumerable<int> inventoryCountIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	inventoryCountIds_	The inventory counts to be deleted.

DeleteInventoryLocation(Int32)

Deletes the given InventoryLocation.

Declaration

public void DeleteInventoryLocation(int inventoryLocationId_)

Parameters

Type	Name	Description
System.Int32	inventoryLocationId_	Inventory location to be deleted.

DeleteJob(Int32)

Deletes the given job.

Declaration

public void DeleteJob(int jobId_)

Parameters

Type	Name	Description
System.Int32	jobId_	Job to be deleted.

DeleteJobActivity(Int32)

Deletes the given job activity.

Declaration

public void DeleteJobActivity(int jobActivityId_)

Parameters

Type	Name	Description
System.Int32	jobActivityId_	Job activity to be deleted.

DeleteJobActivityMaterial(JobActivityMaterial)

Removes any allocations for the given job activity/purchase product variant.

Declaration

public void DeleteJobActivityMaterial(JobActivityMaterial jobActivityMaterial_)

Parameters

Type	Name	Description
JobActivityMaterial	jobActivityMaterial_	The job activity material to be deleted.

DeleteJobActivityMaterial(IEnumerable<JobActivityMaterial>)

Removes any allocations for the given job activity/purchase product variants.

Declaration

public void DeleteJobActivityMaterial(IEnumerable<JobActivityMaterial> jobActivityMaterial_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<JobActivityMaterial>	jobActivityMaterial_	The job activity material to be deleted.

DeleteJobActivitySeries(Int32)

Deletes all of the activities the given job activity series.

Declaration

public void DeleteJobActivitySeries(int jobActivitySeriesId_)

Parameters

Type	Name	Description
System.Int32	jobActivitySeriesId_	Identifies the job activity series to be deleted.

DeleteJobFile(Int32)

Deletes the given Job file.

Declaration

public void DeleteJobFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	File to be deleted.

DeleteJobForm(Int32)

Deletes the given job form.

Declaration

public void DeleteJobForm(int jobFormId_)

Parameters

Type	Name	Description
System.Int32	jobFormId_	Job form to be deleted.

DeleteJobPhase(Int32)

Deletes the given job phase.

Declaration

public void DeleteJobPhase(int jobPhaseId_)

Parameters

Type	Name	Description
System.Int32	jobPhaseId_	Job phase to be deleted.

Remarks

If the phase is in use, an exception will be thrown.

DeletePurchaseOrder(Int32)

Deletes the given PurchaseOrder.

Declaration

public void DeletePurchaseOrder(int purchaseOrderId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	PurchaseOrder to be deleted.

DeletePurchaseOrderFile(Int32)

Deletes the given Purchase Order file.

Declaration

public void DeletePurchaseOrderFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	File to be deleted.

DeletePurchaseOrderLine(Int32)

Deletes the given PurchaseOrderLine.

Declaration

public void DeletePurchaseOrderLine(int purchaseOrderLineId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderLineId_	Purchase order line to be deleted.

DeletePurchaseOrderLines(IEnumerable<Int32>)

Deletes the given PurchaseOrderLines.

Declaration

public void DeletePurchaseOrderLines(IEnumerable<int> purchaseOrderLineIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderLineIds_	PurchaseOrderLines to be deleted.

DeletePurchaseOrderReceipt(Int32, Boolean)

Deletes the given PurchaseOrderReceipt, indicating whether the receipt should be deleteted altogether (the default) or converted into an UnreceivedSerialNumber if it happens to be associated with a serial number.

Declaration

public void DeletePurchaseOrderReceipt(int purchaseOrderReceiptId_, bool retainUnreceivedSerialNumbers_ = false)

Parameters

Type	Name	Description
System.Int32	purchaseOrderReceiptId_	The PurchaseOrderReceipt to be deleted.
System.Boolean	retainUnreceivedSerialNumbers_	If true, indicates that if the receipt is associated with a serialized product, it should simply be converted to an UnreceivedSerialNumber.

DeletePurchaseOrderReceipts(IEnumerable<Int32>, Boolean)

Deletes the given set of PurchaseOrderReceipts, indicating whether the receipts should be deleteted altogether (the default) or converted into a set of UnreceivedSerialNumbers if they happens to be associated with serial numbers.

Declaration

public void DeletePurchaseOrderReceipts(IEnumerable<int> purchaseOrderReceiptIds_, bool retainUnreceivedSerialNumbers_ = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderReceiptIds_	Ids of the PurchaseOrderReceipts to be deleted.
System.Boolean	retainUnreceivedSerialNumbers_	If true, indicates that any receipts associated with serialized products should simply be converted to UnreceivedSerialNumbers.

DeletePurchaseProductVariantInventoryAdjustment(Int32)

Deletes the given purchase product variant inventory adjustment.

Declaration

public void DeletePurchaseProductVariantInventoryAdjustment(int purchaseProductVariantInventoryAdjustmentId_)

Parameters

Type	Name	Description
System.Int32	purchaseProductVariantInventoryAdjustmentId_	The purchase product variant inventory adjustment to be deleted.

DeletePurchaseProductVariantInventoryAdjustments(IEnumerable<Int32>)

Deletes the given set of purchase product variant inventory adjustments.

Declaration

public void DeletePurchaseProductVariantInventoryAdjustments(IEnumerable<int> purchaseProductVariantInventoryAdjustmentIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseProductVariantInventoryAdjustmentIds_	The purchase product variant inventory adjustments to be deleted.

DeleteQuote(Int32)

Deletes the given quote.

Declaration

public void DeleteQuote(int quoteId_)

Parameters

Type	Name	Description
System.Int32	quoteId_	Quote to be deleted.

DeleteSalesperson(Int32)

Deletes the given Salesperson.

Declaration

public void DeleteSalesperson(int salespersonId_)

Parameters

Type	Name	Description
System.Int32	salespersonId_	Salesperson to be deleted.

DeleteSerialNumberAllocation(SerialNumberAllocation)

Deletes the allocation for the given serial number for the given job activity.

Declaration

public void DeleteSerialNumberAllocation(SerialNumberAllocation serialNumberAllocation_)

Parameters

Type	Name	Description
SerialNumberAllocation	serialNumberAllocation_	The serial number allocation to be removed.

DeleteSerialNumberAllocations(IEnumerable<SerialNumberAllocation>)

Deletes the allocations for the given serial numbers for the given job activities.

Declaration

public void DeleteSerialNumberAllocations(IEnumerable<SerialNumberAllocation> serialNumberAllocations_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<SerialNumberAllocation>	serialNumberAllocations_	The serial number allocations to be removed.

DeleteSerialNumberFile(Int32)

Deletes the given Serial Number file.

Declaration

public void DeleteSerialNumberFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	File to be deleted.

DeleteSerialNumberImport(Int32)

Deletes the given serial number import.

Declaration

public void DeleteSerialNumberImport(int serialNumberImportId_)

Parameters

Type	Name	Description
System.Int32	serialNumberImportId_	Serial number import to be deleted.

DeleteSerialNumberImports(IEnumerable<Int32>)

Deletes the given set of serial number imports.

Declaration

public void DeleteSerialNumberImports(IEnumerable<int> serialNumberImportIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberImportIds_	Serial number import s to be deleted.

DeleteSerialNumberInventoryAdjustment(Int32)

Deletes the given serial number inventory adjustment.

Declaration

public void DeleteSerialNumberInventoryAdjustment(int serialNumberInventoryAdjustmentId_)

Parameters

Type	Name	Description
System.Int32	serialNumberInventoryAdjustmentId_	The serial number inventory adjustment to be deleted.

DeleteSerialNumberInventoryAdjustments(IEnumerable<Int32>)

Deletes the given set of serial number inventory adjustments.

Declaration

public void DeleteSerialNumberInventoryAdjustments(IEnumerable<int> serialNumberInventoryAdjustmentIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberInventoryAdjustmentIds_	The serial number inventory adjustments to be deleted.

DeleteSerialNumberRemnant(Int32)

Deletes the given serial number remnant.

Declaration

public void DeleteSerialNumberRemnant(int serialNumberRemnantId_)

Parameters

Type	Name	Description
System.Int32	serialNumberRemnantId_	Serial number remnant to be deleted.

DeleteSerialNumberRemnants(IEnumerable<Int32>)

Deletes the given set of serial number remnants.

Declaration

public void DeleteSerialNumberRemnants(IEnumerable<int> serialNumberRemnantIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberRemnantIds_	Serial number remnants to be deleted.

DeleteSupplier(Int32)

Deletes the given suppplier.

Declaration

public void DeleteSupplier(int supplierId_)

Parameters

Type	Name	Description
System.Int32	supplierId_	Supplier to be deleted.

DeleteSupplierFile(Int32)

Deletes the given Supplier file.

Declaration

public void DeleteSupplierFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	File to be deleted.

DeleteUnreceivedSerialNumber(Int32)

Deletes the given UnreceivedSerialNumber.

Declaration

public void DeleteUnreceivedSerialNumber(int unreceivedSerialNumberId_)

Parameters

Type	Name	Description
System.Int32	unreceivedSerialNumberId_	The UnreceivedSerialNumber to be deleted.

DeleteUnreceivedSerialNumbers(IEnumerable<Int32>)

Deletes the given set of UnreceivedSerialNumbers.

Declaration

public void DeleteUnreceivedSerialNumbers(IEnumerable<int> unreceivedSerialNumberIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	unreceivedSerialNumberIds_	Ids of the UnreceivedSerialNumbers to be deleted.

Disconnect()

Disconnects from the JobTracker instance. (Ignores any errors while logging out.)

Declaration

public void Disconnect()

DownloadAccountFile(Int32, FileInfo, Boolean, Boolean, IFileTransferMonitor)

Downloads a file.

Declaration

public bool DownloadAccountFile(int fileId_, FileInfo targetPath_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false, IFileTransferMonitor feedback_ = null)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to be downloaded.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Boolean	overwriteExistingFile_	If True, downloading a file that already exists will overwrite the existing file.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.

Returns

Type	Description
System.Boolean	True if the file is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadJobFile(Int32, FileInfo, Boolean, Boolean, IFileTransferMonitor)

Downloads a file.

Declaration

public bool DownloadJobFile(int fileId_, FileInfo targetPath_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false, IFileTransferMonitor feedback_ = null)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to be downloaded.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Boolean	overwriteExistingFile_	If True, downloading a file that already exists will overwrite the existing file.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.

Returns

Type	Description
System.Boolean	True if the file is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadLabelForSerialNumber(Int32, FileInfo, Int32, Boolean, Boolean)

Downloads a (pdf) label for a given serial number.

Declaration

public bool DownloadLabelForSerialNumber(int labelTemplateId_, FileInfo targetPath_, int serialNumberId_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
System.Int32	labelTemplateId_	The LabelTemplate to use.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Int32	serialNumberId_	The SerialNumber to use.
System.Boolean	overwriteExistingFile_	Indicates if an existing file should be overwritten.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

Returns

Type	Description
System.Boolean	True if the label is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadLabelsForPurchaseOrder(Int32, FileInfo, Int32, Boolean, Boolean)

Downloads a (pdf) label for a given purchase order.

Declaration

public bool DownloadLabelsForPurchaseOrder(int labelTemplateId_, FileInfo targetPath_, int purchaseOrderId_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
System.Int32	labelTemplateId_	The LabelTemplate to use.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Int32	purchaseOrderId_	The PurchaseOrder to use.
System.Boolean	overwriteExistingFile_	Indicates if an existing file should be overwritten.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

Returns

Type	Description
System.Boolean	True if the label is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadLabelsForPurchaseOrderReceipt(Int32, FileInfo, Int32, Boolean, Boolean)

Downloads a (pdf) label for a given purchase order receipt.

Declaration

public bool DownloadLabelsForPurchaseOrderReceipt(int labelTemplateId_, FileInfo targetPath_, int purchaseOrderReceiptId_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
System.Int32	labelTemplateId_	The LabelTemplate to use.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Int32	purchaseOrderReceiptId_	The PurchaseOrderReceipt to use.
System.Boolean	overwriteExistingFile_	Indicates if an existing file should be overwritten.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

Returns

Type	Description
System.Boolean	True if the label is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadLabelsForSerialNumbers(Int32, FileInfo, IEnumerable<Int32>, Boolean, Boolean)

Downloads a (pdf) label for a given set of serial numbers.

Declaration

public bool DownloadLabelsForSerialNumbers(int labelTemplateId_, FileInfo targetPath_, IEnumerable<int> serialNumberIds_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
System.Int32	labelTemplateId_	The LabelTemplate to use.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberIds_	The SerialNumbers to use.
System.Boolean	overwriteExistingFile_	Indicates if an existing file should be overwritten.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

Returns

Type	Description
System.Boolean	True if the label is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadPurchaseOrderFile(Int32, FileInfo, Boolean, Boolean, IFileTransferMonitor)

Downloads a file.

Declaration

public bool DownloadPurchaseOrderFile(int fileId_, FileInfo targetPath_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false, IFileTransferMonitor feedback_ = null)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to be downloaded.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Boolean	overwriteExistingFile_	If True, downloading a file that already exists will overwrite the existing file.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.

Returns

Type	Description
System.Boolean	True if the file is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadSerialNumberFile(Int32, FileInfo, Boolean, Boolean, IFileTransferMonitor)

Downloads a file.

Declaration

public bool DownloadSerialNumberFile(int fileId_, FileInfo targetPath_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false, IFileTransferMonitor feedback_ = null)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to be downloaded.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Boolean	overwriteExistingFile_	If True, downloading a file that already exists will overwrite the existing file.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.

Returns

Type	Description
System.Boolean	True if the file is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

DownloadSupplierFile(Int32, FileInfo, Boolean, Boolean, IFileTransferMonitor)

Downloads a file.

Declaration

public bool DownloadSupplierFile(int fileId_, FileInfo targetPath_, bool overwriteExistingFile_ = false, bool suppressExceptions_ = false, IFileTransferMonitor feedback_ = null)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to be downloaded.
System.IO.FileInfo	targetPath_	Filespec to use to download the file.
System.Boolean	overwriteExistingFile_	If True, downloading a file that already exists will overwrite the existing file.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.

Returns

Type	Description
System.Boolean	True if the file is successfully downloaded.

Remarks

The file will first be downloaded to the TEMP directory. When the download completes, it will be moved to the target location.

ExecuteCommand(XmlDocument, Boolean)

Executes the command.

Declaration

public XmlDocument ExecuteCommand(XmlDocument commandDocument_, bool testForErrorResponse_)

Parameters

Type	Name	Description
System.Xml.XmlDocument	commandDocument_	Command to be executed.
System.Boolean	testForErrorResponse_	If True, the response from the server will be tested for errors and if any are found, an APIException will be raised automatically.

Returns

Type	Description
System.Xml.XmlDocument	The response document.

GetAccount(Int32)

Retrieves the account with the given Id. If there is no such account, 'Nothing' will be returned.

Declaration

public Account GetAccount(int accountId_)

Parameters

Type	Name	Description
System.Int32	accountId_	Account to retrieve.

Returns

Type	Description
Account	The requested Account (or Nothing if the account does not exist).

GetAccountContact(Int32)

Retrieves the given account contact (if it exists).

Declaration

public AccountContact GetAccountContact(int accountContactId_)

Parameters

Type	Name	Description
System.Int32	accountContactId_	Account contact to lookup.

Returns

Type	Description
AccountContact	The given account contact, or Nothing if there is none with the given id.

GetAccountContacts(Int32)

Retrieves the contacts associated with the given account.

Declaration

public List<AccountContact> GetAccountContacts(int accountId_)

Parameters

Type	Name	Description
System.Int32	accountId_	Account for which contacts are being requested.

Returns

Type	Description
System.Collections.Generic.List<AccountContact>	A list of the account's contacts.

GetAccountFile(Int32)

Retrieves the given Account file.

Declaration

public AccountFile GetAccountFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to retrieve.

Returns

Type	Description
AccountFile	The requested file.

GetAccountFiles(Int32)

Retrieves the files attached to the given Account.

Declaration

public List<AccountFile> GetAccountFiles(int accountId_)

Parameters

Type	Name	Description
System.Int32	accountId_	The account for which files should be retrieved.

Returns

Type	Description
System.Collections.Generic.List<AccountFile>	The account's files.

GetAccountPriceList(Int32, Int32)

Retrieves the given account price list.

Declaration

public AccountPriceList GetAccountPriceList(int accountId_, int priceListId_)

Parameters

Type	Name	Description
System.Int32	accountId_	Account to which the account price list belongs.
System.Int32	priceListId_	Price list on which the account price list is based.

Returns

Type	Description
AccountPriceList	The requested account price list.

GetAccountPriceLists(Int32)

Retrieves the price lists associated with the given account.

Declaration

public List<AccountPriceList> GetAccountPriceLists(int accountId_)

Parameters

Type	Name	Description
System.Int32	accountId_	Account for which price lists should be returned.

Returns

Type	Description
System.Collections.Generic.List<AccountPriceList>	The account's price lists.

GetAccounts(AccountFilter, PagingOptions)

Uses the given filter to retrieve a set of accounts.

Declaration

public List<Account> GetAccounts(AccountFilter accountFilter_, PagingOptions pagingOptions_)

Parameters

Type	Name	Description
AccountFilter	accountFilter_	Options that determine which accounts to retrieve.
PagingOptions	pagingOptions_	Defines how the returned list should be paged.

Returns

Type	Description
System.Collections.Generic.List<Account>	A set of accounts.

GetAccounts(IEnumerable<Int32>)

Retrieves details for the specified accounts.

Declaration

public List<Account> GetAccounts(IEnumerable<int> accountIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	accountIds_	Identifies the accounts to lookup.

Returns

Type	Description
System.Collections.Generic.List<Account>	A list of Accounts.

GetAccounts(String)

Retrieves all of the accounts that match (exactly) the given name.

Declaration

public List<Account> GetAccounts(string accountName_)

Parameters

Type	Name	Description
System.String	accountName_	Name of the accounts to lookup.

Returns

Type	Description
System.Collections.Generic.List<Account>	List of accounts that matchthe given name.

GetAssignee(Int32)

Retrieves a specific Assignee.

Declaration

public Assignee GetAssignee(int assigneeId_)

Parameters

Type	Name	Description
System.Int32	assigneeId_	Assignee to retrieve.

Returns

Type	Description
Assignee	The given assignee (if it exists).

GetAssignees()

Retrieves the set of Assignees.

Declaration

public List<Assignee> GetAssignees()

Returns

Type	Description
System.Collections.Generic.List<Assignee>	All assignees.

GetCostList(Int32)

Retrieves the given CostList.

Declaration

public CostList GetCostList(int costListId_)

Parameters

Type	Name	Description
System.Int32	costListId_	cost list to retrieve. Must not be '0' since the 'Standard' cost lists all have a CostListId=0, so this wouldn't necessarily result in a single cost list being returned.

Returns

Type	Description
CostList	The given cost list (if it exists).

GetCostLists()

Retrieves the set of CostLists.

Declaration

public List<CostList> GetCostLists()

Returns

Type	Description
System.Collections.Generic.List<CostList>	All cost lists.

GetCustomAccountFieldTypes(Boolean)

Retrieves a list of custom field types.

Declaration

public List<AccountCustomFieldType> GetCustomAccountFieldTypes(bool includeInactive_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.

Returns

Type	Description
System.Collections.Generic.List<AccountCustomFieldType>	The custom field types.

GetCustomFileFieldTypes(Boolean)

Retrieves a list of custom field types, with the option of including inactive fields.

Declaration

public List<FileCustomFieldType> GetCustomFileFieldTypes(bool includeInactive_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.

Returns

Type	Description
System.Collections.Generic.List<FileCustomFieldType>	The custom field types.

GetCustomJobActivityFieldTypes(Boolean)

Retrieves a list of custom field types, with the option of including inactive fields.

Declaration

public List<JobActivityCustomFieldType> GetCustomJobActivityFieldTypes(bool includeInactive_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.

Returns

Type	Description
System.Collections.Generic.List<JobActivityCustomFieldType>	The custom field types.

GetCustomJobFieldTypes(Boolean)

Retrieves a list of custom field types, regardless of the processes to which they belong, with the option of including inactive fields.

Declaration

public List<JobCustomFieldType> GetCustomJobFieldTypes(bool includeInactive_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.

Returns

Type	Description
System.Collections.Generic.List<JobCustomFieldType>	The custom field types.

GetCustomJobFieldTypes(Boolean, Int32)

Retrieves a list of custom field types belonging to a particular process, with the option of including inactive fields.

Declaration

public List<JobCustomFieldType> GetCustomJobFieldTypes(bool includeInactive_, int processId_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.
System.Int32	processId_	Process to which the custom job field types are expected to belong. (e.g. is this a job field type query, a lead field type query, a campaign field type query etc.)

Returns

Type	Description
System.Collections.Generic.List<JobCustomFieldType>	The custom field types.

GetCustomLOVFieldValues(Int32)

Retrieves the values associated with a custom list of values field.

Declaration

public List<CustomLOVFieldValue> GetCustomLOVFieldValues(int customFieldId_)

Parameters

Type	Name	Description
System.Int32	customFieldId_	A custom List of values field.

Returns

Type	Description
System.Collections.Generic.List<CustomLOVFieldValue>	The values associated with customFieldId_.

GetCustomPurchaseOrderFieldTypes(Boolean)

Retrieves a list of custom field types, with the option of including inactive fields.

Declaration

public List<PurchaseOrderCustomFieldType> GetCustomPurchaseOrderFieldTypes(bool includeInactive_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderCustomFieldType>	The custom field types.

GetCustomSerialNumberFieldTypes(Boolean)

Retrieves a list of custom field types, with the option of including inactive fields.

Declaration

public List<SerialNumberCustomFieldType> GetCustomSerialNumberFieldTypes(bool includeInactive_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberCustomFieldType>	The custom field types.

GetCustomSupplierFieldTypes(Boolean)

Retrieves a list of custom field types, with the option of including inactive fields.

Declaration

public List<SupplierCustomFieldType> GetCustomSupplierFieldTypes(bool includeInactive_)

Parameters

Type	Name	Description
System.Boolean	includeInactive_	True if inactive fields should be included in the list of custom fields.

Returns

Type	Description
System.Collections.Generic.List<SupplierCustomFieldType>	The custom field types.

GetDisplayOptions()

Returns the display options configured on the JobTracker instance.

Declaration

public DisplayOptions GetDisplayOptions()

Returns

Type	Description
DisplayOptions	Display options in effect for the JobTracker instance.

GetFormTemplate(Int32, Boolean)

Retrieves the given form template, with the option of including the form fields. If there is no such template, Nothing will be returned.

Declaration

public FormTemplate GetFormTemplate(int formTemplateId_, bool includeFields_)

Parameters

Type	Name	Description
System.Int32	formTemplateId_	Form template to retrieve.
System.Boolean	includeFields_	If True, the form fields will be retrieved.

Returns

Type	Description
FormTemplate	A form template. (When no process is specified, it defaults to returning the job form template that belong to the built-in "Job" process.)

GetFormTemplateLOVFieldValues(Int32)

Retrieves the values associated with a form template list of values field.

Declaration

public List<FormTemplateLOVFieldValue> GetFormTemplateLOVFieldValues(int formTemplateFieldId_)

Parameters

Type	Name	Description
System.Int32	formTemplateFieldId_	A form template List of values field.

Returns

Type	Description
System.Collections.Generic.List<FormTemplateLOVFieldValue>	The values associated with formTemplateFieldId_.

GetFormTemplates(Boolean)

Retrieves all form templates, regardless of the process they belong to, with the option of including the form fields. If there are no templates, an empty list will be returned.

Declaration

public List<FormTemplate> GetFormTemplates(bool includeFields_)

Parameters

Type	Name	Description
System.Boolean	includeFields_	If True, the form fields will be retrieved.

Returns

Type	Description
System.Collections.Generic.List<FormTemplate>	A form template.

GetFormTemplates(Boolean, Int32)

Retrieves all Form Templates belonging to the given process, with the option of including the form fields.

Declaration

public List<FormTemplate> GetFormTemplates(bool includeFields_, int processId_)

Parameters

Type	Name	Description
System.Boolean	includeFields_	If True, the form fields will be retrieved.
System.Int32	processId_	Process to which the form templates belong.

Returns

Type	Description
System.Collections.Generic.List<FormTemplate>	A list of form templates. (When no process is specified, it defaults to returning job form templates that belong to the built-in "Job" process.)

GetFormTemplates(IEnumerable<Int32>, Boolean)

Retrieves the given form templates (regardless of the processes to which they belong), with the option of including the form fields. If there are no such templates, an empty list will be returned.

Declaration

public List<FormTemplate> GetFormTemplates(IEnumerable<int> formTemplateIds_, bool includeFields_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	formTemplateIds_	Form templates to retrieve.
System.Boolean	includeFields_	If True, the form fields will be retrieved.

Returns

Type	Description
System.Collections.Generic.List<FormTemplate>	A form template.

GetInventoryCount(Int32)

Retrieves the given inventory count, if it exists.

Declaration

public InventoryCount GetInventoryCount(int inventoryCountId_)

Parameters

Type	Name	Description
System.Int32	inventoryCountId_	The inventory count to retrieve.

Returns

Type	Description
InventoryCount	The requested inventory count, if it exists.

GetInventoryCountDetail(Guid)

Retrieves the given inventory count detail.

Declaration

public InventoryCountDetail GetInventoryCountDetail(Guid inventoryCountDetailId_)

Parameters

Type	Name	Description
System.Guid	inventoryCountDetailId_	Identifies the inventory count detail to retrieve.

Returns

Type	Description
InventoryCountDetail	The requested inventory count detail.

GetInventoryCountDetails(IEnumerable<Guid>)

Retrieves the given inventory count details.

Declaration

public List<InventoryCountDetail> GetInventoryCountDetails(IEnumerable<Guid> inventoryCountDetailIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Guid>	inventoryCountDetailIds_	Identifies the inventory count details to retrieve.

Returns

Type	Description
System.Collections.Generic.List<InventoryCountDetail>	The requested inventory count details.

GetInventoryCountDetails(Int32)

Retrieves the details associated with a particular inventory count.

Declaration

public List<InventoryCountDetail> GetInventoryCountDetails(int inventoryCountId_)

Parameters

Type	Name	Description
System.Int32	inventoryCountId_	The inventory count about which to retrieve detailed information.

Returns

Type	Description
System.Collections.Generic.List<InventoryCountDetail>	Inventory count details for the given inventory count.

GetInventoryCounts()

Retrieves all available inventory counts.

Declaration

public List<InventoryCount> GetInventoryCounts()

Returns

Type	Description
System.Collections.Generic.List<InventoryCount>	A list of all inventory counts.

GetInventoryCounts(IEnumerable<Int32>)

Retrieves the given inventory counts, if they exist.

Declaration

public List<InventoryCount> GetInventoryCounts(IEnumerable<int> inventoryCountIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	inventoryCountIds_	Inventory counts to retrieve.

Returns

Type	Description
System.Collections.Generic.List<InventoryCount>	The requested inventory counts, if they exist.

GetInventoryLocation(Int32)

Retrieves a specific InventoryLocation.

Declaration

public InventoryLocation GetInventoryLocation(int inventoryLocationId_)

Parameters

Type	Name	Description
System.Int32	inventoryLocationId_	Inventory location to lookup.

Returns

Type	Description
InventoryLocation	If there is a inventory location with the given id, it will be returned, otherwise Nothing will be returned.

GetInventoryLocations()

Retrieves the set of InventoryLocations.

Declaration

public List<InventoryLocation> GetInventoryLocations()

Returns

Type	Description
System.Collections.Generic.List<InventoryLocation>	The list of inventory locations.

GetJob(Int32, Boolean, Boolean)

Retrieves the given job.

Declaration

public Job GetJob(int jobId_, bool includeContacts_ = false, bool includeJobPhases_ = false)

Parameters

Type	Name	Description
System.Int32	jobId_	Job to retrieve.
System.Boolean	includeContacts_	If True, the Contacts property will be populated.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.

Returns

Type	Description
Job	The job.

GetJobActivities(Int32, Boolean, Boolean)

Retrieves all Job Activities defined for a particular Job.

Declaration

public List<JobActivity> GetJobActivities(int jobId_, bool includeJobPhases_, bool includeJobActivitySeriesMember_)

Parameters

Type	Name	Description
System.Int32	jobId_	The parent job.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.
System.Boolean	includeJobActivitySeriesMember_	If True, the JobActivitySeriesMember property will be populated.

Returns

Type	Description
System.Collections.Generic.List<JobActivity>	The job's activities.

GetJobActivitiesForSeries(Int32, Boolean, Boolean)

Retrieves all job activities included in a particular job activity series.

Declaration

public List<JobActivity> GetJobActivitiesForSeries(int jobActivitySeriesId_, bool includeJobPhases_, bool includeJobActivitySeriesMember_)

Parameters

Type	Name	Description
System.Int32	jobActivitySeriesId_	The job activity series to look up.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.
System.Boolean	includeJobActivitySeriesMember_	If True, the JobActivitySeriesMember property will be populated.

Returns

Type	Description
System.Collections.Generic.List<JobActivity>	The job activities in the given job activity series.

GetJobActivity(Int32, Boolean, Boolean)

Retrieves a specific job activity.

Declaration

public JobActivity GetJobActivity(int jobActivityId_, bool includeJobPhases_, bool includeJobActivitySeriesMember_)

Parameters

Type	Name	Description
System.Int32	jobActivityId_	The job activity to look up.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.
System.Boolean	includeJobActivitySeriesMember_	If True, the JobActivitySeriesMember property will be populated.

Returns

Type	Description
JobActivity	The job activity.

GetJobActivityMaterialForJob(Int32)

Retireves the job activity material associated with a given set of job.

Declaration

public List<JobActivityMaterial> GetJobActivityMaterialForJob(int jobId_)

Parameters

Type	Name	Description
System.Int32	jobId_	Identifies the job.

Returns

Type	Description
System.Collections.Generic.List<JobActivityMaterial>	The list of job activity material (if there is any).

GetJobActivityMaterialForJobActivities(IEnumerable<Int32>)

Retrieves the job activity material associated with a given set of job activities.

Declaration

public List<JobActivityMaterial> GetJobActivityMaterialForJobActivities(IEnumerable<int> jobActivityIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	jobActivityIds_	Identifies the job activities.

Returns

Type	Description
System.Collections.Generic.List<JobActivityMaterial>	The list of job activity material (if there is any).

GetJobActivityMaterialForJobActivity(Int32)

Retrieves the job activity material associated with a given job activity.

Declaration

public List<JobActivityMaterial> GetJobActivityMaterialForJobActivity(int jobActivityId_)

Parameters

Type	Name	Description
System.Int32	jobActivityId_	Identifies the job activity.

Returns

Type	Description
System.Collections.Generic.List<JobActivityMaterial>	The list of job activity material (if there is any).

GetJobActivityMaterialForJobs(IEnumerable<Int32>)

Retireves the job activity material associated with a given set of jobs.

Declaration

public List<JobActivityMaterial> GetJobActivityMaterialForJobs(IEnumerable<int> jobIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	jobIds_	Identifies the jobs.

Returns

Type	Description
System.Collections.Generic.List<JobActivityMaterial>	The list of job activity material (if there is any).

GetJobActivitySeries(Int32)

Retrieves the given job activity series.

Declaration

public JobActivitySeries GetJobActivitySeries(int jobActivitySeriesId_)

Parameters

Type	Name	Description
System.Int32	jobActivitySeriesId_	The job activity series to retrieve.

Returns

Type	Description
JobActivitySeries	The given job activity series.

GetJobActivityStatuses()

Retrieves the set of defined Job Activity Statuses.

Declaration

public List<JobActivityStatus> GetJobActivityStatuses()

Returns

Type	Description
System.Collections.Generic.List<JobActivityStatus>	The job activity statuses.

GetJobActivityStatusIdMap()

Retrieves a map of Job Activity Statuses keyed on the Status Id.

Declaration

public Dictionary<int, JobActivityStatus> GetJobActivityStatusIdMap()

Returns

Type	Description
System.Collections.Generic.Dictionary<System.Int32, JobActivityStatus>	The job activity status map.

GetJobActivityStatusNameMap()

Retrieves a map of Job Activity Statuses keyed on the Status Name

Declaration

public Dictionary<string, JobActivityStatus> GetJobActivityStatusNameMap()

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, JobActivityStatus>	The job activity status map.

GetJobActivityTypes()

Retrieves all of job activity types, regardless of the processes to which they belong.

Declaration

public List<JobActivityType> GetJobActivityTypes()

Returns

Type	Description
System.Collections.Generic.List<JobActivityType>	The job activity types.

GetJobActivityTypes(Int32)

Retrieves all of the defined job activity types belonging to the given processes.

Declaration

public List<JobActivityType> GetJobActivityTypes(int processId_)

Parameters

Type	Name	Description
System.Int32	processId_	Process to which the returned job activities belong. (e.g. is this a job activity query, a lead activity query, a campaign activity query etc.)

Returns

Type	Description
System.Collections.Generic.List<JobActivityType>	The job activity types.

GetJobFile(Int32, Boolean)

Retrieves the given Job file, optionally including the phases associated with the file.

Declaration

public JobFile GetJobFile(int fileId_, bool includeJobPhases_)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to retrieve.
System.Boolean	includeJobPhases_	If True, the JobPhases will be populated.

Returns

Type	Description
JobFile	The requested file.

GetJobFiles(Int32, Boolean)

Retrieves the files attached to the given Job, optionally including the phases associated with the files.

Declaration

public List<JobFile> GetJobFiles(int jobId_, bool includeJobPhases_)

Parameters

Type	Name	Description
System.Int32	jobId_	The job for which files should be retrieved.
System.Boolean	includeJobPhases_	If True, the JobPhases will be included in the returned files.

Returns

Type	Description
System.Collections.Generic.List<JobFile>	The job's files.

GetJobForm(Int32, Boolean, Connection.GetJobForm_FieldInclusionType_Enum)

Retrieves a single job form, optionally including the phases associated with the form and also indicating if the form fields should be included.

Declaration

public JobForm GetJobForm(int jobFormId_, bool includeJobPhases_, Connection.GetJobForm_FieldInclusionType_Enum fieldIndicator_ = Connection.GetJobForm_FieldInclusionType_Enum.NoFields)

Parameters

Type	Name	Description
System.Int32	jobFormId_	The job form to look up.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.
Connection.GetJobForm_FieldInclusionType_Enum	fieldIndicator_	Indicates which field types should be included or excluded.

Returns

Type	Description
JobForm	The job form.

GetJobForms(Int32, Boolean, Connection.GetJobForm_FieldInclusionType_Enum)

Retrieves all job forms associated with the given Job, optionally including the phases associated with the forms and also indicating if the form fields should be included.

Declaration

public List<JobForm> GetJobForms(int jobId_, bool includeJobPhases_, Connection.GetJobForm_FieldInclusionType_Enum fieldIndicator_ = Connection.GetJobForm_FieldInclusionType_Enum.NoFields)

Parameters

Type	Name	Description
System.Int32	jobId_	The parent job to look up.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.
Connection.GetJobForm_FieldInclusionType_Enum	fieldIndicator_	Indicates which field types should be included or excluded.

Returns

Type	Description
System.Collections.Generic.List<JobForm>	The job forms associated with the given job.

GetJobs(JobFilter, PagingOptions, Boolean, Boolean)

Retrieves details for a filtered and paged set of jobs.

Declaration

public List<Job> GetJobs(JobFilter jobFilter_, PagingOptions pagingOptions_, bool includeContacts_ = false, bool includeJobPhases_ = false)

Parameters

Type	Name	Description
JobFilter	jobFilter_	Required options that determine which jobs to retrieve.
PagingOptions	pagingOptions_	Defines how the returned list should be paged.
System.Boolean	includeContacts_	If True, the Contacts property will be populated.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.

Returns

Type	Description
System.Collections.Generic.List<Job>

GetJobs(IEnumerable<Int32>, Boolean, Boolean)

Retrieves details for the specified jobs.

Declaration

public List<Job> GetJobs(IEnumerable<int> jobIds_, bool includeContacts_ = false, bool includeJobPhases_ = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	jobIds_	Identifies the jobs to lookup.
System.Boolean	includeContacts_	If True, the Contacts property will be populated.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.

Returns

Type	Description
System.Collections.Generic.List<Job>	A list of Jobs.

GetJobsForAccount(Int32, Boolean, Boolean)

Retrieves the jobs associated with the given account (regardless of the jobs' processes) and optionally including the associated contacts and phases.

Declaration

public List<Job> GetJobsForAccount(int accountId_, bool includeContacts_ = false, bool includeJobPhases_ = false)

Parameters

Type	Name	Description
System.Int32	accountId_	Account for which jobs will be retrieved.
System.Boolean	includeContacts_	If True, the Contacts property will be populated.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.

Returns

Type	Description
System.Collections.Generic.List<Job>	The list of jobs belonging to the given account.

GetJobsForAccount(Int32, Int32, Boolean, Boolean)

Retrieves the jobs associated with the given account belonging to the given process and optionally including the associated contacts and phases.

Declaration

public List<Job> GetJobsForAccount(int accountId_, int processId_, bool includeContacts_ = false, bool includeJobPhases_ = false)

Parameters

Type	Name	Description
System.Int32	accountId_	Account for which jobs will be retrieved.
System.Int32	processId_	Process to which the jobs are expected to belong. (e.g. is this a job query, a lead query, a campaign query etc.) If not specified, jobs of all processes will be returned.
System.Boolean	includeContacts_	If True, the Contacts property will be populated.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.

Returns

Type	Description
System.Collections.Generic.List<Job>	The list of jobs belonging to the given account.

GetJobsOfPurchaseOrders(IEnumerable<Int32>, IEnumerable<Int32>, Boolean, Boolean)

Retrieves details for the specified jobs.

Declaration

public List<Job> GetJobsOfPurchaseOrders(IEnumerable<int> purchaseOrderIds_, IEnumerable<int> processIds_ = null, bool includeContacts_ = false, bool includeJobPhases_ = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderIds_	Identifies the related Purchase Orders to use.
System.Collections.Generic.IEnumerable<System.Int32>	processIds_	Processes to which the jobs are expected to belong. (e.g. is this a job query, a lead query, a campaign query etc.) If not specified, jobs of all processes will be returned.
System.Boolean	includeContacts_	If True, the Contacts property will be populated.
System.Boolean	includeJobPhases_	If True, the JobPhases property will be populated.

Returns

Type	Description
System.Collections.Generic.List<Job>	A list of Jobs.

GetJobTemplates(Int32)

Retrieves all job templates associated with the given process.

Declaration

public List<JobTemplate> GetJobTemplates(int processId_ = 1)

Parameters

Type	Name	Description
System.Int32	processId_	Identifies the JTProcess whose templates should be retrieved (Defaults to the Job process.

Returns

Type	Description
System.Collections.Generic.List<JobTemplate>	A list of job templates.

GetLabelTemplate(Int32)

Returns the given label template. If there is no such template, Nothing will be returned.

Declaration

public LabelTemplate GetLabelTemplate(int labelTemplateId_)

Parameters

Type	Name	Description
System.Int32	labelTemplateId_	Label template to retrieve.

Returns

Type	Description
LabelTemplate	The label template, if it exists.

GetLabelTemplates()

Retrieves all available label templates.

Declaration

public List<LabelTemplate> GetLabelTemplates()

Returns

Type	Description
System.Collections.Generic.List<LabelTemplate>	All label templates.

GetLabelTemplates(IEnumerable<Int32>)

Retrieves the given list of label templates (if they exist).

Declaration

public List<LabelTemplate> GetLabelTemplates(IEnumerable<int> labelTemplateIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	labelTemplateIds_	Label templates to retrieve.

Returns

Type	Description
System.Collections.Generic.List<LabelTemplate>	The specified label templates.

GetPageView(Int32)

Gets the requested page view.

Declaration

public PageView GetPageView(int pageViewId_)

Parameters

Type	Name	Description
System.Int32	pageViewId_	Identifies the page view to retrieve.

Returns

Type	Description
PageView	The requested view.

GetPageViews()

Get's all page views visible to the authenticated user.

Declaration

public List<PageView> GetPageViews()

Returns

Type	Description
System.Collections.Generic.List<PageView>	All public/private/external page views for all pages accessible to the authenticated user.

GetPageViews(PageViewFilter)

Gets the page views matching the given filter. If no filter is given, all page views will be returned that are visible to the authenticated user.

Declaration

public List<PageView> GetPageViews(PageViewFilter pageViewFilter_)

Parameters

Type	Name	Description
PageViewFilter	pageViewFilter_	Describes filter to be applied when retrieving the page views.

Returns

Type	Description
System.Collections.Generic.List<PageView>	The requested page views.

GetPageViews(IEnumerable<Int32>)

Gets the requested page views.

Declaration

public List<PageView> GetPageViews(IEnumerable<int> pageViewIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	pageViewIds_	Identifies the page views to retrieve.

Returns

Type	Description
System.Collections.Generic.List<PageView>	The requested views.

GetPageViewsOfPage(PageView.Page_Enum)

Gets the views belonging to the indicated page.

Declaration

public List<PageView> GetPageViewsOfPage(PageView.Page_Enum page_)

Parameters

Type	Name	Description
PageView.Page_Enum	page_	Identifies the page to which the retrieved page views should belong.

Returns

Type	Description
System.Collections.Generic.List<PageView>	The requested views.

GetPageViewsOfPages(IEnumerable<PageView.Page_Enum>)

Gets the views belonging to the indicated pages.

Declaration

public List<PageView> GetPageViewsOfPages(IEnumerable<PageView.Page_Enum> pages_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PageView.Page_Enum>	pages_	Identifies the page to which the retrieved page views should belong.

Returns

Type	Description
System.Collections.Generic.List<PageView>	The requested views.

GetPriceLists()

Retrieves all of the globally defined price lists.

Declaration

public List<PriceList> GetPriceLists()

Returns

Type	Description
System.Collections.Generic.List<PriceList>	All of the globally defined price lists.

GetProcess(Int32)

Retrieves a specific Process.

Declaration

public JTProcess GetProcess(int processId_)

Parameters

Type	Name	Description
System.Int32	processId_	Process to retrieve.

Returns

Type	Description
JTProcess	The given process (if it exists).

GetProcesses()

Retrieves the set of Processes.

Declaration

public List<JTProcess> GetProcesses()

Returns

Type	Description
System.Collections.Generic.List<JTProcess>	All Processes.

GetProductAttributeTypes()

Retrieves a list of product attribute types.

Declaration

public List<ProductAttributeType> GetProductAttributeTypes()

Returns

Type	Description
System.Collections.Generic.List<ProductAttributeType>	The product attribute types.

GetProductAttributeValues(Int32)

Retrieves the values associated with a product attribute.

Declaration

public List<ProductAttributeValue> GetProductAttributeValues(int productAttributeTypeId_)

Parameters

Type	Name	Description
System.Int32	productAttributeTypeId_	A product attribute type.

Returns

Type	Description
System.Collections.Generic.List<ProductAttributeValue>	The values associated with productAttributeTypeId_.

GetProductFamilies()

Retrieves the set of product families.

Declaration

public List<ProductFamily> GetProductFamilies()

Returns

Type	Description
System.Collections.Generic.List<ProductFamily>	All product families.

GetProductFamily(Int32)

Retrieves the given ProductFamily.

Declaration

public ProductFamily GetProductFamily(int productFamilyId_)

Parameters

Type	Name	Description
System.Int32	productFamilyId_	Product family to retrieve.

Returns

Type	Description
ProductFamily	The product family if found (Null otherwise)

GetProductLine(Int32)

Retrieves the given ProductLine.

Declaration

public ProductLine GetProductLine(int productLineId_)

Parameters

Type	Name	Description
System.Int32	productLineId_	Product line to retrieve.

Returns

Type	Description
ProductLine	The product line if found (Null otherwise)

GetProductLines()

Retrieves the set of ProductLines.

Declaration

public List<ProductLine> GetProductLines()

Returns

Type	Description
System.Collections.Generic.List<ProductLine>	All product lines.

GetProductLines(Int32)

Retrieves the ProductLines associated with the given ProductFamily.

Declaration

public List<ProductLine> GetProductLines(int productFamilyId_)

Parameters

Type	Name	Description
System.Int32	productFamilyId_	ProductFamily whose lines are to be retrieved.

Returns

Type	Description
System.Collections.Generic.List<ProductLine>	The given product line if found (Null otherwise)

GetPurchaseOrder(Int32)

Retrieves a specific PurchaseOrder.

Declaration

public PurchaseOrder GetPurchaseOrder(int purchaseOrderId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	PurchaseOrder to retrieve.

Returns

Type	Description
PurchaseOrder	The given PurchaseOrder (if it exists).

GetPurchaseOrderFile(Int32)

Retrieves the given Purchase Order file.

Declaration

public PurchaseOrderFile GetPurchaseOrderFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to retrieve.

Returns

Type	Description
PurchaseOrderFile	The requested file.

GetPurchaseOrderFiles(Int32)

Retrieves the files attached to the given purchase order.

Declaration

public List<PurchaseOrderFile> GetPurchaseOrderFiles(int poId_)

Parameters

Type	Name	Description
System.Int32	poId_	The purchase order for which files should be retrieved.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderFile>	The purchase order's files.

GetPurchaseOrderLine(Int32)

Retrieves a specific PurchaseOrderLine.

Declaration

public PurchaseOrderLine GetPurchaseOrderLine(int purchaseOrderLineId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderLineId_	Identifies the PurchaseOrderLine to be retrieved.

Returns

Type	Description
PurchaseOrderLine	The requested line (if it exists).

GetPurchaseOrderLines(IEnumerable<Int32>)

Retrieves a specific set of PurchaseOrderLines.

Declaration

public List<PurchaseOrderLine> GetPurchaseOrderLines(IEnumerable<int> purchaseOrderLineIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderLineIds_	The specific lines to retrieve. (If this is Null, no lines will be returned.)

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderLine>	The requested lines (if there are any).

GetPurchaseOrderLines(Int32)

Retrieves the lines associated with a given PurchaseOrder.

Declaration

public List<PurchaseOrderLine> GetPurchaseOrderLines(int purchaseOrderId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	Identifies the PurchaseOrder whose lines should be retrieved.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderLine>	The associated lines (if there are any)

GetPurchaseOrderLinesOfPurchaseOrders(IEnumerable<Int32>)

Retrieves the lines associated with a set of PurchaseOrders.

Declaration

public List<PurchaseOrderLine> GetPurchaseOrderLinesOfPurchaseOrders(IEnumerable<int> purchaseOrderIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderIds_	Identifies the PurchaseOrders whose lines should be retrieved.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderLine>	The associated lines (if there are any).

GetPurchaseOrderReceipt(Int32)

Retrieves a specific PurchaseOrderReceipt.

Declaration

public PurchaseOrderReceipt GetPurchaseOrderReceipt(int purchaseOrderReceiptId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderReceiptId_	Identifies the PurchaseOrderReceipt to retrieve.

Returns

Type	Description
PurchaseOrderReceipt	The requested PurchaseOrderReceipt (if it exists).

GetPurchaseOrderReceipts(IEnumerable<Int32>)

Retrieves a specific set of PurchaseOrderReceipts.

Declaration

public List<PurchaseOrderReceipt> GetPurchaseOrderReceipts(IEnumerable<int> purchaseOrderReceiptIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderReceiptIds_	Identifies the PurchaseOrderReceipts to retrieve.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	A list of PurchaseOrderReceipts matching the given ids. (If one or more of the ids don't have corresponding PurchaseOrderReceipts, there will simply be nothing returned for those ids.)

GetPurchaseOrderReceiptsOfPurchaseOrder(Int32)

Retrieves any PurchaseOrderReceipts associated with a given PurchaseOrder.

Declaration

public List<PurchaseOrderReceipt> GetPurchaseOrderReceiptsOfPurchaseOrder(int purchaseOrderId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	Identifies the PurchaseOrder.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	Any PurchaseOrderReceipts associated with the given PurchaseOrder.

GetPurchaseOrderReceiptsOfPurchaseOrderLine(Int32)

Retrieves any PurchaseOrderReceipts associated with a given PurchaseOrderLine.

Declaration

public List<PurchaseOrderReceipt> GetPurchaseOrderReceiptsOfPurchaseOrderLine(int purchaseOrderLineId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderLineId_	Identifies the PurchaseOrderLine.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	Any PurchaseOrderReceipts associated with the given PurchaseOrderLine.

GetPurchaseOrderReceiptsOfPurchaseOrderLines(IEnumerable<Int32>)

Retrieves any PurchaseOrderReceipts associated with a given set of PurchaseOrderLines.

Declaration

public List<PurchaseOrderReceipt> GetPurchaseOrderReceiptsOfPurchaseOrderLines(IEnumerable<int> purchaseOrderLineIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderLineIds_	Identifies the PurchaseOrderLines.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	Any PurchaseOrderReceipts associated with the given PurchaseOrderLines.

GetPurchaseOrderReceiptsOfPurchaseOrders(IEnumerable<Int32>)

Retrieves any PurchaseOrderReceipts associated with a given set of PurchaseOrders.

Declaration

public List<PurchaseOrderReceipt> GetPurchaseOrderReceiptsOfPurchaseOrders(IEnumerable<int> purchaseOrderIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderIds_	Identifies the PurchaseOrders.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrderReceipt>	Any PurchaseOrderReceipts associated with the given PurchaseOrders.

GetPurchaseOrders(PurchaseOrderFilter, PagingOptions)

Retrieves the specified set of PurchaseOrders.

Declaration

public List<PurchaseOrder> GetPurchaseOrders(PurchaseOrderFilter purchaseOrderFilter_, PagingOptions pagingOptions_)

Parameters

Type	Name	Description
PurchaseOrderFilter	purchaseOrderFilter_	Indicates which purchase orders to retrieve.
PagingOptions	pagingOptions_	Defines how the returned list should be paged.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrder>	The requested list of purchase orders.

GetPurchaseOrders(IEnumerable<Int32>)

Retrieves a specific set of PurchaseOrders.

Declaration

public List<PurchaseOrder> GetPurchaseOrders(IEnumerable<int> purchaseOrderIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderIds_	Identifies the PurchaseOrders to retrieve.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrder>	A list of PurchaseOrders matching the given ids. (If one or more of the ids don't have corresponding PurchaseOrders, there will simply be nothing returned for those ids.)

GetPurchaseOrdersOfJobs(IEnumerable<Int32>)

Retrieves any PurchaseOrders related to the given Moraware.JobTrackerAPI5.Jobss.

Declaration

public List<PurchaseOrder> GetPurchaseOrdersOfJobs(IEnumerable<int> jobIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	jobIds_	Identifies the Moraware.JobTrackerAPI5.Jobss for which POs will be retrieved.

Returns

Type	Description
System.Collections.Generic.List<PurchaseOrder>	A list of PurchaseOrders related to the given Jobs.

GetPurchaseProduct(Int32)

Retrieves a specific purchase product.

Declaration

public PurchaseProduct GetPurchaseProduct(int purchaseProductId_)

Parameters

Type	Name	Description
System.Int32	purchaseProductId_	Purchase product to retrieve.

Returns

Type	Description
PurchaseProduct	The given purchase product (if it exists).

GetPurchaseProducts()

Returns a list of all purchase products.

Declaration

public List<PurchaseProduct> GetPurchaseProducts()

Returns

Type	Description
System.Collections.Generic.List<PurchaseProduct>	The purchase products.

GetPurchaseProducts(IEnumerable<Int32>)

Returns a list of the given purchase products.

Declaration

public List<PurchaseProduct> GetPurchaseProducts(IEnumerable<int> purchaseProductIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseProductIds_	Defines the products to retrieve. If a Null is passed in, all purchase products will be returned.

Returns

Type	Description
System.Collections.Generic.List<PurchaseProduct>	The list of sell products (if there are any).

GetPurchaseProductVariant(Int32)

Retrieves a specific product variant.

Declaration

public PurchaseProductVariant GetPurchaseProductVariant(int variantId_)

Parameters

Type	Name	Description
System.Int32	variantId_	Id of the variant to be retrieved.

Returns

Type	Description
PurchaseProductVariant	The requested variant.

GetPurchaseProductVariantInventoryAdjustment(Int32)

Retrieves a specific purchase product variant inventory adjustment.

Declaration

public PurchaseProductVariantInventoryAdjustment GetPurchaseProductVariantInventoryAdjustment(int purchaseProductVariantInventoryAdjustmentId_)

Parameters

Type	Name	Description
System.Int32	purchaseProductVariantInventoryAdjustmentId_	Identifies the purchase product variant inventory adjustment to retrieve.

Returns

Type	Description
PurchaseProductVariantInventoryAdjustment	The purchase product variant inventory adjustment (if it exists).

GetPurchaseProductVariantInventoryAdjustments(IEnumerable<Int32>)

Retrieves a set of purchase product variant inventory adjustments.

Declaration

public List<PurchaseProductVariantInventoryAdjustment> GetPurchaseProductVariantInventoryAdjustments(IEnumerable<int> purchaseProductVariantInventoryAdjustmentIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseProductVariantInventoryAdjustmentIds_	Identifies the purchase product variant inventory adjustments to retrieve.

Returns

Type	Description
System.Collections.Generic.List<PurchaseProductVariantInventoryAdjustment>	The list of purchase product variant inventory adjustments.

GetPurchaseProductVariants(IEnumerable<PurchaseProductVariant>)

Retrieves a specific set of variants.

Declaration

public List<PurchaseProductVariant> GetPurchaseProductVariants(IEnumerable<PurchaseProductVariant> purchaseProductVariants_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PurchaseProductVariant>	purchaseProductVariants_	Defines the variants to be retrieved.

Returns

Type	Description
System.Collections.Generic.List<PurchaseProductVariant>	The requested variants.

GetPurchaseProductVariants(IEnumerable<Int32>)

Retrieves a specific set of variants.

Declaration

public List<PurchaseProductVariant> GetPurchaseProductVariants(IEnumerable<int> purchaseProductVariantIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseProductVariantIds_	Identifies the variants to be retrieved.

Returns

Type	Description
System.Collections.Generic.List<PurchaseProductVariant>	The requested variants.

GetSalespeople()

Retrieves the set of salespeople.

Declaration

public List<Salesperson> GetSalespeople()

Returns

Type	Description
System.Collections.Generic.List<Salesperson>	The list of salespeople.

GetSalesperson(Int32)

Retrieves the given Salesperson.

Declaration

public Salesperson GetSalesperson(int salesPersonId_)

Parameters

Type	Name	Description
System.Int32	salesPersonId_	Salesperson to lookup.

Returns

Type	Description
Salesperson	If there is a salesperson with the given id, it will be returned, otherwise Nothing will be returned.

GetSellProduct(Int32)

Retrieves a specific sell product.

Declaration

public SellProduct GetSellProduct(int sellProductId_)

Parameters

Type	Name	Description
System.Int32	sellProductId_	Sell product to retrieve.

Returns

Type	Description
SellProduct	The given sell product (if it exists).

GetSellProducts()

Returns a list of all sell products.

Declaration

public List<SellProduct> GetSellProducts()

Returns

Type	Description
System.Collections.Generic.List<SellProduct>	The list of sell products.

GetSellProducts(IEnumerable<Int32>)

Returns a list of the given sell products.

Declaration

public List<SellProduct> GetSellProducts(IEnumerable<int> sellProductIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	sellProductIds_	Defines the products to retrieve. If a Null is passed in, all sell products will be returned.

Returns

Type	Description
System.Collections.Generic.List<SellProduct>	The list of sell products (if there are any).

GetSellProductVariant(Int32)

Retrieves a specific product variant.

Declaration

public SellProductVariant GetSellProductVariant(int variantId_)

Parameters

Type	Name	Description
System.Int32	variantId_	Id of the variant to be retrieved.

Returns

Type	Description
SellProductVariant	The requested variant.

GetSellProductVariants(IEnumerable<SellProductVariant>)

Retrieves a specific set of variants.

Declaration

public List<SellProductVariant> GetSellProductVariants(IEnumerable<SellProductVariant> sellProductVariants_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<SellProductVariant>	sellProductVariants_	Defines the variants to be retrieved.

Returns

Type	Description
System.Collections.Generic.List<SellProductVariant>	The requested variants.

GetSellProductVariants(IEnumerable<Int32>)

Retrieves a specific set of variants.

Declaration

public List<SellProductVariant> GetSellProductVariants(IEnumerable<int> sellProductVariantIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	sellProductVariantIds_	Identifies the variants to be retrieved.

Returns

Type	Description
System.Collections.Generic.List<SellProductVariant>	The requested variants.

GetSerialNumber(Int32)

Retrieves a specific SerialNumber.

Declaration

public SerialNumber GetSerialNumber(int serialNumberId_)

Parameters

Type	Name	Description
System.Int32	serialNumberId_	SerialNumber to retrieve.

Returns

Type	Description
SerialNumber	The given SerialNumber (if it exists).

GetSerialNumberAllocations(IEnumerable<Int32>)

Retrieves the allocations against the given serial numbers.

Declaration

public List<SerialNumberAllocation> GetSerialNumberAllocations(IEnumerable<int> serialNumberIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberIds_	Serial Numbers to include.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberAllocation>

GetSerialNumberFile(Int32)

Retrieves the given Serial Number file.

Declaration

public SerialNumberFile GetSerialNumberFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to retrieve.

Returns

Type	Description
SerialNumberFile	The requested file.

GetSerialNumberFiles(Int32)

Retrieves the files attached to the given Serial Number.

Declaration

public List<SerialNumberFile> GetSerialNumberFiles(int serialNumberId_)

Parameters

Type	Name	Description
System.Int32	serialNumberId_	The serial number for which files should be retrieved.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberFile>	The serial number's files.

GetSerialNumberImport(Int32)

Retrieves a specific serial number import.

Declaration

public SerialNumberImport GetSerialNumberImport(int serialNumberImportId_)

Parameters

Type	Name	Description
System.Int32	serialNumberImportId_	Serial number import to retrieve.

Returns

Type	Description
SerialNumberImport	The serial number import import.

GetSerialNumberImports(IEnumerable<Int32>)

Retrieves a set of serial number imports.

Declaration

public List<SerialNumberImport> GetSerialNumberImports(IEnumerable<int> serialNumberImportIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberImportIds_	Identifies the serial number imports to retrieve.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberImport>	The list of serial number imports.

GetSerialNumberInventoryAdjustment(Int32)

Retrieves a specific serial number inventory adjustment.

Declaration

public SerialNumberInventoryAdjustment GetSerialNumberInventoryAdjustment(int serialNumberInventoryAdjustmentId_)

Parameters

Type	Name	Description
System.Int32	serialNumberInventoryAdjustmentId_	Identifies the serial number inventory adjustment to retrieve.

Returns

Type	Description
SerialNumberInventoryAdjustment	The serial number inventory adjustment (if it exists).

GetSerialNumberInventoryAdjustments(IEnumerable<Int32>)

Retrieves a set of serial number inventory adjustments.

Declaration

public List<SerialNumberInventoryAdjustment> GetSerialNumberInventoryAdjustments(IEnumerable<int> serialNumberInventoryAdjustmentIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberInventoryAdjustmentIds_	Identifies the serial number inventory adjustments to retrieve.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberInventoryAdjustment>	The list of serial number inventory adjustments.

GetSerialNumberInventoryAdjustmentsForSerialNumber(Int32)

Retrieves the serial number inventory adjustments for the given serial number.

Declaration

public List<SerialNumberInventoryAdjustment> GetSerialNumberInventoryAdjustmentsForSerialNumber(int serialNumberId_)

Parameters

Type	Name	Description
System.Int32	serialNumberId_	Parent of the adjustments to retrieve.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberInventoryAdjustment>	Any child serial number inventory adjustments

GetSerialNumberInventoryAdjustmentsForSerialNumbers(IEnumerable<Int32>)

Retrieves the serial number inventory adjustments for the given serial number.

Declaration

public List<SerialNumberInventoryAdjustment> GetSerialNumberInventoryAdjustmentsForSerialNumbers(IEnumerable<int> serialNumberIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberIds_	Parents of the adjustments to retrieve.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberInventoryAdjustment>	Any child serial number inventory adjustments

GetSerialNumberRemnant(Int32)

Retrieves a specific serial number remnant.

Declaration

public SerialNumberRemnant GetSerialNumberRemnant(int serialNumberRemnantId_)

Parameters

Type	Name	Description
System.Int32	serialNumberRemnantId_	Serial number remnant to retrieve.

Returns

Type	Description
SerialNumberRemnant	The serial number remnant.

GetSerialNumberRemnants(IEnumerable<Int32>)

Retrieves a set of serial number remnants.

Declaration

public List<SerialNumberRemnant> GetSerialNumberRemnants(IEnumerable<int> serialNumberRemnantIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberRemnantIds_	Identifies the serial number remnants to retrieve.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberRemnant>	The list of serial number remnants.

GetSerialNumberRemnantsOfParent(IEnumerable<Int32>)

Retrieves a set of serial number remnants belonging to a specific set of parent serial numbers.

Declaration

public List<SerialNumberRemnant> GetSerialNumberRemnantsOfParent(IEnumerable<int> parentSerialNumberIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	parentSerialNumberIds_	Identifies the parents of the remnants to retrieve.

Returns

Type	Description
System.Collections.Generic.List<SerialNumberRemnant>	The list of serial number remnants.

GetSerialNumbers(SerialNumberFilter, PagingOptions)

Uses the given filter to retrieve a set of serial numbers.

Declaration

public List<SerialNumber> GetSerialNumbers(SerialNumberFilter serialNumberFilter_, PagingOptions pagingOptions_)

Parameters

Type	Name	Description
SerialNumberFilter	serialNumberFilter_	Options that determine which serial numbers to retrieve.
PagingOptions	pagingOptions_	Defines how the returned list should be paged.

Returns

Type	Description
System.Collections.Generic.List<SerialNumber>	A set of serial numbers.

GetSerialNumbers(IEnumerable<Int32>)

Retrieves a specific set of SerialNumbers.

Declaration

public List<SerialNumber> GetSerialNumbers(IEnumerable<int> serialNumberIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	serialNumberIds_	Identifies the SerialNumbers to retrieve.

Returns

Type	Description
System.Collections.Generic.List<SerialNumber>	A list of SerialNumbers matching the given ids. (If one or more of the ids don't have corresponding SerialNumbers, there will simply be nothing returned for those ids.)

GetServerAPIVersion()

Determine the current and minimum supported api version for the JobTracker server instance.

Declaration

public ServerAPIVersion GetServerAPIVersion()

Returns

Type	Description
ServerAPIVersion	The current and minimum supported api version.

GetShipToLocation(Int32)

Retrieves the given ShipToLocation.

Declaration

public ShipToLocation GetShipToLocation(int shipToLocationId_)

Parameters

Type	Name	Description
System.Int32	shipToLocationId_	Ship-to location to retrieve.

Returns

Type	Description
ShipToLocation	The given ship-to location (if it exists).

GetShipToLocations()

Retrieves the set of ShipToLocations.

Declaration

public List<ShipToLocation> GetShipToLocations()

Returns

Type	Description
System.Collections.Generic.List<ShipToLocation>	All ship-to locations.

GetSupplier(Int32)

Retrieves a specific Supplier.

Declaration

public Supplier GetSupplier(int supplierId_)

Parameters

Type	Name	Description
System.Int32	supplierId_	Supplier to retrieve.

Returns

Type	Description
Supplier	The given supplier (if it exists).

GetSupplierFile(Int32)

Retrieves the given Supplier file.

Declaration

public SupplierFile GetSupplierFile(int fileId_)

Parameters

Type	Name	Description
System.Int32	fileId_	The file to retrieve.

Returns

Type	Description
SupplierFile	The requested file.

GetSupplierFiles(Int32)

Retrieves the files attached to the given Supplier.

Declaration

public List<SupplierFile> GetSupplierFiles(int supplierId_)

Parameters

Type	Name	Description
System.Int32	supplierId_	The supplier for which files should be retrieved.

Returns

Type	Description
System.Collections.Generic.List<SupplierFile>	The supplier's files.

GetSuppliers()

Retrieves the set of Suppliers.

Declaration

public List<Supplier> GetSuppliers()

Returns

Type	Description
System.Collections.Generic.List<Supplier>	All Suppliers.

GetUnitOfMeasure(Int32)

Retrieves a specific unit of measure.

Declaration

public UnitOfMeasure GetUnitOfMeasure(int unitOfMeasureId_)

Parameters

Type	Name	Description
System.Int32	unitOfMeasureId_	Unit of measure to retrieve.

Returns

Type	Description
UnitOfMeasure	The given unit of measure (if it exists).

GetUnitOfMeasures()

Retrieves the set of units of measure.

Declaration

public List<UnitOfMeasure> GetUnitOfMeasures()

Returns

Type	Description
System.Collections.Generic.List<UnitOfMeasure>	All units of measure.

GetUnreceivedSerialNumber(Int32)

Retrieves a specific UnreceivedSerialNumber.

Declaration

public UnreceivedSerialNumber GetUnreceivedSerialNumber(int unreceivedSerialNumberId_)

Parameters

Type	Name	Description
System.Int32	unreceivedSerialNumberId_	Identifies the UnreceivedSerialNumber to retrieve.

Returns

Type	Description
UnreceivedSerialNumber	The requested UnreceivedSerialNumber (if it exists).

GetUnreceivedSerialNumbers(IEnumerable<Int32>)

Retrieves a specific set of UnreceivedSerialNumbers.

Declaration

public List<UnreceivedSerialNumber> GetUnreceivedSerialNumbers(IEnumerable<int> unreceivedSerialNumberIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	unreceivedSerialNumberIds_	Identifies the UnreceivedSerialNumbers to retrieve.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	A list of UnreceivedSerialNumbers matching the given ids. (If one or more of the ids don't have corresponding UnreceivedSerialNumbers, there will simply be nothing returned for those ids.)

GetUnreceivedSerialNumbersOfPurchaseOrder(Int32)

Retrieves any UnreceivedSerialNumbers associated with a given PurchaseOrder.

Declaration

public List<UnreceivedSerialNumber> GetUnreceivedSerialNumbersOfPurchaseOrder(int purchaseOrderId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	Identifies the PurchaseOrder.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	Any UnreceivedSerialNumbers associated with the given PurchaseOrder.

GetUnreceivedSerialNumbersOfPurchaseOrderLine(Int32)

Retrieves any UnreceivedSerialNumbers associated with a given PurchaseOrderLine.

Declaration

public List<UnreceivedSerialNumber> GetUnreceivedSerialNumbersOfPurchaseOrderLine(int purchaseOrderLineId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderLineId_	Identifies the PurchaseOrderLine.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	Any UnreceivedSerialNumbers associated with the given PurchaseOrderLine.

GetUnreceivedSerialNumbersOfPurchaseOrderLines(IEnumerable<Int32>)

Retrieves any UnreceivedSerialNumbers associated with a given set of PurchaseOrderLines.

Declaration

public List<UnreceivedSerialNumber> GetUnreceivedSerialNumbersOfPurchaseOrderLines(IEnumerable<int> purchaseOrderLineIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderLineIds_	Identifies the PurchaseOrderLines.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	Any UnreceivedSerialNumbers associated with the given PurchaseOrderLines.

GetUnreceivedSerialNumbersOfPurchaseOrders(IEnumerable<Int32>)

Retrieves any UnreceivedSerialNumbers associated with a given set of PurchaseOrders.

Declaration

public List<UnreceivedSerialNumber> GetUnreceivedSerialNumbersOfPurchaseOrders(IEnumerable<int> purchaseOrderIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	purchaseOrderIds_	Identifies the PurchaseOrders.

Returns

Type	Description
System.Collections.Generic.List<UnreceivedSerialNumber>	Any UnreceivedSerialNumbers associated with the given PurchaseOrders.

MoveJobToAccount(Int32, Int32)

Move the given job to the given account. (The target account must be active.)

Declaration

public void MoveJobToAccount(int jobId_, int accountId_)

Parameters

Type	Name	Description
System.Int32	jobId_	The Job to be moved.
System.Int32	accountId_	The new Account.

RemovePurchaseOrderFromJob(Int32, Int32)

Removes the given Purchase Order from the given Job.

Declaration

public void RemovePurchaseOrderFromJob(int purchaseOrderId_, int jobId_)

Parameters

Type	Name	Description
System.Int32	purchaseOrderId_	Identifies the Purchase Order to use.
System.Int32	jobId_	Identifies the job to use.

ReorderAssignees(IEnumerable<Int32>)

Re-orders the assignees.

Declaration

public void ReorderAssignees(IEnumerable<int> assigneeIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	assigneeIds_	A list of assignees, in the desired order.

ReorderCustomLOVFieldValues(Int32, IEnumerable<Int32>)

Re-orders the values associated with the given List of Values custom field.

Declaration

public void ReorderCustomLOVFieldValues(int customFieldTypeId_, IEnumerable<int> fieldValueIds_)

Parameters

Type	Name	Description
System.Int32	customFieldTypeId_	The custom field to which the field values belong.
System.Collections.Generic.IEnumerable<System.Int32>	fieldValueIds_	An ordered list of field value ids.

Remarks

An exception will be thrown if the given List of Values field is not configured to support custom ordering.

ReorderFormTemplateLOVFieldValues(Int32, IEnumerable<Int32>)

Re-orders the values associated with the given List of Values custom field.

Declaration

public void ReorderFormTemplateLOVFieldValues(int formTemplateFieldId_, IEnumerable<int> fieldValueIds_)

Parameters

Type	Name	Description
System.Int32	formTemplateFieldId_	The form template field to which the field values belong.
System.Collections.Generic.IEnumerable<System.Int32>	fieldValueIds_	An ordered list of field value ids.

Remarks

An exception will be thrown if the given List of Values field is not configured to support custom ordering.

ReorderJobActivitiesInSeries(Int32, IEnumerable<Int32>)

Allows you to ensure a particular order for auto-scheduled activities within any non-auto-scheduled activities.

Declaration

public void ReorderJobActivitiesInSeries(int jobActivitySeriesId_, IEnumerable<int> orderedJobActivityIds_)

Parameters

Type	Name	Description
System.Int32	jobActivitySeriesId_	The job activity series to which the job activities belong.
System.Collections.Generic.IEnumerable<System.Int32>	orderedJobActivityIds_	Ordered list of the job activities belonging to a job activity series.

ReorderJobPhases(IEnumerable<Int32>)

Re-orders the job phases.

Declaration

public void ReorderJobPhases(IEnumerable<int> jobPhaseIds_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	jobPhaseIds_	A list of job phases, in the desired order.

SplitPurchaseOrderLine(PurchaseOrderSplitLine)

Creates a set of purchase order lines by splitting an existing purchase order line.

Declaration

public void SplitPurchaseOrderLine(PurchaseOrderSplitLine purchaseOrderSplitLine_)

Parameters

Type	Name	Description
PurchaseOrderSplitLine	purchaseOrderSplitLine_	Describes how the existing purchase order line is to be split.

SplitPurchaseOrderLines(IEnumerable<PurchaseOrderSplitLine>)

Creates a set of purchase order lines by splitting a set of existing purchase order lines.

Declaration

public void SplitPurchaseOrderLines(IEnumerable<PurchaseOrderSplitLine> purchaseOrderSplitLines_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PurchaseOrderSplitLine>	purchaseOrderSplitLines_	Describes how the existing purchase order lines are to be split.

UpdateAccount(Account, Boolean)

Updates the fields of an account.

Declaration

public void UpdateAccount(Account account_, bool allowDuplicates_ = false)

Parameters

Type	Name	Description
Account	account_	Account to be updated.
System.Boolean	allowDuplicates_	If True, you will be able to change the name of the account to be the same as another account without an error.

UpdateAccountContact(AccountContact)

Updates the given AccountContact.

Declaration

public void UpdateAccountContact(AccountContact accountContact_)

Parameters

Type	Name	Description
AccountContact	accountContact_	The AccountContact to update.

UpdateAccountFile(AccountFile)

Update the attributes of a file.

Declaration

public void UpdateAccountFile(AccountFile accountFile_)

Parameters

Type	Name	Description
AccountFile	accountFile_	File to be updated.

UpdateAccountPriceList(AccountPriceList)

Updates Discount, Tax and Active Status (not the Sequence number) of an Account Price List.

Declaration

public void UpdateAccountPriceList(AccountPriceList accountPriceList_)

Parameters

Type	Name	Description
AccountPriceList	accountPriceList_	The account price list to update.

UpdateAssignee(Assignee)

Updates the given assignee.

Declaration

public void UpdateAssignee(Assignee assignee_)

Parameters

Type	Name	Description
Assignee	assignee_	Assignee to be updated.

UpdateInventoryCount(InventoryCount)

Updates the given inventory count.

Declaration

public void UpdateInventoryCount(InventoryCount inventoryCount_)

Parameters

Type	Name	Description
InventoryCount	inventoryCount_	The inventory count to be updated.

UpdateInventoryLocation(InventoryLocation)

Updates the given InventoryLocation.

Declaration

public void UpdateInventoryLocation(InventoryLocation inventoryLocation_)

Parameters

Type	Name	Description
InventoryLocation	inventoryLocation_	Inventory location to be updated.

UpdateJob(Job)

Updates a particular job.

Declaration

public void UpdateJob(Job job_)

Parameters

Type	Name	Description
Job	job_	Job to be updated.

UpdateJobActivity(JobActivity)

Will update the activity.

Declaration

public void UpdateJobActivity(JobActivity jobActivity_)

Parameters

Type	Name	Description
JobActivity	jobActivity_	The job activity to be updated.

UpdateJobActivityAndAttachToSeries(JobActivity, Int32)

Will update the activity and add (move) it to the series identified by jobActivitySeriesId_.

Declaration

public void UpdateJobActivityAndAttachToSeries(JobActivity jobActivity_, int jobActivitySeriesId_)

Parameters

Type	Name	Description
JobActivity	jobActivity_	Job activity to be updated.
System.Int32	jobActivitySeriesId_	Existing series.

UpdateJobActivityAndCreateSeries(JobActivity, Int32, String)

Will update the activity and create a series.
seriesLength_ will determine the number of activities in the series, and seriesName_ (if given) will be used as the name for the new series.

Declaration

public void UpdateJobActivityAndCreateSeries(JobActivity jobActivity_, int seriesLength_, string seriesName_ = "")

Parameters

Type	Name	Description
JobActivity	jobActivity_	Job activity to be updated.
System.Int32	seriesLength_	Number of activities to include in the series.
System.String	seriesName_	(Optional) name for the new series.

UpdateJobActivityAndExtendCurrentSeries(JobActivity, Int32)

Will update the activity and extend this activity's series by the given amount.

Declaration

public void UpdateJobActivityAndExtendCurrentSeries(JobActivity jobActivity_, int additionalDays_)

Parameters

Type	Name	Description
JobActivity	jobActivity_	Job activity to be updated.
System.Int32	additionalDays_	Number of days by which to extend the series.

UpdateJobActivityAndRemoveFromSeries(JobActivity)

Will update the activity and remove the activity from any series it may belong to.

Declaration

public void UpdateJobActivityAndRemoveFromSeries(JobActivity jobActivity_)

Parameters

Type	Name	Description
JobActivity	jobActivity_	Job activity to be updated.

UpdateJobActivityMaterial(JobActivityMaterial)

Sets the entire allocation of the given purchase product variant for the given job activity.

Declaration

public void UpdateJobActivityMaterial(JobActivityMaterial jobActivityMaterial_)

Parameters

Type	Name	Description
JobActivityMaterial	jobActivityMaterial_	Job activity material to be assigned.

Remarks

Performing an update with empty job activity material has the same effect as deleting the job activity material.

UpdateJobActivityMaterial(IEnumerable<JobActivityMaterial>)

Sets the entire allocation of the given purchase product variant for the given job activity.

Declaration

public void UpdateJobActivityMaterial(IEnumerable<JobActivityMaterial> jobActivityMaterial_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<JobActivityMaterial>	jobActivityMaterial_	Job activity material to be assigned.

Remarks

Performing an update with empty job activity material has the same effect as deleting the job activity material.

UpdateJobActivitySeries(JobActivitySeries, IEnumerable<Int32>)

Updates the given job activity series, optionally providing an order for the activities that comprise the series.

Declaration

public void UpdateJobActivitySeries(JobActivitySeries jobActivitySeries_, IEnumerable<int> orderedJobActivityIds_ = null)

Parameters

Type	Name	Description
JobActivitySeries	jobActivitySeries_	The job activity series to be updated.
System.Collections.Generic.IEnumerable<System.Int32>	orderedJobActivityIds_	An (optional) ordered list of the job activities belonging to the job activity series. Allows you to ensure a particular order for auto-scheduled activities within any non-auto-scheduled activities.

UpdateJobFile(JobFile)

Update the attributes of a file.

Declaration

public void UpdateJobFile(JobFile jobFile_)

Parameters

Type	Name	Description
JobFile	jobFile_	File to be updated.

UpdateJobForm(JobForm)

Updates the fields of a job form.

Declaration

public void UpdateJobForm(JobForm jobForm_)

Parameters

Type	Name	Description
JobForm	jobForm_	Form to be updated.

UpdateJobPhase(JobPhase)

Updates the fields of the given job phase.

Declaration

public void UpdateJobPhase(JobPhase jobPhase_)

Parameters

Type	Name	Description
JobPhase	jobPhase_	Job phase to be updated.

UpdatePurchaseOrder(PurchaseOrder)

Updates the given purchaseOrder.

Declaration

public void UpdatePurchaseOrder(PurchaseOrder purchaseOrder_)

Parameters

Type	Name	Description
PurchaseOrder	purchaseOrder_	PurchaseOrder to be updated.

UpdatePurchaseOrderFile(PurchaseOrderFile)

Update the attributes of a file.

Declaration

public void UpdatePurchaseOrderFile(PurchaseOrderFile purchaseOrderFile_)

Parameters

Type	Name	Description
PurchaseOrderFile	purchaseOrderFile_	File to be updated.

UpdatePurchaseOrderMiscellaneousLine(PurchaseOrderMiscellaneousLine)

Updates a purchase order miscellaneous line.

Declaration

public void UpdatePurchaseOrderMiscellaneousLine(PurchaseOrderMiscellaneousLine purchaseOrderMiscellaneousLine_)

Parameters

Type	Name	Description
PurchaseOrderMiscellaneousLine	purchaseOrderMiscellaneousLine_	Defines the line to be updated.

UpdatePurchaseOrderProductLine(PurchaseOrderProductLine)

Updates a purchase order product line.

Declaration

public void UpdatePurchaseOrderProductLine(PurchaseOrderProductLine purchaseOrderProductLine_)

Parameters

Type	Name	Description
PurchaseOrderProductLine	purchaseOrderProductLine_	Defines the line to be updated.

UpdatePurchaseOrderReceipt(PurchaseOrderReceipt)

Updates an PurchaseOrderReceipt.

Declaration

public void UpdatePurchaseOrderReceipt(PurchaseOrderReceipt purchaseOrderReceipt_)

Parameters

Type	Name	Description
PurchaseOrderReceipt	purchaseOrderReceipt_	Purchase Order Receipt to be updated.

UpdatePurchaseOrderReceipts(IEnumerable<PurchaseOrderReceipt>)

Updates a set of PurchaseOrderReceipts.

Declaration

public void UpdatePurchaseOrderReceipts(IEnumerable<PurchaseOrderReceipt> purchaseOrderReceipts_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PurchaseOrderReceipt>	purchaseOrderReceipts_	Purchase Order Receipt to be updated.

UpdatePurchaseProductVariantAllocation(PurchaseProductVariantAllocation)

Sets the unserialized allocation of the given purchase product variant for the given job activity.

Declaration

public void UpdatePurchaseProductVariantAllocation(PurchaseProductVariantAllocation purchaseProductVariantAllocation_)

Parameters

Type	Name	Description
PurchaseProductVariantAllocation	purchaseProductVariantAllocation_	(Unserialized) allocation to be made.

UpdatePurchaseProductVariantAllocations(IEnumerable<PurchaseProductVariantAllocation>)

Sets the unserialized allocations of the given purchase product variants for the given job activities.

Declaration

public void UpdatePurchaseProductVariantAllocations(IEnumerable<PurchaseProductVariantAllocation> purchaseProductVariantAllocations_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PurchaseProductVariantAllocation>	purchaseProductVariantAllocations_	(Unserialized) allocations to be made.

UpdatePurchaseProductVariantInventoryAdjustment(PurchaseProductVariantInventoryAdjustment)

Updates a purchase product variant inventory adjustment.

Declaration

public void UpdatePurchaseProductVariantInventoryAdjustment(PurchaseProductVariantInventoryAdjustment purchaseProductVariantInventoryAdjustment_)

Parameters

Type	Name	Description
PurchaseProductVariantInventoryAdjustment	purchaseProductVariantInventoryAdjustment_	Identifies and describes the purchase product variant inventory adjustment to be updated.

UpdateSalesperson(Salesperson)

Updates the given salesperson.

Declaration

public void UpdateSalesperson(Salesperson salesperson_)

Parameters

Type	Name	Description
Salesperson	salesperson_	Salesperson to be updated.

UpdateSerialNumber(SerialNumber)

Updates the given serial number.

Declaration

public void UpdateSerialNumber(SerialNumber serialNumber_)

Parameters

Type	Name	Description
SerialNumber	serialNumber_	Serial Number to be updated.

UpdateSerialNumberAllocation(SerialNumberAllocation)

Sets the allocation for the given serial number for the given job activity.

Declaration

public void UpdateSerialNumberAllocation(SerialNumberAllocation serialNumberAllocation_)

Parameters

Type	Name	Description
SerialNumberAllocation	serialNumberAllocation_	The serial number allocation to be set.

Remarks

Setting a quantity of 0 will result in the allocation being deleted.

UpdateSerialNumberAllocations(IEnumerable<SerialNumberAllocation>)

Sets the allocation for the given serial numbers for the given job activities.

Declaration

public void UpdateSerialNumberAllocations(IEnumerable<SerialNumberAllocation> serialNumberAllocations_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<SerialNumberAllocation>	serialNumberAllocations_	The serial number allocations to be set.

Remarks

Setting a quantity of 0 will result in the allocation being deleted.

UpdateSerialNumberFile(SerialNumberFile)

Update the attributes of a file.

Declaration

public void UpdateSerialNumberFile(SerialNumberFile serialNumberFile_)

Parameters

Type	Name	Description
SerialNumberFile	serialNumberFile_	File to be updated.

UpdateSerialNumberImport(SerialNumberImport)

Updates the given serial number import.

Declaration

public void UpdateSerialNumberImport(SerialNumberImport serialNumberImport_)

Parameters

Type	Name	Description
SerialNumberImport	serialNumberImport_	Serial number import to be updated.

UpdateSerialNumberInventoryAdjustment(SerialNumberInventoryAdjustment)

Updates a serial number inventory adjustment.

Declaration

public void UpdateSerialNumberInventoryAdjustment(SerialNumberInventoryAdjustment serialNumberInventoryAdjustment_)

Parameters

Type	Name	Description
SerialNumberInventoryAdjustment	serialNumberInventoryAdjustment_	Identifies and describes the serial number inventory adjustment to be updated.

UpdateSerialNumberRemnant(SerialNumberRemnant)

Updates the given serial number remnant.

Declaration

public void UpdateSerialNumberRemnant(SerialNumberRemnant serialNumberRemnant_)

Parameters

Type	Name	Description
SerialNumberRemnant	serialNumberRemnant_	Serial number remnant to be updated.

UpdateSupplier(Supplier)

Updates the given supplier.

Declaration

public void UpdateSupplier(Supplier supplier_)

Parameters

Type	Name	Description
Supplier	supplier_	Supplier to be updated.

UpdateSupplierFile(SupplierFile)

Update the attributes of a file.

Declaration

public void UpdateSupplierFile(SupplierFile supplierFile_)

Parameters

Type	Name	Description
SupplierFile	supplierFile_	File to be updated.

UpdateUnreceivedSerialNumber(UnreceivedSerialNumber)

Updates an UnreceivedSerialNumber.

Declaration

public void UpdateUnreceivedSerialNumber(UnreceivedSerialNumber unreceivedSerialNumber_)

Parameters

Type	Name	Description
UnreceivedSerialNumber	unreceivedSerialNumber_	Unreceived serial number to be updated.

UpdateUnreceivedSerialNumbers(IEnumerable<UnreceivedSerialNumber>)

Updates a set of UnreceivedSerialNumbers.

Declaration

public void UpdateUnreceivedSerialNumbers(IEnumerable<UnreceivedSerialNumber> unreceivedSerialNumbers_)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UnreceivedSerialNumber>	unreceivedSerialNumbers_	Unreceived serial numbers to be updated.

UploadAccountFile(AccountFile, FileInfo, Boolean, IFileTransferMonitor, Boolean)

Uploads an account file.

Declaration

public void UploadAccountFile(AccountFile accountFile_, FileInfo fileInfo_, bool overwriteExisting_, IFileTransferMonitor feedback_ = null, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
AccountFile	accountFile_	Describes the file.
System.IO.FileInfo	fileInfo_	Location of the file on the local file system.
System.Boolean	overwriteExisting_	If True, uploading a file that already exists will overwrite the existing file.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

UploadJobFile(JobFile, FileInfo, Boolean, IFileTransferMonitor, Boolean)

Uploads a job file.

Declaration

public void UploadJobFile(JobFile jobFile_, FileInfo fileInfo_, bool overwriteExisting_, IFileTransferMonitor feedback_ = null, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
JobFile	jobFile_	Describes the file.
System.IO.FileInfo	fileInfo_	Location of the file on the local file system.
System.Boolean	overwriteExisting_	If True, uploading a file that already exists will overwrite the existing file.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

UploadPurchaseOrderFile(PurchaseOrderFile, FileInfo, Boolean, IFileTransferMonitor, Boolean)

Uploads a purchase order file.

Declaration

public void UploadPurchaseOrderFile(PurchaseOrderFile purchaseOrderFile_, FileInfo fileInfo_, bool overwriteExisting_, IFileTransferMonitor feedback_ = null, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
PurchaseOrderFile	purchaseOrderFile_	Describes the file.
System.IO.FileInfo	fileInfo_	Location of the file on the local file system.
System.Boolean	overwriteExisting_	If True, uploading a file that already exists will overwrite the existing file.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

UploadSerialNumberFile(SerialNumberFile, FileInfo, Boolean, IFileTransferMonitor, Boolean)

Uploads a serial number file.

Declaration

public void UploadSerialNumberFile(SerialNumberFile serialNumberFile_, FileInfo fileInfo_, bool overwriteExisting_, IFileTransferMonitor feedback_ = null, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
SerialNumberFile	serialNumberFile_	Describes the file.
System.IO.FileInfo	fileInfo_	Location of the file on the local file system.
System.Boolean	overwriteExisting_	If True, uploading a file that already exists will overwrite the existing file.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.

UploadSupplierFile(SupplierFile, FileInfo, Boolean, IFileTransferMonitor, Boolean)

Uploads a supplier file.

Declaration

public void UploadSupplierFile(SupplierFile supplierFile_, FileInfo fileInfo_, bool overwriteExisting_, IFileTransferMonitor feedback_ = null, bool suppressExceptions_ = false)

Parameters

Type	Name	Description
SupplierFile	supplierFile_	Describes the file.
System.IO.FileInfo	fileInfo_	Location of the file on the local file system.
System.Boolean	overwriteExisting_	If True, uploading a file that already exists will overwrite the existing file.
IFileTransferMonitor	feedback_	(Optional) Object to monitor progress.
System.Boolean	suppressExceptions_	If True, no exceptions will be thrown on error.