Customer Header Record

This documentation defines the Customer Header Record (ARCUSTHD) 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

#NameDescriptionLengthPadding Type
1AR_NUMBERThe unique accounting identifier assigned to the customer.10Pad with trailing spaces.
2BRANCH_IDThe ID of the branch the customer belongs to.3Pad with trailing spaces.
3OPEN_ORDER_AMTThe sum total of the customer’s current outstanding balance.6Pad with trailing spaces.
4CURRENT_BALANCEThe sum total of the customer’s open invoice amounts.6Pad with trailing spaces.
5PERIOD1_BALANCEThe sum total of open invoices dated during the first billing period.6Pad with trailing spaces.
6PERIOD2_BALANCEThe sum total of open invoices dated during the second billing period.6Pad with trailing spaces.
7PERIOD3_BALANCEThe sum total of open invoices dated during the third billing period.6Pad with trailing spaces.
8PERIOD4_BALANCEThe sum total of open invoices dated during the fourth billing period.6Pad with trailing spaces.
9PASTDO_BALANCEThe sum total of the customer’s past due balance.6Pad with trailing spaces.
10PASTDO1_BALANCEThe sum total of the customer’s past due balance applied to the first billing period.6Pad with trailing spaces.
11PASTDO2_BALANCEThe sum total of the customer’s past due balance applied to the second billing period.6Pad with trailing spaces.
12PASTDO3_BALANCEThe sum total of the customer’s past due balance applied to the third billing period.6Pad with trailing spaces.
13PASTDO4_BALANCEThe sum total of the customer’s past due balance applied to the fourth billing period.6Pad with trailing spaces.
14MSR_AMOUNTThe sum total of the customer’s open invoices dated later than the fourth billing period.6Pad with trailing spaces.
15NTD_REAGE_DATENTD date on which this customer should be re-aged to calculate the above dollar fields.6Pad with trailing spaces.
16CUSTOMER_TYPEThe type code assigned to the customer to determine which customer group they belong to.6Pad with trailing spaces.
17ASSIGN_OPRThe collection operator assigned to the customer.3Pad with trailing spaces.
18ACTIVEDetermines if the customer is active within the system. Accepts: Y or N.1Pad with trailing spaces.
19DISCONTINUANCEIf applicable, determines the reason the customer has been slated for deactivation.1Pad with trailing spaces.
20NTD_DISC_DATEIf applicable, the NTD date the customer will become inactive within the system.6Pad with trailing spaces.
21CYCLE_BILLThe cycle code that groups customers by their billing schedule.2Pad with trailing spaces.
22BILLING_STATUSDetermines if the customer has recurring lines.
R: Yes, the customer has recurring lines.
N: No, the customer does not have recurring lines.		1Pad with trailing spaces.
23RATE_INHIBITDetermines if the customer should not receive rate increases. Accepts: Y or N.1Pad with trailing spaces.
24CREDIT_CODEThe customer’s credit rating.6Pad with trailing spaces.
25NTD_OLDEST_INVOICEThe NTD date of the customer’s oldest open invoice.6Pad with trailing spaces.
26TOTAL_INVOICES_PAIDThe total number of invoices the customer has paid in full.3Pad with trailing spaces.
27TOTAL_DAYS_TO_PAYThe average number of days it takes the customer to pay invoices after they are issued.4Pad with trailing spaces.
28REASON_CODEThe default reason used to describe why rate changes are made on this customer.1Pad with trailing spaces.
29NTD_OLDEST_CHARGEThe NTD date of the customer’s oldest positive invoice.6Pad with trailing spaces.

Example request 

curl --request GET \
--url 'https://global-rest.ci.matrixmcloud.com/rest/rest.php?dataSource=dice&*view=arcusthd&*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 

{
  "ARCUSTHD": [
    {
      "AR_NUMBER": "0000000010",
      "BRANCH_ID": "PRO",
      "OPEN_ORDER_AMT": 728.48,
      "CURRENT_BALANCE": 0,
      "PERIOD1_BALANCE": 0,
      "PERIOD2_BALANCE": 0,
      "PERIOD3_BALANCE": 29.68,
      "PERIOD4_BALANCE": 698.8,
      "PASTDO_BALANCE": 0,
      "PASTDO1_BALANCE": 0,
      "PASTDO2_BALANCE": 0,
      "PASTDO3_BALANCE": 29.68,
      "PASTDO4_BALANCE": 698.8,
      "MSR_AMOUNT": 29.94,
      "NTD_REAGE_DATE": "739404",
      "CUSTOMER_TYPE": "RES",
      "ASSIGN_OPR": "",
      "ACTIVE": "Y",
      "DISCONTINUANCE": "",
      "NTD_DISC_DATE": "",
      "CYCLE_BILL": "00",
      "BILLING_STATUS": "R",
      "RATE_INHIBIT": "",
      "CREDIT_CODE": "GOOD",
      "NTD_OLDEST_INVOICE": "735510",
      "TOTAL_INVOICES_PAID": 2,
      "TOTAL_DAYS_TO_PAY": 198,
      "REASON_CODE": "",
      "NTD_OLDEST_CHARGE": "735510"
    }
  ],
  "totalRecords": 1
}
← Subscriber Record
Customer Contacts →