Keystone Windows Client Company Database REST API
Jump to navigation
Jump to search
Overview
The Keystone REST Server exposes a REST API which is used to communicate with the Keystone Windows Client Company Database.
See: Keystone_REST_Server_(KServer) for more on KServer.
Example URIs:
http://127.0.0.1:8212/rest/kWCcoapi/v1/connection
Portal Functions
endpoints
endpoints
- returns list of endpoints
trxsync
trxsync
rdmQTProspCustList/cdsKey
rdmQTProspCustList/cdsKey
- Returns information about prospective customers.
AR
The AR database contains accounts receivable.
rdmARLocation/cdsKey
rdmARLocation/cdsKey
{
"metadata": {
"rdmARLocation_cdsKey": {
"fields": [
{
"name": "LOC_ID",
"datatype": "ftInteger"
},
{
"name": "LOC_DESC",
"datatype": "ftString",
"size": 30
},
{
"name": "LOC_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
0,
"On-Line Tickets (01&02)",
"T",
"Y"
],
[
1,
"Plant 1 File",
"B",
"Y"
],
[
2,
"Plant 2 File",
"B",
"Y"
],
[
10,
"Westfield",
"R",
"N"
]
]
]
}
- returns location info for plants
rdmARCustomerClass/cdsKey
rdmARCustomerClass/cdsKey
{
"metadata": {
"rdmARCustomerClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"00",
null,
"N"
],
[
"CC",
"Commercial Concrete Contractor",
"Y"
],
[
"CD",
"COMMERICAL DIRECT",
"Y"
],
[
"CH",
"Church",
"N"
],
[
"CP",
"CONCRETE PRODUCERS-PRECAST",
"Y"
],
[
"CT",
"CONCRETE TESTING",
"Y"
],
[
"EM",
"Employee",
"Y"
],
[
"GC",
"GENERAL CONTRACTOR",
"Y"
],
[
"GO",
"MADOT / Municipal Contractors",
"Y"
],
[
"HB",
"Home Builders & Developers",
"Y"
],
[
"IN",
"Invite",
"N"
],
[
"KD",
"DEMOLITION/ENVIRONMENTAL",
"Y"
],
[
"MC",
"MASONRY CONTRACTOR",
"Y"
],
[
"MU",
"MUNCIPALITY",
"Y"
],
[
"NP",
"Not for profit",
"Y"
],
[
"PA",
"ASPHALT-PAVING",
"Y"
],
[
"RE",
"RESIDENTIAL CONTRACTOR",
"N"
],
[
"RF",
"Residential Flatwork",
"Y"
],
[
"RW",
"Residential Foundations",
"Y"
],
[
"SC",
"School/College/Universities",
"Y"
],
[
"SG",
"SAND & GRAVEL",
"Y"
],
[
"SW",
"Site Contractors",
"Y"
],
[
"UT",
"Utility Contractor",
"Y"
]
]
]
}
- Returns customer class info
rdmARPriceGroup/cdsKey
rdmARPriceGroup/cdsKey
{
"metadata": {
"rdmARPriceGroup_cdsKey": {
"fields": [
{
"name": "GROUP_NO",
"datatype": "ftString",
"size": 4
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"1",
"$1.00 OFF LIST",
"Y"
],
[
"10",
"10.00",
"Y"
],
[
"2",
"$2.00 OFF LIST",
"Y"
],
[
"3",
"$3.00 OFF LIST",
"Y"
],
[
"4",
"$ 4.00 OFF LIST",
"Y"
],
[
"5",
"$5 OFF LIST",
"Y"
],
[
"6",
"$ 6.00 OFF LIST",
"Y"
],
[
"7",
"$ 7.00 OFF LIST",
"Y"
],
[
"8",
"$ 8.00 OFF LIST",
"Y"
],
[
"9",
"$ 9.00 OFF LIST",
"Y"
]
]
]
}
- Returns price group information.
rdmARSalesperson/cdsKey
rdmARSalesperson/cdsKey
- Returns salesperson information.
rdmARCreditTermsClass/cdsKey
rdmARCreditTermsClass/cdsKey
{
"metadata": {
"rdmARCreditTermsClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"1",
"DISCOUNT 15 DAYS/NET 30",
"Y"
],
[
"10",
"Net 7 Days",
"Y"
],
[
"11",
"discount net 45",
"Y"
],
[
"2",
"NET 60",
"Y"
],
[
"3",
"**NET30**",
"Y"
],
[
"30",
"net 30 days",
"Y"
],
[
"45",
"net 45",
"Y"
],
[
"5",
"NO CASH DISCOUNT",
"Y"
],
[
"6",
"DISCOUNT 15 DAYS",
"Y"
],
[
"7",
"DISCOUNT $1.00/NET 60 DAYS",
"Y"
],
[
"8",
"$2.00 Discount 15 days NEt 45",
"Y"
],
[
"9",
"DISCOUNT 15 SAYS/NET 45",
"Y"
]
]
]
}
- Returns Credit Terms Class information.
rdmARCustomer/cdsKey
rdmARCustomer/cdsKey
- Returns customer information.
rdmARTaxRate/cdsAllTaxRates
rdmARTaxRate/cdsAllTaxRates
- Returns tax rate info.
rdmARExemptClass/cdsKey
rdmARExemptClass/cdsKey
{
"metadata": {
"rdmARExemptClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"1",
"DEFAULT CUSTOMER",
"Y"
],
[
"2",
"DEFAULT PRODUCT",
"Y"
],
[
"3",
"RESALE",
"Y"
],
[
"4",
"GOVT.-CITY",
"Y"
],
[
"5",
"GOVT. STATE",
"Y"
],
[
"6",
"NOT FOR PROFIT",
"Y"
],
[
"7",
"SCHOOL",
"Y"
],
[
"9",
"Service Charge",
"Y"
]
]
]
}
- Returns tax exemption status information.
rdmARProduct/cdsKey
rdmARProduct/cdsKey
{
"metadata": {
"rdmARProduct_cdsKey": {
"fields": [
{
"name": "PRODUCT_CODE",
"datatype": "ftString",
"size": 20
},
{
"name": "DESCRIPTION_1",
"datatype": "ftString",
"size": 35
},
{
"name": "DESCRIPTION_2",
"datatype": "ftString",
"size": 35
},
{
"name": "UNIT_OF_MEASURE",
"datatype": "ftString",
"size": 2
},
{
"name": "PRODUCT_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "TAX_CODE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "TAX_CODE_2",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "TAX_CODE_3",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "BASE_PRODUCT",
"datatype": "ftString",
"size": 20
},
{
"name": "PLANT_NO",
"datatype": "ftString",
"size": 3
},
{
"name": "PRODUCT_CLASS",
"datatype": "ftString",
"size": 2
},
{
"name": "UPC_CODE",
"datatype": "ftString",
"size": 16
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "STOCKED",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "AUTO_QTY",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "DEFAULT_QTY",
"datatype": "ftBCD",
"size": 4,
"precision": 18
},
{
"name": "DEFAULT_SLUMP",
"datatype": "ftBCD",
"size": 2,
"precision": 18
}
]
}
},
"data": [
[
[
"1 1/2\"ST",
"1 1/2\" washed stone",
null,
"TN",
"A",
"Y",
"Y",
"Y",
"1 1/2\"ST",
null,
"BA",
null,
"N",
"N",
"N",
0,
null
],
- Returns product information.
rdmARProduct/cdsIngSubTypeLookup
rdmARProduct/cdsIngSubTypeLookup
- Returns product subtype info.
rdmARPlant/cdsKey
rdmARPlant/cdsKey
- Returns Plant info.
rdmARProductClass/cdsKey
rdmARProductClass/cdsKey
{
"metadata": {
"rdmARProductClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"20",
"2000 PSI",
"Y"
],
[
"25",
"2500 psi",
"Y"
],
[
"26",
"2500 psi with 3/8\"",
"Y"
],
[
"27",
"2500 psi high early",
"Y"
],
[
"28",
"2500 psi pump mix, mid or high rang",
"Y"
],
- Returns product class information
rdmARProduct/cdsIngSubTypeLookup
rdmARProduct/cdsIngSubTypeLookup
{
"metadata": {
"rdmARProduct_cdsIngSubTypeLookup": {
"fields": [
{
"name": "ingredient_type",
"datatype": "ftWideString",
"size": 1
},
{
"name": "ingredient_subtype",
"datatype": "ftWideString",
"size": 1
},
{
"name": "subtype_desc",
"datatype": "ftWideString",
"size": 30
}
]
}
},
"data": [
[
[
"X",
"A",
"Air Entrainment"
],
[
"X",
"R",
"Retarder"
],
[
"X",
"W",
"Water Reducer"
]
]
]
}
- Returns information about ingredients contained in a product.
rdmARUnitOfMeasure/cdsKey
rdmARUnitOfMeasure/cdsKey
{
"metadata": {
"rdmARUnitOfMeasure_cdsKey": {
"fields": [
{
"name": "UNIT_OF_MEASURE",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "EXPANDED_UMS",
"datatype": "ftString",
"size": 8
},
{
"name": "SUBTOTAL",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "UMS_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"8E",
"8\" Equivalent",
"8E",
"N",
"C",
"Y"
],
rdmARAllowanceClass/cdsKey
rdmARAllowanceClass/cdsKey
{
"metadata": {
"rdmARAllowanceClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ALLOW_GL",
"datatype": "ftString",
"size": 20
},
{
"name": "ALLOW_INCLUDES_TAX",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"1",
"SALES TAX",
"32115",
"N",
"Y"
],
- Returns tax allowance class info.
rdmARDriver/cdsKey
rdmARDriver/cdsKey
- Returns driver info.
rdmARJobClass/cdsKey
rdmARJobClass/cdsKey
{
"metadata": {
"rdmARJobClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"30",
"Class 30 AUTO GENERATED",
"Y"
],
[
"PW",
"Prevailing Wage",
"Y"
],
[
"SC",
"School",
"Y"
]
]
]
}
- Returns Job Class.
rdmARJobPrice/cdsKeyGroup
rdmARJobPrice/cdsKeyGroup
?{CUST_No.}
?{INCLUDE_INACTIVE}
- Returns job price for a given customer.
rdmARLocation/cdsKey
rdmARLocation/cdsKey
{
"metadata": {
"rdmARLocation_cdsKey": {
"fields": [
{
"name": "LOC_ID",
"datatype": "ftInteger"
},
{
"name": "LOC_DESC",
"datatype": "ftString",
"size": 30
},
{
"name": "LOC_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
0,
"On-Line Tickets (01&02)",
"T",
"Y"
],
[
1,
"Plant 1 File",
"B",
"Y"
],
[
2,
"Plant 2 File",
"B",
"Y"
],
[
10,
"Westfield",
"R",
"N"
]
]
]
}
- Returns location info.
rdmAROwner/cdsKey
rdmAROwner/cdsKey
- Returns owner information
rdmARPlantGroup/cdsKey
rdmARPlantGroup/cdsKey
{
"metadata": {
"rdmARPlantGroup_cdsKey": {
"fields": [
{
"name": "GROUP_ID",
"datatype": "ftString",
"size": 3
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"01",
"Chicopee",
"Y"
],
[
"02",
"Westfield",
"N"
],
[
"03",
"Greenfield",
"Y"
],
[
"ALL",
"All Plants",
"Y"
]
]
]
}
- Returns plant groups
rdmARTaxLocality/cdsKey
rdmARTaxLocality/cdsKey
{
"metadata": {
"rdmARTaxLocality_cdsKey": {
"fields": [
{
"name": "TAX_LOCALITY",
"datatype": "ftString",
"size": 4
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"CT",
"CONNECTICUT",
"Y"
],
[
"MA",
"MASSACHUSETTS",
"Y"
],
[
"MA1",
"old mass sales tax",
"Y"
],
[
"VT",
"Vermont",
"Y"
]
]
]
}
- Returns tax locality info.
rdmARTaxRate/cdsKey
rdmARTaxRate/cdsKey
- Returns tax rates
rdmARTruck/cdsKey
rdmARTruck/cdsKey
{
"metadata": {
"rdmARTruck_cdsKey": {
"fields": [
{
"name": "TRUCK_NO",
"datatype": "ftString",
"size": 10
},
{
"name": "DEFAULT_DRIVER",
"datatype": "ftString",
"size": 10
},
{
"name": "CURRENT_DRIVER",
"datatype": "ftString",
"size": 10
},
{
"name": "CUST_NO",
"datatype": "ftString",
"size": 10
},
{
"name": "GROSS_WEIGHT",
"datatype": "ftInteger"
},
{
"name": "TARE_WEIGHT",
"datatype": "ftInteger"
},
{
"name": "LEGAL_MAX_WEIGHT",
"datatype": "ftInteger"
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "TRUCK_CAPACITY",
"datatype": "ftBCD",
"size": 4,
"precision": 18
},
{
"name": "TRUCK_CLASS",
"datatype": "ftString",
"size": 2
},
{
"name": "CLASSIFICATION",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"10",
"FRANK",
"FRANK",
null,
0,
36000,
75000,
"Y",
13,
"CM",
"C"
],
- Returns truck info
rdmARTruckClass/cdsKey
rdmARTruckClass/cdsKey
{
"metadata": {
"rdmARTruckClass_cdsKey": {
"fields": [
{
"name": "TRUCK_CLASS",
"datatype": "ftString",
"size": 2
},
{
"name": "SPACE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "TRUCK_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"CM",
" ",
"Front Discharge Concrete Mixer",
"C",
"Y"
],
[
"TD",
" ",
"Trailer Dump",
"A",
"Y"
]
]
]
}
- Returns truck class.
rdmARZone/cdsKey
rdmARZone/cdsKey
- Returns zone info.
AP
The AP database contains accounts payable information.
rdmAPCheck/cdsKey
rdmAPCheck/cdsKey
- Returns info about checks and whether they are active.
rdmAPInvoice/cdsKey
rdmAPInvoice/cdsKey
- Returns info about invoices and whether they are active.
rdmAPPayTermsClass/cdsKey
rdmAPPayTermsClass/cdsKey
{
"metadata": {
"rdmAPPayTermsClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"10",
"Net 10",
"Y"
],
[
"15",
"due by 15th of the month",
"Y"
],
[
"1T",
"Net 10th",
"Y"
],
[
"2T",
"2% 10 NET 30th",
"Y"
],
[
"30",
"NET 30 DAYS",
"Y"
],
[
"3T",
"Net 30th",
"Y"
],
[
"4T",
"1%10 Net 30",
"Y"
],
[
"60",
"60 Days",
"Y"
],
[
"DR",
"DUE UPON RECEIPT",
"Y"
],
[
"N6",
"1% Discount Net 60",
"Y"
]
]
]
}
- Returns Payment Terms info.
rdmAPPO/cdsKey
rdmAPPO/cdsKey
{
"metadata": {
"rdmAPPO_cdsKey": {
"fields": [
{
"name": "VEND_ID",
"datatype": "ftString",
"size": 10
},
{
"name": "PO_NUMBER",
"datatype": "ftString",
"size": 20
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "SESSION_NO",
"datatype": "ftInteger"
},
{
"name": "TRANS_NO",
"datatype": "ftInteger"
},
{
"name": "STATUS",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "ORDER_DATE",
"datatype": "ftDate"
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "UNLINKED_RC_FLAG",
"datatype": "ftInteger"
}
]
}
},
"data": [
[
[
"ABC100",
"1",
"Popeyes",
461450,
1,
"A",
"2023-05-15T00:00:00.000Z",
"Y",
1
]
]
]
}
- Returns info about purchase orders.
rdmAPProduct/cdsKey
rdmAPProduct/cdsKey
{
"metadata": {
"rdmAPProduct_cdsKey": {
"fields": [
{
"name": "PRODUCT_CODE",
"datatype": "ftString",
"size": 20
},
{
"name": "DESCRIPTION_1",
"datatype": "ftString",
"size": 35
},
{
"name": "DESCRIPTION_2",
"datatype": "ftString",
"size": 35
},
{
"name": "UNIT_OF_MEASURE",
"datatype": "ftString",
"size": 2
},
{
"name": "PRODUCT_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "TAX_CODE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "PLANT_NO",
"datatype": "ftString",
"size": 3
},
{
"name": "PRODUCT_CLASS",
"datatype": "ftString",
"size": 2
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "STOCKED",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"1 1/2\"ST",
"1 1/2\" washed stone",
null,
"TN",
"A",
"Y",
null,
"BA",
"N",
"N"
],
- Returns product info.
rdmAPReceipt/cdsKey
rdmAPReceipt/cdsKey
{
"metadata": {
"rdmAPReceipt_cdsKey": {
"fields": [
{
"name": "VEND_ID",
"datatype": "ftString",
"size": 10
},
{
"name": "VEND_RECEIPT_NO",
"datatype": "ftString",
"size": 20
},
{
"name": "NAME",
"datatype": "ftString",
"size": 30
},
{
"name": "SESSION_NO",
"datatype": "ftInteger"
},
{
"name": "TRANS_NO",
"datatype": "ftInteger"
}
]
}
},
"data": [
[
[
"ABC100",
"333",
"ABC-ASSOC BUILDERS & CONTRACTO",
461472,
1
]
]
]
}
- Returns receipt info.
rdmAPTen99Class/cdsKey
rdmAPTen99Class/cdsKey
- Returns Ten99class Info.
rdmAPTen99State/cdsKey
rdmAPTen99State/cdsKey
- Returns Ten99State Info
rdmAPVendor/cdsKey
rdmAPVendor/cdsKey
- Returns vendor info.
rdmAPVendorClass/cdsKey
rdmAPVendorClass/cdsKey
{
"metadata": {
"rdmAPVendorClass_cdsKey": {
"fields": [
{
"name": "CLASS_NO",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"BA",
"Banking / Credit Cards",
"Y"
],
- Returns vendor class info.
rdmAPUnitOfMeasure/cdsKey
rdmAPUnitOfMeasure/cdsKey
{
"metadata": {
"rdmAPUnitOfMeasure_cdsKey": {
"fields": [
{
"name": "UNIT_OF_MEASURE",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "SUBTOTAL",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "UMS_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"8E",
"8\" Equivalent",
"N",
"C",
"Y"
],
APCashFlow
APCashFlow
?$GETREPORT=True
- Returns cash flow info
APMTDCheckRegister
APMTDCheckRegister
?$GETREPORT=True
- Return check register info
Report/AP
report/APCashFlow
report/APCashFlow
- Returns detailed cash flow reports for accounts payable.
report/APCheckRegister
report/APCheckRegister
- Returns detailed check register reports.
report/APExemptClassList
report/APExemptClassList
- Returns detailed report of exempt classes
report/APFlaggedInvoice
report/APFlaggedInvoice
- Returns detailed report of flagged invoices.
report/APInvBatchList
report/APInvBatchList
- Returns detailed reports of inventory batch list.
report/APInvoiceRegister
report/APInvoiceRegister
- Returns detailed invoice register report.
report/APMTDCheckRegister
report/APMTDCheckRegister
- Returns detailed month to date check register report.
report/APPayTermsList
report/APPayTermsList
- Returns detailed pay terms list report.
report/APPOReceiptList
report/APPOReceiptList
- Returns purchase order receipt list report.
report/APPurchaseOrders
report/APPurchaseOrders
- Returns purchase order report
report/APReprintChecks
report/APReprintChecks
- Returns detailed reprint check report.
report/AP1099Forms
report/AP1099Forms
- Returns detailed 1099 Form report.
report/AP1099ClassList
report/AP1099ClassList
- Returns detailed report of 1099 Classes.
report/APVendClassList
report/APVendClassList
- Returns detailed report of Vendor Classes.
report/APVendInvHistory
report/APVendInvHistory
- Returns detailed report of Vendor Inventory History.
report/APVendInvHistoryChecks
report/APVendInvHistoryChecks
- Returns detailed report of Vendor Inventory History Checks.
report/APVendInvHistoryGLDist
report/APVendInvHistoryGLDist
- Returns detailed report of Vendor Inventory General Ledger Distributions
report/APVendList
report/APVendList
- Returns detailed list of Vendors.
report/APVendorLabels
report/APVendorLabels
- Returns detailed report of Vendor Labels.
GL
The GL database contains general ledger info.
rdmGLAccount/cdsKey
rdmGLAccount/cdsKey
- Returns GL Account info.
/rdmGLAccount/cdsKey
/rdmGLAccount/cdsKey
- Returns GL account info.
rdmGLBatch/cdsKey
rdmGLBatch/cdsKey
{
"metadata": {
"rdmGLBatch_cdsKey": {
"fields": [
{
"name": "BATCH_TYPE",
"datatype": "ftString",
"size": 2
},
{
"name": "BATCH_ID",
"datatype": "ftString",
"size": 14
},
{
"name": "RECUR_IND",
"datatype": "ftString",
"size": 3
},
{
"name": "TRX_DATE",
"datatype": "ftDate"
},
{
"name": "BATCH_DESC",
"datatype": "ftString",
"size": 35
}
]
}
},
"data": [
[
[
"JE",
"DEPR.",
"(R)",
"2016-07-01T00:00:00.000Z",
"depreciation"
]
]
]
}
- Returns general ledger batch data.
rdmGLGroup/cdsKey
rdmGLGroup/cdsKey
{
"metadata": {
"rdmGLGroup_cdsKey": {
"fields": [
{
"name": "GROUP_ID",
"datatype": "ftString",
"size": 20
},
{
"name": "LINE_DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"AST",
"Assets",
"Y"
],
- Returns GL account classes
rdmGLSegment/cdsKey
rdmGLSegment/cdsKey
- Returns list of general ledger segments.
rdmGLSourceCode/cdsKey
rdmGLSourceCode/cdsKey
- Returns general ledger source codes
rdmGLTransactionBatch/cdsKey
rdmGLTransactionBatch/cdsKey
{
"metadata": {
"rdmGLTransactionBatch_cdsKey": {
"fields": [
{
"name": "BATCH_TYPE",
"datatype": "ftString",
"size": 2
},
{
"name": "BATCH_ID",
"datatype": "ftString",
"size": 14
},
{
"name": "RECUR_IND",
"datatype": "ftString",
"size": 3
},
{
"name": "TRX_DATE",
"datatype": "ftDate"
},
{
"name": "BATCH_DESC",
"datatype": "ftString",
"size": 35
}
]
}
},
"data": [
[
[
"JE",
"DEPR.",
"(R)",
"2016-07-01T00:00:00.000Z",
"depreciation"
]
]
]
}
- Returns transaction batches.
rdmGLNRMCAGroup/cdsKey
rdmGLNRMCAGroup/cdsKey
- Returns NRMCA Group
Report/GL
report/GLDistributionStd
report/GLDistributionStd
- Returns detailed report of general ledger distributions.
report/GLDistributionStdPayroll
report/GLDistributionStdPayroll
- Returns detailed report of payroll distributions.
report/GLGroupList
report/GLGroupList
- Returns detailed report of general ledger groups.
report/GLNRMCAGroupList
report/GLNRMCAGroupList
- Returns detailed report of NRMCA groups
report/GLSegmentList
report/GLSegmentList
{
"metadata": {
"GLSegmentList": {
"fields": [
{
"name": "SEGMENT_NO",
"datatype": "ftInteger"
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "BEGIN_POS",
"datatype": "ftInteger"
},
{
"name": "SEG_LENGTH",
"datatype": "ftInteger"
},
{
"name": "SEG_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "UNALLOC_ID",
"datatype": "ftString",
"size": 20
},
{
"name": "MEMO",
"datatype": "ftMemo"
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
1,
"Account",
1,
4,
"A",
null,
null,
"Y"
],
[
2,
"Profit Center",
6,
2,
"P",
null,
null,
"Y"
]
]
]
}
- Returns detailed report of general ledger segments.
report/GLSourceCodeList
report/GLSourceCodeList
- Returns detailed list of source codes
report/GLTrialBalanceByMonth
report/GLTrialBalanceByMonth
- Returns detailed report of general ledger trial balance each month.
report/GLTrialBalanceNRMCAByMonth
report/GLTrialBalanceNRMCAByMonth
- Returns detailed report of general ledger NRMCA trial balance by month.
CC
- The CC database contains compucrete data.
rdmCCAsset/cdsKey
rdmCCAsset/cdsKey
- Returns data about assets.
rdmCCAssetClass/cdsKey
rdmCCAssetClass/cdsKey
- Returns data about types of assets.
rdmCCCompany/cdsKey
rdmCCCompany/cdsKey
- Returns company data
rdmCCQuery
rdmCCQuery
- returns data about recently ran queries
rdmCCForm/cdsKey
rdmCCForm/cdsKey
{
"metadata": {
"rdmCCForm_cdsKey": {
"fields": [
{
"name": "FORM_ID",
"datatype": "ftString",
"size": 10
},
{
"name": "FORM_TYPE",
"datatype": "ftFixedChar",
"size": 1
},
{
"name": "FORM_NAME",
"datatype": "ftString",
"size": 10
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "COMPANY_ID",
"datatype": "ftString",
"size": 3
},
{
"name": "USER_ID",
"datatype": "ftString",
"size": 10
},
{
"name": "IP_ADDRESS",
"datatype": "ftString",
"size": 40
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"APCHK",
"F",
"APCHK",
null,
null,
null,
null,
"Y"
]
- Returns CC form.
rdmCCDevice/cdsKey
rdmCCDevice/cdsKey
- Returns device info
rdmCCForm/cdsKey
rdmCCForm/cdsKey
- Returns CC form.
rdmCCQuery/cdsKey
rdmCCQuery/cdsKey
- Returns info about previous queries.
DI
- The DI Database contains dispatch data
rdmDIOrder/cdsDIAllTrucks
rdmDIOrder/cdsDIAllTrucks
- Returns order for all trucks.
rdmDIOrder/cdsDIPlantGroups
rdmDIOrder/cdsDIPlantGroups
- Returns orders for all plant groups.
rdmDITruck/cdsKey
rdmDITruck/cdsKey
- Returns truck data.
rdmDIPlant/cdsKey
rdmDIPlant/cdsKey
- Return plant data.
rdmDIUsageClass/cdsKey
rdmDIUsageClass/cdsKey
- Returns usage class data.
rdmDIZone/cdsKey
rdmDIZone/cdsKey
- Returns zone data.
rdmDIEventType/cdsKey
rdmDIEventType/cdsKey
- Returns event type data.
rdmDIOrder/cdsMaster
rdmDIOrder/cdsMaster
?KEY1 = xxxxxx
?KEY2 = xx
- Returns order data
- KEY1 = SESSION_NO
- KEY2 = TRANS_NO
rdmDIOrder/cdsTruckDemand
rdmDIOrder/cdsTruckDemand
?beg_datetime = yyyy-mm-dd
?end_datetime = yyyy-mm-dd
- Returns orders within a specified date range
rdmDIPlant/cdsMaster
rdmDIPlant/cdsMaster
?KEY = xx
- Returns plant data for a specified plant
- KEY = PLANT_NO
rdmDISchedule/cdsDIAvailTrucks
rdmDISchedule/cdsDIAvailTrucks
- Returns schedule data for available trucks
rdmDISchedule/cdsDISchedulePlantTotals
rdmDISchedule/cdsDISchedulePlantTotals
?BEG_DATETIME = yyyy-mm-dd
?END_DATETIME = yyyy-mm-dd
{
"metadata": {
"rdmDISchedule_cdsDISchedulePlantTotals": {
"fields": [
{
"name": "ORD_PLANT_NO",
"datatype": "ftString",
"size": 3
},
{
"name": "LDS_ORDERED",
"datatype": "ftInteger"
},
{
"name": "LDS_DELIVERED",
"datatype": "ftInteger"
},
{
"name": "LDS_REMAINING",
"datatype": "ftInteger"
},
{
"name": "LDS_WILLCALL",
"datatype": "ftInteger"
},
{
"name": "LDS_PLUS",
"datatype": "ftInteger"
},
{
"name": "QTY_ORDERED",
"datatype": "ftBCD",
"size": 4,
"precision": 18
},
{
"name": "QTY_DELIVERED",
"datatype": "ftBCD",
"size": 4,
"precision": 18
},
{
"name": "QTY_REMAINING",
"datatype": "ftBCD",
"size": 4,
"precision": 18
},
{
"name": "QTY_WILLCALL",
"datatype": "ftBCD",
"size": 4,
"precision": 18
},
{
"name": "ORDS_ORDERED",
"datatype": "ftInteger"
},
{
"name": "ORDS_WILLCALL",
"datatype": "ftInteger"
}
]
}
},
"data": [
[
[
"14",
238,
238,
0,
0,
0,
2443,
2443,
0,
0,
108,
0
]
]
]
}
- Returns total quantities for a set time period
rdmDITruck/cdsMaster
rdmDITruck/cdsMaster
?KEY = xx
- Returns Truck data for specified truck
- KEY = TRUCK_NO
rdmDIUsageClass/cdsMaster
rdmDIUsageClass/cdsMaster
?CLASS_NO
- Returns detailed data about selected usage class.
rdmDIZone/cdsMaster
rdmDIZone/cdsMaster
?KEY = 10
- Returns detailed data about specified zone
- KEY = ZONE
JC
- The JC Database contains data about job costs
rdmJCBudCat/cdsKey
rdmJCBudCat/cdsKey
{
"metadata": {
"rdmJCBudCat_cdsKey": {
"fields": [
{
"name": "BUDCAT_ID",
"datatype": "ftString",
"size": 10
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"AGG",
"Aggregates / Materials",
"Y"
],
- Returns a list of budget categories
rdmJCJob/cdsKey
rdmJCJob/cdsKey
- Returns list of jobs
rdmJCJobGroup/cdsKey
rdmJCJobGroup/cdsKey
{
"metadata": {
"rdmJCJobGroup_cdsKey": {
"fields": [
{
"name": "JOB_GROUP",
"datatype": "ftString",
"size": 2
},
{
"name": "DESCRIPTION",
"datatype": "ftString",
"size": 35
},
{
"name": "ACTIVE_FLAG",
"datatype": "ftFixedChar",
"size": 1
}
]
}
},
"data": [
[
[
"1",
"A",
"Y"
]
]
]
}
- Returns list of job groups
Report/JC
report/JCBudCatList
report/JCBudCatList
- Returns detailed report of budget categories
report/JCJobGroupList
report/JCJobGroupList
- Returns detailed reports of job groups
report/JCJobGroupList
report/JCJobGroupList
- Returns detailed reports of job group lists.