Skip to main content

ClearView CRM Connector (Technical Reference)

Philippe Trussart avatar
Written by Philippe Trussart
Updated this week

Generated from connector source on 2025-09-08 15:35:04 UTC

Overview

The ClearView CRM connector pulls data from the ClearView CRM API into your Bytespree data lake.

Key characteristics:

  • API base: https://api.clearviewcrm.com/{VERSION}/api/proc

  • Default API VERSION: pm02prod (overridable via config).

  • Authentication: HTTP Basic (username & password) tied to a ClearView dsource (data source).

  • Payloads/Responses: XML via datafile requests; action get_table_pg.

  • All columns are extracted as strings.

  • The connector treats TCN as the row uniqueness field.

Setup & Configuration

Provide the following settings:

{ "dsource": "<your ClearView dsource>", "username": "<api username>", "password": "<api password>", "api_version": "pm02prod" }

Sync Behavior

  • Initial sync start: 01/01/2000 12:00:00 am.

  • Window size: 7 days per request window.

  • Pagination:

    1. A header call returns REQUESTID and TOTAL_PAGES for a date window.

    2. Page calls use that REQUESTID plus a PAGE index (1..TOTAL_PAGES).

  • Page size: 50 records per page.

  • Change filtering: Request XML uses <CHANGE_START> and <CHANGE_END> to limit rows by the API's change tracking.

  • No saved bookmark/state: Each run iterates windows from the initial sync date up to the time of execution. Downstream deduplication should rely on TCN.

Error Handling & Retries

  • Retries with exponential backoff (up to 5 attempts) for header and page fetches.

  • XML is validated; any element containing ERROR triggers an exception and retry.

  • Non-mapped fields in API responses are ignored and logged; see Schema Handling.

Schema Handling

  • The connector uses a static table map (see below). Any field not listed for a table is not emitted (but a warning is logged).

  • Field names from XML are normalized by replacing . with _.

  • All fields are typed as strings in the current implementation.

Known Limitations / Notes

  • Because there is no incremental bookmark, a full windowed backfill runs on each execution — potentially slow on large datasets.

  • Page size is fixed at 50; very large tables result in many page calls.

  • Some tables are wide (e.g., PAYMENT, PROSPECT, APPEALS, GIFT_VIEW), which can increase payload size and processing time.

  • Only the fields listed below are synced; new fields introduced by ClearView will be dropped until this connector’s schema map is updated.

Tables & Columns

(Columns are listed alphabetically for each table.)

ACTIONS

Column count: 11

1. CODE
2. DESCRIPTION
3. FB_INDICATOR
4. SETDATE
5. TCN
6. TENANT_ID
7. TIMESTAMP
8. TYPE
9. UPDATE_DATE
10. USERID_ADD
11. USERID_CHANGE

ADDITIONAL_DEMOGRAPHICS

Column count: 28

1. AGE  
2. BIRTHYEAR  
3. CHILDREN  
4. DECEASED  
5. DOB  
6. DOBVERIFIED  
7. DOD  
8. GENERATIONCODE  
9. GENDER  
10. IDNUMBER  
11. MAIDEN  
12. MARITAL  
13. MC1SDATE  
14. MCODE1  
15. SPOUSEDECEASED  
16. SPOUSEDOB  
17. SPOUSEDOBVERIFIED  
18. SPOUSEDOD  
19. SPOUSEGENDER  
20. TCN  
21. TENANT_ID  
22. TIMESTAMP  
23. UPDATE_DATE  
24. USERID_ADD  
25. USERID_CHANGE  
26. USERNUMBER1  
27. USERTEXT1  
28. USERTEXT2

ADDRESS

Column count: 21

