BootView WebApi

<back to all web services

GetCollectionAttemptBills

The following routes are available for this service:
GET/collectionattempts/{attemptId}/billsGet all the bills related to this attempt--either directly linked or where the bill orginated from the attempt. See the link property for attempt associations.
GetCollectionAttemptBills Parameters:
NameParameterData TypeRequiredDescription
AttemptIdpathGuidYesThe collection attempt id for which we want all the bills.

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

HTTP + XML

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

POST /xml/reply/GetCollectionAttemptBills HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetCollectionAttemptBills xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AttemptId>00000000-0000-0000-0000-000000000000</AttemptId>
</GetCollectionAttemptBills>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCollectionAttemptBill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptBill>
    <Amount>0</Amount>
    <BillType>String</BillType>
    <BillTypeId>0</BillTypeId>
    <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
    <CustomerAccountNumber>String</CustomerAccountNumber>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <CustomerViolationCodeId>00000000-0000-0000-0000-000000000000</CustomerViolationCodeId>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateDue>0001-01-01T00:00:00</DateDue>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <IsDeleted>false</IsDeleted>
    <IsInJudgement>false</IsInJudgement>
    <IsVoid>false</IsVoid>
    <LinkType>Any</LinkType>
    <Note>String</Note>
    <OriginatingAttemptId>00000000-0000-0000-0000-000000000000</OriginatingAttemptId>
    <PaylockContingencyAmount>0</PaylockContingencyAmount>
    <PaymentPlanStartDate>0001-01-01T00:00:00</PaymentPlanStartDate>
    <ReferenceId>String</ReferenceId>
    <ShouldApplyContingencyAmount>false</ShouldApplyContingencyAmount>
    <TotalAllocated>0</TotalAllocated>
    <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId>
  </CollectionAttemptBill>
</ArrayOfCollectionAttemptBill>