View source for Keystone Windows Client Company Database REST API

[[CATEGORY: KSERVER]]
==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====

<code>endpoints</code>

: returns list of endpoints

====trxsync====

<code>trxsync</code>

====rdmQTProspCustList/cdsKey====

<code>rdmQTProspCustList/cdsKey</code>

: Returns information about prospective customers.

===AR===

The AR database contains accounts receivable. 

====rdmARLocation/cdsKey====

<code>rdmARLocation/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: returns location info for plants


====rdmARCustomerClass/cdsKey====

<code>rdmARCustomerClass/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns customer class info

====rdmARPriceGroup/cdsKey====

<code>rdmARPriceGroup/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns price group information.

====rdmARSalesperson/cdsKey====

<code>rdmARSalesperson/cdsKey</code>

: Returns salesperson information.

====rdmARCreditTermsClass/cdsKey====

<code>rdmARCreditTermsClass/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns Credit Terms Class information.

====rdmARCustomer/cdsKey====

<code>rdmARCustomer/cdsKey</code>

: Returns customer information.

====rdmARTaxRate/cdsAllTaxRates====

<code>rdmARTaxRate/cdsAllTaxRates</code>

: Returns tax rate info.

====rdmARExemptClass/cdsKey====

<code>rdmARExemptClass/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns tax exemption status information.

====rdmARProduct/cdsKey====

<code>rdmARProduct/cdsKey</code>

<pre>
{
	"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
			],

</pre>

: Returns product information.

====rdmARProduct/cdsIngSubTypeLookup====

<code>rdmARProduct/cdsIngSubTypeLookup</code>

: Returns product subtype info.

====rdmARPlant/cdsKey====

<code>rdmARPlant/cdsKey</code>

: Returns Plant info.

====rdmARProductClass/cdsKey====

<code>rdmARProductClass/cdsKey</code>

<pre>
{
	"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"
			],
</pre>

: Returns product class information

====rdmARProduct/cdsIngSubTypeLookup====

<code>rdmARProduct/cdsIngSubTypeLookup</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns information about ingredients contained in a product.

====rdmARUnitOfMeasure/cdsKey====

<code>rdmARUnitOfMeasure/cdsKey</code>

<pre>
{
	"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"
			],
</pre>

====rdmARAllowanceClass/cdsKey====

<code>rdmARAllowanceClass/cdsKey</code>

<pre>
{
	"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"
			],
</pre>

: Returns tax allowance class info.

====rdmARDriver/cdsKey====

<code>rdmARDriver/cdsKey</code>

: Returns driver info.

====rdmARJobClass/cdsKey====

<code>rdmARJobClass/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns Job Class.

====rdmARJobPrice/cdsKeyGroup====

<code>rdmARJobPrice/cdsKeyGroup<BR>
?{CUST_No.}<BR>
?{INCLUDE_INACTIVE}</code>

: Returns job price for a given customer.

====rdmARLocation/cdsKey====

<code>rdmARLocation/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns location info.

====rdmAROwner/cdsKey====

<code>rdmAROwner/cdsKey</code>

: Returns owner information

====rdmARPlantGroup/cdsKey====

<code>rdmARPlantGroup/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns plant groups

====rdmARTaxLocality/cdsKey====

<code>rdmARTaxLocality/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns tax locality info.

====rdmARTaxRate/cdsKey====

<code>rdmARTaxRate/cdsKey</code>

: Returns tax rates

====rdmARTruck/cdsKey====

<code>rdmARTruck/cdsKey</code>

<pre>
{
	"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"
			],
</pre>

:Returns truck info

====rdmARTruckClass/cdsKey====

<code>rdmARTruckClass/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns truck class.

====rdmARZone/cdsKey====

<code>rdmARZone/cdsKey</code>

: Returns zone info.

===AP===

The AP database contains accounts payable information.