1.  ATYPE  
2.  CARRTE  
3.  CASSDATE  
4.  CHECK_DIGIT  
5.  CITY  
6.  CONGRESS  
7.  DELIVERABLE  
8.  DELIVERY_LINE  
9.  DELIVERY_POINT  
10. IDNUMBER  
11. LINE1  
12. PREFERENCE  
13. SEASONAL  
14. STANDARDIZED  
15. STATE  
16. TCN  
17. TENANT_ID  
18. TIMESTAMP  
19. TRANSNUM  
20. USERID_ADD  
21. ZIP

ADDRESSES

Column count: 31

1.  ATYPE
2.  CASSDATE
3.  CHECK_DIGIT
4.  CITY
5.  CODE
6.  CONGRESS
7.  COUNTY_FIPS
8.  COUNTY_NAME
9.  DELIVERABLE
10. DELIVERY_LINE
11. DELIVERY_POINT
12. DESCRIPTION
13. IDNUMBER
14. LATITUDE
15. LINE1
16. LINE2
17. LINE3
18. LONGITUDE
19. PREFERENCE
20. PS_STATUS_CODE
21. SEASONAL
22. STANDARDIZED
23. STARTDATE
24. STATE
25. TCN
26. TIMESTAMP
27. TYPE
28. UPDATE_DATE
29. USERID_ADD
30. USERID_CHANGE
31. ZIP

APPEALS

Column count: 105

1.  ACKNOWLEDGEMENT
2.  ADDITIONAL_SQL
3.  APPEAL
4.  APPEALCODE
5.  ASSIGN_PRIORITY
6.  CAMPAIGNCODE
7.  CHANNEL
8.  COMMON_GIFT_MHIGH
9.  COMMON_GIFT_MLOW
10. COMMON_GIFT__x0024_HIGH
11. COMMON_GIFT__x0024_LOW
12. COST_COMPLETE
13. COST_PER_1000
14. DATE_MAILED
15. DEFAULT_ACKNOWLEDGEMENT
16. END_DATE
17. EXPIRATION
18. FIRST_CONTR_DATE
19. FIRST_GIFT_ALTERNATE_MHIGH
20. FIRST_GIFT_ALTERNATE_MLOW
21. FIRST_GIFT_ALTERNATE__x0024_HIGH
22. FIRST_GIFT_ALTERNATE__x0024_LOW
23. FIRST_GIFT_MHIGH
24. FIRST_GIFT_MLOW
25. FIRST_GIFT__x0024_HIGH
26. FIRST_GIFT__x0024_LOW
27. FUNDCODE
28. INTERESTS_EXCL
29. INTERESTS_INCL
30. ISGIFTAPPEAL
31. ISPROMOTION
32. LARGEST_GIFT_MHIGH
33. LARGEST_GIFT_MLOW
34. LARGEST_GIFT__x0024_HIGH
35. LARGEST_GIFT__x0024_LOW
36. LIST_BROKER
37. MOST_RECENT_ALTERNATE_MHIGH
38. MOST_RECENT_ALTERNATE_MLOW
39. MOST_RECENT_ALTERNATE__x0024_HIGH
40. MOST_RECENT_ALTERNATE__x0024_LOW
41. MOST_RECENT_GIFT_MHIGH
42. MOST_RECENT_GIFT_MLOW
43. MOST_RECENT_GIFT__x0024_HIGH
44. MOST_RECENT_GIFT__x0024_LOW
45. NUM_GIFTS_PER1_MHIGH
46. NUM_GIFTS_PER1_MLOW
47. NUM_GIFTS_PER1__x0023_HIGH
48. NUM_GIFTS_PER1__x0023_LOW
49. NUM_GIFTS_PER1__x0024_HIGHSUM
50. NUM_GIFTS_PER1__x0024_LOWSUM
51. NUM_GIFTS_PER2_MHIGH
52. NUM_GIFTS_PER2_MLOW
53. NUM_GIFTS_PER2__x0023_HIGH
54. NUM_GIFTS_PER2__x0023_LOW
55. NUM_GIFTS_PER2__x0024_HIGHSUM
56. NUM_GIFTS_PER2__x0024_LOWSUM
57. NUM_GIFTS__x0023_HIGH
58. NUM_GIFTS__x0023_LOW
59. NUM_GIFTS__x0024_HIGHSUM
60. NUM_GIFTS__x0024_LOWSUM
61. PACKAGECODE
62. PER1_ANDOR_PER2
63. PIECES_MAILED
64. QRY_ID
65. REMARK
66. S_FIRST_MHIGH
67. S_FIRST_MLOW
68. S_FIRST__x0024_HIGH
69. S_FIRST__x0024_LOW
70. S_LARGEST_MHIGH
71. S_LARGEST_MLOW
72. S_LARGEST__x0024_HIGH
73. S_LARGEST__x0024_LOW
74. S_MOST_RECENT_MHIGH
75. S_MOST_RECENT_MLOW
76. S_MOST_RECENT__x0024_HIGH
77. S_MOST_RECENT__x0024_LOW
78. S_TOTAL__x0023_HIGH
79. S_TOTAL__x0023_LOW
80. S_TOTAL__x0024_HIGHSUM
81. S_TOTAL__x0024_LOWSUM
82. SEND_ACKNOWLEDGEMENT
83. START_DATE
84. TCN
85. TENANT_ID
86. TEST_COUNT
87. TEST_PANEL_NUM
88. TEST_PERCENTAGE
89. TEST_REMAINDER
90. TIMESTAMP
91. TOTAL_x0023_
92. TOTAL_x0023_REQ_WO_CONTR
93. TOTAL_x0023_REQ_W_CONTR
94. TOTAL_x0023__NEW
95. TOTAL_x0023__x0024_100
96. TOTAL_x0023__x0024_100_NEW
97. TOTAL_x0024_
98. TOTAL_x0024__NEW
99. TOTAL_x0024__x0024_100
100. TOTAL_x0024__x0024_100_NEW
101. UPDATE_DATE
102. USERID_ADD
103. USERID_CHANGE
104. ZERO_GIFTS_PER1
105. ZERO_GIFTS_PER2

