KellPro API Reference Guide

api.kellpro.com/v2

GET | POST | DELETE treasurer/receipts

Provides information about the receipts associated with invoices.

Resource URL

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

Parameters

id Optional

DELETE — The identifier assigned to the record.

Example: 525

invoice_link Optional

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

Example: 1283

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

paid_by Optional

POST — The name of the person who paid the receipt

Example: SMITH, JOHN

paid_date Optional

POST — The date the invoice was paid.

Example: 2020-09-22

paid_date_end Optional

GET — The ending date for the paid_date date range. Must be accompanied by the paid_date_start parameter.

Example: 2000-02-10

paid_date_start Optional

GET — The starting date for the paid_date date range. Must be accompanied by the paid_date_end parameter.

Example: 2000-01-01

paid_fees Optional

POST — The fees amount paid on the receipt.

Example: 348.99

paid_penalties Optional

POST — The penalties amount paid on the receipt.

Example: 148.99

paid_total Optional

POST — The total amount paid on the receipt.

Example: 3148.99

per_page Optional

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

Example: 50

posted_date Optional

POST — The date the receipt was posted.

Example: 2020-09-22

receipt_link Optional

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

Example: 1283

receipt_number Optional

POST — The system number assigned to the receipt.

Example: 001283

site_id

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

Example: 2

tax_roll_link Optional

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

Example: 8411

Example Request

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

[
	{
		"id":3477028,
		"site_id":5,
		"receipt_link":29336,
		"receipt_number":"15150",
		"posted_date":null,
		"paid_date":"2014-01-03",
		"paid_by":"DOUGLAS M PHENIX TRUTEE",
		"paid_total":"161.0000",
		"paid_penalties":"0.0000",
		"paid_fees":"0.0000",
		"invoice_link":15234,
		"origin":null
	}
]