reapit / foundations

Foundations platform mono repo
57 stars 22 forks source link

Tenancy Start/End Date Not being Returned by API #5540

Closed tsadlerbrs closed 2 years ago

tsadlerbrs commented 2 years ago

Describe the bug We have an issue currently in live with Bective relating to some tenancy records not returning the start/end date of a tenancy along with the lettings fee in one example

This has been verified with Bective and they have confirmed that the values are configured correctly in Reapit UI so we're un-clear why these data fields are not being returned.

I've attached screen shots at the footer of the ticket

To Reproduce

Make a call to the tenancies API method with customer code URA

Tenancy IDs in question are:

NHO210062

API Response:

{ "_embedded": [ { "id": "NHO210062", "created": "2021-07-12T08:48:20Z", "modified": "2021-07-12T08:48:32Z", "startDate": null, "endDate": null, "status": "offerPending", "agentRole": "rentCollection", "rent": 750, "rentFrequency": "weekly", "endDateConfirmed": false, "isPeriodic": false, "rentInstalmentsFrequency": "monthly", "rentInstalmentsAmount": 3250.0, "rentInstalmentsStart": null, "meterReadingGas": null, "meterReadingGasLastRead": null, "meterReadingElectricity": null, "meterReadingElectricityLastRead": null, "meterReadingWater": null, "meterReadingWaterLastRead": null, "typeId": "AS", "negotiatorId": "RG", "propertyId": "NHO170043", "applicantId": "LGO211541", "lettingFee": { "type": "percentage", "amount": 0.0, "frequency": "monthly" }, "managementFee": { "type": "fixed", "amount": 8.0, "frequency": "sameAsLettingFee" }, "source": { "id": "SRC010", "type": "source" }, "related": [], "fromArchive": false, "_eTag": "\"087FAB9DD058F640B56CD5FA7CCA7598\"", "_links": { "self": { "href": "/tenancies/NHO210062" }, "documents": { "href": "/documents/?associatedType=tenancy&associatedId=NHO210062" }, "tasks": { "href": "/tasks/?tenancyId=NHO210062" }, "checks": { "href": "/tenancies/NHO210062/checks" }, "appointments": { "href": "/appointments/?attendeeType=tenancy&attendeeId=NHO210062" }, "type": { "href": "/configuration/tenancyTypes/AS" }, "negotiator": { "href": "/negotiators/RG" }, "property": { "href": "/properties/NHO170043" }, "applicant": { "href": "/applicants/LGO211541" }, "source": { "href": "/sources/SRC010" } }, "_embedded": null, "metadata": {} } ], "pageNumber": 1, "pageSize": 100, "pageCount": 1, "totalPageCount": 1, "totalCount": 1, "_links": { "self": { "href": "/tenancies/?PageNumber=1&PageSize=100&id=NHO210062" }, "first": { "href": "/tenancies/?PageNumber=1&PageSize=100&id=NHO210062" } } }

NHO210149

{ "_embedded": [ { "id": "NHO210149", "created": "2021-10-19T16:34:44Z", "modified": "2021-10-19T16:34:52Z", "startDate": null, "endDate": null, "status": "offerPending", "agentRole": "rentCollection", "rent": 525, "rentFrequency": "weekly", "endDateConfirmed": false, "isPeriodic": false, "rentInstalmentsFrequency": "monthly", "rentInstalmentsAmount": 2275.0, "rentInstalmentsStart": null, "meterReadingGas": null, "meterReadingGasLastRead": null, "meterReadingElectricity": null, "meterReadingElectricityLastRead": null, "meterReadingWater": null, "meterReadingWaterLastRead": null, "typeId": "AS", "negotiatorId": "RG", "propertyId": "NHO190250", "applicantId": "NHO212091", "lettingFee": { "type": "percentage", "amount": 10.0, "frequency": "monthly" }, "managementFee": { "type": "percentage", "amount": 10.0, "frequency": "sameAsLettingFee" }, "source": { "id": "SRC008", "type": "source" }, "related": [], "fromArchive": false, "_eTag": "\"BA5450C8A77AD4DD505ADCA383F4DCF1\"", "_links": { "self": { "href": "/tenancies/NHO210149" }, "documents": { "href": "/documents/?associatedType=tenancy&associatedId=NHO210149" }, "tasks": { "href": "/tasks/?tenancyId=NHO210149" }, "checks": { "href": "/tenancies/NHO210149/checks" }, "appointments": { "href": "/appointments/?attendeeType=tenancy&attendeeId=NHO210149" }, "type": { "href": "/configuration/tenancyTypes/AS" }, "negotiator": { "href": "/negotiators/RG" }, "property": { "href": "/properties/NHO190250" }, "applicant": { "href": "/applicants/NHO212091" }, "source": { "href": "/sources/SRC008" } }, "_embedded": null, "metadata": {} } ], "pageNumber": 1, "pageSize": 100, "pageCount": 1, "totalPageCount": 1, "totalCount": 1, "_links": { "self": { "href": "/tenancies/?PageNumber=1&PageSize=100&id=NHO210149" }, "first": { "href": "/tenancies/?PageNumber=1&PageSize=100&id=NHO210149" } } }