CONTACT

Column count: 29

1.  ACTIONCODE
2.  ACTIONDATE
3.  APPEALCODE
4.  C_DATE
5.  C_END_DATE
6.  C_TIME
7.  CONTACTEEID
8.  FUNDCODE
9.  IDNUMBER
10. PREV_CONTACT
11. PROPOSALNUMBER
12. REMARK
13. SEQ
14. SOLICITORCODE
15. STATUSCODE
16. TCN
17. TENANT_ID
18. TIMESTAMP
19. TRACK
20. TRANSNUM
21. UNITID
22. UPDATE_DATE
23. USERCODE1
24. USERCODE2
25. USERCODE3
26. USERID_ADD
27. USERID_CHANGE
28. USERNUMBER1
29. VOLUNTEER_ID

EMAIL

Column count: 19

1.  ALLOW_ATTACH
2.  ATYPE
3.  DELIVERABLE
4.  EMAIL
5.  ENDDATE
6.  FORMAT_PREF
7.  IDNUMBER
8.  OPT_OUT
9.  PREFERENCE
10. REMARK
11. SEASONAL
12. STARTDATE
13. TCN
14. TENANT_ID
15. TIMESTAMP
16. TRANSNUM
17. UPDATE_DATE
18. USERID_ADD
19. USERID_CHANGE

EVENTS

Column count: 17

1.  CODE
2.  DESCRIPTION
3.  EVENT_END
4.  EVENT_START
5.  EVENTS_EVENT_END_TIME
6.  EVENTS_EVENT_START_TIME
7.  EVENTS_REG_DATE_START_TIME
8.  ISTEMPLATE
9.  REG_DATE_START
10. REMARK
11. TCN
12. TENANT_ID
13. TIMESTAMP
14. UNITID
15. UPDATE_DATE
16. USERID_ADD
17. USERID_CHANGE

EVENT_FEES

Column count: 23