====rdmAPCheck/cdsKey====

<code>rdmAPCheck/cdsKey</code>

: Returns info about checks and whether they are active.

====rdmAPInvoice/cdsKey====

<code>rdmAPInvoice/cdsKey</code>

: Returns info about invoices and whether they are active.

====rdmAPPayTermsClass/cdsKey====

<code>rdmAPPayTermsClass/cdsKey</code>

<pre>
{
	"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"
			]
		]
	]
}
</pre>

: Returns Payment Terms info.

====rdmAPPO/cdsKey====

<code>rdmAPPO/cdsKey</code>

<pre>
{
    "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
            ]
        ]
    ]
}
</pre>

: Returns info about purchase orders.

====rdmAPProduct/cdsKey====

<code>rdmAPProduct/cdsKey</code>

<pre>
{
	"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"
			],
</pre>

: Returns product info.

====rdmAPReceipt/cdsKey====

<code>rdmAPReceipt/cdsKey</code>

<pre>
{
    "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
            ]
        ]
    ]
}
</pre>

: Returns receipt info.

====rdmAPTen99Class/cdsKey====

<code>rdmAPTen99Class/cdsKey</code>


: Returns Ten99class Info.

====rdmAPTen99State/cdsKey====

<code>rdmAPTen99State/cdsKey</code>

: Returns Ten99State Info

====rdmAPVendor/cdsKey====

<code>rdmAPVendor/cdsKey</code>

: Returns vendor info.

====rdmAPVendorClass/cdsKey====

<code>rdmAPVendorClass/cdsKey</code>

<pre>
{
	"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"
			],
</pre>

: Returns vendor class info.

====rdmAPUnitOfMeasure/cdsKey====

<code>rdmAPUnitOfMeasure/cdsKey</code>

<pre>
{
    "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"
            ],
</pre>

====APCashFlow====

<code>APCashFlow<BR>
?$GETREPORT=True</code>

: Returns cash flow info

====APMTDCheckRegister====

<code>APMTDCheckRegister<BR>
?$GETREPORT=True</code>

: Return check register info

===Report/AP===

====report/APCashFlow====

<code>report/APCashFlow</code>

: Returns detailed cash flow reports for accounts payable.

====report/APCheckRegister====

<code>report/APCheckRegister</code>

: Returns detailed check register reports.

====report/APExemptClassList====

<code>report/APExemptClassList</code>

: Returns detailed report of exempt classes

====report/APFlaggedInvoice====

<code>report/APFlaggedInvoice</code>

: Returns detailed report of flagged invoices.

====report/APInvBatchList====

<code>report/APInvBatchList</code>

: Returns detailed reports of inventory batch list.

====report/APInvoiceRegister====

<code>report/APInvoiceRegister</code>

: Returns detailed invoice register report.

====report/APMTDCheckRegister====

<code>report/APMTDCheckRegister</code>

: Returns detailed month to date check register report.

====report/APPayTermsList====

<code>report/APPayTermsList</code>

: Returns detailed pay terms list report.

====report/APPOReceiptList====

<code>report/APPOReceiptList</code>

: Returns purchase order receipt list report.

====report/APPurchaseOrders====

<code>report/APPurchaseOrders</code>

: Returns purchase order report

====report/APReprintChecks====

<code>report/APReprintChecks</code>

: Returns detailed reprint check report.

====report/AP1099Forms====

<code>report/AP1099Forms</code>

: Returns detailed 1099 Form report.

====report/AP1099ClassList====

<code>report/AP1099ClassList</code>

: Returns detailed report of 1099 Classes.

====report/APVendClassList====

<code>report/APVendClassList</code>

: Returns detailed report of Vendor Classes.

====report/APVendInvHistory====

<code>report/APVendInvHistory</code>

: Returns detailed report of Vendor Inventory History.

====report/APVendInvHistoryChecks====

<code>report/APVendInvHistoryChecks</code>

