SalesPad API Help Page

Index of Business Objects

APDistribution APIGridLayout APIGroupPermission APIObjectPermission APIPrintingPermissions APIPropertyPermission APIRecentItem APIRequiredFields APISalesDocumentPermissions APISystemSetting APIUserCustomer APIUserCustomerInfo APIVisualPermission APTransaction ARTransaction ARTransactionHistory ARTransactionOpen Batch CashApplication CashReceipt CashReceiptCreditCardPayment CompanyInfo ConfigAttribute ConfigDynamicItem ConfigDynamicItemCondition ConfigOption ConfiguredItem ConfiguredSalesLineItem ConfigVersion CountryCode CRMNote Currency Customer CustomerAddr CustomerAR CustomerARDetail CustomerClass CustomerGroupPricing CustomerItemClassPriceLevel CustomerSearch Download GetInventorySearch GLAccount GLDistribution GLTransaction GroupPermission GroupPricing GroupPricingCustomerDetail GroupPricingDetail GroupPricingItemDetail InventoryByLoc InventoryLotNum InventoryMultibin InventorySearch InventorySerialNum ItemClass ItemMaster ItemPriceList LicensePlate LicensePlateDetail Location LogException ManufacturingBOM PayFabricTransaction PayLinkPaymentComplete PaymentTerm PriceLevel Print PurchaseLineItem PurchaseOrder QuickPick SalesBatch SalesComment SalesDocument SalesDocumentHistory SalesDocumentHold SalesDocumentID SalesDocumentLock SalesDocumentPayment SalesDocumentSearch SalesDocumentSearch_Light SalesDocumentTrackingNumber SalesFulfillment SalesHold SalesLineItem SalesLineItemHistory SalesLineItemSearch SalesLineLotNum SalesRep SalesTaxDetail SalesTaxSchedule SalesTerritory Schema ServiceTransfer ServiceTransferHistory ServiceTransferLine ServiceTransferLineHistory ServiceTransferLineSearch ServiceTransferLock ServiceTransferSearch Session ShippingHeader ShippingMethod Stepper SystemGroup SystemUser SystemUserField SystemUserMembership UOfM UOfMSchedule UOfMScheduleDetail VersionInfo Workflow WorkflowQueue

APDistribution

CRUD operations for APDistribution

API	Description
GET api/APDistribution	ODATA enabled get APDistribution requests.
GET api/APDistribution/{Voucher_Number}/{Control_Type}/{Distribution_Sequence_Number}	Get APDistribution requests.
POST api/APDistribution	Create APDistribution objects

APIGridLayout

CRUD operations for APIGridLayout

API	Description
GET api/APIGridLayout	ODATA enabled get APIGridLayout requests.
GET api/APIGridLayout/{UserName}/{GridType}/{GridID}	Get APIGridLayout requests.
POST api/APIGridLayout	Create APIGridLayout objects
PUT api/APIGridLayout/{UserName}/{GridType}/{GridID}	Update APIGridLayout objects
DELETE api/APIGridLayout/{UserName}/{GridType}/{GridID}	Delete APIGridLayout objects

APIGroupPermission

CRUD operations for APIGroupPermission

API	Description
GET api/APIGroupPermission	ODATA enabled get APIGroupPermission requests.
GET api/APIGroupPermission/{GroupName}	Get APIGroupPermission requests.
POST api/APIGroupPermission	Create APIGroupPermission objects
PUT api/APIGroupPermission/{GroupName}	Update APIGroupPermission objects
DELETE api/APIGroupPermission/{GroupName}	Delete APIGroupPermission objects

APIObjectPermission

CRUD operations for APIObjectPermission

API	Description
GET api/APIObjectPermission	ODATA enabled get APIObjectPermission requests.
GET api/APIObjectPermission/{GroupName}/{ObjectName}	Get APIObjectPermission requests.
POST api/APIObjectPermission	Create APIObjectPermission objects
PUT api/APIObjectPermission/{GroupName}/{ObjectName}	Update APIObjectPermission objects
DELETE api/APIObjectPermission/{GroupName}/{ObjectName}	Delete APIObjectPermission objects
PUT api/APIObjectPermission/Bulk	Create/Update APIObjectPermission objects in bulk

APIPrintingPermissions

CRUD operations for APIPrintingPermissions

API	Description
GET api/APIPrintingPermissions	ODATA enabled get APIPrintingPermissions requests.
GET api/APIPrintingPermissions/{GroupName}/{Report_ID}	Get APIPrintingPermissions requests.
POST api/APIPrintingPermissions	Create APIPrintingPermissions objects
PUT api/APIPrintingPermissions/{GroupName}/{Report_ID}	Update APIPrintingPermissions objects
DELETE api/APIPrintingPermissions/{GroupName}/{Report_ID}	Delete APIPrintingPermissions objects
PUT api/APIPrintingPermissions/Bulk	Create/Update APIPrintingPermissions objects in bulk

APIPropertyPermission

CRUD operations for APIPropertyPermission

API	Description
GET api/APIPropertyPermission	ODATA enabled get APIPropertyPermission requests.
GET api/APIPropertyPermission/{GroupName}/{ObjectName}/{PropertyName}	Get APIPropertyPermission requests.
POST api/APIPropertyPermission	Create APIPropertyPermission objects
PUT api/APIPropertyPermission/{GroupName}/{ObjectName}/{PropertyName}	Update APIPropertyPermission objects
DELETE api/APIPropertyPermission/{GroupName}/{ObjectName}/{PropertyName}	Delete APIPropertyPermission objects
PUT api/APIPropertyPermission/Bulk	Create/Update APIPropertyPermission objects in bulk

APIRecentItem

CRUD operations for APIRecentItem

API	Description
GET api/APIRecentItem	ODATA enabled get APIRecentItem requests.
GET api/APIRecentItem/{ItemID}	Get APIRecentItem requests.
PUT api/APIRecentItem/{ItemID}	Update APIRecentItem if it exists, or create APIRecentItem if it doesn't exist
DELETE api/APIRecentItem/{ItemID}	Delete APIRecentItem objects

APIRequiredFields

CRUD operations for APIRequiredFields

API	Description
GET api/APIRequiredFields	ODATA enabled get APIRequiredFields requests.
GET api/APIRequiredFields/{BusinessObject}/{SecurityGroup}/{FieldName}	Get APIRequiredFields requests.
POST api/APIRequiredFields	Create APIRequiredFields objects
DELETE api/APIRequiredFields/{BusinessObject}/{SecurityGroup}/{FieldName}	Delete APIRequiredFields objects
POST api/APIRequiredFields/Bulk	Create APIRequiredFields objects in bulk
DELETE api/APIRequiredFields/Bulk	Delete APIRequiredFields objects in bulk

APISalesDocumentPermissions

CRUD operations for APISalesDocumentPermissions