1. AUDIENCE_TYPE
2. BENEFIT
3. DEFAULT_AMOUNT
4. DEFAULT_QTY
5. DESCRIPTION
6. EVENT
7. FEE_DESCRIPTION
8. FEECODE
9. FEEGROUP
10. REGISTRANT_TYPE
11. TCN
12. TIMESTAMP
13. TOTAL_FEEAMOUNT
14. TOTAL_FEEBALANCE
15. TOTAL_FEECOUNT
16. TOTAL_FEEQUANTITY
17. TRANSNUM
18. TYPE
19. U_DISCOUNT
20. U_STANDARD
21. UPDATE_DATE
22. USERID_ADD
23. USERID_CHANGE

EVENT_FEE_PACKAGES

Column count: 9

1.  EVENT
2.  FEE_GROUPCODES_DESCR
3.  FEE_GROUPCODES_TYPE
4.  FEEGROUP
5.  REMARK
6.  TCN
7.  TIMESTAMP
8.  TRANSNUM
9.  USERID_ADD

EVENT_FEE_SUBSIDIES

Column count: 15

1.  DESCRIPTION
2.  EVENT_PKG_ID
3.  FEEGROUP
4.  FEE_ID
5.  FEE_PACKAGES_FEEGROUP
6.  PROSPECTID
7.  REMARK
8.  TCN
9.  TIMESTAMP
10. TOTAL_FEEAMOUNT
11. TOTAL_FEECOUNT
12. TOTAL_FEEQUANTITY
13. TOTAL_FEESUBSIDY
14. TRANSNUM
15. USERID_ADD

EVENT_GROUPS

Column count: 12

1. EVENT
2. GOALAMT
3. GROUPNAME
4. GROUPTYPE
5. NUMPOSITIONS
6. POSITIONTYPE
7. TCN
8. TIMESTAMP
9. TRANSNUM
10. UPDATE_DATE
11. USERID_ADD
12. USERID_CHANGE

FUNDS

Column count: 9

1. ENDOWMENT
2. FUND
3. FUNDCODE
4. TCN
5. TENANT_ID
6. TIMESTAMP
7. UPDATE_DATE
8. USERID_ADD
9. USERID_CHANGE

GIFT

Column count: 71

1.  ACKNOWLEDGED
2.  ACKNOWLEDGEMENT
3.  ANONYMOUS
4.  APPEALCODE
5.  APRIL
6.  ASSOC_ATTACHED
7.  AUGUST
8.  BALANCE
9.  BATCHNO
10. BATCHTRANSNUM
11. BATCH_GIFTDATE
12. BATCH_TRANTYPE
13. BILLS
14. CLASSCODE
15. DBACCOUNTNO
16. DECEMBER
17. DISPLAY_DATE
18. DOCUMENT_NUMBER
19. EXPIRATION
20. EXTERNAL_ID
21. EXTERNAL_SOURCE
22. FEBRUARY
23. FIRSTPAYMENT
24. FREQUENCY
25. FREQUENCYTYPE
26. FUNDCODE
27. GIFTAMOUNT
28. GIFTDATE
29. GIFTTYPE
30. HMFLAG
31. HM_REMARK
32. HONOR
33. IDNUMBER
34. JANUARY
35. JULY
36. JUNE
37. LAST_BATCHNO
38. MARCH
39. MATCH
40. MAY
41. MERGED
42. MULTIPLIER
43. NEXTPAYMENT
44. NOTIFY_ATTACHED
45. NOVEMBER
46. NUMPAYMENTS
47. OCTOBER
48. ORIGAMT
49. PREM_ATTACHED
50. PREMIUM_DECLINED
51. PROPOSALNUMBER
52. QUANTITY
53. REMARK
54. SEC_REMARK
55. SEPTEMBER
56. SOFT_CREDIT
57. SOLICITORCODE
58. TCN
59. TENANT_ID
60. TIMESTAMP
61. TRANSNUM
62. TRANTYPE
63. UPDATE_DATE
64. USERCODE1
65. USERFLAG1
66. USERFLAG2
67. USERFLAG3
68. USERID_ADD
69. USERID_CHANGE
70. USERTEXT1
71. UNITID

