KellPro API Reference Guide

api.kellpro.com/v2

GET | POST | DELETE treasurer/mortgagecodes

Provides information about the receipts associated with invoices.

Resource URL

https://api.kellpro.com/v2/treasurer/mortgagecodes.format

Parameters

address1 Optional

POST — The first address line for the contact information.

Example: 1729 W. Plato Rd.

address2 Optional

POST — The second address line for the contact information.

Example:

city Optional

POST — The city for the contact information.

Example: Duncan

contact_name Optional

POST — The name of the contact associated with the mortgage code.

Example: Keller, Tim

email Optional

POST — The email for the contact information.

Example: test@test.com

fax Optional

POST — The fax number for the contact information.

Example: 1234567890

hide_online Optional

POST — A flag to hide the tax rolls associated with the mortgage code.

Example: TRUE|FALSE

hide_statement_message Optional

POST — A flag to hide the statement message.

Example: TRUE|FALSE

id Optional

DELETE — The identifier assigned to the record.

Example: 525

mortgage_code Optional

POST — The mortgage code assigned to the provider or company

Example: 0123

mortgage_code_link Optional

POST — A system unique identifier used by the customer system to identify the mortgage code

Example: 12345

mortgage_company Optional

POST — The company associated with the mortgage code

Example: Core Logic

phone Optional

POST — The fax number for the contact information.

Example: 1234567890

postal Optional

POST — The postal code for the contact information.

Example: 73533

provider Optional

POST — The company associated with the mortgage code

Example: Core Logic

site_id

GET | POST | DELETE — The identifier assigned to the site.

Example: 2

state Optional

POST — The state for the contact information.

Example: OK

statement_message Optional

POST — A message to be displayed on the tax rolls.

Example: This is not a bill.

Example Request

GET https://api.kellpro.com/v2/treasurer/mortgagecodes.json?site_id=5&mortgage_code_link=4564

[
	{
		"id":1518,
		"site_id":5,
		"mortgage_code_link":4564,
		"provider":"",
		"mortgage_code":"00001",
		"mortgage_company":"B A C",
		"contact_name":"",
		"address1":"888-210-8757",
		"address2":"2142094932",
		"city":"",
		"state":"",
		"postal":"",
		"phone":"",
		"fax":"",
		"email":"",
		"statement_message":"***DO NOT REMIT PAYMENT - THIS IS FOR YOUR RECORDS ONLY***",
		"hide_statement_message":0,
		"hide_online":0
	}
]