POST api/PTGetFolioHeader
Documentation for 'Post'.
Request Information
Request body formats
application/json, text/json
Sample:
{
"JurisdictionNumber": "sample string 1",
"RollNumber": "sample string 2"
}
Response Information
Response body formats
application/json, text/json
Sample:
{
"PTFolioHeader": {
"JurNum": "sample string 1",
"RollNum": "sample string 2",
"ClientCode": "sample string 3",
"MailingAddress": "sample string 4",
"Email": "sample string 5",
"ContactEmail": "sample string 6",
"PrimaryPropertyAddress": "sample string 7",
"CurrentAssessmentItems": [
{
"AssessmentTypeCode": "sample string 1",
"PropertyClassCode": "sample string 2",
"Amount": 3.0
},
{
"AssessmentTypeCode": "sample string 1",
"PropertyClassCode": "sample string 2",
"Amount": 3.0
},
{
"AssessmentTypeCode": "sample string 1",
"PropertyClassCode": "sample string 2",
"Amount": 3.0
}
],
"LegalReference": "sample string 8",
"OwnerName": "sample string 9",
"OwnerTypeCode": "sample string 10",
"OwnerTypeDesc": "sample string 11",
"ClientName": "sample string 12",
"ClientTypeCode": "sample string 13",
"ClientTypeDesc": "sample string 14",
"FolioStatusCode": "sample string 15",
"FolioStatusDesc": "sample string 16",
"Phone1": "sample string 17",
"Phone2": "sample string 18",
"Fax": "sample string 19",
"UBAccounts": [
{
"HAS_UNAPPLIED_CREDITS": true,
"VCH_PIN": "sample string 2",
"CLIENT_TYPE_CODE": "sample string 3",
"PT_FOLIO_CLIENT_CODE": "sample string 4",
"ADD_DISC_CODE_DESC": "sample string 5",
"ADD_DISC_CAT_CODE_DESC": "sample string 6",
"PROPERTY_ADDRESS": "sample string 7",
"PROP_FOLIO_NUMBER": "sample string 8",
"ORIG_HASH": "sample string 9",
"CustomFieldList": [
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
},
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
},
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
}
],
"BOOK_NUM": "sample string 10",
"ACCT_NUM": "sample string 11",
"SEQ_NUM": "sample string 12",
"CLIENT_CODE": "sample string 13",
"ADDRESS_NUM": 1,
"ACCT_STAT_CODE": "sample string 14",
"TENANT_FLAG": "sample string 15",
"MAIL_SEQ": "sample string 16",
"PROP_ST_NUM1": "sample string 17",
"PROP_ST_NUM2": "sample string 18",
"PROP_UNIT_NUM1": "sample string 19",
"PROP_UNIT_NUM2": "sample string 20",
"PROP_ST_NAME": "sample string 21",
"PROP_ST_DIR": "sample string 22",
"PROP_POSTAL_ZIP": "sample string 23",
"PROP_JUR_NUM": "sample string 24",
"PROP_ROLL_NUM": "sample string 25",
"ACCT_START_DATE": "2025-04-03T21:26:38.999505-07:00",
"ACCT_TERM_DATE": "2025-04-03T21:26:38.999505-07:00",
"XREF_ACCT": "sample string 26",
"CLASS_CODE": "sample string 27",
"LETTER_STAGE_CODE": "sample string 28",
"DEP_STAT_CODE": "sample string 29",
"DEP_AMT": 1.0,
"DEP_RCVD_DATE": "2025-04-03T21:26:38.999505-07:00",
"DEP_APPL_DATE": "2025-04-03T21:26:38.999505-07:00",
"DEP_INT_AMT": 1.0,
"DEP_INT_DATE": "2025-04-03T21:26:38.999505-07:00",
"XFER_TAXES_FLAG": "sample string 30",
"ADD_DISC_CODE": "sample string 31",
"ADD_DISC_CAT_CODE": "sample string 32",
"DEF_CAT_CODE": "sample string 33",
"PEN_FLAG": "sample string 34",
"INS_USER": "sample string 35",
"INS_DATE": "2025-04-03T21:26:38.999505-07:00",
"UPD_USER": "sample string 36",
"UPD_DATE": "2025-04-03T21:26:38.999505-07:00",
"BILL_CLIENT_CODE": "sample string 37",
"PROP_CITY": "sample string 38",
"CUST_DDF": 1.0,
"CUST_SUMMER_BL": 1.0,
"CUST_WINTER_BL": 1.0,
"UB_CUST_AREA_CODE": "sample string 39",
"UB_CUST_GATE_STATION": "sample string 40",
"UB_PEN_START_YEAR": 1,
"UB_PEN_START_MONTH": 1,
"UB_CUST_TAX_EXEMPT": "sample string 41",
"LANGUAGE_CODE": "sample string 42",
"UB_PEN_HOLD_UNTIL_DATE": "2025-04-03T21:26:38.999505-07:00"
},
{
"HAS_UNAPPLIED_CREDITS": true,
"VCH_PIN": "sample string 2",
"CLIENT_TYPE_CODE": "sample string 3",
"PT_FOLIO_CLIENT_CODE": "sample string 4",
"ADD_DISC_CODE_DESC": "sample string 5",
"ADD_DISC_CAT_CODE_DESC": "sample string 6",
"PROPERTY_ADDRESS": "sample string 7",
"PROP_FOLIO_NUMBER": "sample string 8",
"ORIG_HASH": "sample string 9",
"CustomFieldList": [
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
},
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
},
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
}
],
"BOOK_NUM": "sample string 10",
"ACCT_NUM": "sample string 11",
"SEQ_NUM": "sample string 12",
"CLIENT_CODE": "sample string 13",
"ADDRESS_NUM": 1,
"ACCT_STAT_CODE": "sample string 14",
"TENANT_FLAG": "sample string 15",
"MAIL_SEQ": "sample string 16",
"PROP_ST_NUM1": "sample string 17",
"PROP_ST_NUM2": "sample string 18",
"PROP_UNIT_NUM1": "sample string 19",
"PROP_UNIT_NUM2": "sample string 20",
"PROP_ST_NAME": "sample string 21",
"PROP_ST_DIR": "sample string 22",
"PROP_POSTAL_ZIP": "sample string 23",
"PROP_JUR_NUM": "sample string 24",
"PROP_ROLL_NUM": "sample string 25",
"ACCT_START_DATE": "2025-04-03T21:26:38.999505-07:00",
"ACCT_TERM_DATE": "2025-04-03T21:26:38.999505-07:00",
"XREF_ACCT": "sample string 26",
"CLASS_CODE": "sample string 27",
"LETTER_STAGE_CODE": "sample string 28",
"DEP_STAT_CODE": "sample string 29",
"DEP_AMT": 1.0,
"DEP_RCVD_DATE": "2025-04-03T21:26:38.999505-07:00",
"DEP_APPL_DATE": "2025-04-03T21:26:38.999505-07:00",
"DEP_INT_AMT": 1.0,
"DEP_INT_DATE": "2025-04-03T21:26:38.999505-07:00",
"XFER_TAXES_FLAG": "sample string 30",
"ADD_DISC_CODE": "sample string 31",
"ADD_DISC_CAT_CODE": "sample string 32",
"DEF_CAT_CODE": "sample string 33",
"PEN_FLAG": "sample string 34",
"INS_USER": "sample string 35",
"INS_DATE": "2025-04-03T21:26:38.999505-07:00",
"UPD_USER": "sample string 36",
"UPD_DATE": "2025-04-03T21:26:38.999505-07:00",
"BILL_CLIENT_CODE": "sample string 37",
"PROP_CITY": "sample string 38",
"CUST_DDF": 1.0,
"CUST_SUMMER_BL": 1.0,
"CUST_WINTER_BL": 1.0,
"UB_CUST_AREA_CODE": "sample string 39",
"UB_CUST_GATE_STATION": "sample string 40",
"UB_PEN_START_YEAR": 1,
"UB_PEN_START_MONTH": 1,
"UB_CUST_TAX_EXEMPT": "sample string 41",
"LANGUAGE_CODE": "sample string 42",
"UB_PEN_HOLD_UNTIL_DATE": "2025-04-03T21:26:38.999505-07:00"
},
{
"HAS_UNAPPLIED_CREDITS": true,
"VCH_PIN": "sample string 2",
"CLIENT_TYPE_CODE": "sample string 3",
"PT_FOLIO_CLIENT_CODE": "sample string 4",
"ADD_DISC_CODE_DESC": "sample string 5",
"ADD_DISC_CAT_CODE_DESC": "sample string 6",
"PROPERTY_ADDRESS": "sample string 7",
"PROP_FOLIO_NUMBER": "sample string 8",
"ORIG_HASH": "sample string 9",
"CustomFieldList": [
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
},
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
},
{
"EntityName": "sample string 1",
"FieldName": "sample string 2",
"Value": "sample string 3",
"Label": "sample string 4",
"FieldType": "sample string 5"
}
],
"BOOK_NUM": "sample string 10",
"ACCT_NUM": "sample string 11",
"SEQ_NUM": "sample string 12",
"CLIENT_CODE": "sample string 13",
"ADDRESS_NUM": 1,
"ACCT_STAT_CODE": "sample string 14",
"TENANT_FLAG": "sample string 15",
"MAIL_SEQ": "sample string 16",
"PROP_ST_NUM1": "sample string 17",
"PROP_ST_NUM2": "sample string 18",
"PROP_UNIT_NUM1": "sample string 19",
"PROP_UNIT_NUM2": "sample string 20",
"PROP_ST_NAME": "sample string 21",
"PROP_ST_DIR": "sample string 22",
"PROP_POSTAL_ZIP": "sample string 23",
"PROP_JUR_NUM": "sample string 24",
"PROP_ROLL_NUM": "sample string 25",
"ACCT_START_DATE": "2025-04-03T21:26:38.999505-07:00",
"ACCT_TERM_DATE": "2025-04-03T21:26:38.999505-07:00",
"XREF_ACCT": "sample string 26",
"CLASS_CODE": "sample string 27",
"LETTER_STAGE_CODE": "sample string 28",
"DEP_STAT_CODE": "sample string 29",
"DEP_AMT": 1.0,
"DEP_RCVD_DATE": "2025-04-03T21:26:38.999505-07:00",
"DEP_APPL_DATE": "2025-04-03T21:26:38.999505-07:00",
"DEP_INT_AMT": 1.0,
"DEP_INT_DATE": "2025-04-03T21:26:38.999505-07:00",
"XFER_TAXES_FLAG": "sample string 30",
"ADD_DISC_CODE": "sample string 31",
"ADD_DISC_CAT_CODE": "sample string 32",
"DEF_CAT_CODE": "sample string 33",
"PEN_FLAG": "sample string 34",
"INS_USER": "sample string 35",
"INS_DATE": "2025-04-03T21:26:38.999505-07:00",
"UPD_USER": "sample string 36",
"UPD_DATE": "2025-04-03T21:26:38.999505-07:00",
"BILL_CLIENT_CODE": "sample string 37",
"PROP_CITY": "sample string 38",
"CUST_DDF": 1.0,
"CUST_SUMMER_BL": 1.0,
"CUST_WINTER_BL": 1.0,
"UB_CUST_AREA_CODE": "sample string 39",
"UB_CUST_GATE_STATION": "sample string 40",
"UB_PEN_START_YEAR": 1,
"UB_PEN_START_MONTH": 1,
"UB_CUST_TAX_EXEMPT": "sample string 41",
"LANGUAGE_CODE": "sample string 42",
"UB_PEN_HOLD_UNTIL_DATE": "2025-04-03T21:26:38.999505-07:00"
}
],
"ShowPhaseInValueLabel": true,
"ShowPhaseInValue": true,
"ShowInterestAndTotal": true,
"PhaseInValue": 23.0,
"PaymentPlanStatusCode": "sample string 24",
"PaymentPlanTypeDesc": "sample string 25",
"PIDs": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"HogType": "sample string 26",
"SaleFlag": true,
"ProvinceCode": "sample string 28",
"InterestApplicable": true
}
}