API	Description
GET api/APISalesDocumentPermissions	ODATA enabled get APISalesDocumentPermissions requests.
GET api/APISalesDocumentPermissions/{GroupName}/{Sales_Doc_Type}/{Sales_Doc_Id}	Get APISalesDocumentPermissions requests.
POST api/APISalesDocumentPermissions	Create APISalesDocumentPermissions objects
PUT api/APISalesDocumentPermissions/{GroupName}/{Sales_Doc_Type}/{Sales_Doc_Id}	Update APISalesDocumentPermissions objects
DELETE api/APISalesDocumentPermissions/{GroupName}/{Sales_Doc_Type}/{Sales_Doc_Id}	Delete APISalesDocumentPermissions objects

APISystemSetting

CRUD operations for APISystemSetting

API	Description
GET api/APISystemSetting	ODATA enabled get APISystemSetting requests.
GET api/APISystemSetting/{ApiKey}	Get APISystemSetting requests.
POST api/APISystemSetting	Create APISystemSetting objects
PUT api/APISystemSetting/{ApiKey}	Update APISystemSetting objects
DELETE api/APISystemSetting/{ApiKey}	Delete APISystemSetting objects

APIUserCustomer

CRUD operations for APIUserCustomer

API	Description
GET api/APIUserCustomer	ODATA enabled get APIUserCustomer requests.
GET api/APIUserCustomer/{UserName}/{CustomerNum}/{ShipTo}	Get APIUserCustomer requests.
POST api/APIUserCustomer	Create APIUserCustomer objects
DELETE api/APIUserCustomer/{UserName}/{CustomerNum}/{ShipTo}	Delete APIUserCustomer objects

APIUserCustomerInfo

Retrieve APIUserCustomer with Customer Information

API	Description
GET api/APIUserCustomerInfo/{UserName}/{CustomerNum}/{ShipTo}	GET APIUserCustomer with Customer Information

APIVisualPermission

CRUD operations for APIVisualPermission

API	Description
GET api/APIVisualPermission	ODATA enabled get APIVisualPermission requests.
GET api/APIVisualPermission/{GroupName}/{PropertyName}	Get APIVisualPermission requests.
POST api/APIVisualPermission	Create APIVisualPermission objects
PUT api/APIVisualPermission/{GroupName}/{PropertyName}	Update APIVisualPermission objects
DELETE api/APIVisualPermission/{GroupName}/{PropertyName}	Delete APIVisualPermission objects
PUT api/APIVisualPermission/Bulk	Create/Update APIVisualPermission objects in bulk

APTransaction

CRUD operations for APTransaction

API	Description
GET api/APTransaction	ODATA enabled get APTransaction requests.
GET api/APTransaction/{Transaction_Type}/{Transaction_Number}	Get APTransaction requests.
POST api/APTransaction	Create APTransaction objects
POST api/APTransaction/WithArguments	Creates an APTransaction with additional arguments, such as if distributions should be auto-created.

ARTransaction

CRUD operations for ARTransaction

API	Description
GET api/ARTransaction	ODATA enabled get ARTransaction requests.
GET api/ARTransaction/{Transaction_Number}/{Transaction_Type}	Get ARTransaction requests.
POST api/ARTransaction	Create ARTransaction objects

ARTransactionHistory

CRUD operations for ARTransactionHistory

API	Description
GET api/ARTransactionHistory	ODATA enabled get ARTransactionHistory requests.
GET api/ARTransactionHistory/{Transaction_Number}/{Transaction_Type}	Get ARTransactionHistory requests.

ARTransactionOpen

CRUD operations for ARTransactionOpen

API	Description
GET api/ARTransactionOpen	ODATA enabled get ARTransactionOpen requests.
GET api/ARTransactionOpen/{Transaction_Number}/{Transaction_Type}	Get ARTransactionOpen requests.

Batch

CRUD operations for Batch

API	Description
GET api/Batch	ODATA enabled get Batch requests.
GET api/Batch/{Batch_Source}	Get Batch requests.

CashApplication

CRUD operations for CashApplication

API	Description
GET api/CashApplication	ODATA enabled get CashApplication requests.
GET api/CashApplication/{Apply_To_Document_Number}/{Apply_To_Document_Type}/{Apply_From_Document_Number}/{Apply_From_Document_Type}	Get CashApplication requests.
POST api/CashApplication	Create CashApplication objects
PUT api/CashApplication/{Apply_To_Document_Number}/{Apply_To_Document_Type}/{Apply_From_Document_Number}/{Apply_From_Document_Type}	Update CashApplication objects
DELETE api/CashApplication/{Apply_To_Document_Number}/{Apply_To_Document_Type}/{Apply_From_Document_Number}/{Apply_From_Document_Type}	Delete CashApplication objects

CashReceipt

CRUD operations for CashReceipt

API	Description
GET api/CashReceipt	ODATA enabled get CashReceipt requests.
GET api/CashReceipt/{Document_Number}/{RM_Document_Type}	Get CashReceipt requests.
POST api/CashReceipt	Create CashReceipt objects
PUT api/CashReceipt/{Document_Number}/{RM_Document_Type}	Update CashReceipt objects
DELETE api/CashReceipt/{Document_Number}/{RM_Document_Type}	Delete CashReceipt objects
GET api/CashReceipt/GetCheckbookIDs	Get CashReceipt requests.
GET api/CashReceipt/GetCashReceiptBatches	No documentation available.
GET api/CashReceipt/GetApplicableDocuments?customerNum={customerNum}	ODATA enabled get SalesDocumentSearch requests.

CashReceiptCreditCardPayment

CRUD operations for CashReceiptCreditCardPayment

API	Description
GET api/CashReceiptCreditCardPayment	ODATA enabled get CashReceiptCreditCardPayment requests.
GET api/CashReceiptCreditCardPayment/{Document_Number}/{RM_Document_Type}	Get CashReceiptCreditCardPayment requests.
POST api/CashReceiptCreditCardPayment	Create CashReceiptCreditCardPayment objects
PUT api/CashReceiptCreditCardPayment/{Document_Number}/{RM_Document_Type}	Update CashReceiptCreditCardPayment objects
DELETE api/CashReceiptCreditCardPayment/{Document_Number}/{RM_Document_Type}	Delete CashReceiptCreditCardPayment objects

CompanyInfo

CRUD operations for CompanyInfo

API	Description
GET api/CompanyInfo	ODATA enabled get CompanyInfo requests.
GET api/CompanyInfo/{RowID}	Get CompanyInfo requests.

ConfigAttribute

CRUD operations for ConfigAttribute

API	Description
GET api/ConfigAttribute	ODATA enabled get ConfigAttribute requests.
GET api/ConfigAttribute/{Attribute_ID}	Get ConfigAttribute requests.

ConfigDynamicItem

CRUD operations for ConfigDynamicItem

API	Description
GET api/ConfigDynamicItem	ODATA enabled get ConfigDynamicItem requests.
GET api/ConfigDynamicItem/{Dynamic_Item_ID}	Get ConfigDynamicItem requests.

