GET | /bills | Find all the bills that meet the search criteria |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | query | Guid | No | The customer Id for which we want the bills. |
Followup | query | bool | No | Whether the bill is flagged for followup. |
LicenseTag | query | string | No | The license tag. |
LicenseState | query | string | No | The license state. |
CarMakeModel | query | string | No | The car make and model. |
CarColor | query | string | No | The car color. |
ReferenceId | query | string | No | The reference Id. |
BillType | query | int | No | The bill type. |
IsPaid | query | int | No | Whether the bill has been paid. |
IsVoid | query | int | No | Whether the bill has been voided. |
DueFrom | query | DateTime | No | The earliest bill issued date. |
DueTo | query | DateTime | No | The most recent bill issued date. |
FirstName | query | string | No | First name on the bill. |
LastName | query | string | No | Last name on the bill. |
StickerId | query | string | No | The sticker Id. |
SortField | query | string | No | The sort field. |
PageIndex | query | int | No | The page index. |
PageSize | query | int | No | Number of results to return. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | No | |
LastName | form | string | No | |
AddressStreet1 | form | string | No | |
City | form | string | No | |
BillId | form | Guid | No | |
DateCreated | form | DateTime | No | |
State | form | string | No | |
Zip | form | string | No | |
OriginatingAttemptId | form | Guid | No | |
IsVoid | form | bool | No | |
ReferenceId | form | string | No | |
VehicleId | form | Guid | No | |
BootedOn | form | DateTime | No | |
UserName | form | string | No | |
Phonenumber | form | string | No | |
LicenseTag | form | string | No | |
LicenseState | form | string | No | |
CarMakeModel | form | string | No | |
CarColor | form | string | No | |
IsFollowup | form | bool | No | |
AmountDue | form | decimal | No | |
CollectionAttemptId | form | Guid | No | |
AmountPaid | form | decimal | No | |
NetDue | form | decimal | No | |
CustomerCode | form | string | No | |
StickerId | form | string | No | |
BillTypeId | form | int | No | |
BillType | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /bills HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { firstName: String, lastName: String, addressStreet1: String, city: String, billId: 00000000000000000000000000000000, dateCreated: 0001-01-01, state: String, zip: String, originatingAttemptId: 00000000000000000000000000000000, isVoid: False, referenceId: String, vehicleId: 00000000000000000000000000000000, bootedOn: 0001-01-01, userName: String, phonenumber: String, licenseTag: String, licenseState: String, carMakeModel: String, carColor: String, isFollowup: False, amountDue: 0, collectionAttemptId: 00000000000000000000000000000000, amountPaid: 0, netDue: 0, customerCode: String, stickerId: String, billTypeId: 0, billType: String }