: Returns detailed report of Vendor Inventory History Checks.

====report/APVendInvHistoryGLDist====

<code>report/APVendInvHistoryGLDist</code>

: Returns detailed report of Vendor Inventory General Ledger Distributions

====report/APVendList====

<code>report/APVendList</code>

: Returns detailed list of Vendors.

====report/APVendorLabels====

<code>report/APVendorLabels</code>

: Returns detailed report of Vendor Labels.

===GL===

The GL database contains general ledger info.

====rdmGLAccount/cdsKey====

<code>rdmGLAccount/cdsKey</code>

: Returns GL Account info.

====/rdmGLAccount/cdsKey====

<code>/rdmGLAccount/cdsKey</code>

: Returns GL account info.

====rdmGLBatch/cdsKey====

<code>
rdmGLBatch/cdsKey
</code>

<pre>
{
    "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"
            ]
        ]
    ]
}
</pre>

: Returns general ledger batch data.

====rdmGLGroup/cdsKey====

<code>rdmGLGroup/cdsKey</code>

<pre>
{
	"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"
			],
</pre>

: Returns GL account classes

====rdmGLSegment/cdsKey====

<code>
rdmGLSegment/cdsKey
</code>

: Returns list of general ledger segments.

====rdmGLSourceCode/cdsKey====

<code>
rdmGLSourceCode/cdsKey
</code>

: Returns general ledger source codes

====rdmGLTransactionBatch/cdsKey====

<code>
rdmGLTransactionBatch/cdsKey
</code>

<pre>
{
    "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"
            ]
        ]
    ]
}
</pre>

: Returns transaction batches.


====rdmGLNRMCAGroup/cdsKey====

<code>
rdmGLNRMCAGroup/cdsKey
</code>

: Returns NRMCA Group

===Report/GL===

====report/GLDistributionStd====

<code>report/GLDistributionStd</code>

: Returns detailed report of general ledger distributions.

====report/GLDistributionStdPayroll====

<code>report/GLDistributionStdPayroll</code>

: Returns detailed report of payroll distributions.

====report/GLGroupList====

<code>report/GLGroupList</code>

: Returns detailed report of general ledger groups.

====report/GLNRMCAGroupList====

<code>report/GLNRMCAGroupList</code>

: Returns detailed report of NRMCA groups

====report/GLSegmentList====

<code>report/GLSegmentList</code>

<pre>
{
    "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"
            ]
        ]
    ]
}
</pre>

: Returns detailed report of general ledger segments.

====report/GLSourceCodeList====

<code>report/GLSourceCodeList</code>

: Returns detailed list of source codes

====report/GLTrialBalanceByMonth====

<code>report/GLTrialBalanceByMonth</code>

: Returns detailed report of general ledger trial balance each month.

====report/GLTrialBalanceNRMCAByMonth====

<code>report/GLTrialBalanceNRMCAByMonth</code>

: Returns detailed report of general ledger NRMCA trial balance by month.

===CC===

: The CC database contains compucrete data.

====rdmCCAsset/cdsKey====

<code>rdmCCAsset/cdsKey</code>

: Returns data about assets.

====rdmCCAssetClass/cdsKey====

<code>rdmCCAssetClass/cdsKey</code>

: Returns data about types of assets.

====rdmCCCompany/cdsKey====

<code>rdmCCCompany/cdsKey</code>

: Returns company data

====rdmCCQuery====

<code>rdmCCQuery</code>

: returns data about recently ran queries

====rdmCCForm/cdsKey====

<code>rdmCCForm/cdsKey</code>

<pre>
{
	"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"
			]
</pre>

: Returns CC form.

====rdmCCDevice/cdsKey====

<code>rdmCCDevice/cdsKey</code>

: Returns device info

====rdmCCForm/cdsKey====

<code>rdmCCForm/cdsKey</code>

: Returns CC form.

====rdmCCQuery/cdsKey====