ConfigDynamicItemCondition

CRUD operations for ConfigDynamicItemCondition

API	Description
GET api/ConfigDynamicItemCondition	ODATA enabled get ConfigDynamicItemCondition requests.
GET api/ConfigDynamicItemCondition/{Item_Condition_ID}	Get ConfigDynamicItemCondition requests.

ConfigOption

CRUD operations for ConfigOption

API	Description
GET api/ConfigOption	ODATA enabled get ConfigOption requests.
GET api/ConfigOption/{Option_ID}	Get ConfigOption requests.

ConfiguredItem

API endpoints for ConfiguredItem

API	Description
POST api/ConfiguredItem/Validate	Validates Configuration String code representing Configured Item.
POST api/ConfiguredItem	Creates Configured Item and BOM from Configuration Code, CustomerNum, and ShipToAddressCode
PUT api/ConfiguredItem/Configuration	Returns available ConfigAttributes, ConfigOptions, ConfigLineItems, and ConfigurationString based on selected options (and restrictions set up in SalesPad) For each AttributeOptionPair, send Attribute ID and EITHER Option array: Option ID(s) for dropdowns, true/false for checkbox, or text value if textbox. OR Sub_Configuration (of AttributeOptionPairs) Send an empty AttributeOptionPairs array for original configuration (no options selected)
PUT api/ConfiguredItem/ConfigurationFromString	Returns Item Number, available Sub-Configurations, ConfigAttributes, ConfigOptions, Selections, and ConfigLineItems based on given ConfigurationString

ConfiguredSalesLineItem

SalesLineItem endpoints for Configured Line Items

API	Description
POST api/ConfiguredSalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/{Source}/AddConfiguredItem	Create ConfiguredItem, BOM (Bill of Materials), SalesLineItem from configuration. This request will also automatically create and save a BOM (Bill of Materials).
PUT api/ConfiguredSalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/{Source}/{Line_Num}/{Component_Seq_Num}/AddConfiguredItem	Update SalesLineItem from configuration. This request will also automatically create and save a BOM (Bill of Materials).
PUT api/ConfiguredSalesLineItem/ClearConfiguratorCache	No documentation available.

ConfigVersion

CRUD operations for ConfigVersion

API	Description
GET api/ConfigVersion	ODATA enabled get ConfigVersion requests.
GET api/ConfigVersion/{Item_Number}	Get ConfigVersion requests.

CountryCode

CRUD operations for CountryCode

API	Description
GET api/CountryCode	ODATA enabled get CountryCode requests.
GET api/CountryCode/{Country_Code}	Get CountryCode requests.

CRMNote

CRUD operations for CRMNote

API	Description
GET api/CRMNote	ODATA enabled get CRMNote requests.
GET api/CRMNote/{Note_ID}	Get CRMNote requests.
POST api/CRMNote	Create CRMNote objects
PUT api/CRMNote/{Note_ID}	Update CRMNote objects
DELETE api/CRMNote/{Note_ID}	Delete CRMNote objects

Currency

CRUD operations for Currency

API	Description
GET api/Currency	ODATA enabled get Currency requests.
GET api/Currency/{Currency_ID}	Get Currency requests.

Customer

CRUD operations for Customer

API	Description
GET api/Customer	ODATA enabled get Customer requests.
GET api/Customer/{Customer_Num}	Get Customer requests.
GET api/Customer/{Customer_Num}/SalesDocuments	Retrieves all Open Sales Documents for the specified Customer.
POST api/Customer	Create Customer objects
PUT api/Customer/{Customer_Num}	Update Customer objects
POST api/Customer/CustomerAndAddress	Create Customer object and Customer Address

CustomerAddr

CRUD operations for CustomerAddr

API	Description
GET api/CustomerAddr	ODATA enabled get CustomerAddr requests.
GET api/CustomerAddr/{Customer_Num}/{Address_Code}	Get CustomerAddr requests.
POST api/CustomerAddr	Create CustomerAddr objects
PUT api/CustomerAddr/{Customer_Num}/{Address_Code}	Update CustomerAddr objects
DELETE api/CustomerAddr/{Customer_Num}/{Address_Code}	Delete CustomerAddr objects
GET api/CustomerAddr/{Customer_Num}/AddressCode	Get Customer Address Codes.

CustomerAR

CRUD operations for CustomerAR

API	Description
GET api/CustomerAR	ODATA enabled get CustomerAR requests.
GET api/CustomerAR/{Customer_Num}/{Seq}	Get CustomerAR requests.

CustomerARDetail

CRUD operations for CustomerARDetail

API	Description
GET api/CustomerARDetail	ODATA enabled get CustomerARDetail requests.
GET api/CustomerARDetail/{Doc_Type}/{Doc_Num}	Get CustomerARDetail requests.

CustomerClass

CRUD operations for CustomerClass

API	Description
GET api/CustomerClass	ODATA enabled get CustomerClass requests.
GET api/CustomerClass/{Customer_Class}	Get CustomerClass requests.

CustomerGroupPricing

CRUD operations for CustomerGroupPricing

API	Description
GET api/CustomerGroupPricing	ODATA enabled get CustomerGroupPricing requests.
GET api/CustomerGroupPricing/{CustomerDetail_ID}	Get CustomerGroupPricing requests.

CustomerItemClassPriceLevel

CRUD operations for CustomerItemClassPriceLevel

API	Description
GET api/CustomerItemClassPriceLevel	ODATA enabled get CustomerItemClassPriceLevel requests.
GET api/CustomerItemClassPriceLevel/{Customer_Num}/{Item_Class}/{Price_Level}	Get CustomerItemClassPriceLevel requests.

CustomerSearch

CRUD operations for CustomerSearch

API	Description
GET api/CustomerSearch	ODATA enabled get CustomerSearch requests.
GET api/CustomerSearch/{Customer_Num}/{Addr_Code}	Get CustomerSearch requests.

Download

Operations for file downloads

API	Description
GET api/Download	Download UDF file attachment. QueryString must be provided with 'entity' and 'udf' values, all other key/values will be assumed to be primary keys for loading the correct object from the database.

GetInventorySearch

API	Description
PUT api/GetInventorySearch	Executes sppGetInventorySearch stored procedure and returns results

GLAccount

CRUD operations for GLAccount

API	Description
GET api/GLAccount	ODATA enabled get GLAccount requests.
GET api/GLAccount/{Account_Index}/{Account_Number}	Get GLAccount requests.
POST api/GLAccount	Create GLAccount objects
PUT api/GLAccount/{Account_Index}/{Account_Number}	Update GLAccount objects
DELETE api/GLAccount/{Account_Index}/{Account_Number}	Delete GLAccount objects

GLDistribution

CRUD operations for GLDistribution

