BootView WebApi

GetPaymentReceipt

The following routes are available for this service:
GET	/receipts/paymentreceipt	Returns an html formated payment receipt

**GetPaymentReceipt** Parameters:
Name	Parameter	Data Type	Required	Description
CollectionAttemptId	query	Guid	Yes	The Collection Attempt Id.

**PaymentReceiptResponse** Parameters:
Name	Parameter	Data Type	Required
Bills	form	List<CollectionAttemptBill>	No
Payments	form	List<CollectionAttemptPayment>	No
Customer	form	string	No
LicenceTag	form	string	No
MakeModel	form	string	No
TotalPaid	form	decimal	No
TotalDue	form	decimal	No
NetDue	form	decimal	No
StickerId	form	string	No
AttemptDate	form	DateTime?	No
Location	form	string	No
Condition	form	string	No
ParkingAreaName	form	string	No
BootReturnLoacation	form	string	No
BootReturnDate	form	DateTime?	No
LastCardPaymentPayeeName	form	string	No

**CollectionAttemptBill** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
ReferenceId	form	string	No
OriginatingAttemptId	form	Guid?	No
CreatedByUserId	form	Guid	No
DateCreated	form	DateTime	No
Amount	form	decimal	No
IsVoid	form	bool	No
BillTypeId	form	int	No
BillType	form	string	No
DateDue	form	DateTime	No
Note	form	string	No
IsDeleted	form	bool	No
VehicleId	form	Guid	No
CustomerViolationCodeId	form	Guid?	No
IsInJudgement	form	bool?	No
CustomerId	form	Guid	No
CustomerAccountNumber	form	string	No
PaymentPlanStartDate	form	DateTime?	No
PaylockContingencyAmount	form	decimal?	No
ShouldApplyContingencyAmount	form	bool?	No
LinkType	form	BillAssociatedToAttemptBy	No
TotalAllocated	form	decimal	No

**BillAssociatedToAttemptBy** Enum:
Any
Linked
OriginatedOnAttempt

**CollectionAttemptPayment** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
TransactionNumber	form	int	No
OriginatingAttemptId	form	Guid?	No
BatchNumber	form	int	No
TotalAmount	form	decimal	No
PlacedDate	form	DateTime	No
IsSuccessful	form	bool	No
PaymentType	form	string	No
CreatedByUserId	form	Guid	No
FirstName	form	string	No
LastName	form	string	No
Phone	form	string	No
Email	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
StateCode	form	string	No
PostalCode	form	string	No
CountryCode	form	string	No
PaymentNote	form	string	No
IsDeleted	form	bool	No
CustomerId	form	Guid	No
CustomerReceiptNumber	form	string	No
CustomerReceiptDate	form	DateTime?	No
LinkType	form	PaymentAssociatedToAttemptBy	No
TotalAllocated	form	decimal	No
CreatedByUserName	form	string	No

**PaymentAssociatedToAttemptBy** Enum:
Any
AllocatedToLinkedAttemptBill
AllocatedToBillOriginatedOnAttempt
OriginatedOnAttempt

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.

GET /receipts/paymentreceipt HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentReceiptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AttemptDate>0001-01-01T00:00:00</AttemptDate>
  <Bills>
    <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>
  </Bills>
  <BootReturnDate>0001-01-01T00:00:00</BootReturnDate>
  <BootReturnLoacation>String</BootReturnLoacation>
  <Condition>String</Condition>
  <Customer>String</Customer>
  <LastCardPaymentPayeeName>String</LastCardPaymentPayeeName>
  <LicenceTag>String</LicenceTag>
  <Location>String</Location>
  <MakeModel>String</MakeModel>
  <NetDue>0</NetDue>
  <ParkingAreaName>String</ParkingAreaName>
  <Payments>
    <CollectionAttemptPayment i:nil="true" />
  </Payments>
  <StickerId>String</StickerId>
  <TotalDue>0</TotalDue>
  <TotalPaid>0</TotalPaid>
</PaymentReceiptResponse>