Kickserv APIv2 - Payments Object

This documention is neither written nor endorsed by Kickserv. It has not been reviewed by Kickserv for accuracy and the API is entirely unsupported. It may work, it may not. You are responsible for anything that you do using the API and Kickserv can't undo it for you. Use at your own risk.

Mouseover the JSON key to see a brief description of each key. Keys that either haven't been identified (or that we haven't gotten around to adding yet) will show 'XXX'. Keys that are light gray are obsolete/legacy but still are returned in API responses.

Each payment recorded in Kickserv exists as its own payment object. Depending on the specifics of the payment some of the fields may change. For example, the 'payment_type' if the first entry below reflects a payment through Stripe, whereas the second payment was manually recorded. Each object also contains a customer object (which has been removed here for ease of reading). Payments can be retrieved from a few different endpoints and there are some differences in formatting - the format below is what's returned inside a job object.

Date recorded in the 'ref_number' field will sync to Quickbooks, but the 'notes' field will not.

If you spot a mistake or know the purpose of an undescribed key please let us know by emailing kickservapi@veildg.com.

Back to object map list

[
{
"id": 555666777,
"date": "2022-05-09",
"payment_type": "Credit Card (Online)",
"amount": "1464.27",
"notes": "Stripe Payment for 1 Job: #11111.n From Customer Michael Customer (#3921)",
"ref_number": null,
"txn_id": "16608",
"created_at": "2022-05-09T15:55:14-04:00",
"updated_at": "2022-05-11T12:57:55-04:00",
"updated_by": 394511,
"stripe_payment_id": "ch_3KxcegFEG4MjwVK6Ty2dVcdgYC",
"qb_error": null,
"status": "credit_card_transaction_complete",
"customer": { ** Customer object ** }
},
{
"id": 444555666,
"date": "2022-06-05",
"payment_type": "Credit Card",
"amount": "1163.56",
"notes": null,
"ref_number": null,
"txn_id": null,
"created_at": "2022-06-05T11:09:49-04:00",
"updated_at": "2022-06-05T11:09:49-04:00",
"updated_by": 61956,
"stripe_payment_id": null,
"qb_error": null,
"status": "transaction_complete",
"customer": { ** Customer object ** }
}
]