GET: ALL PAYMENTS
Type:
GET
Method:
payments
Parameter:
(integer)
{start} / {limit}
URL Example:
https://www.bizstim.com/api/payments/0/20
start parameter refers to the first record to return. Default = 0.limit parameter refers to the number of records to return. Default = 20. Maximum = 100.start and limit can be omitted from the URL and their defaults will be chosen.total key in the json object is the total number of records found. Use this to create your own pagination.| ELEMENT | TYPE | DESCRIPTION |
|---|---|---|
id |
integer | Unique id. id for the revenues table. |
client_id |
integer | Unique id. id on the clients table |
qb_payment_id |
integer | Unique id. id from QuickBooks |
revenue_amount |
string | Payment amount (2 decimal places) |
revenue_tax * |
string | Depracted and not currently in use |
revenue_date |
string | Date of the payment (YYYY-MM-DD) |
revenue_credit |
integer | Type of payment (0=regular payment, 1=credit, 2=debit, 3=package) |
revenue_note |
string | Payment note |
* The revenue_tax field will always be 0.00. This field is not in use.
{
"status": "success",
"total": 175,
"response": [
{
"id": "61",
"client_id": "49",
"qb_payment_id": "0",
"revenue_amount": "16.87",
"revenue_tax": "0.00",
"revenue_date": "2021-02-22",
"revenue_credit": "0",
"revenue_note": ""
},
{
...
}
]
}
GET: PAYMENT
Type:
GET
Method:
payment
Parameter:
(integer)
{payment_id}
URL Example:
https://www.bizstim.com/api/payment/61
| ELEMENT | TYPE | DESCRIPTION |
|---|---|---|
id |
integer | Unique id. id for the revenues table. |
client_id |
integer | Unique id. id on the clients table |
qb_payment_id |
integer | Unique id. id from QuickBooks |
revenue_amount |
string | Payment amount (2 decimal places) |
revenue_tax * |
string | Depracted and not currently in use |
revenue_date |
string | Date of the payment (YYYY-MM-DD) |
revenue_credit |
integer | Type of payment (0=regular payment, 1=credit, 2=debit, 3=package) |
revenue_note |
string | Payment note |
* The revenue_tax field will always be 0.00. This field is not in use.
{
"status": "success",
"response": {
"id": "61",
"client_id": "49",
"qb_payment_id": "0",
"revenue_amount": "16.87",
"revenue_tax": "0.00",
"revenue_date": "2021-02-22",
"revenue_credit": "0",
"revenue_note": ""
}
}