API	Description
GET api/GLDistribution	ODATA enabled get GLDistribution requests.
GET api/GLDistribution/{Journal_Entry}/{Sequence_Line}	Get GLDistribution requests.
POST api/GLDistribution	Create GLDistribution objects

GLTransaction

CRUD operations for GLTransaction

API	Description
GET api/GLTransaction	ODATA enabled get GLTransaction requests.
GET api/GLTransaction/{Batch_Number}/{Batch_Source}/{Journal_Entry}	Get GLTransaction requests.
POST api/GLTransaction	Create GLTransaction objects

GroupPermission

CRUD operations for GroupPermission

API	Description
GET api/GroupPermission	ODATA enabled get GroupPermission requests.
GET api/GroupPermission/{Security_Group}	Get GroupPermission requests.

GroupPricing

CRUD operations for GroupPricing

API	Description
GET api/GroupPricing	ODATA enabled get GroupPricing requests.
GET api/GroupPricing/{Group_ID}	Get GroupPricing requests.
POST api/GroupPricing	Create GroupPricing objects
PUT api/GroupPricing/{Group_ID}	Update GroupPricing objects
DELETE api/GroupPricing/{Group_ID}	Delete GroupPricing objects

GroupPricingCustomerDetail

CRUD operations for GroupPricingCustomerDetail

API	Description
GET api/GroupPricingCustomerDetail	ODATA enabled get GroupPricingCustomerDetail requests.
GET api/GroupPricingCustomerDetail/{CustomerDetail_ID}	Get GroupPricingCustomerDetail requests.
POST api/GroupPricingCustomerDetail	Create GroupPricingCustomerDetail objects
PUT api/GroupPricingCustomerDetail/{CustomerDetail_ID}	Update GroupPricingCustomerDetail objects
DELETE api/GroupPricingCustomerDetail/{CustomerDetail_ID}	Delete GroupPricingCustomerDetail objects

GroupPricingDetail

CRUD operations for GroupPricingDetail

API	Description
GET api/GroupPricingDetail	ODATA enabled get GroupPricingDetail requests.
GET api/GroupPricingDetail/{ItemDetail_ID}	Get GroupPricingDetail requests.

GroupPricingItemDetail

CRUD operations for GroupPricingItemDetail

API	Description
GET api/GroupPricingItemDetail	ODATA enabled get GroupPricingItemDetail requests.
GET api/GroupPricingItemDetail/{ItemDetail_ID}	Get GroupPricingItemDetail requests.
POST api/GroupPricingItemDetail	Create GroupPricingItemDetail objects
PUT api/GroupPricingItemDetail/{ItemDetail_ID}	Update GroupPricingItemDetail objects
DELETE api/GroupPricingItemDetail/{ItemDetail_ID}	Delete GroupPricingItemDetail objects

InventoryByLoc

CRUD operations for InventoryByLoc

API	Description
GET api/InventoryByLoc	ODATA enabled get InventoryByLoc requests.
GET api/InventoryByLoc/{Item_Number}/{Location}	Get InventoryByLoc requests.

InventoryLotNum

CRUD operations for InventoryLotNum

API	Description
GET api/InventoryLotNum	ODATA enabled get InventoryLotNum requests.
GET api/InventoryLotNum/{Item_Number}/{Location}/{Date_Received}/{Qty_Type}	Get InventoryLotNum requests.

InventoryMultibin

CRUD operations for InventoryMultibin

API	Description
GET api/InventoryMultibin	ODATA enabled get InventoryMultibin requests.
GET api/InventoryMultibin/{Item_Number}/{Location}/{Bin}/{Qty_Type}	Get InventoryMultibin requests.

InventorySearch

CRUD operations for InventorySearch

API	Description
GET api/InventorySearch	ODATA enabled get InventorySearch requests.
GET api/InventorySearch/{Item_Number}	Get InventorySearch requests.
GET api/InventorySearch/Aggregated	ODATA enabled GET aggregated InventorySearch requests - returns inventory totals for all locations. (This is equivalent to GET api/InventorySearch?$filter=Location eq '')
GET api/InventorySearch/AggregatedMultiLoc	ODATA enabled GET aggregated InventorySearch requests - returns inventory totals for multiple locations. This is meant to work in conjunction with inventory search filter scripts that use specific locations.

InventorySerialNum

CRUD operations for InventorySerialNum

API	Description
GET api/InventorySerialNum	ODATA enabled get InventorySerialNum requests.
GET api/InventorySerialNum/{Item_Number}/{Location}/{Qty_Type}	Get InventorySerialNum requests.

ItemClass

CRUD operations for ItemClass

API	Description
GET api/ItemClass	ODATA enabled get ItemClass requests.
GET api/ItemClass/{Item_Class}	Get ItemClass requests.

ItemMaster

CRUD operations for ItemMaster

API	Description
GET api/ItemMaster	ODATA enabled get ItemMaster requests.
GET api/ItemMaster/{Item_Number}	Get ItemMaster requests.
POST api/ItemMaster	Create ItemMaster objects
PUT api/ItemMaster/{Item_Number}	Update ItemMaster objects
GET api/ItemMaster/{Item_Number}/UofM	GETs Unit Of Measure Schedule Details for specified item.
POST api/ItemMaster/{Item_Number}/{New_Item_Number}/Copy	Copy existing Item to new Item and update from ItemMaster body before saving. 'CopyFlags' is an optional header for setting flags to also copy the following related Business Objects. Multiple flags should use a pipe delimiter ('\|'). Available Flags: CopyStandardPricing CopyCustomerItemNumbers CopyVendorItems CopyWarehouses CopyKitComponents CopyVendorSpecialCosting OR All - Copy all of the above CopyFlags can also be passed in URL Parameters: ex/ [...]/Copy?CopyFlags=CopyStandardPricing\|CopyVendorItems
GET api/ItemMaster/ItemType	GET Item types
GET api/ItemMaster/ItemTracking	GET Item tracking options

ItemPriceList

CRUD operations for ItemPriceList

API	Description
GET api/ItemPriceList	ODATA enabled get ItemPriceList requests.
GET api/ItemPriceList/{Item_Number}/{Currency_ID}/{Price_Level}/{UOfM}/{To_Qty}	Get ItemPriceList requests.

LicensePlate

CRUD operations for LicensePlate

API	Description
GET api/LicensePlate	ODATA enabled get LicensePlate requests.
GET api/LicensePlate/{License_Plate_ID}	Get LicensePlate requests.
PUT api/LicensePlate/{License_Plate_ID}	Update LicensePlate objects
DELETE api/LicensePlate/{License_Plate_ID}	Delete LicensePlate objects
POST api/LicensePlate	Create LicensePlate objects. Generates SSCC if not provided.
GET api/LicensePlate/WithDetails/{License_Plate_ID}	Gets a License Plate and License Plate Details in one http request. 'Details' is an array property for License Plate Details.
PUT api/LicensePlate/WithDetails/{License_Plate_ID}	Updates a License Plate and License Plate Details in one http request. 'Details' is an array property for License Plate Details. Note: This endpoint will not create or delete details, only update existing details. To create or delete details, use POST LicensePlateDetail or DELETE LicensePlateDetail.
POST api/LicensePlate/WithDetails	Creates a License Plate and License Plate Details in one http request. Generates SSCC if not provided. 'Details' is an array property for License Plate Details.

