LoadAndRetrieveVertexCache

Load and Retrieve Vertex Cache

Minor Business Rule

Object Name: B4000050

Parent DLL: CALLBSFN

Location: Client/Server

Language: C

Data Structure

D4000050A - LoadAndRetrieveVertexCache

Special Input Expected
The value in this field determines functionality based on being called from Procurement or Sales.



Significant Data Values

1 - called from Procurement

2 - called from Sales

x - xxxxxxxxxxxxx




^

Parameter NameData ItemData TypeReq/OptI/O/Both
cCalledFromFlagEV01charOPTINPUT

Special Input Expected
The value in this field determines functionality based on being called from Procurement or Sales.



Significant Data Values

1 - called from Procurement

2 - called from Sales

x - xxxxxxxxxxxxx

^

mnSupplierOrShipToSHANMATH_NUMERICOPTINPUT


Special Input Expected

Procurement should pass Supplier.  Sales should pass Ship To Address Number.





^

jdDateTransactionJulianTRDJJDEDATEOPTINPUT

The date that an order was entered into the system. This date determines which effective level the system uses for inventory pricing.

szCompanyCOcharOPTINPUT

Special Input Expected
Procurement should populate this field with the the detail branch plant company.  Sales should 

populate this field with Company Key Order Number.





^

szHeaderBranchPlantMCUcharOPTINPUT

Special Input Expected
Used to retrieve the address book number of the Header Branch Plant from branch plant constants when 

calling from Sales.  Do not pass a value into this field when calling from Procurement. 



^

szDetailBranchPlantMCUcharOPTINPUT

Special Input Expected
Used to retrieve the address book number of the Detail Branch Plant from branch plant constants when 

called from Sales.  Used to retrieve the appropriate category code from the address book of the detail 

branch plant for Sales and Procurement.





^

mnJobnumberAJOBSMATH_NUMERICREQBOTH

Special Input Expected
This field is the unique key for the cache.  It needs to be passed in to retrieve or load the Vertex 

cache.  If zero is passed in, function will retrieve a job number using API and will return to 

function.





^

cModeProcessingMODEcharREQINPUT

Special Input Expected
Mode to control cache function.



Significant Data Values

1 - load cache with values

2 - retrieve cache populated by Vertex




^

cWriteRegisterFlagEV01charOPTINPUT

Special Input Expected
Procurement should always populate this field with '0'.  Sales should always populate this field with 

'0' with the exception of sales update.  If Sales Update is run in final update mode then a '1' 

should be passed into this field.





^

mnIdentifierShortItemITMMATH_NUMERICOPTINPUT

Special Input Expected
Item number is used along with detail branch/plant to retrieve category code from the Item Branch 

File.  If item/branch record is not found then check the Item Master File.





^

szOrderTypeDCTOcharOPTINPUT

Special Input Expected
Used to retrieve product category code.





^

szLineTypeLNTYcharOPTINPUT

Special Input Expected
Used to retrieve product category code.



^

mnStateTaxableAmountVSTTBMATH_NUMERICOPTOUTPUT

The state amount that is subject to tax.

mnStateTaxRateVSTTRMATH_NUMERICOPTOUTPUT

State tax rate.

mnStateTaxAmountVSTTAMATH_NUMERICOPTOUTPUT

Amount of state tax calculated.

mnCountyTaxableAmountVCNTBMATH_NUMERICOPTOUTPUT

The county amount that is subject to tax.

mnCountyTaxRateVCNTRMATH_NUMERICOPTOUTPUT

County tax rate.

mnCountyTaxAmountVCNTAMATH_NUMERICOPTOUTPUT

Amount of county tax calculated.

mnCityTaxableAmountVCTTBMATH_NUMERICOPTOUTPUT

The city amount that is subject to tax.

mnCityTaxRateVCTTRMATH_NUMERICOPTOUTPUT

City tax rate.

mnCityTaxAmountVCTTAMATH_NUMERICOPTOUTPUT

Amount of city tax calculated.

mnDistrictTaxableAmountVDSTBMATH_NUMERICOPTOUTPUT

The district amount that is subject to tax.

mnDistrictTaxRateVDSTRMATH_NUMERICOPTOUTPUT

District tax rate.

mnDistrictTaxAmountVDSTAMATH_NUMERICOPTOUTPUT

Amount of district tax calculated.

mnTotalTaxRateVTTXRMATH_NUMERICOPTOUTPUT

The total combined tax rate for a transaction.

szIntraStateTaxedGeoCodeVITGCcharOPTOUTPUT

The location, other than the taxing jurisdiction, where local taxes are collected.

mnIntraStateCountyRateVICNRMATH_NUMERICOPTOUTPUT

The jurisdiction's county tax rate.

mnIntraStateCountyTaxVICNTMATH_NUMERICOPTOUTPUT

The jurisdiction's county tax amount.

mnIntraStateCityRateVICTRMATH_NUMERICOPTOUTPUT

The jurisdiction's city tax rate.

mnIntraStateCityTaxVICTTMATH_NUMERICOPTOUTPUT

The jurisdiction's city tax amount.

mnIntraStateDistrictRateVIDSRMATH_NUMERICOPTOUTPUT

The jurisdiction's district tax rate.

