| URL |
Description and Resources |
GET
[agencyID].landmax.pro/api/payments/preceipts?apiKey=[YourAPIKey]
Get list of receipts and information.
{
"success": true,
"results": 40,
"rows": [
{
"sid": "agxlfmxhbmRtYXgtZXVyLwsSDlBSZWNlaXB0RW50aXR5IhsxeT",
"date": 1470394818659,
"reference": "PR-0059",
"outgoing": true,
"amount": 70000,
"unprocessedAmount": 0,
"note": "",
"partySid": "agxlfmxhbmRtYXgtZXVyNgsSB0NvbnRhY3QYgICAgKOHggoMCxIMUFBhcn",
"contactCard": {
"sid": "agxlfmxhbmRtYXgtZXVyFAsSB0NvbnRhY3QYgICAgKOHggoMogEKbG14d2Vic2l0ZQ",
"fullName": "Romo Ltd",
"name": "Romo Ltd",
"surname": "",
"email": null,
"address": "Not Specified",
"phones": [
],
"phoneNumber": null,
"phoneNumberRaw": null,
"photoUrl": "//storage.googleapis.com/cdn.landmax.pro/img/no_user.gif",
"company": true,
"personType": null,
"persons": {
"LANDLORD": "Landlord"
},
"contactSid": "agxlfmxhbmRtYXgtZXVyFAsSB0NvbnRhY3QYgICAgKOHggoMogEKbG14d2Vic2l0ZQ"
},
"partyProfile": "LANDLORD",
"partyProfileFriendlyName": "Landlord",
"partyType": "PRIMARY",
"agencyBankAccount": {
"itemId": "-1",
"bankName": "",
"address": null,
"accountName": " Not set",
"accountNumber": "",
"sortCode": ""
},
"partyBankAccount": {
"itemId": "-1",
"bankName": "",
"address": null,
"accountName": " Not set",
"accountNumber": "",
"sortCode": ""
},
"paymentMethod": "CASH"
}, |
|
| Parameters |
Example |
| beforeDate |
beforeDate=2016-09-01 |
| before |
|
| partySid |
|
|
GET
[agencyID].landmax.pro/api/payments/preceipts/[sid]?apiKey=[YourAPIKey]
Get individual receipt information.
{
"sid": "agxlfmxhbmRtYXgtZXVyLwsSDlBSZWNlaXB0RW50aXR",
"date": 1469713569039,
"reference": "PR-0058",
"outgoing": false,
"amount": 120000,
"unprocessedAmount": 120000,
"note": "",
"partySid": "agxlfmxhbmRtYXgtZXVyNAsSB0NvbnRhY3QYgICAgNXOgl",
"contact": {
"bankAccountInfo": null,
"employmentInfo": {
"employerName": null,
"position": null,
"address": null,
"phone": null,
"email": null,
"website": null
},
"sid": "agxlfmxhbmRtYXgtZXVyFAsSB0NvbnRhY3QYgICAgNXOgQoMogEKbG14d2Vic2l0ZQ",
"firstName": "Lucy",
"surName": "Loo",
"fullName": "Lucy Loo",
"title": "Mr",
"address": null,
"addressStr": null,
"email": null,
"phone": null,
"photo": "//storage.googleapis.com/cdn.landmax.pro/img/no_user.gif",
"contactPersons": [
],
"representsCompany": false,
"correspondenceAddress": null
},
"partyProfile": "TENANT",
"partyProfileFriendlyName": "Tenant",
"partyType": "PRIMARY",
"agencyBankAccount": {
"itemId": "-1",
"bankName": "",
"address": null,
"accountName": " Not set",
"accountNumber": "",
"sortCode": ""
},
"partyBankAccount": {
"itemId": "-1",
"bankName": "",
"address": null,
"accountName": " Not set",
"accountNumber": "",
"sortCode": ""
},
"paymentMethod": "CASH",
"historyItemGroups": [
],
"processedVatTotal": 0,
"singleHistoryItemGroups": false
} |
|
|
GET
[agencyID].landmax.pro/api/payments/plogs?apiKey=[YourAPIKey]
Get list of Due Payments.
{
"success": true,
"results": 100,
"rows": [
{
"sid": "agxlfmxhbmRtYXgtZXVyKwsSClBMb2dFbnRpdHkiGzF5Mm96enFrb2x1M",
"date": 1472616410237,
"type": "RECEIVABLE",
"amount": 100000,
"unpaidAmount": 100000,
"description": "Rent payment from 31/08/2016 to 29/11/2016 due for tenancy T0035: 5 Cessford Farm Cottages,
KELSO, Roxburghshire, TD5 8EG",
"partyKey": "agxlfmxhbmRtYXgtZXVyNAsSB0NvbnRhY3QYgICAgPDekAkMCxIMUFB",
"vat": 0.0,
"nominalCode": 1001,
"contextKey": "agxlfmxhbmRtYXgtZXVyGgsSDVRlbmFuY3lFbnRpdHkYgICAgMffmwoMogEKbG14d2Vic2l0ZQ",
"agencyBankAccount": null,
"partyBankAccount": null,
"paymentMethod": null,
"relatedGroup": "Invoice PG-0148",
"relatedGroupSid": "agxlfmxhbmRtYXgtZXVyLQsSDFBHcm91cEVudGl0eSIbMXkyb3p6cTZlNXlzc",
"partyProfile": "TENANT",
"partyProfileFriendlyName": "Tenant",
"partyType": "PRIMARY",
"contactCard": {
"sid": "agxlfmxhbmRtYXgtZXVyFAsSB0NvbnRhY3QYgICAgPDekAkMogEKbG14d2Vic2l0ZQ",
"fullName": "Mike Saunders",
"name": "Mike",
"surname": "Saunders",
"email": null,
"address": "Not Specified",
"phones": [
],
"phoneNumber": null,
"phoneNumberRaw": null,
"photoUrl": "//storage.googleapis.com/cdn.landmax.pro/img/no_user.gif",
"company": false,
"personType": null,
"persons": {
"TENANT": "Tenant"
},
"contactSid": "agxlfmxhbmRtYXgtZXVyFAsSB0NvbnRhY3QYgICAgPDekAkMogEKbG14d2Vic2l0ZQ"
},
"contextType": "TENANCY",
"contextTenancy": {
"sid": "agxlfmxhbmRtYXgtZXVyGgsSDVRlbmFuY3lFbnRpdHkYgICAgMffmwoMogEKbG14d2Vic2l0ZQ",
"tenancyDescription": "T0035: 5 Cessford Farm Cottages, KELSO, Roxburghshire, TD5 8EG",
"propertyAddressStr": "5 Cessford Farm Cottages, KELSO, Roxburghshire, TD5 8EG",
"tenantNames": [
"Mike Saunders"
]
},
"contextProperty": null,
"contextContractorJob": null,
"status": {
"paidAmount": 0,
"balancedAmount": 0,
"dueAmount": 100000,
"overdueDays": 82
}
}, |
|
| Parameter |
Example |
| beforeDate |
beforeDate=2016-09-01 |
| before |
|
| partySid |
|
| contextSid |
|
|
GET
[agencyID].landmax.pro/api/payments/pgroups?apiKey=[YourAPIKey]
Get list of Statement/Invoice Information.
Example Response:
"success": true,
"results": 91,
"rows": [
{
"sid": "agxlfmxhbmRtYXgtZXVyLQsSDFBH",
"date": 1470802312184,
"reference": "PG-0126",
"outgoing": false,
"note": "For property: The Lodge, Bristol, TR5",
"partySid": "agxlfmxhbmRtYXgtZXVyNAsSB0NvbnRhY3QYgICAwISaiQo",
"contactCard": {
"sid": "agxlfmxhbmRtYXgtZXVyFAsSB0NvbnRhY3QYgICAwISaiQoMogEKbG14d2Vic2l0ZQ",
"fullName": "Sam Burns",
"name": "Sam",
"surname": "Burns",
"email": null,
"address": "Not Specified",
"phones": [
],
"phoneNumber": null,
"phoneNumberRaw": null,
"photoUrl": "//storage.googleapis.com/cdn.landmax.pro/img/no_user.gif",
"company": false,
"personType": null,
"persons": {
"TENANT": "Tenant"
},
"contactSid": "agxlfmxhbmRtYXgtZXVyFAsSB0NvbnRhY3QYgICAwISaiQoMogEKbG14d2Vic2l0ZQ"
},
"partyProfile": "TENANT",
"partyProfileFriendlyName": "Tenant",
"partyType": "PRIMARY",
"status": {
"paidPayablesAmount": 0,
"paidReceivablesAmount": 0,
"balancedReceivablesAmount": 0,
"balancedPayablesAmount": 0,
"duePayablesAmount": 0,
"dueReceivablesAmount": 200000,
"maxOverdueDays": 143
}
}, |
|
| Parameter |
Example |
| beforeDate |
beforeDate=2016-09-01 |
| before |
|
| partySid |
|
| outgoing |
|
|
|
|
