Entrata Website Search

API

Code Snippet

Select any of the web services below to view details and examples.

API » AR Transactions » getLeaseArTransactions

getLeaseArTransactions

Retrieves a list of all transactions for a given lease



*propertyId [Integer] This is a required field. This field accepts single value. PropertyId
leaseIds [Integer] This is an optional field. This field accepts comma seperated multiple values. leaseIds
leaseStatusTypeIds [Integer] This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled.
transactionTypeIds [Integer] This is an optional field. This field accepts comma seperated multiple values. Type of transactions on lease. Possible values 1-12
arCodeIds [Integer] This is an optional field. This field accepts comma seperated multiple values. arCodeIds
showFullLedger [Boolean] This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items.
includeOtherIncomeLeases [Boolean] This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response.
includeReversals [Boolean] This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response 'showFullLedger' must be t rue(1).
transactionFromDate [Date] This is an optional field. This field accepts single value. This will return transactions starting from the provided date.
transactionToDate [Date] This is an optional field. This field accepts single value. This will return transaction till the provided date.
ledgerIds [Integer] This is an optional field. This field accepts comma seperated multiple values. These ids we will get from getFinancialPickList.
residentFriendlyMode [Boolean] This is an optional field. This field accepts single value.
 Id [Integer] This node shows leaseId, it comes under lease node.
 PropertyId [Integer] PropertyId
 unitSpaceId [Integer] This node shows unitSpaceId associated with lease.
 Id-customer [Integer] This node shows customerId, it comes under customer node
 firstName [String] This node shows first name of the customer
 lastName [String] This node shows last name of the customer.
 Id-ledger [Integer] This node shows ledgerId, it comes under ledger node
 name [String] This node shows name of the ledger.
 balance [Float] This node shows balance amount of the ledger.
 pastDueBalance [Float] This node shows due balance amount of the ledger.
 writeOff [Float] This amount is calculated based on the trigger(BAD_DEBT_WRITE_OFF/BAD _DEBT_RECOVERY)
 Id-transactions [Integer] This node shows transaction Id, it comes under transaction node
 transactionTypeId [Integer] This return id for type of transaction. Same as mention in request.
 arCodeId [Integer] arCodeId
 arCodeName [String] This node shows name of the arCode.
 leaseIntervalId [Integer] leaseIntervalId
 description [String] This node shows description provided for transaction.
 transactionDate [Date] This node shows date of the transaction.
 postDate [Date] This node shows posted date of transaction.
 postMonth [Date] This node shows postMonth of transaction.
 balanceDue [Float] This node shows amount due for the transaction.
 amount [Float] This node shows transaction amount.
 amountPaid [Float] This node shows transaction amount paid.

Request URL

https://YOUR_DOMAIN.docs.entrata.com/api/artransactions

Request Type

Request Copy to Clipboard

Response Copy to Clipboard



/* An Example XML Request */
string xmlRequest = '';

/* An Example JSON Request */ string jsonRequest = '';
/* Initiate a Web Request object */ HttpWebRequest webRequest = null; webRequest = WebRequest.Create(' REPLACE THIS WITH THE WEB SERVICE URL ') as HttpWebRequest; webRequest.Method = 'POST'; webRequest.Headers.Add("Authorization", "Basic ");
/* Add Form data */
FileInfo fi = new FileInfo(@"E:\RabitMQ\Learn RabbitMQ With C.pdf"); string fileName = fi.Name; byte[] fileContents = File.ReadAllBytes(fi.FullName);
string boundary = "--AaB03x";
StringBuilder sb = new StringBuilder();
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: form-data; name=\"{0}\"", "requestBody")); sb.AppendLine(); sb.AppendLine(xmlRequest);
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: form-data; name=\"{0}\"", "requestContentType")); sb.AppendLine(); sb.AppendLine("application/xml; CHARSET=UTF-8");
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: file; name=\"{0}\"; filename=\"{1}\"", "file1", fileName)); sb.AppendLine("Content-Type: application/octet-stream"); sb.AppendLine(); sb.AppendLine(Encoding.UTF8.GetString(fileContents)); sb.AppendLine(boundary);
/* Initiate the request writer */ StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
/* If you want to send an XML Request, use these options */ webRequest.ContentType = "multipart/form-data; boundary=AaB03x"; requestWriter.Write(xmlRequest);
/* If you want to send an XML Request, use these options */ webRequest.ContentType = 'multipart/form-data; boundary=AaB03x'; requestWriter.Write(jsonRequest);
requestWriter.Close();
/* Read the response */ StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream()); string responseData = responseReader.ReadToEnd(); responseReader.Close();