LicensePlateDetail

CRUD operations for LicensePlateDetail

API	Description
GET api/LicensePlateDetail	ODATA enabled get LicensePlateDetail requests.
GET api/LicensePlateDetail/{License_Plate_Detail_ID}	Get LicensePlateDetail requests.
POST api/LicensePlateDetail	Create LicensePlateDetail objects
PUT api/LicensePlateDetail/{License_Plate_Detail_ID}	Update LicensePlateDetail objects
DELETE api/LicensePlateDetail/{License_Plate_Detail_ID}	Delete LicensePlateDetail objects

Location

CRUD operations for Location

API	Description
GET api/Location	ODATA enabled get Location requests.
GET api/Location/{Location_Code}	Get Location requests.

LogException

Exception Logging

API	Description
POST api/LogException	Logs an exception to the exception logger set up in web.config.

ManufacturingBOM

CRUD operations for ManufacturingBOM

API	Description
GET api/ManufacturingBOM	ODATA enabled get ManufacturingBOM requests.
GET api/ManufacturingBOM/{Mfg_BOM_Number}/{BOM_Category}/{BOM_Type}/{BOM_Name}	Get ManufacturingBOM requests.

PayFabricTransaction

CRUD operations for PayFabricTransaction

API	Description
GET api/PayFabricTransaction	ODATA enabled get PayFabricTransaction requests.
GET api/PayFabricTransaction/{Sales_Doc_Type}/{Sales_Doc_Num}/{Seq_Number}	Get PayFabricTransaction requests.
PUT api/PayFabricTransaction/{Sales_Doc_Type}/{Sales_Doc_Num}/{Seq_Number}	Update PayFabricTransaction objects
DELETE api/PayFabricTransaction/{Sales_Doc_Type}/{Sales_Doc_Num}/{Seq_Number}	Delete PayFabricTransaction objects
POST api/PayFabricTransaction	Create PayFabricTransaction objects Master Number and Sequence Number are generated from the Sales Document instead of the request.
POST api/PayFabricTransaction/CreateTransactionLink	Creates TransactionLink URL to be used with PayFabric
POST api/PayFabricTransaction/CompleteTransaction	Accepts PayFabric response and creates SalesDocumentPayment
POST api/PayFabricTransaction/CaptureVoidCreditTransaction	Captures Void or Credit Transaction
POST api/PayFabricTransaction/AddWalletLink	Creates AddWalletLink URL to be used with PayFabric
POST api/PayFabricTransaction/GetWalletLink	Creates GetWalletLink URL to be used with PayFabric
POST api/PayFabricTransaction/GetCustomerWallet	Get CreditCards per Customer
POST api/PayFabricTransaction/DeleteCustomerWallet	Delete Wallet per Customer
GET api/PayFabricTransaction/GetPayfabricEnabled	Checks if PayFabric is Enabled

PayLinkPaymentComplete

CRUD operations for PayLinkPaymentComplete

API	Description
POST api/PayLinkPaymentComplete	Create PayFabricTransaction and SalesDocumentPayment from PayLink request

PaymentTerm

CRUD operations for PaymentTerm

API	Description
GET api/PaymentTerm	ODATA enabled get PaymentTerm requests.
GET api/PaymentTerm/{Payment_Terms}	Get PaymentTerm requests.

PriceLevel

CRUD operations for PriceLevel

API	Description
GET api/PriceLevel	ODATA enabled get PriceLevel requests.
GET api/PriceLevel/{Price_Level}	Get PriceLevel requests.

Print

API Endpoints for SalesPad Printed Reports

API	Description
GET api/Print/OutputTypes	Retrieve list of available OutputTypes
GET api/Print/Reports	Retrieve list of available reports
GET api/Print/SalesDocument/{Report_ID}/{Report_Name}/{Sales_Doc_Type}/{Sales_Doc_Num}/{Source}/{OutputType}	Retrieve specified Sales Document Printed Report OutputType is optional, defaults to 5 ('application/pdf'). (See api/Print/OutputTypes for additional OutputTypes)

PurchaseLineItem

CRUD operations for PurchaseLineItem

API	Description
GET api/PurchaseLineItem	ODATA enabled get PurchaseLineItem requests.
GET api/PurchaseLineItem/{PO_Number}/{Line_Seq}/{PO_Type}	Get PurchaseLineItem requests.
POST api/PurchaseLineItem	Create PurchaseLineItem objects
PUT api/PurchaseLineItem/{PO_Number}/{Line_Seq}/{PO_Type}	Update PurchaseLineItem objects
DELETE api/PurchaseLineItem/{PO_Number}/{Line_Seq}/{PO_Type}	Delete PurchaseLineItem objects

PurchaseOrder

CRUD operations for PurchaseOrder

API	Description
GET api/PurchaseOrder	ODATA enabled get PurchaseOrder requests.
GET api/PurchaseOrder/{PO_Number}/{PO_Type}	Get PurchaseOrder requests.
GET api/PurchaseOrder/Lock/{PO_Number}/{PO_Type}	Lock PurchaseOrder objects
DELETE api/PurchaseOrder/Lock/{PO_Number}/{PO_Type}	Unlock PurchaseOrder objects
POST api/PurchaseOrder	Create PurchaseOrder objects
GET api/PurchaseOrder/WithLines/{PO_Number}/{PO_Type}	Gets a Purchase Order and Purchase Line Items in one http request. 'LineItems' is an array property for Purchase Line Items.
PUT api/PurchaseOrder/WithLines/{PO_Number}/{PO_Type}	Updates a Purchase Order and Purchase Line Items in one http request. 'LineItems' is an array property for Purchase Line Items. Note: This endpoint will not create or delete lines, only update existing lines. To create or delete lines, use POST PurchaseLineItem or DELETE PurchaseLineItem.
POST api/PurchaseOrder/WithLines	Creates a Purchase Order and Purchase Line Items in one http request. 'LineItems' is an array property for Purchase Line Items.
PUT api/PurchaseOrder/{PO_Number}/{PO_Type}	Update PurchaseOrder objects
DELETE api/PurchaseOrder/{PO_Number}/{PO_Type}	Delete PurchaseOrder objects

QuickPick

API endpoints for QuickPick

API	Description
GET api/QuickPick	Returns QuickPick Categories at root level
GET api/QuickPick/{Category_ID}	Returns QuickPick Subcategories and Items belonging to Category requested

SalesBatch

CRUD operations for SalesBatch

API	Description
GET api/SalesBatch	ODATA enabled get SalesBatch requests.
GET api/SalesBatch/{Sales_Batch}	Get SalesBatch requests.

