PublicAPIService
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAPVoucher
Post an APVoucher -
AddARCreditMemoAndApplyToARInvoice
Apply AR credit memo and apply it to a specified AR invoice -
AddCallToExistingWorkOrder
This function will add new call to an existing work order. The work order numer should be set in the call object -
AddEquipment
Add an equipment -
AddMake
Add a Make -
AddModel
Add a Model -
AddModel2
Add a Model (uses the ModelData object) -
AddMultipleCalls
This function will add multiple service calls to the same work order. If calls.WorkOrder is provided system will attempt to use that number to create the work order. -
Authorize
This will check the specified authorization parameters -
Authorize2
This will check the specified authorization parameters -
DGWAddItem
This function will add an Item to the e-automate database (uses the ItemData object) -
DGWSaveItem
Updates the specified item. -
DropShipDefaultBin
This will return the default Drop Ship bin name that may be used for Purchase Orders -
DropShipDefaultWarehouse
This will return the default Drop Ship warehouse name that may be used for Purchase Orders -
ECIFMACustomerList
ECI Internal call that will return a listing of customer accounts. -
ECIFMAEquipCustUpdateList
ECI Internal call that will return a listing of customer assests that may have been modified since the specified date. -
ECIFMAEquipmentList
ECI Internal call that will return a listing of customer assets. -
ECIFMAInsertMeterReadings
ECI Internal call for submitting meter readings from FMAudit. -
ECIFMAUpdateAccountAuditDate
ECI Internal call for updating an account record from FMAudit. -
ECIFMAUpdateDevice
ECI Internal call for updating a device record and meter readings from FMAudit. -
ExistsCustomer
Returns true if the specified customer exists -
ExistsItem
Returns true if the specified item exists -
GetCustomerByCustomAttribute
Returns the Customer data for the specified custom attribute. -
addARReceipt
After adding Sales Order, call this routine to add a receipt -
addCall
This function will add a Service Call. Caller length: 255, Description length: 2048, optPONumber length: 15 -
addCall2
This function will add a Service Call (using call object) -
addChargeAccount
Adds a new charge account related to a supported vault provider. -
addContact
Adds a new contact. -
addCustomer
Adds a new customer. -
addEquipmentMeterReadings
This function add/update the meter readings for the specified meter reading group. -
addEquipmentMeterReadings2
This function add/update the meter readings for the specified meter reading group. The optIgnoreCheck value can be used to suppress the check on the validity of the ready values - this is intended to be used when the value is submitted directly from the device. -
addGLJournal
Post a GLJournal entry. Amount: - If credit, + if debit. If this tag has a valid value it will override the CreditAmount and/or DebitAmount values. -
addItem
This function will add an Item to the e-automate database. Before an attempt to add an item is made consumer should make sure that the Item does not already exist. The ItemNumber must be unique. -
addItem2
This function will add an Item to the e-automate database (uses the ItemData object) -
addItemVendor
This function will add an Item/Vendor reference) -
addPart
This function will add a Part type Item to the e-automate database. Before an attempt to add an item is made consumer should make sure that the Item does not already exist. The ItemNumber must be unique. -
addPurchaseOrder
This function will add a Purchase Order with the data supplied. The return value will contain the new PurchaseOrderID. -
addPurchaseOrderReceipt
This function will add a PO Receipt for the specified Purchase Order. -
addPurchaseOrderReceiptAndVoucher
This function will add a PO Receipt for the specified Purchase Order. -
addPurchaseOrderVoucher
This function will create a PO Voucher for the specified Purchase Order. -
addResupplyNotificationOrders
This function adds a Sales Order and Purchase Order from a resupply notification and returns the POMajor. -
addSalesOrder
This function will add a Sales Order with the data supplied. The result data from this function will be in the same format as the input parameters and contain the new SalesOrderID in the SalesOrder.SalesOrderNumber.ID field. -
addSalesQuote
Adds a new sales quote. -
addShipment
This function will add a Shipment record with the data supplied. The result data from this function will be in the same format as the input parameters and contain the new Shipment and FulFillment values. -
addSupply
This function will add a Supply type Item to the e-automate database. Before an attempt to add an item is made consumer should make sure that the Item does not already exist. The ItemNumber must be unique. -
addTechToTechItemTransfer
Inserts a new tech-to-tech item transfer between the specified technicians with the specified item and quantity. -
addUnit
Inserts a new unit. -
addVendor
This function will add a Vendor with the data supplied. The result data from this function will be in the same format as the input parameters and contain the new VendorID. -
addWhsToTechItemTransfer
Adds a Whs to tech item transfer to the specified technician. -
applyARReceiptPayment
Apply unapplied Payment -
autoReceivePurchaseOrder
This function will auto receive a Purchase Order and return the receiptID. -
checkConfig
Returns the current configuration information. -
defaultSalesRepSetting
This will return the default sales rep that may br used for Sales Orders. -
genericItemForSalesSetting
This setting will specify the Item number to be used on Sales Orders placed through the PIP when the function ItemUsageForSalesSetting returns a value of 'GENERIC' -
getAPIVersion
Returns the current API version. -
getAPVoucherApplications
This function will return a list of AP Voucher Applications for a specified Voucher Number. -
getAPVoucherApplicationsByDate
This function will return a list of AP Voucher Applications for a specified date range. -
getAndApplyUnappliedPaymentsReadyToApply
Call this at end of period to get AND apply all unapplied payments that are ready to apply. This API call combines getUnappliedPaymentsReadyToApply and applyARReceiptPayment into one call -
getBillCode
Return the information for the specified BillCode. -
getBillCodeList
Returns the list of BillCodes. -
getBin
Return the bin information for the specified bin. -
getBinList
Returns the bins that have been updated since the specified time. -
getBinListForWarehouse
Returns the bins that are assigned to specified Warehouse. -
getCall
Returns the call information for the specified call number. -
getCallList
Returns all of the call data that's been updated since the specified time. -
getCallListForEquipment
Returns the calls for the specified equipment that have been updated since the specified time. -
getCallListForWorkOrder
Returns the calls for the specified work order that have been updated since the specified time. -
getCallStatusList
Returns the call status that have been updated since the specified time. -
getCallType
Returns the call type information for the specified call type. -
getCallTypeList
Returns the call types that have been updated since the specified time. -
getCancelCodeList
Returns the cancel codes that have been updated since the specified time. -
getCategory
Returns the category information for the specified category code. -
getCategoryList
Returns the categories that have been updated since the specified time. -
getChargeAccount
Returns details for the specified charge account. -
getChargeAccountListForCustomer
Returns a list of charge accounts for the specified Customer. -
getCompanyCustomer
This function retrieves the Main Branch Company Customer Settings. -
getCompanyIDByDBName
Returns the company name from the DBName version. -
getContact
Returns the details for the specified Contact. -
getContactDataList
Returns a Contact Data list. The returned list contains all Contact data, based on the list of contact IDs, since the previous timestamp. -
getContactList
Returns a list of Contacts. -
getContactListForCustomer
Returns a list of Contacts for the specified Customer. -
getContract
Returns the details for the specified Contract. -
getContractByBillGroup
Returns the extended details for contracts by BillGroup -
getContractForLeaseUploader
Returns LeaseUploaderContractData for the specified ContractID. -
getContractLease
Returns the details for the specified ContractLease. -
getContractLeaseList
Returns a list of ContractLeases for a specified Date. -
getContractLeaseListForCustomer
Returns a list of ContractLeases for the specified Customer. -
getContractList
Returns a list of Contracts for a specified Date. -
getContractListForCustomer
Returns a list of Contracts for the specified Customer. -
getCurrentTimeStamp
Returns the server's current time. -
getCustomer
Returns the Customer data for the specified customer number. -
getCustomerDataList
Returns a Customer Data array. The returned list contains Customer data based on the list of customer IDs. -
getCustomerList
Returns a Customer list. The returned list contains any new or updated Customers since the previous timestamp. -
getCustomerPOPInfo
Returns custom information of Customer for PO Processor -
getCustomersByName
This function retrieves an array of the complete Customer Data for any Customer matching the CustomerName supplied. -
getCustomersWithEquipOnContract
Returns a Customer Data array. The returned list contains only customers that have equipment on contract -
getDeliveryMethodList
Returns the delivery methods. -
getEquipment
Returns equipment data for the specified equipment number. -
getEquipmentCode
Returns the equipment code information based on the specified equipment code. -
getEquipmentCodeList
Returns the equipment codes that have been updated since the specified time. -
getEquipmentFromSerialNumber
Returns the equipment information from the specified parameters. Make and Model are optional fields. -
getEquipmentList
Returns a list of equipment that's been updated since the specified time. -
getEquipmentListForCustomer
Returns a list of equipment for the specified customer that's been updated since the specified time. -
getEquipmentTrackingConfig
Returns the specified equipment tracking config data. -
getEquipmentTrackingConfigList
Returns the equipment tracking configs (TimeStamp is reserved - not used at this time). -
getEquipmentsByNumber
This function retrieves an array of the complete Customer Data for any Customer matching the CustomerName supplied. -
getEquipmentsFromSerialNumber
Returns all equipment records matching the information from the specified parameters. Make and Model are optional fields. -
getEquipmentsFromSerialNumbers
Returns a list of equipments based on the specified list of serial numbers. -
getExpenseCodeList
Returns the list of expense codes. -
getExportModule
Returns the ExportModule data for the specified ModuleID or ModuleName. -
getGLBranch
Returns the GLBranch information for the specified branch. -
getGLBranchList
Returns all branches that have been updated since the specified time. -
getGroupedInventoryInfo
Returns all of the grouped inventory information. -
getGroupedInventoryInfoForWarehouse
Returns all of the grouped inventory information for the specified warehouse. -
getHoldCodeList
Returns the hold codes that have been updated since the specified time. -
getHostItemList
Returns all the Hosts. -
getIncompleteCodeList
Returns the incomplete codes that have been updated since the specified time. -
getInventoryCode
Returns the inventory code information based on the specified inventory code. -
getInventoryCodeList
Returns the inventory codes that have been updated since the specified time. -
getInventoryForItem
Returns the inventory summary for the specified item. -
getInventoryForItemWarehouse
Returns item inventory summary for the specified warehouse. -
getItem
Returns the item information for the specified item. -
getItemByMakeModelOEMVendorNum
Returns the item information for the specified item. -
getItemList
Returns all items that have been updated since the specified time. -
getItemListEx
Returns all items that match specified criteria since the specified time. -
getItemOutCost
Returns the item cost information for the specified item. -
getItemPrice
Returns the item price information for the specified item. -
getItemVendorList
Returns the item vendor list data for the specified item, since the specified time. -
getLatestPurchaseOrderRevisionByPOMajor
This function will return the data for the latest revision of the specified Purchase Order. -
getMake
Returns the make information for the specified made code. -
getMakeList
Returns the makes that have been updated since the specified time. -
getMappedShipMethods
This function returns all of the ship methods that have been mapped with Vendor Connector ship via codes, limiting them to a Vendor Connector Vendor Name if supplied. -
getMappedVendor
This function retrieves a matched vendor based on its Vendor Connector name. -
getMatchedVendor
This function retrieves the list of matched VC/EA vendors -
getMeterDueCount
Returns the meter due count for the specified customer. -
getMeterDueCustomerList
Returns a Customer list with meters due. -
getMeterDueList
Returns the meter due summary for the specified customer. -
getMeterSource
Returns the meter source information for the specified meter source. -
getMeterSourceList
Returns the meter sources that have been updated since the specified time. -
getMeterType
This function will return the Meter Data for the specified Meter Type. -
getMeterTypeList
This function will return a list of Meter Types. -
getModel
Return the model information for the specified model code. -
getModelByMake
Return the model information for the specified model code. -
getModelCategoryList
Returns the list of model categories. -
getModelList
Returns the models that have been updated since the specified time. -
getNextPONumber
This will return the next POMajor value for pending PO submissions -
getOnHoldCode
Returns the on hold code information for the specified on hold code. -
getOnHoldCodeList
Returns the on hold codes that have been updated since the specified time. -
getOpenCallList
Returns all open call data that's been updated since the specified time. -
getOpenCallListForEquipment
Returns the open calls for the specified equipment that have been updated since the specified time. -
getOpenPhysicalInventorySummary
Returns the physical inventory with open statuses. -
getPIPInternalURL
Returns the internal URL of the Public API. -
getPOCoreOrder
Returns the core order for the given poNumber. -
getPOItem
Returns the item information for the specified PO item. -
getPartnerConnectorAuth
Returns the URL and Credentials for the Partner Connector -
getPriorityCode
Returns the priority information based on the specified Priority. -
getPriorityList
Returns the priority codes that have been updated since the specified time. -
getProblemCodeList
Returns the problem codes that have been updated since the specified time. -
getPurchaseOrder
This function will return the specified Purchase Order data. -
getPurchaseOrderBillToByCustomProperty
This needs to be provided. -
getPurchaseOrderList
This function will return a list of Purchase Orders. -
getPurchaseOrderListBySentId
This function will return a list of Purchase Orders using time and the sent id. Sent = 1, Unsent = 0 -
getPurchaseOrderListForSalesOrder
This function will return a list of Purchase Orders related to the specified Sales Order. -
getPurchaseOrderShipViaCode
This function will return the specified Purchase Order data. -
getPurchaseOrders
This function will return the specified Purchase Order(s) data. -
getPurchaseOrdersAwaitingShipment
This function grabs all Purchase Orders that haven't been shipped yet (Only returns PONumbers and VendorNames). -
getPurchaseOrdersByVendor
This function will return a list of open Purchase Orders for the specified vendor. -
getPurchaseOrdersReceivableByVendor
This function will return a list of receivable Purchase Orders for the specified vendor. -
getRelatedItemsForEquipment
Returns the related items for the equipment specified. Related items must be e-info enabled. -
getRelatedItemsList
Returns all items that are releated to the passed in item. -
getRepairCodeList
Returns the repair codes that have been updated since the specified time. -
getSHAttribute
Gets the ShAttributes for Managed Network (Shockey Monkey/n-able -
getSOShipment
Returns all of the shipments for a given Sales Order. -
getSalesCode
Returns the sales code information for the specified sales code. -
getSalesCodeList
Returns the sales codes that have been updated since the specified time. -
getSalesInvoice
Get Sales Invoice -
getSalesInvoiceListByOrderType
Get list of Sales Invoices by Sales Order Type -
getSalesOrder
This function will return the details for the Sales Order specified. -
getSalesOrderList
Returns the sales order list for sales since the specified time. -
getSalesOrderListUnlinked
Returns the sales order list for unlinked (w/ PO) sales since the specified time. -
getSalesOrderStatus
Returns the sales order Status information for the specified sales order Status. -
getSalesOrderStatusList
Returns all sales order statuses that have been updated since the specified time. -
getSalesOrderType
Returns the sales order type information for the specified sales order type. -
getSalesOrderTypeList
Returns all sales order types that have been updated since the specified time. -
getSalesQuote
Returns sales quote information for the specified sales quote number. -
getSalesQuoteList
Returns all sales quotes that have been updated since the specified time. -
getSalesQuoteListForCustomer
Returns a sales quote list for the specified customer. -
getSalesRep
Returns the details for the specified SalesRep. -
getSalesRepList
Returns the list of SalesReps. -
getServerStatus
Verifies the database connection is set and that a connection can be established. -
getServerVersion
Returns the server version. -
getServiceCall
Returns the call information for the specified call number including invoiced calls details. -
getServiceCode
Returns the service code information for the specified service code. -
getServiceCodeList
Returns the service codes that have been updated since the specified timestamp. -
getShipMethod
Returns the shipment method information for the specified shipment method. -
getShipMethodList
Returns the shipment methods that have been updated since the specified time. -
getSingleTaxCodeFromSearch
Returns the single tax code information based on the specified search parameters. -
getTaxAmountFromSearch
Returns the tax amount based on the specified search parameters. -
getTaxCalculationMethod
Canadian Customers: Taxes are first calculated and rounded at the authority level. US Customers: Taxes are first calculated and rounded at the authority level. These taxes are summed up and compared to the totals times the tax rates. If there is a difference (because of rounding) the amount is adjusted from the authority with the greatest tax amount. -
getTaxCode
Returns the tax code information for the specified tax code. -
getTaxCodeList
Returns the tax codes that have been updated since the specified time. -
getTaxCodeListFromSearch
Returns the tax codes based on the specified search parameters. -
getTechnician
Returns the details for the specified technician. -
getTechnicianAvailability
Returns the technician availability summary between the specified dates. -
getTechnicianBin
Returns the technician bin for the specified technician. -
getTechnicianBranch
Returns the technician branch for the specified technician. -
getTechnicianBranchWarehouse
Returns the technician branch warehouse for the specified technician. -
getTechnicianList
Returns the list of technicians. -
getTerm
Returns the term information for the specified term code. -
getTermList
Returns the terms that have been updated since the specified time. -
getTerritoryCode
Returns the Territory information based on the specified Territory. -
getTerritoryList
Returns the Territory codes that have been updated since the specified time. -
getUnappliedPaymentsReadyToApply
Call this at end of period to get all unapplied payments that are ready to apply -
getUnit
Returns the unit data for the specified unit. -
getUnitList
Returns the unit list since the specified time. -
getUser
Returns the details for the specified User. -
getUserList
Returns a list of active Users. -
getVendor
This function retrieves the complete Vendor Data for the Vendor Number Supplied. The input parameter may contain the Vendor ID given in the (ID) field and/or Vendor Number given in the (Code) Field. -
getVendorConnectorAuth
Returns the URL and Credentials for the Vendor Connector -
getVendorList
This function retrieves a list of Vendor Numbers. If the Timestamp is given then only the Vendor records that have been added or updated since the timestamp will be returned. -
getVendorShipMethod
Returns the default ship method for the specified vendor. -
getVendorsByName
This function retrieves an array of the complete Vendor Data for any Vendor matching the VendorName supplied. -
getVoucherExists
This function determines whether or not a voucher with the specified invoice number has already been added. -
getVoucherList
This function will return a list of Purchase Orders. -
getWarehouse
Returns the warehouse information for the specified warehouse. -
getWarehouseList
Returns the warehouses that have been updated since the specified time. -
insertContractUploaderMenuLinks
Inserts right-mouse menu links for Contract Uploader. -
insertMenuLinks
Inserts right-mouse menu links for POP. -
insertPOPMenuLinks
Inserts the right-click menu links for POP and the PO Export Module -
insertServiceUploaderMenuLinks
Inserts right-mouse menu links for Contract Uploader. -
itemUsageForSalesSetting
This function will specify how the eautomate customer wants to enter details into Sales Orders. It will return one of two values 'GENERIC' or 'ADDITEM'. GENERIC: Each line item on a sales order will use the same Item Number. The description for these Items will be changed to match what is actually being purchased. Use GenericItemForSalesSetting to get the generic Item Number to use in this case. ADDITEM: All Items will be insterted into eautomate before being added to a Sales order if they don't already exist in the e-automate database. -
markCallComplete
Marks the specified call as complete on the specified close date. -
saveCall
Updates the specified call. -
saveContact
This function will save any changes that exist between the Contact data supplied and what is stored in the database. -
saveCustomer
This function will save any changes that exist between the Customer data supplied and what is stored in the database. -
saveEquipment
Updates the specified equipment. -
saveItem
Updates the specified item. -
saveItemVendor
Updates the specified item/vendor relationship. -
saveMappedVendor
This function will save (or insert) a Vendor Connector / e-a mapped vendor. -
saveMatchedVendor
This function will save any changes that exist between the Vendor data supplied and what is stored in the database. -
saveModel
Updates the information for the specified Model. -
savePurchaseOrder
This function will save any changes that exist between the Purchase Order data supplied and what is stored in the database. -
saveSalesOrder
This function will save any changes that exist between the Sales Order data supplied and what is stored in the database. -
saveVendor
This function will save any changes that exist between the Vendor data supplied and what is stored in the database. -
setCallClosed
Sets the specified call as closed with the option to reschedule. -
setCallDispatched
Sets the specified call as dispatched to the specified technician. -
setCallTechnician
Assigns the specified call to the specified technician. -
setCallUndispatched
Sets the specified call as undispatched from the specified technician. -
setExportModule
Inserts or updates an ExportModule, depending on whether or not the ExportModuleID was supplied. -
setMappedShipMethods
This method removes all of the old ship method mappings to the vendor connector ship via codes and adds the passed parameter as the new set, limiting them to a Vendor Connector Vendor Name if supplied. -
setPIPInternalURL
Sets the internal URL of the Public API. -
setPODetailPrice
This function updates the price of the specified PODetail. -
setPartnerConnectorAuth
Updates the URL and Credentials for the Partner Connector -
setPhysicalInventoryCounts
Updates the physical counts. -
setPurchaseOrderRemarks
This function sets the remarks field on the specified Purchase Order -
setTechGPSPoint
Sets the specified tech's GPS point. -
setVendorConnectorAuth
Updates the URL and Credentials for the Vendor Connector -
setVendorItemCost
Sets the cost of an item for a specific vendor. -
setVendorShipMethod
Sets the default ship method for the specified vendor. If both ID and Code are invalid, NULL is entered. -
updatePOToPlaced
This function updates the specified PO to show that it was placed, and can take a confirmation number if it's available (if it's not, just leave it empty).