KellPro API Reference Guide

api.kellpro.com/v2

GET | POST | DELETE treasurer/invoices

Provides information about the invoices associated with tax items.

Resource URL

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

Parameters

id Optional

DELETE — The identifier assigned to the record.

Example: 525

interest_date Optional

POST — The date the interest should be calculated from.

Example: 2020-08-04

interest_percent Optional

Example:

invoice_amount Optional

POST — The total amount of the invoice.

Example: 3148.99

invoice_due Optional

POST — The date, if any that the invoice is due by.

Example: 2020-08-04

invoice_due_maximum Optional

GET — The maximum invoice_due amount on rows that will be returned.

Example: 1000

invoice_due_minimum Optional

GET — The minimum invoice_due amount on rows that will be returned.

Example: 100

invoice_link Optional

POST | DELETE — A system unique identifier used by the customer system to identify the invoice.

Example: 1283

invoice_parent_link Optional

POST — A system unique identifier used by the customer system to link child invoices to the parent invoice.

Example: 3821

invoice_type Optional

POST — A one character representation of the type of invoice. Most of the time will not be set. S=Special Assessment

Example: S

item_number Optional

POST — The tax roll item number assigned to the record. Should be a 1 decimal point float.

Example: 2524.0

offset Optional

GET — Specifies which page of the results to return. Can be used to page through the results returned. Page numbering starts at 1, not 0.

Example: 2

origin Optional

POST — System origin of the data.

Example: kpsMike

owner Optional

POST — The name of the owner associated with the invoice.

Example: Keller, Tim

parcel Optional

POST — The string identifier for the parcel.

Example: 1930-00-001-009-0-000-00

per_page Optional

GET — The number of rows to return per page of results, maximum of 100.

Example: 50

per_type Optional

POST — A one character representation of a narrowed down type of invoice.

Example: F

posted_date Optional

POST — The date the invoice was issued.

Example: 2020-08-04

site_id

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

Example: 2

tax_roll_link Optional

POST — A system unique identifier used by the customer system to identify the tax roll.

Example: 8411

tax_year Optional

POST — The year representing the fiscal year the information is for.

Example: 2012

tax_year_end Optional

GET — The ending year for the tax year date range. Must be accompanied by the tax_year_start parameter.

Example: 2010

tax_year_start Optional

GET — The starting year for the tax year date range. Must be accompanied by the tax_year_end parameter.

Example: 2000

Example Request

GET https://api.kellpro.com/v2/treasurer/invoices.json?site_id=5&invoice_link=11336

[
	{
		"id":4118364,
		"site_id":5,
		"tax_year":2013,
		"tax_roll_link":18960,
		"invoice_link":11336,
		"invoice_amount":"136.0000",
		"invoice_due":"0.0000",
		"interest_date":"2013-12-31",
		"posted_date":"2013-11-12",
		"invoice_parent_link":0,
		"item_number":"19703.0",
		"invoice_type":"R",
		"owner":"BREWER,BLAKE",
		"parcel":"0275-00-007-004-0-001-00",
		"tsvector":"'-0':7A '-00':4A,9A '-001':8A '-004':6A '-007':5A '0275':3A '027500007004000100':10A '19703.0':19A '73648':18C '945':14B 'blake':2A 'box':13B 'brewer':1A 'citi':16C 'elk':15C 'o':12B 'ok':17C 'p':11B",
		"per_type":null,
		"origin":null,
		"payment_attempted_date":null,
		"outdated":null,
		"interest_percent":null
	}
]