Expected behaviour We expect the start date, end date and lettings fee to be returned by the API as they are configured in the tenancy record in the Reapit UI

Screenshots

image

image

image

plittlewood-rpt commented 2 years ago

Hi @tsadlerbrs I don't think you are looking at the right records. The records in your JSON extract are for pending lettings offers (so there generally won't be a tenancy start/end date at this point), and your screenshots are for a current and arranging tenancy respectively. I've just checked both NHO210149 and NHO210062 and neither have dates set so the API is responding as intended. Please can you double check your examples and let me know if there is something to investigate. If there is no issue please close the ticket as appropriate. Thanks

plittlewood-rpt commented 2 years ago

Hi @tsadlerbrs - please can you confirm if you have been able to review the above? The API looks to be behaving as intended. If we don't hear back from you the ticket will be closed. Thanks

tsadlerbrs commented 2 years ago

@plittlewood-rpt My colleague is reviewing this today - will revert back and either close or raise any issues if required.

Thanks

tsadlerbrs commented 2 years ago

@plittlewood-rpt Sorry for the delay - have been going back and forth with the client on this to get the relevant info needed.

When we try searching on tenancies by property code (NHO210062 example) we got no results back.

Bective have provided us with the tenancy code NHO170043 for the tenancy in question - again when searching the tenancies endpoint we do not get a response back.

I've included below the screen shot the client has sent us (sensitive info redacted) which shows the tenancy record highlighted:

image

I do notice in the background it has a status of "tenancy current - unavailable" - not sure of the purpose of this status but could this be related to why we're not getting a tenancy back from the API?

Many Thanks,

Tom

plittlewood-rpt commented 2 years ago

Hi @tsadlerbrs

Thanks for coming back to me. Please can you let me know the specific calls you are making where you aren't getting the expected data returned (URLs, query string parameters etc) and I can get someone to have a look

Thanks Pete

tsadlerbrs commented 2 years ago

Hi @plittlewood-rpt

I have tried two different methods – calling the endpoint as follows:

https://platform.reapit.cloud/tenancies/NHO170043

and also calling the endpoint and setting the parameter ‘id’ to NHO170043. Both methods return no records.

Cheers,

Tom

plittlewood-rpt commented 2 years ago

Hi @tsadlerbrs

NHO170043 isn't the code of the tenancy, it's the code of the property that the tenancy is associated with. The code of the tenancy you show in your screenshot is NHO210063. It sounds like you are being given the incorrect codes to work with. The tenancy code is available in Agency Cloud from the top of the Tenancy window, the property code is available in Agency Cloud from the top of the main Property screen. In your screenshot, the model window is a list of tenancies associated to the property, you'd need to click into one of those to get the code of the actual tenancy. The screen behind it shows Property information.

I hope this helps clear this up - I can't see any problems here though. Let me know if I can help any further

plittlewood-rpt commented 2 years ago

Hi @tsadlerbrs - based on the above I am going to close this ticket. Please get back to us if there are any outstanding issues