BootView WebApi

<back to all web services

FindBills

The following routes are available for this service:
GET/billsFind all the bills that meet the search criteria
FindBills Parameters:
NameParameterData TypeRequiredDescription
CustomerIdqueryGuidNoThe customer Id for which we want the bills.
FollowupqueryboolNoWhether the bill is flagged for followup.
LicenseTagquerystringNoThe license tag.
LicenseStatequerystringNoThe license state.
CarMakeModelquerystringNoThe car make and model.
CarColorquerystringNoThe car color.
ReferenceIdquerystringNoThe reference Id.
BillTypequeryintNoThe bill type.
IsPaidqueryintNoWhether the bill has been paid.
IsVoidqueryintNoWhether the bill has been voided.
DueFromqueryDateTimeNoThe earliest bill issued date.
DueToqueryDateTimeNoThe most recent bill issued date.
FirstNamequerystringNoFirst name on the bill.
LastNamequerystringNoLast name on the bill.
StickerIdquerystringNoThe sticker Id.
SortFieldquerystringNoThe sort field.
PageIndexqueryintNoThe page index.
PageSizequeryintNoNumber of results to return.
BillSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
AddressStreet1formstringNo
CityformstringNo
BillIdformGuidNo
DateCreatedformDateTimeNo
StateformstringNo
ZipformstringNo
OriginatingAttemptIdformGuidNo
IsVoidformboolNo
ReferenceIdformstringNo
VehicleIdformGuidNo
BootedOnformDateTimeNo
UserNameformstringNo
PhonenumberformstringNo
LicenseTagformstringNo
LicenseStateformstringNo
CarMakeModelformstringNo
CarColorformstringNo
IsFollowupformboolNo
AmountDueformdecimalNo
CollectionAttemptIdformGuidNo
AmountPaidformdecimalNo
NetDueformdecimalNo
CustomerCodeformstringNo
StickerIdformstringNo
BillTypeIdformintNo
BillTypeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/FindBills HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/csv
Content-Length: length

{"customerId":"00000000000000000000000000000000","followup":false,"licenseTag":"String","licenseState":"String","carMakeModel":"String","carColor":"String","referenceId":"String","billType":0,"isPaid":0,"isVoid":0,"dueFrom":"\/Date(-62135596800000-0000)\/","dueTo":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","stickerId":"String","sortField":"String","pageIndex":0,"pageSize":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"firstName":"String","lastName":"String","addressStreet1":"String","city":"String","billId":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","state":"String","zip":"String","originatingAttemptId":"00000000000000000000000000000000","isVoid":false,"referenceId":"String","vehicleId":"00000000000000000000000000000000","bootedOn":"\/Date(-62135596800000-0000)\/","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"}