| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <BillSearchResultItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel"> <AddressStreet1>String</AddressStreet1> <AmountDue>0</AmountDue> <AmountPaid>0</AmountPaid> <BillId>00000000-0000-0000-0000-000000000000</BillId> <BillType>String</BillType> <BillTypeId>0</BillTypeId> <BootedOn>0001-01-01T00:00:00</BootedOn> <CarColor>String</CarColor> <CarMakeModel>String</CarMakeModel> <City>String</City> <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId> <CustomerCode>String</CustomerCode> <DateCreated>0001-01-01T00:00:00</DateCreated> <FirstName>String</FirstName> <IsFollowup>false</IsFollowup> <IsVoid>false</IsVoid> <LastName>String</LastName> <LicenseState>String</LicenseState> <LicenseTag>String</LicenseTag> <NetDue>0</NetDue> <OriginatingAttemptId>00000000-0000-0000-0000-000000000000</OriginatingAttemptId> <Phonenumber>String</Phonenumber> <ReferenceId>String</ReferenceId> <State>String</State> <StickerId>String</StickerId> <UserName>String</UserName> <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId> <Zip>String</Zip> </BillSearchResultItem>