GET | /receipts/paymentreceipt | Returns an html formated payment receipt |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CollectionAttemptId | query | Guid | Yes | The Collection Attempt Id. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Any |
Linked |
OriginatedOnAttempt |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 | |
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 |
Any |
AllocatedToLinkedAttemptBill |
AllocatedToBillOriginatedOnAttempt |
OriginatedOnAttempt |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { bills: [ { referenceId: String, originatingAttemptId: 00000000000000000000000000000000, dateCreated: 0001-01-01, amount: 0, isVoid: False, billTypeId: 0, billType: String, dateDue: 0001-01-01, note: String, isDeleted: False, customerViolationCodeId: 00000000000000000000000000000000, isInJudgement: False, customerAccountNumber: String, paymentPlanStartDate: 0001-01-01, paylockContingencyAmount: 0, shouldApplyContingencyAmount: False, linkType: Any, totalAllocated: 0 } ], payments: [ { } ], customer: String, licenceTag: String, makeModel: String, totalPaid: 0, totalDue: 0, netDue: 0, stickerId: String, attemptDate: 0001-01-01, location: String, condition: String, parkingAreaName: String, bootReturnLoacation: String, bootReturnDate: 0001-01-01, lastCardPaymentPayeeName: String }