GIFT_VIEW

Column count: 77

1.  ACKNOWLEDGED
2.  ACKNOWLEDGEMENT
3.  ACKNOWLEDGEMENT_DESC
4.  ANONYMOUS
5.  APPEAL
6.  APPEALCODE
7.  APRIL
8.  ASSOC_ATTACHED
9.  AUGUST
10. BALANCE
11. BATCHNO
12. BATCHTRANSNUM
13. BILLS
14. CLASSCODE
15. CLASSIFICATION
16. DBACCOUNTDESC
17. DBACCOUNTNO
18. DECEMBER
19. DISPLAY_DATE
20. DOCUMENT_NUMBER
21. EXPIRATION
22. EXTERNAL_ID
23. EXTERNAL_SOURCE
24. FEBRUARY
25. FIRSTPAYMENT
26. FREQUENCY
27. FREQUENCYTYPE
28. FUND
29. FUNDCODE
30. GIFTAMOUNT
31. GIFTDATE
32. GIFTDESC
33. GIFTTYPE
34. HMFLAG
35. HM_REMARK
36. HONOR
37. IDNUMBER
38. JANUARY
39. JULY
40. JUNE
41. LAST_BATCHNO
42. MARCH
43. MATCH
44. MAY
45. MULTIPLIER
46. NEXTPAYMENT
47. NOTIFY_ATTACHED
48. NOVEMBER
49. NUMPAYMENTS
50. OCTOBER
51. ORIGAMT
52. PREMIUM_DECLINED
53. PREM_ATTACHED
54. PROPOSALNUMBER
55. QUANTITY
56. REMARK
57. SEC_REMARK
58. SEPTEMBER
59. SOFTCREDITID
60. SOFT_CREDIT
61. SOLICITOR
62. SOLICITORCODE
63. SOLICITOR_ID
64. TCN
65. TIMESTAMP
66. TRANSNUM
67. TRANTYPE
68. UNITID
69. UPDATE_DATE
70. USERCODE1
71. USERCODE1_DESC
72. USERFLAG1
73. USERFLAG2
74. USERFLAG3
75. USERID_ADD
76. USERID_CHANGE
77. USERTEXT1

INTEREST

Column count: 13

1.  CATCODE
2.  END_DATE
3.  IDATE
4.  IDNUMBER
5.  INTCODE
6.  REMARK
7.  TCN
8.  TENANT_ID
9.  TIMESTAMP
10. TRANSNUM
11. UPDATE_DATE
12. USERID_ADD
13. USERID_CHANGE

ITEMS

Column count: 23

1.  ASSEMBLYTYPE
2.  CATEGORYCODE
3.  DESCRIPTION
4.  FUNDCODE
5.  INDIV_SALE
6.  ISGIFTOPP
7.  ISOFFICEITEM
8.  ISORDERITEM
9.  ISPREMIUM
10. ISRECOGNITION
11. ITEMCODE
12. ITEMPRICE
13. STARTDATE
14. STATUS
15. STOCK_FLAG
16. TAXABLE_FLAG
17. TCN
18. TIMESTAMP
19. UPDATE_DATE
20. USERID_ADD
21. USERID_CHANGE
22. VARPRICEFLAG
23. WAREHOUSE

MAIL

Column count: 31

