The procedures listed in this section are suitable for performing common tasks within an integrating application, and we recommend their use.
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Cards |
GS_Add_Account_On_The_Fly |
Adds either a posting, unit, fixed allocation or variable allocation account on the fly. |
Posting |
Any “GL_BB“ procedure (such as GL_BB_Initialize) |
These are General Ledger black box posting routines used for various generic posting activities. |
Post_GL_Batch |
Posts normal or clearing batches entered using the General Ledger Batch Entry window. |
|
Post_GL_Master |
Posts normal, clearing or business batches that are marked to post in the Master Posting window. |
|
Post_GL_Series |
Posts any type of GL batch or quick journal. |
|
Transactions |
Calculate_GL_Period |
Returns the number of fiscal periods a specified date falls within, and whether a given period is closed. |
Get_Next_Journal_Entry |
Increments a journal entry number from the GL_SETP table. |
|
Verify_Journal_Entry |
Verifies that a given journal entry number hasn’t already been posted to the GL_YTD_TRX_OPEN table. |
|
Verify_TRX_Date |
Calculates the General Ledger period and fiscal year, and verifies a transaction date. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Posting |
IV_Post_Batch |
Posts batches listed in Master Post, Series Post or Inventory Batch Entry windows. |
Transactions |
IV_Allocate_Qty |
Updates the quantity allocated fields for a site record and overall site record. |
IV_Default_Document_ Number |
Generates and reserves the next document number for use in Transaction Entry and Transfer Entry windows. |
|
IV_Document_Number_ Validate |
Ascertains whether a document number exists in the IV_TRX_HIST_HDR table. If the number doesn’t exist, the document number is valid. If the number exists, it’s incremented and re-verified until no matching number exists in the IV_TRX_HIST_HDR table. |
|
IV_Get_New_Qty_ Available |
Returns the quantity available from the IV_Item_MSTR_QTYS table for a given item number, location and quantity type. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Posting |
IVC_Post_Batch |
Posts any batch entered in Invoicing Batch Entry. |
Transactions |
IVC_Calculate_Item_ Amounts |
Returns the unit cost, unit price and quantity for an item and unit of measure (U of M). |
IVC_Tax_Recalc_Invoice |
Recalculates all taxes for lines on an invoice. |
|
IVC_Update_Dist |
Updates the distributions for an invoicing document. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Transactions |
MC_Calculate_Amt_ From_X_Rate |
Calculates a transaction amount based on the exchange rate. |
MC_Get_Exchange_Rate |
Locates a valid exchange rate for an exchange table ID and an exchange date. |
|
MC_Verify_Currency_ID |
Verifies a currency ID by ascertaining whether it exists, whether it’s available to the current company, and whether it’s active for the current company. |
|
MC_Verify_Exchange_ Table_ID |
Verifies an exchange table ID by ascertaining whether it exists, whether it’s available to the current company, and whether it’s active for the current company. |
|
MC_Verify_Rate_Type_ID |
Verifies a rate type ID by ascertaining whether it exists and whether the rate type ID has an association with the currency ID. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Calculations |
Batch_Total_Inc_Dec |
Increases or decreases the batch total for a particular batch. |
Number_of_Trx_Per_ Batch_Inc_Dec |
Increases or decreases the number of transactions for a particular batch. |
|
Conversion |
Convert_To_Words_And_ |
Converts a currency amount to words only, or to a combination of words and numbers. For example, the currency amount $20.08 would convert to “Twenty Dollars and 08 Cents” for words only, and “$***20 Dollars And 08 Cents” for words and numbers. |
Posting |
PM_Distribution_Default |
Creates default distribution accounts for a cash receipt, if there are no distributions. |
PM_Validate_Batch_ Information |
Verifies the information in the Batch_Headers table for a batch. |
|
Post_PM_Batch |
Posts a single transaction entry, manual payments, or computer checks batch. |
|
Transactions |
PM_Add_Vendor_On_ The_Fly |
Prepares the PM_Vendor_ Maintenance form for a new vendor that’s added on the fly. |
PM_Control_Number_Fix |
Gets the next valid control numbers (voucher and payment numbers) from the PM_SETP table for the PM_Transaction_ Entry form. |
|
PM_Create_Distributions |
Updates an existing distribution with a distribution amount. If the distribution doesn’t exist, it’s created. |
|
Validation |
PM_Control_Number_ Validate |
Validates any control number (a voucher or payment number) by checking whether the control number exists in the PM_Key_MSTR table. If it exists, this script increments the number. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Posting |
UPR_Batch_Number_ Increment |
Increments the batch ID by 1 when processing excess returned commissions. |
Transactions |
UPR_Get_Base_ Employee_Pay_Record |
Returns pay record information for a given employee ID. |
UPR_Get_Posting_ Account_Number |
Returns the posting account number for an account type, department, job title and code. |
|
UPR_Set_Batch_Status_ To_Busy |
Sets the batch status of the UPR_TRX_ Batch_Activity table to busy for a given batch ID when a user edits the batch. |
|
UPR_TRX_Sequence_ Number_Validate |
Ascertains the next available transaction number. |
|
UPR_Verify_Based_On_ Pay_Record |
Ascertains whether the pay code for the current employee ID is valid. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Posting |
RM_Post_Master |
Posts any batch entered in Receivables Batch Entry. |
Transactions |
Document_Number_Inc_Dec |
Increments or decrements a document number. |
RM_Cash_Distribution_ Default |
Creates default distribution accounts for a cash receipt if no distributions exist. |
|
RM_Create_Default_ Commissions |
Creates default distribution accounts for a commission if no distributions exist. |
|
RM_Document_Number_Validate |
Validates a document number by checking for a record in the RM_Keys_MSTR table. |
|
RM_Sales_Distribution_ |
Creates default General Ledger distributions for transaction documents created in Receivables Transaction Entry. |
|
RM_Validate_GL_ Account |
Validates any General Ledger account for use in Receivables Management. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Posting |
SOP_Delete_Document |
Deletes unposted work transactions by unallocating the line items. |
SOP_Post_Batch |
Posts any batch entered in Sales Order Processing Batch Entry. |
|
SOP_Post_Delete_Work_Records |
Deletes the work records that are no longer required after posting a transaction and printing the posting journal |
|
SOP_Post_Init |
Returns the information required for posting a batch of Sales Order Processing documents. |
|
SOP_Post_Print_Reports |
Prints the posting journals for a batch of Sales Order Processing transactions. |
|
SOP_Post_TRX |
Posts a Sales Order Processing transaction. |
|
Reports |
SOP_DP_Print_Forms |
Prints Sales Order Processing documents. This script should be called in the background. |
Transactions |
SOP_Allocate_QTY |
Allocates a quantity for an item entered in a transaction, and returns item quantity information. |
SOP_Auto_Allocate_Lot_Numbers |
Assigns lot numbers based on the valuation method. |
|
SOP_Auto_Allocate_ Serial_ Numbers |
Assigns serial numbers based on the valuation method. |
|
SOP_Calculate_Item_ Amounts |
Returns the unit cost based on the valuation method, and the unit price based on the valuation method and price method. |
|
SOP_Comm_Calc_ Invoice_Total |
Calculates the commissions for a document that’s set to calculate commissions on the invoice total. |
|
SOP_Comm_Calc_Line_ Item |
Calculates the commissions for a document that’s set to calculate commissions on the sale amount. |
|
SOP_Dist_Default |
Creates default distributions for an entire document. |
|
|
SOP_Dist_Update_Other |
Updates the various header level distributions for a document. |
SOP_Get_Aux_Accounts |
Returns the proper posting account number for Sales Order Processing distributions. |
|
SOP_Password |
Verifies various type ID and module setup options supported. These options can be accessed with a password. |
|
SOP_Process_Hold_ Assign |
Assigns a process hold to a document by creating the process hold in the SOP_Process_Holds_WORK_HIST table. |
|
SOP_Process_Hold_ Check |
Ascertains whether a process hold restricting a particular action exists for a document. |
|
SOP_Process_Hold_ Default |
Assigns default process holds for a document. |
|
SOP_Process_Hold_ Delete |
Removes the SOP_Process_Holds_WORK_HIST records for a document. |
|
SOP_Process_Hold_ Delete_Hold |
Removes a single process hold from a document. |
Details about the procedures listed here are available in the SDK.
Category |
Procedure |
Description |
---|---|---|
Activity tracking |
Check_For_Other_Users_Logged_In |
Ascertains whether one or multiple users are logged into a company. |
Install/startup |
Initialize |
Creates initial entries in the SY_Pathnames table, and creates pathname translation records for the current dictionary location ID. |
Posting |
SY_Master_Post |
Posts all batches of a single batch source entered in the Master Posting window that are marked to post. |
Table maintenance |
Progress_Control |
Checks whether the Progress_Control form is open, and displays the table name, record processed and percentage complete. |
Taxes |
TX_Calculate_Taxes |
Calculates taxes for a document. This is the primary gateway into the tax engine. |
Transactions |
Check_Batch_Activity_ File |
Determines whether a record exists in the SY_Batch_Activity table. |
Check_Batch_Header_ File_Locked |
Determines whether a record is locked in the SY_Batch_Activity table. |
|
Delete_Batch_Activity_ Record |
Removes a record from the SY_Batch_Activity table. |
|
Utilities |
Translate_Pathnames |
Returns a pathname from the SY_Pathnames table and converts it to the corresponding translation entered in the SY_Pathnames_ Translate_MSTR table based on the dictionary location ID entered in the defaults file. |