SalesComment

CRUD operations for SalesComment

API	Description
GET api/SalesComment	ODATA enabled get SalesComment requests.
GET api/SalesComment/{CommentID}	Get SalesComment requests.

SalesDocument

CRUD operations for SalesDocument

API	Description
GET api/SalesDocument	ODATA enabled get SalesDocument requests.
GET api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}	Get SalesDocument requests.
PUT api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}	Update SalesDocument objects
DELETE api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}	Delete SalesDocument objects
GET api/SalesDocument/Lock/{Sales_Doc_Type}/{Sales_Doc_Num}	Lock SalesDocument objects
DELETE api/SalesDocument/Lock/{Sales_Doc_Type}/{Sales_Doc_Num}	Unlock SalesDocument objects
POST api/SalesDocument	Create Sales Document objects
GET api/SalesDocument/WithLines/{Sales_Doc_Type}/{Sales_Doc_Num}	Retrieves a Sales Document and its Sales Line Items in one http request. 'LineItems' is an array property for Sales Line Items.
POST api/SalesDocument/WithLines	Creates a Sales Document and Sales Line Items in one http request. 'LineItems' is an array property for Sales Line Items. 'UpdateFlags' is an optional header for setting flags to update the document before save. Multiple flags should use a pipe delimiter ('\|'). Available Flags: SetLineNum - Sets Line Numbers, starting with 16384 and incrementing by same SetItemPrice - Sets Line Item prices based on SalesPad desktop pricing rules CalculateTotal - Calculates subtotals of Line Items and Document Header RunBusinessRules - Triggers LineItemUpdated event which can run any Business Rules set to that event RunConfigurator - Sets Configured Item price based on string code CopyAddressInfoFromAddressCode - Copies physical address information (street address, city, etc.) from the address code passed for 3rd party tax services. Ex/ "UpdateFlags":"SetLineNum\|SetItemPrice\|CalculateTotal" Note: If no line numbers are provided or duplicates are detected, SetLineNum routine will automatically be run to avoid line numbering issues.
POST api/SalesDocument/WithLinesAndResources	Creates a Sales Document, Sales Line Items, and Resources in one http request. 'Resources' is an array property for Sales Document Resources. Same as SalesDocument/WithLines endpoint, with the addition of Resources - see documentation on /WithLines endpoint for more info on 'UpdateFlags', etc. NOTE: Resource Content is stripped from response for performance reasons.
PUT api/SalesDocument/WithLines/{Sales_Doc_Type}/{Sales_Doc_Num}	Update a Sales Document and its Sales Line Items in one http request. 'LineItems' is an array property for Sales Line Items. Note: This endpoint will not create or delete lines, only update existing lines. To create or delete lines, use POST SalesLineItem, DELETE SalesLineItem, or DELETE api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}/DeleteLineItems. 'UpdateFlags' is an optional header for setting flags to update the document before save. Multiple flags should use a pipe delimiter ('\|'). Available Flags: SetItemPrice - Sets Line Item prices based on SalesPad desktop pricing rules CalculateTotal - Calculates subtotals of Line Items and Document Header RunBusinessRules - Triggers LineItemUpdated event which can run any Business Rules set to that event RunConfigurator - Sets Configured Item price based on string code Ex/ "UpdateFlags":"SetItemPrice\|CalculateTotal"
PUT api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}/UpdateLineItems	Given properties for one line, updates properties for all Line Items in specified Sales Document. Useful for updating Warehouse, etc. for all lines. For bulk updating individual lines, see PUT api/SalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/CreateOrUpdate
DELETE api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}/DeleteLineItems	Delete Line Items from Sales Document
PUT api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}/{Address_Code}/ShippingAddress	Update Sales Document Shipping Address
PUT api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}/Transfer	Transfer Sales Document (Quote -> Order)
POST api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_Num}/Copy/{New_Sales_Doc_Type}/{New_Sales_Doc_ID}/{New_Customer_Num}	Copy a Sales Document. Returns newly created document. New_xxxx parameters are optional and values from the current document will be used if they are not provided.
GET api/SalesDocument/{Sales_Doc_Type}/{Sales_Doc_ID}/Batches	Get Workflow Queues for a Sales Document

SalesDocumentHistory

CRUD operations for SalesDocumentHistory

API	Description
GET api/SalesDocumentHistory	ODATA enabled get SalesDocumentHistory requests.
GET api/SalesDocumentHistory/{Sales_Doc_Type}/{Sales_Doc_Num}	Get SalesDocumentHistory requests.

SalesDocumentHold

CRUD operations for SalesDocumentHold

API	Description
GET api/SalesDocumentHold	ODATA enabled get SalesDocumentHold requests.
GET api/SalesDocumentHold/{Sales_Doc_Type}/{Sales_Doc_Num}/{Hold_Code}	Get SalesDocumentHold requests.
POST api/SalesDocumentHold	Create SalesDocumentHold objects
DELETE api/SalesDocumentHold/{Sales_Doc_Type}/{Sales_Doc_Num}/{Hold_Code}	Delete SalesDocumentHold objects

SalesDocumentID

CRUD operations for SalesDocumentID

API	Description
GET api/SalesDocumentID	ODATA enabled get SalesDocumentID requests.
GET api/SalesDocumentID/{Sales_Doc_Type}/{Sales_Doc_ID}	Get SalesDocumentID requests.

SalesDocumentLock

CRUD operations for SalesDocumentLock

API	Description
GET api/SalesDocumentLock	ODATA enabled get SalesDocumentLock requests.
GET api/SalesDocumentLock/{Sales_Doc_Type}/{Sales_Doc_Num}/{Session_ID}/{User_Name}	Get SalesDocumentLock requests.
GET api/SalesDocumentLock/HasLock/{Sales_Doc_Type}/{Sales_Doc_Num}	Return true / false depending on whether owner of session has a lock on the specified document.

SalesDocumentPayment

CRUD operations for SalesDocumentPayment

API	Description
GET api/SalesDocumentPayment	ODATA enabled get SalesDocumentPayment requests.
GET api/SalesDocumentPayment/{Sales_Doc_Type}/{Sales_Doc_Num}/{Seq_Num}	Get SalesDocumentPayment requests.
POST api/SalesDocumentPayment	Create SalesDocumentPayment objects
DELETE api/SalesDocumentPayment/{Sales_Doc_Type}/{Sales_Doc_Num}/{Seq_Num}	Delete SalesDocumentPayment objects

SalesDocumentSearch

CRUD operations for SalesDocumentSearch

API	Description
GET api/SalesDocumentSearch	ODATA enabled get SalesDocumentSearch requests.
GET api/SalesDocumentSearch/{Sales_Doc_Type}/{Sales_Doc_Num}	Get SalesDocumentSearch requests.

SalesDocumentSearch_Light

CRUD operations for SalesDocumentSearch_Light