1.  APPEALCODE
2.  CAMPAIGNCODE
3.  C_ACTIVITYID
4.  COMMONGIFT
5.  EMAIL
6.  FIRSTGIFT
7.  FIRSTGIFTDATE
8.  IDNUMBER
9.  INHOME_DATE
10. LASTGIFT
11. LASTGIFTDATE
12. MAIL_COST
13. MAIL_OCCUR
14. MAIL_POSTAGE
15. MAIL_STATUS
16. MAIL_TABLE
17. MAXGIFT
18. MAXGIFTDATE
19. PER1_NUM
20. PER1_SUM
21. TCN
22. TENANT_ID
23. TIMESTAMP
24. TOTALGIFTS
25. TOTALPAYAMOUNT
26. TRANSNUM
27. UNITID
28. UPDATE_DATE
29. USERID_ADD
30. USERID_CHANGE
31. ZIP

MEMBERSHIP

Column count: 17

1.  CARDID1
2.  CARDNAME1
3.  COMPLIMENTARY
4.  DECLINED_FLAG
5.  EXPIRATION
6.  IDNUMBER
7.  LENGTH_CHOSEN
8.  LEVEL_CODE
9.  MATCH
10. MEM_AMOUNT
11. MEM_DATE
12. MEMBER_SINCE
13. MEMBERSHIP_LENGTH
14. MEMBERSHIP_START
15. MEMBERSHIP_STATUS
16. MEMBERSHIP_TYPE
17. TCN

MEMO

Column count: 14

1.  IDNUMBER
2.  MEMO_DATE
3.  SECTIONCODE
4.  TCN
5.  TENANT_ID
6.  TEXT
7.  TEXT_HTM
8.  TEXT_HTML
9.  TIMESTAMP
10. TRANSNUM
11. UNITID
12. UPDATE_DATE
13. USERID_ADD
14. USERID_CHANGE

PAYMENT

Column count: 138

1.  ACKNOWLEDGED
2.  ACKNOWLEDGED_DATE
3.  ACKNOWLEDGEMENT
4.  ANONYMOUS
5.  APPEALCODE
6.  APRIL
7.  ATYPE
8.  AUGUST
9.  BATCHNO
10. BATCHTRANSNUM
11. BILLFLAG
12. CARRTE
13. CASSDATE
14. CFIRST
15. CHECK_DATE
16. CHECK_DIGIT
17. CHECK_NUMBER
18. CITY
19. CLASSCODE
20. CLAST
21. CNAME_ID
22. CONGRESS
23. CORPORATE_ID
24. CORPORATELINKTYPE
25. COUNTY_FIPS
26. COUNTY_NAME
27. CT_ACCESS
28. DECEMBER
29. DELIVERY_LINE
30. DELIVERY_POINT
31. DELIVERABLE
32. DOCUMENT_NUMBER
33. EMAIL_ALLOW_ATTACH
34. EMAIL_ATYPE
35. EMAIL_DELIVERABLE
36. EMAIL_EMAIL
37. EMAIL_FORMAT_PREF
38. EMAIL_IDNUMBER
39. EMAIL_PREFERENCE
40. EMAIL_SEASONAL
41. EMAIL_TIMESTAMP
42. EMAIL_TCN
43. EMAIL_TRANSNUM
44. EMAIL_USERID_ADD
45. EMAILFLAG
46. EXTERNAL_ID
47. EXTERNAL_SOURCE
48. FAMILIAR
49. FAMILYLINKTYPE
50. FEBRUARY
51. FIRST
52. FOOTNOTE
53. FREQUENCYTYPE
54. FUNDCODE
55. GIFTTYPE
56. GREETING
57. GREETINGPREF
58. HMFLAG
59. HM_REMARK
60. HONOR
61. IDNUMBER
62. ISUNIT
63. JANUARY
64. JULY
65. JUNE
66. LAST
67. LATITUDE
68. LINE1
69. LONGITUDE
70. LTRANSNUM
71. MAILFLAG
72. MARCH
73. MATCH
74. MAY
75. MIDDLE
76. NOVEMBER
77. OCTOBER
78. PAY_METHOD
79. PAYAMOUNT
80. PAYDATE
81. PHONE_AREACODE
82. PHONEFLAG
83. PHONE_IDNUMBER
84. PHONE_PHONE
85. PHONE_PREFERENCE
86. PHONE_PTYPE
87. PHONE_SEASONAL_PHONE
88. PHONE_TIMESTAMP
89. PHONE_TRANSNUM
90. PHONE_USERID_ADD
91. PREFERENCE
92. PS_STATUS_CODE
93. RECEIPT
94. RECEIVED
95. RECORDTYPE
96. REMARK
97. REVDATE
98. REVTRANSNUM
99. REVTRANTYPE
100. SALUTCODE
101. SEASONAL
102. SEC_REMARK
103. SEPTEMBER
104. SOLICIT
105. SOLICITORCODE
106. SPLIT_TOTAL
107. SPLIT_TRANSNUM
108. STANDARDIZED
109. STATE
110. SUFFIX
111. TCN
112. TENANT_ID
113. TIMESTAMP
114. TITLECODE
115. TRANSFER_REASON
116. TRANSFER_SOURCE
117. TRANSNUM
118. TRANTYPE
119. UNITID
120. UPDATE_DATE
121. USERCODE0
122. USERCODE1
123. USERCODE2
124. USERCODE3
125. USERCODE4
126. USERCODE5
127. USERCODE6
128. USERCODE7
129. USERCODE8
130. USERFLAG1
131. USERFLAG2
132. USERFLAG3
133. USERID_ADD
134. USERID_CHANGE
135. USERNUMBER1
136. USERNUMBER2
137. USERTEXT1
138. ZIP

