API

Code Snippet

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

API » Vendors » getInvoices

getInvoices

This version will Include standard, catalog and job cost details in API.



ids [Integer] This is an optional field. This field accepts comma seperated multiple values.
invoiceNumber [Integer] This is an optional field. This field accepts single value.
vendorIds [Integer] This is an optional field. This field accepts comma seperated multiple values.
propertyIds [String] This is an optional field. This field accepts comma seperated multiple values.
fromDate [Date] This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.
toDate [Date] This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.
paidInvoiceFromDate [Date] This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or afte r the given date.
paidInvoiceToDate [Date] This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date.
postMonth [Date] This is an optional field. This field accepts single value.
includeVoidedPayments [Boolean] This is an optional field. This field accepts single value. Returns voided payment details if provided as 1
voidedPaymentFromDate [Date] This is an optional field. This field accepts single value.
voidedPaymentToDate [Date] This is an optional field. This field accepts single value.
includeExported [Boolean] This is an optional field. This field accepts single value.
customerRefunds [Boolean] This is an optional field. This field accepts single value.
invoiceTypeIds [Integer] This is an optional field. This field accepts comma seperated multiple values.
No Parameters Found.

Request URL

https://YOUR_DOMAIN.entrata.com/api/vendors

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 .entrata.com/api/v1/vendors
Request Parameter:
Username *
Password *
ids [Integer] optional
invoiceNumber [Integer] optional
vendorIds [Integer] optional
propertyIds [String] optional
fromDate [Date] optional
toDate [Date] optional
paidInvoiceFromDate [Date] optional
paidInvoiceToDate [Date] optional
postMonth [Date] optional
includeVoidedPayments [Boolean]
Off
voidedPaymentFromDate [Date] optional
voidedPaymentToDate [Date] optional
includeExported [Boolean]
Off
customerRefunds [Boolean]
Off
invoiceTypeIds [Integer] optional
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
Version 2
This version will Include standard, catalog and job cost type invoice details in API.

Your life is about to
get a whole lot easier

Sign in
to Entrata