API	Description
GET api/SalesDocumentSearch_Light	ODATA enabled get SalesDocumentSearch_Light requests.
GET api/SalesDocumentSearch_Light/{Sales_Doc_Type}/{Sales_Doc_Num}	Get SalesDocumentSearch_Light requests.

SalesDocumentTrackingNumber

CRUD operations for SalesDocumentTrackingNumber

API	Description
GET api/SalesDocumentTrackingNumber	ODATA enabled get SalesDocumentTrackingNumber requests.
GET api/SalesDocumentTrackingNumber/{Sales_Doc_Type}/{Sales_Doc_Num}/{Tracking_Number}	Get SalesDocumentTrackingNumber requests.

SalesFulfillment

CRUD operations for SalesFulfillment

API	Description
GET api/SalesFulfillment	ODATA enabled get SalesFulfillment requests.
GET api/SalesFulfillment/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}/{Serial_Lot_Number}	Get SalesFulfillment requests.

SalesHold

CRUD operations for SalesHold

API	Description
GET api/SalesHold	ODATA enabled get SalesHold requests.
GET api/SalesHold/{Hold_Code}	Get SalesHold requests.

SalesLineItem

CRUD operations for SalesLineItem

API	Description
GET api/SalesLineItem	ODATA enabled get SalesLineItem requests.
GET api/SalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}	Get SalesLineItem requests.
POST api/SalesLineItem	Create SalesLineItem objects
PUT api/SalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}	Update SalesLineItem objects
DELETE api/SalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}	Delete SalesLineItem objects
PUT api/SalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/CreateOrUpdate	Creates or Updates multiple SalesLineItems in one request. SalesLineItem Primary Keys must be included in order to look up and update an existing line (Sales_Doc_Num and Sales_Doc_Type from URL, as well as Line_Num, Component_Seq_Num) If creating a new line, Item_Number and Quantity are sufficient.
PUT api/SalesLineItem/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}/UpdateFulfillment	Update fulfillment for a specific line. Date_Received and Date_Seq_Number are not required for serial tracked items and are optional for lot tracked items. Quantity is assumed to be in the base unit of measure for tracked items (Bin, Serial, Lot) and for non-tracked items, it is assumed to be in the UofM that is listed on the sales line.

SalesLineItemHistory

CRUD operations for SalesLineItemHistory

API	Description
GET api/SalesLineItemHistory	ODATA enabled get SalesLineItemHistory requests.
GET api/SalesLineItemHistory/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}	Get SalesLineItemHistory requests.

SalesLineItemSearch

CRUD operations for SalesLineItemSearch

API	Description
GET api/SalesLineItemSearch	ODATA enabled get SalesLineItemSearch requests.
GET api/SalesLineItemSearch/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}	Get SalesLineItemSearch requests.

SalesLineLotNum

CRUD operations for SalesLineLotNum

API	Description
GET api/SalesLineLotNum	ODATA enabled get SalesLineLotNum requests.
GET api/SalesLineLotNum/{Sales_Doc_Type}/{Sales_Doc_Num}/{Line_Num}/{Component_Seq_Num}/{Qty_Type}/{Serial_Lot_Seq}	Get SalesLineLotNum requests.

SalesRep

CRUD operations for SalesRep

API	Description
GET api/SalesRep	ODATA enabled get SalesRep requests.
GET api/SalesRep/{Sales_Person_ID}	Get SalesRep requests.
GET api/SalesRep/SalesRepIDs	ODATA enabled Get All SalesRep IDs.

SalesTaxDetail

CRUD operations for SalesTaxDetail

API	Description
GET api/SalesTaxDetail	ODATA enabled get SalesTaxDetail requests.
GET api/SalesTaxDetail/{Tax_Schedule}/{Tax_Detail}	Get SalesTaxDetail requests.

SalesTaxSchedule

CRUD operations for SalesTaxSchedule

API	Description
GET api/SalesTaxSchedule	ODATA enabled get SalesTaxSchedule requests.
GET api/SalesTaxSchedule/{Tax_Schedule}	Get SalesTaxSchedule requests.

SalesTerritory

CRUD operations for SalesTerritory

API	Description
GET api/SalesTerritory	ODATA enabled get SalesTerritory requests.
GET api/SalesTerritory/{Sales_Territory}	Get SalesTerritory requests.

Schema

CRUD operations for Schema

API	Description
GET api/Schema	Retrieve schema for all business objects
GET api/Schema/{Schema}	Retrieve schema for a specific business object

ServiceTransfer

CRUD operations for ServiceTransfer

API	Description
GET api/ServiceTransfer	ODATA enabled get ServiceTransfer requests.
GET api/ServiceTransfer/{Order_Document_ID}	Get ServiceTransfer requests.
GET api/ServiceTransfer/Lock/{Order_Document_ID}	Lock ServiceTransfer objects
DELETE api/ServiceTransfer/Lock/{Order_Document_ID}	Unlock ServiceTransfer objects
POST api/ServiceTransfer	Create ServiceTransfer objects
PUT api/ServiceTransfer/{Order_Document_ID}	Update ServiceTransfer objects
DELETE api/ServiceTransfer/{Order_Document_ID}	Delete ServiceTransfer objects
GET api/ServiceTransfer/WithLines/{Order_Document_ID}	Gets a Service Transfer and Service Transfer Line Items in one http request. 'LineItems' is an array property for Service Transfer Line Items.
PUT api/ServiceTransfer/WithLines/{Order_Document_ID}	Updates a Service Transfer and Service Transfer Line Items in one http request. 'LineItems' is an array property for Service Transfer Line Items. Note: This endpoint will not create or delete lines, only update existing lines. To create or delete lines, use POST ServiceTransferLine or DELETE ServiceTransferLine.
POST api/ServiceTransfer/WithLines	Creates a Service Transfer and Service Transfer Line Items in one http request. 'LineItems' is an array property for Service Transfer Line Items.

ServiceTransferHistory

CRUD operations for ServiceTransferHistory

API	Description
GET api/ServiceTransferHistory	ODATA enabled get ServiceTransferHistory requests.
GET api/ServiceTransferHistory/{Order_Document_ID}	Get ServiceTransferHistory requests.

ServiceTransferLine

CRUD operations for ServiceTransferLine

API	Description
POST api/ServiceTransferLine	Create ServiceTransferLine objects
PUT api/ServiceTransferLine/{Order_Document_ID}/{Line_Item_Seq}	Update ServiceTransferLine objects
DELETE api/ServiceTransferLine/{Order_Document_ID}/{Line_Item_Seq}	Delete ServiceTransferLine objects
GET api/ServiceTransferLine	ODATA enabled get ServiceTransferLine requests.
GET api/ServiceTransferLine/{Order_Document_ID}/{Line_Item_Seq}	Get ServiceTransferLine requests.

ServiceTransferLineHistory

CRUD operations for ServiceTransferLineHistory