<code>rdmCCQuery/cdsKey</code>

: Returns info about previous queries.


===DI===

: The DI Database contains dispatch data

====rdmDIOrder/cdsDIAllTrucks====

<code>rdmDIOrder/cdsDIAllTrucks</code>

: Returns order for all trucks.

====rdmDIOrder/cdsDIPlantGroups====

<code>rdmDIOrder/cdsDIPlantGroups</code>

: Returns orders for all plant groups.

====rdmDITruck/cdsKey====

<code>rdmDITruck/cdsKey</code>

: Returns truck data.

====rdmDIPlant/cdsKey====

<code>
rdmDIPlant/cdsKey
</code>

: Return plant data.

====rdmDIUsageClass/cdsKey====

<code>rdmDIUsageClass/cdsKey</code>

: Returns usage class data.

====rdmDIZone/cdsKey====

<code>rdmDIZone/cdsKey</code>

: Returns zone data.

====rdmDIEventType/cdsKey====

<code>rdmDIEventType/cdsKey</code>

: Returns event type data.

====rdmDIOrder/cdsMaster====

<code>
rdmDIOrder/cdsMaster<BR>
?KEY1 = xxxxxx<BR>
?KEY2 = xx
</code>

: Returns order data
:: KEY1 = SESSION_NO
:: KEY2 = TRANS_NO

====rdmDIOrder/cdsTruckDemand====

<code>
rdmDIOrder/cdsTruckDemand<BR>
?beg_datetime = yyyy-mm-dd<BR>
?end_datetime = yyyy-mm-dd
</code>

: Returns orders within a specified date range

====rdmDIPlant/cdsMaster====

<code>
rdmDIPlant/cdsMaster<BR>
?KEY = xx
</code>

: Returns plant data for a specified plant
:: KEY = PLANT_NO

====rdmDISchedule/cdsDIAvailTrucks====

<code>
rdmDISchedule/cdsDIAvailTrucks
</code>

: Returns schedule data for available trucks

====rdmDISchedule/cdsDISchedulePlantTotals====

<code>
rdmDISchedule/cdsDISchedulePlantTotals<BR>
?BEG_DATETIME = yyyy-mm-dd<BR>
?END_DATETIME = yyyy-mm-dd
</code>

<pre>
{
    "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
            ]
        ]
    ]
}
</pre>

: Returns total quantities for a set time period

====rdmDITruck/cdsMaster====

<code>
rdmDITruck/cdsMaster<BR>
?KEY = xx
</code>

: Returns Truck data for specified truck
:: KEY = TRUCK_NO

====rdmDIUsageClass/cdsMaster====

<code>
rdmDIUsageClass/cdsMaster<BR>
?CLASS_NO
</code>
 
: Returns detailed data about selected usage class.

====rdmDIZone/cdsMaster====

<code>
rdmDIZone/cdsMaster<BR>
?KEY = 10
</code>

: Returns detailed data about specified zone
:: KEY = ZONE

===JC===

: The JC Database contains data about job costs

====rdmJCBudCat/cdsKey====

<code>rdmJCBudCat/cdsKey</code>

<pre>
{
    "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"
            ],
</pre>

: Returns a list of budget categories

====rdmJCJob/cdsKey====

<code>rdmJCJob/cdsKey</code>

: Returns list of jobs

====rdmJCJobGroup/cdsKey====

<code>rdmJCJobGroup/cdsKey</code>

<pre>
{
    "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"
            ]
        ]
    ]
}
</pre>

: Returns list of job groups

===Report/JC===

====report/JCBudCatList====

<code>report/JCBudCatList</code>

: Returns detailed report of budget categories

====report/JCJobGroupList====

<code>report/JCJobGroupList</code>

: Returns detailed reports of job groups

====report/JCJobGroupList====

<code>report/JCJobGroupList</code>

: Returns detailed reports of job group lists.