Recurring Records

This documentation defines the Recurring Records (ARSUBDET) schema fields.

Please Note This documentation defines the most relevant fields. Treat the response from the View Table Schema (XMGETFMT) endpoint as the authoritative field list for any specific site.

Date formats

NTD is a timestamp format used by DICE. NTD dates are used when defining time frames within endpoint calls. See the Date Format documentation for information on converting NTD to UNIX and vice versa if needed.

Field definitions

#	Name	Description	Length	Padding Type
1	AR_NUMBER	The unique accounting identifier assigned to the customer.	10	Pad with trailing spaces.
2	ACCOUNT_NUMBER	The subscriber account number assigned upon creation.	9	Right justify data and pad with leading spaces.
3	BILLING_CODE_LINE	The unique identifier assigned to the line.	2	Pad with trailing spaces.
4	BILLING_CODE	The assigned billing code that determines the sales and deferred GL accounts for recurring charges.	6	Pad with trailing spaces.
5	DESCRIPTION	A brief description of the billing code.	35	Pad with trailing spaces.
6	BILLABLE_AMOUNT	The amount that will be billed when this line is included.	6	Pad with trailing spaces.
7	STOP_DATE	If applicable, the date the line should stop being billed.	6	Pad with trailing spaces.
8	INCREASE_DATE	If applicable, the date the rate for this line will increase.	6	Pad with trailing spaces.
9	LAST_RATE_CHG	The date the line’s rate was last changed.	6	Pad with trailing spaces.
10	CONTRACT_DATE	The date assigned to the contract applied to this line.	6	Pad with trailing spaces.
11	INTERVAL_TYPE	The billing interval used to determine how often this line is billed. The available options are defined below.	1	Pad with trailing spaces.
12	SALES_TAX_GROUP	The code of the tax group used when billing this line.	6	Pad with trailing spaces.
13	CONTRACT_CODE	The code assigned to the contract applied to this line.	6	Pad with trailing spaces.
14	WARRANTY_CODE	The ID of the warranty assigned to covered parts/labor for this line.	6	Pad with trailing spaces.
15	SYSTEM_TYPE	If applicable, the ID assigned to the system type associated with the parts/labor for this line.	6	Pad with trailing spaces.
16	COMMUNICATION_TYPE	If applicable, the ID assigned to the communication method used by the system associated with the parts/labor for this line.	6	Pad with trailing spaces.
17	COMMISSIONABLE	If applicable, the value that determines how commissions are calculated for this line.	1	Pad with trailing spaces.
18	TAXABLE	The ID used to determine the tax category used for this line.	1	Pad with trailing spaces.
19	PRORATED	Determines if the line should bill from the start date rather than the start cycle when billed. Updates to `N` after the line has been billed. Accepts: `Y` or `N`.	1	Pad with trailing spaces.
20	PO_NUMBER	The PO number that should be associated with this recurring line.	15	Pad with trailing spaces.
21	LAST_RATE	The rate previously used for this line.	6	Pad with trailing spaces.
22	NEW_RATE	The rate that will be used for this line on the increase date.	6	Pad with trailing spaces.
23	JOB_NUMBER	The ID of the job assigned to the recurring line.	12	Pad with trailing spaces.
24	LINE_MSR_TOTAL	The monthly rate used for the line.	6	Pad with trailing spaces.
25	PHASE	Legacy field. No longer used.	6	Pad with trailing spaces.
26	LAST_ENTRY	The date this line was last changed.	6	Pad with trailing spaces.
27	LAST_OPERATOR	The operator code of the individual who last updated the recurring line.	3	Pad with trailing spaces.
28	START_DATE	The date this line began billing.	6	Pad with trailing spaces.
29	START_CYCLE	The date this line will next be billed.	6	Pad with trailing spaces.
30	LAST_INVOICED	The date of the last invoice this line was included on.	6	Pad with trailing spaces.
31	POSTING_CODE	Determines the GL receivable account used for this line.	6	Pad with trailing spaces.
32	GROUPING_CODE	If applicable, the group this line belongs to for linking multiple lines into one.	6	Pad with trailing spaces.
33	DEFER	Determines if this line’s revenue is deferred and recognized over its billing period. Accepts: `Y` or `N`.	1	Pad with trailing spaces.
34	RATE_TABLE	Determines the rate table used to charge the customer based on alarm activity/setup.	6	Pad with trailing spaces.
35	SERVICE_CODE	If applicable, determines the service code assigned to the line for service contracts.	6	Pad with trailing spaces.
36	OVERRIDE_COMMISSION	If applicable, the commission amount that should be used for this line over the default commission rate.	6	Pad with trailing spaces.
37	REC_IDENTIFIER_1	Recurring identifier 1.	9	Pad with trailing spaces.
38	REC_IDENTIFIER_2	Recurring identifier 2.	9	Pad with trailing spaces.
39	REC_IDENTIFIER_3	Recurring identifier 3.	9	Pad with trailing spaces.
40	REC_IDENTIFIER_4	Recurring identifier 4.	9	Pad with trailing spaces.
41	REFERENCE_JOB_NUMBER	If applicable, the job number that should be used as a reference for this line.	12	Pad with trailing spaces.
42	REFERENCE_JOB_TYPE	If applicable, the job type that should be used as a reference for this line.	6	Pad with trailing spaces.