API	Description
GET api/ServiceTransferLineHistory	ODATA enabled get ServiceTransferLineHistory requests.
GET api/ServiceTransferLineHistory/{Order_Document_ID}/{Line_Item_Seq}	Get ServiceTransferLineHistory requests.

ServiceTransferLineSearch

CRUD operations for ServiceTransferLineSearch

API	Description
GET api/ServiceTransferLineSearch	ODATA enabled get ServiceTransferLineSearch requests.
GET api/ServiceTransferLineSearch/{Order_Document_ID}/{Line_Item_Seq}/{Source}	Get ServiceTransferLineSearch requests.

ServiceTransferLock

CRUD operations for ServiceTransferLock

API	Description
GET api/ServiceTransferLock	ODATA enabled get ServiceTransferLock requests.
GET api/ServiceTransferLock/{Order_Document_ID}	Get ServiceTransferLock requests.

ServiceTransferSearch

CRUD operations for ServiceTransferSearch

API	Description
GET api/ServiceTransferSearch	ODATA enabled get ServiceTransferSearch requests.
GET api/ServiceTransferSearch/{Order_Document_ID}/{Source}	Get ServiceTransferSearch requests.

Session

Operations for User Sessions

API	Description
GET api/Session/Ping	Checks whether the Session is still active. If active, lastpingtime will be updated.
GET api/Session/ActiveUsers	Retrieves Seat and License Counts for Internal and External Users
GET api/Session	Create Session ID for user - "Login" Also returns SystemGroup, APIGroupPermissions, APIObjectPermissions, APIPropertyPermissions, and APIUserCustomers Session expires in 15 minutes of inactivity.
GET api/Session/Permanent	Create Permanent Session ID for user. Requires SalesPad GP API license. Session ID will not expire.
DELETE api/Session	Delete Session ID and Sales Document Locks for user - "Logout"
DELETE api/Session/Permanent	Delete / Invalidate Permanent Session ID.

ShippingHeader

CRUD operations for ShippingHeader

API	Description
POST api/ShippingHeader	Create ShippingHeader objects
GET api/ShippingHeader	ODATA enabled get ShippingHeader requests.
GET api/ShippingHeader/{Shipping_Number}/{Sales_Doc_Num}/{Sales_Doc_Type}	Get ShippingHeader requests.
PUT api/ShippingHeader/{Shipping_Number}/{Sales_Doc_Num}/{Sales_Doc_Type}	Update ShippingHeader objects
DELETE api/ShippingHeader/{Shipping_Number}/{Sales_Doc_Num}/{Sales_Doc_Type}	Delete ShippingHeader objects

ShippingMethod

CRUD operations for ShippingMethod

API	Description
GET api/ShippingMethod	ODATA enabled get ShippingMethod requests.
GET api/ShippingMethod/{Shipping_Method}	Get ShippingMethod requests.

Stepper

Operations for Sales Document Stepper

API	Description
PUT api/Stepper/{Sales_Doc_Type}/{Sales_Doc_Num}/{Next_Step}/{Run_Script}	Endpoint to change a Sales Document Step property to a new step number. If True, Run_Script will run C# script set up in SalesPad Desktop WebAPI Module -> Stepper Script

SystemGroup

CRUD operations for SystemGroup

API	Description
GET api/SystemGroup	ODATA enabled get SystemGroup requests.
GET api/SystemGroup/{Security_Group}	Get SystemGroup requests.
POST api/SystemGroup	Create SystemGroup objects
PUT api/SystemGroup/{Security_Group}	Update SystemGroup objects
DELETE api/SystemGroup/{Security_Group}	Delete SystemGroup objects
POST api/SystemGroup/Permission	Create SystemGroup and APIGroupPermission
POST api/SystemGroup/{Security_Group}/Copy	Copy SystemGroup and all related permissions to new group

SystemUser

CRUD operations for SystemUser

API	Description
GET api/SystemUser	ODATA enabled get SystemUser requests.
GET api/SystemUser/{User_Name}	Get SystemUser requests.
DELETE api/SystemUser/{User_Name}	Delete SystemUser objects
POST api/SystemUser	Create SystemUser objects
PUT api/SystemUser/{User_Name}	Update SystemUser objects
PUT api/SystemUser/{User_Name}/UpdatePassword	No documentation available.
POST api/SystemUser/SystemUserAndMembership	Create System User and associate with System Group via SystemUserMembership
DELETE api/SystemUser/SystemUserAndMembership/{User_Name}	Delete SystemUser and association with SystemGroup from SystemUserMemberships

SystemUserField

CRUD operations for SystemUserField

API	Description
GET api/SystemUserField	ODATA enabled get SystemUserField requests.
GET api/SystemUserField/{Table_Name}/{Field_Name}	Get SystemUserField requests.

SystemUserMembership

CRUD operations for SystemUserMembership

API	Description
GET api/SystemUserMembership	ODATA enabled get SystemUserMembership requests.
GET api/SystemUserMembership/{User_Name}/{Security_Group}	Get SystemUserMembership requests.
DELETE api/SystemUserMembership/{User_Name}/{Security_Group}	Delete SystemUserMembership objects
POST api/SystemUserMembership	Create SystemUserMembership objects
PUT api/SystemUserMembership/{User_Name}/{Security_Group}	Update SystemUserMembership objects

UOfM

CRUD operations for UOfM

API	Description
GET api/UOfM	ODATA enabled get UOfM requests.
GET api/UOfM/{Unit_Of_Measure_Sched}	Get UOfM requests.

UOfMSchedule

CRUD operations for UOfMSchedule

API	Description
GET api/UOfMSchedule	ODATA enabled get UOfMSchedule requests.
GET api/UOfMSchedule/{Unit_Of_Measure_Sched}	Get UOfMSchedule requests.

UOfMScheduleDetail

CRUD operations for UOfMScheduleDetail

API	Description
GET api/UOfMScheduleDetail	ODATA enabled get UOfMScheduleDetail requests.
GET api/UOfMScheduleDetail/{UOfM_Schedule}/{UOfM}/{Seq_Number}	Get UOfMScheduleDetail requests.

VersionInfo

Database Versioning Info

API	Description
GET api/VersionInfo	ODATA enabled Get VersionInfo requests.
GET api/VersionInfo/{Version}	Get VersionInfo by version number
GET api/VersionInfo/CurrentVersion	Get Current Version of database.

Workflow

Provides the ability to forward Sales Documents through SalesPad Workflow

API	Description
PUT api/Workflow/{Sales_Doc_Type}/{Sales_Doc_Num}/Forward	Forward a Sales Document to the next queue in workflow

WorkflowQueue

CRUD operations for WorkflowQueue

API	Description
GET api/WorkflowQueue	ODATA enabled get WorkflowQueue requests.
GET api/WorkflowQueue/{Sales_Doc_Type}/{Sales_Doc_ID}/{Queue}	Get WorkflowQueue requests.