BootView WebApi

<back to all web services

GetPaymentReceipt

The following routes are available for this service:
GET/receipts/paymentreceiptReturns an html formated payment receipt
GetPaymentReceipt Parameters:
NameParameterData TypeRequiredDescription
CollectionAttemptIdqueryGuidYesThe Collection Attempt Id.
PaymentReceiptResponse Parameters:
NameParameterData TypeRequiredDescription
BillsformList<CollectionAttemptBill>No
PaymentsformList<CollectionAttemptPayment>No
CustomerformstringNo
LicenceTagformstringNo
MakeModelformstringNo
TotalPaidformdecimalNo
TotalDueformdecimalNo
NetDueformdecimalNo
StickerIdformstringNo
AttemptDateformDateTime?No
LocationformstringNo
ConditionformstringNo
ParkingAreaNameformstringNo
BootReturnLoacationformstringNo
BootReturnDateformDateTime?No
CollectionAttemptBill Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
ReferenceIdformstringNo
OriginatingAttemptIdformGuid?No
CreatedByUserIdformGuidNo
DateCreatedformDateTimeNo
AmountformdecimalNo
IsVoidformboolNo
BillTypeIdformintNo
BillTypeformstringNo
DateDueformDateTimeNo
NoteformstringNo
IsDeletedformboolNo
VehicleIdformGuidNo
CustomerViolationCodeIdformGuid?No
IsInJudgementformbool?No
CustomerIdformGuidNo
CustomerAccountNumberformstringNo
PaymentPlanStartDateformDateTime?No
PaylockContingencyAmountformdecimal?No
ShouldApplyContingencyAmountformbool?No
LinkTypeformBillAssociatedToAttemptByNo
TotalAllocatedformdecimalNo
CollectionAttemptPayment Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TransactionNumberformintNo
OriginatingAttemptIdformGuid?No
BatchNumberformintNo
TotalAmountformdecimalNo
PlacedDateformDateTimeNo
IsSuccessfulformboolNo
PaymentTypeformstringNo
CreatedByUserIdformGuidNo
FirstNameformstringNo
LastNameformstringNo
PhoneformstringNo
EmailformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateCodeformstringNo
PostalCodeformstringNo
CountryCodeformstringNo
PaymentNoteformstringNo
IsDeletedformboolNo
CustomerIdformGuidNo
CustomerReceiptNumberformstringNo
CustomerReceiptDateformDateTime?No
LinkTypeformPaymentAssociatedToAttemptByNo
TotalAllocatedformdecimalNo
CreatedByUserNameformstringNo

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/GetPaymentReceipt HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetPaymentReceipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
</GetPaymentReceipt>
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>
  <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>