PROSPECT

Column count: 92

1.  BATCHNO
2.  TITLECODE
3.  ACQ_ACCOUNT
4.  IDNUMBER
5.  FIRSTNAME
6.  LASTNAME
7.  MIDDLENAME
8.  SUFFIX
9.  PREFIX
10. GENDER
11. MARITALSTATUS
12. EMAIL
13. PHONE
14. DOB
15. DECEASED_DATE
16. TYPE
17. PRIMARY_ADDRESS_STREET1
18. PRIMARY_ADDRESS_STREET2
19. PRIMARY_ADDRESS_CITY
20. PRIMARY_ADDRESS_STATE
21. PRIMARY_ADDRESS_POSTAL_CODE
22. PRIMARY_ADDRESS_COUNTRY
23. PRIMARY_ADDRESS_TYPE
24. TENANT_ID
25. TIMESTAMP
26. UPDATE_DATE
27. USERID_ADD
28. USERID_CHANGE
29. TCN
30. DOBVERIFIED
31. SOLICIT
32. MAILFLAG
33. FOOTNOTE
34. FAMILYLINKTYPE
35. RECORDTYPE
36. GREETINGPREF
37. GREETING
38. CORPORATELINKTYPE
39. CT_ACCESS
40. ANONYMOUS
41. ISUNIT
42. FREQUENCYTYPE
43. JANUARY
44. FEBRUARY
45. MARCH
46. APRIL
47. MAY
48. JUNE
49. JULY
50. AUGUST
51. SEPTEMBER
52. OCTOBER
53. NOVEMBER
54. DECEMBER
55. BILLFLAG
56. CNAME_ID
57. EMAILFLAG
58. PHONEFLAG
59. CDECEASED
60. USERCODE1
61. USERCODE2
62. USERCODE3
63. USERCODE4
64. USERCODE8
65. USERCODE0
66. SOURCECODE
67. USERNUMBER1
68. USERNUMBER2
69. FIRST
70. MIDDLE
71. LAST
72. SALUTCODE
73. FAMILIAR
74. REFERENCE
75. LISTING
76. CFIRST
77. CMIDDLE
78. CLAST
79. CSALUTCODE
80. USERDATE1
81. USERCODE6
82. CFAMILIAR
83. CSUFFIX
84. SOLICITORCODE
85. ALERT_MESSAGE
86. USERCODE5
87. USERCODE9
88. USERCODE7
89. CTITLECODE
90. FAMILY_ID
91. UNITID
92. CORPORATE_ID

REGISTRATION