Interval type options

Option	Definition
0	Ten Year
2	Bi-Annually
3	Tri-Annually
4	Four Year
5	Five Year
6	Six Year
7	Seven Year
8	Eight Year
9	Nine Year
A	Annually
B	Bi-Monthly
E	Eighteen Months
F	Four Months
I	Bi-Weekly
M	Monthly
Q	Quarterly
S	Semi-Annually
W	Weekly

Example request

curl --request GET \
--url 'https://global-rest.ci.matrixmcloud.com/rest/rest.php?dataSource=dice&*view=arsubdet&*limit=1&*blanks=all' \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \

Example response

{
  "ARSUBDET": [
    {
      "AR_NUMBER": "0000000010",
      "ACCOUNT_NUMBER": "   BATEST",
      "BILLING_CODE_LINE": " !",
      "BILLING_CODE": "RESA",
      "DESCRIPTION": "RESIDENTIAL MONITORING",
      "BILLABLE_AMOUNT": 119.88,
      "STOP_DATE": "",
      "INCREASE_DATE": "09/25/20",
      "LAST_RATE_CHG": "06/20/19133502",
      "CONTRACT_DATE": "06/20/19",
      "INTERVAL_TYPE": "A",
      "SALES_TAX_GROUP": "MI",
      "CONTRACT_CODE": "1YEAR",
      "WARRANTY_CODE": "1YEAR",
      "SYSTEM_TYPE": "",
      "COMMUNICATION_TYPE": "",
      "COMMISSIONABLE": "N",
      "TAXABLE": "",
      "PRORATED": "Y",
      "PO_NUMBER": "",
      "LAST_RATE": 119.88,
      "NEW_RATE": 122.28,
      "JOB_NUMBER": "",
      "LINE_MSR_TOTAL": 0,
      "PHASE": "",
      "LAST_ENTRY": "08/12/24",
      "LAST_OPERATOR": "TJC",
      "START_DATE": "06/20/19133502",
      "START_CYCLE": "01/01/21",
      "LAST_INVOICED": "",
      "POSTING_CODE": "ALL",
      "GROUPING_CODE": "NONE",
      "DEFER": "Y",
      "RATE_TABLE": "",
      "SERVICE_CODE": "",
      "OVERRIDE_COMMISSION": 0,
      "REC_IDENTIFIER_1": "",
      "REC_IDENTIFIER_2": "",
      "REC_IDENTIFIER_3": "",
      "REC_IDENTIFIER_4": "",
      "REFERENCE_JOB_NUMBER": "",
      "REFERENCE_JOB_TYPE": ""
    }
  ],
  "totalRecords": 1
}

Recurring Records

Date formats #

Field definitions #

Interval type options #

Example request #

Example response #

Date formats

Field definitions

Interval type options

Example request

Example response