mnIntraStateDistrictTaxVIDSTMATH_NUMERICOPTOUTPUT

The jurisdiction's district tax amount.

szShipToStateVSTSTcharOPTOUTPUT

The state that is associated with the ship-to GeoCode.

szShipToCountyVSTCNcharOPTOUTPUT

The county associated with the ship-to GeoCode.

szShipToCityVSTCTcharOPTOUTPUT

The city associated with the ship-to GeoCode.

szShipFromStateVSFSTcharOPTOUTPUT

The state that is associated with the ship-from GeoCode.

szShipFromCountyVSFCNcharOPTOUTPUT

The county that is associated with the ship-from GeoCode.

szShipFromCityVSFCTcharOPTOUTPUT

The city that is associated with the ship-from GeoCode.

szOrderAcceptStateVOASTcharOPTOUTPUT

The state that is associated with the order acceptance GeoCode.

szOrderAcceptCountyVOACNcharOPTOUTPUT

The county that is associated with the order acceptance GeoCode.

szOrderAcceptCityVOACTcharOPTOUTPUT

The city that is associated with the order acceptance GeoCode.

szShipToGeoCodeTXA1charOPTBOTH

Special Input Expected
This is the tax rate area retrieved from Sales or Procurement functions.


Special Output Returned

DELETE THIS SECTION IF IT DOES NOT APPLY.


Significant Data Values

x - xxxxxxxxxxxxx

x - xxxxxxxxxxxxx

x - xxxxxxxxxxxxx

DELETE THIS SECTION IF IT DOES NOT APPLY.



^

cDistrictApplyFlagVDSAFcharOPTOUTPUT

Special Input Expected
DELETE THIS SECTION IF IT DOES NOT APPLY.


Special Output Returned

Used to determine tax summary description.  If district tax applies to the sity, use the city name 

returned to display to district tax, else use the county name returned.


Significant Data Values

1 - District Tax applies to the city

2 - District Tax applies to the county




^

mnUnitsTransactionQtyUORGMATH_NUMERICOPTINPUT

The quantity of units affected by this transaction.

szTransactionTaxGeoCodeVTTGCcharOPTOUTPUT

The GeoCode that identifies the taxing jurisdiction. This value is determined by the Quantum tax calculating engine.

mnDocumentOrderInvoiceEDOCOMATH_NUMERICOPTINPUT

A number that identifies an original document. This document can be a voucher, a sales order, an invoice, unapplied cash, a journal entry, 
and so on.

szCompanyKeyOrderNoKCOOcharOPTINPUT

A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a 
sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the 
order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order 
type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to 
assign a next number. In this case, you probably would not use the order company to locate the document.

szOrderSuffixSFXOcharOPTINPUT

In the A/R and A/P systems, a code that corresponds to the pay item. In the Sales Order and Procurement systems, this code identifies 
multiple transactions for an original order. For purchase orders, the code is always 000. For sales orders with multiple partial receipts against an 
order, the first receiver used to record receipt has a suffix of 000, the next has a suffix of 001, the next 002, and so on.

mnLineNumberLNIDMATH_NUMERICOPTINPUT

A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns 
this number,but in some cases you can override it.

szShipFromGeoCodeTXA1charOPTOUTPUT

A code that identifies a tax or geographic area that has common tax rates and tax authorities. The system validates the code you enter 
against the Tax Areas table (F4008). The system uses the tax rate area in conjunction with the tax explanation code and tax rules to calculate tax 
and G/L distribution amounts when you create an invoice or voucher.

szOrderAcceptGeoCodeTXA1charOPTOUTPUT

A code that identifies a tax or geographic area that has common tax rates and tax authorities. The system validates the code you enter 
against the Tax Areas table (F4008). The system uses the tax rate area in conjunction with the tax explanation code and tax rules to calculate tax 
and G/L distribution amounts when you create an invoice or voucher.

cTaxableYNTAX1charOPTNONE

A code that indicates whether the item is subject to sales tax when you sell it. The system calculates tax on the item only if the customer is 
also taxable.

mnIntraStateDistrictTaxableVDSTBMATH_NUMERICOPTNONE

The district amount that is subject to tax.

mnIntraStateCityTaxableVCTTBMATH_NUMERICOPTNONE

The city amount that is subject to tax.

mnIntraStateCountyTaxableVCNTBMATH_NUMERICOPTNONE

The county amount that is subject to tax.

cIntraStateDistrictApplyFlagVDSAFcharOPTNONE

Determines whether the district tax, if any, is for the city or county. Valid values are:    blank No district tax    1       District tax applies to the city    
2       District tax applies to the county 

mnDocVoucherInvoiceDOCMATH_NUMERICOPTNONE

A number that identifies the original document, such as a voucher, invoice, or journal entry. On entry forms, you can assign the document 
number or let the system assign it using the Next Numbers program (P0002). Matching document numbers (DOCM) identify related documents 
in the Accounts Receivable and Accounts Payable systems. Examples of original and matching documents are: Accounts Payable     o 
Original document - voucher     o Matching document - payment  Accounts Receivable     o Original document - invoice     o Matching document - 
receipt  Note: In the Accounts Receivable system, the following transactions simultaneously generate original and matching documents: 
deductions, unapplied receipts, chargebacks, and drafts.

Related Functions

None

Related Tables

None