/* An Example XML Request */
string xmlRequest = '';

/* An Example JSON Request */ string jsonRequest = '';
import java.io.InputStream; import org.apache.commons.httpclient.HttpClient;
public class PostExample {
public static void main(String[] args){
HttpClient httpClient = new DefaultHttpClient();
try { HttpPost request = new HttpPost("REPLACE THIS WITH THE WEB SERVICE URL"); request.addHeader("Authorization", "Basic <BASE64 ENCODED VALUE OF USERNAME:PASSWORD>"); request.addHeader("content-type", "multipart/form-data");
File file1 = new File("[/path/to/upload]");
MultipartEntityBuilder builder = MultipartEntityBuilder.create(); builder.addBinaryBody( "file1", new FileInputStream( file1 ), ContentType.APPLICATION_OCTET_STREAM, file1.getName() );
/* If you want to send an XML Request, use these options */ builder.addTextBody( "requestBody", xmlRequest ); builder.addTextBody( "requestContentType", "APPLICATION/XML; CHARSET=UTF-8" );
/* If you want to send an JSON Request, use these options */ builder.addTextBody( "requestBody", jsonRequest ); builder.addTextBody( "requestContentType", "APPLICATION/JSON; CHARSET=UTF-8" );
HttpEntity multipartFormData = builder.build(); request.setEntity( multipartFormData );
HttpResponse response = httpClient.execute(request);
// handle response here... System.out.println(response); }catch (Exception ex) { // handle exception here ex.printStackTrace(); } finally { httpClient.getConnectionManager().shutdown(); } } }

/* An Example XML Request */
string xmlRequest = '' ;

/* An Example JSON Request */ $jsonRequest = '' ;
$resCurl = curl_init();
curl_setopt( $resCurl, CURLOPT_POST, true ); curl_setopt( $resCurl, CURLOPT_URL, REPLACE THIS WITH THE WEB SERVICE URL ); curl_setopt( $resCurl, CURLOPT_RETURNTRANSFER, 1 );
$strFirstFileName = '<filename with path>'; $strSecondFileName = '<filename with path>'; if( true == function_exists( 'curl_file_create' ) ) { $strFirsFilePath = curl_file_create( $strFirstFileName ); $strSecondFilePath = curl_file_create( $strSecondFileName ); } else { $strFirsFilePath = '@' . realpath( $strFirstFileName ); $strSecondFilePath = '@' . realpath( $strSecondFileName ); }
/* If you want to send an XML Request, use these options */ $arrmixPost = [ 'requestContentType' => 'APPLICATION/XML; CHARSET=UTF-8', 'requestBody' => $xmlRequest, 'file1' => $strFirsFilePath, 'file2' => $strSecondFilePath ]; /* If you want to send a JSON Request, use these options */ $arrmixPost = [ 'requestContentType' => 'APPLICATION/JSON; CHARSET=UTF-8', 'requestBody' => $jsonRequest, 'file1' => $strFirsFilePath, 'file2' => $strSecondFilePath ];
curl_setopt( $resCurl, CURLOPT_HTTPHEADER, array( 'Content-type: multipart/form-data', 'Authorization: Basic <BASE64 ENCODED VALUE OF USERNAME:PASSWORD>' ) ); curl_setopt( $resCurl, CURLOPT_POSTFIELDS, $arrmixPost ); $result = curl_exec( $resCurl ); if( false === $result ) { echo 'Curl error: ' . curl_error( $resCurl ); curl_close( $resCurl ); } else { curl_close( $resCurl ); echo $result; }
Domain .docs.entrata.com/api/v1/artransactions
Request Parameter:
Username *
Password *
propertyId [Integer] *
leaseIds [Integer] optional
leaseStatusTypeIds [Integer] optional
transactionTypeIds [Integer] optional
arCodeIds [Integer] optional
showFullLedger [Boolean]
Off
includeOtherIncomeLeases [Boolean]
Off
includeReversals [Boolean]
Off
transactionFromDate [Date] optional
transactionToDate [Date] optional
ledgerIds [Integer] optional
residentFriendlyMode [Boolean]
Off
Request URL Parameter:
Page Number
Page Size
Request Header:
Send Pagination Links in Response Body
Off

Request Type

Request URL

Request Headers

Request Headers will be shown here

Request Copy to Clipboard

Request code will be shown here

Response Copy to Clipboard

Response code will be shown here

Response Headers

Response Headers will be shown here

Your life is about to
get a whole lot easier

Sign in
to Entrata