Column count: 19

1.  BALANCE
2.  COMPLIMENTARY
3.  EVENT
4.  IDNUMBER
5.  LOCATION
6.  PREMIUM_DECLINED
7.  REMARK
8.  T_DATE
9.  TCN
10. TENANT_ID
11. TIMESTAMP
12. TOTAL
13. TRANSNUM
14. UNITID
15. UPDATE_DATE
16. USERCODE6
17. USERFLAG1
18. USERID_ADD
19. USERID_CHANGE

REG_NAME

Column count: 16

1.  ATTENDED
2.  FNAME
3.  GROUPID
4.  NAME
5.  NAME_ID
6.  POSITIONID
7.  REGID
8.  TCN
9.  TENANT_ID
10. TIMESTAMP
11. TRANSNUM
12. UPDATE_DATE
13. USERTEXT1
14. USERTEXT2
15. USERID_ADD
16. USERID_CHANGE

TRACKING

Column count: 33

1.  APPEALCODE
2.  D_AMOUNT
3.  D_DATE
4.  DEADLINE
5.  DEPARTMENT
6.  DESCRIPTION
7.  FUNDCODE
8.  GRANTYEAR
9.  IC_DATE
10. IDNUMBER
11. LETTERTYPE
12. OFFERED_AMOUNT
13. OFFERED_DATE
14. OPPORTUNITY_TYPE
15. ORIGIN
16. OUTCOME_TYPE
17. PRIORITY
18. PROBABILITY
19. PROPOSALNUMBER
20. PROJECTED
21. PROJECTED_DATE
22. REMARK
23. REQUESTED
24. REQUESTED_DATE
25. SOLICITORCODE
26. STATUS
27. TCN
28. TENANT_ID
29. TIMESTAMP
30. UPDATE_DATE
31. USERID_ADD
32. USERID_CHANGE
33. USERNUMBER1

UNIT

Column count: 15

1.  INACTIVE
2.  LEVEL
3.  LEVEL6_ID
4.  LEVEL9_ID
5.  START_DATE
6.  TCN
7.  TENANT_ID
8.  TIMESTAMP
9.  TYPE
10. TYPE_DESCRIPTION
11. UNITID
12. UNIT_TYPE
13. UPDATE_DATE
14. USERID_ADD
15. USERID_CHANGE

USER_FAVORITE

Column count: 14

1.  DESCRIPTION
2.  GROUPINGID
3.  LINK_TYPE
4.  LINKED_DOC
5.  LINKED_REC
6.  SEQ
7.  TCN
8.  TENANT_ID
9.  TIMESTAMP
10. TRANSNUM
11. UPDATE_DATE
12. USERID
13. USERID_ADD
14. USERID_CHANGE

API Request Shapes (for reference)

Header (window registration) request XML:

<?xml version="1.0" encoding="UTF-8"?> <XMLREQUEST> <RECORD> <TABLE>{TABLE_NAME}</TABLE> <PAGESIZE>{PAGE_SIZE}</PAGESIZE> <CHANGE_START>{MM/DD/YYYY HH:MI:SS am/pm}</CHANGE_START> <!-- optional --> <CHANGE_END>{MM/DD/YYYY HH:MI:SS am/pm}</CHANGE_END> <!-- optional --> </RECORD> </XMLREQUEST>

Page request XML:

<?xml version="1.0" encoding="UTF-8"?> <XMLREQUEST> <RECORD> <TABLE>{TABLE_NAME}</TABLE> <REQUESTID>{REQUEST_ID}</REQUESTID> <PAGE>{PAGE_NUMBER}</PAGE> </RECORD> </XMLREQUEST>

Field-Level Notes

  • Many tables include common audit fields: TENANT_ID, TCN, TIMESTAMP, UPDATE_DATE, USERID_ADD, USERID_CHANGE.

  • Address-like tables include standardized address components; event-related tables include start/end date+time split fields.

Did this answer your question?