GetCollectionReportBuilder

Method

GetCollectionReportBuilder(GetCollectionReportBuilderRequest)

note

When an “Invalid” Location ID is included in the request along with valid Location IDs:

• An error message will be displayed if the Location ID doesn’t exist for that Entity ID.
• Data will be provided for those locations that exist for that Entity ID and are enabled with Collection Settings.

Parameters

TYPE	NAME	DESCRIPTION
GetCollectionReportBuilderRequest	request

Returns

TYPE	DESCRIPTION
GetCollectionReportBuilderResponse

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pv="https://ssl.selectpayment.com/PV">
   <soapenv:Header>
      <pv:SecurityHeader>
         <pv:BinarySecurityToken>your security token here</pv:BinarySecurityToken>
      </pv:SecurityHeader>
   </soapenv:Header>
   
   <soapenv:Body>
    <pv:GetCollectionReportBuilder>
		<pv:storeId>0</pv:storeId>
		<pv:storeKey isNull="false"/>
		<pv:entityId>123456</pv:entityId>
		<pv:locationIds>
			<pv:int>0</pv:int>
		</pv:locationIds>		
		<pv:Int32Array0>654321</pv:Int32Array0>
		<pv:/locationIds>
		<pv:returnedBeginDate>12/18/2025 2:05:35 PM</pv:returnedBeginDate>
		<pv:returnedEndDate>12/18/2025 2:05:35 PM</pv:returnedEndDate>
    </pv:GetCollectionReportBuilder>
   </soapenv:Body>
</soapenv:Envelope>

Example Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
	<GetCollectionReportBuilderResponse xmlns="https://ssl.selectpayment.com/PV">
		<GetCollectionReportBuilderResult>
			<WSCollection>
				<CollectionId>11212</CollectionId>
				<Location>Accounts Receivable (11111)</Location>
				<ReturnDate>6/13/2013 1:24:00 PM</ReturnDate>
				<NameOnAccount>John Doe</NameOnAccount>
				<TransactionNumber>20130613-44</TransactionNumber>
				<Field1>white</Field1>
				<Field2>blue</Field2>
				<Field3>red</Field3>
				<ReferenceNumber>T:NKLMNKBA1</ReferenceNumber>
				<FaceAmount>$123.45</FaceAmount>
				<CollectionAmount>$123.45</CollectionAmount>
			</WSCollection>
			<WSCollection>
				<CollectionId>11212</CollectionId>
				<Location> Accounts Receivable (11111)</Location>
				<ReturnDate>6/13/2013 1:24:00 PM</ReturnDate>
				<NameOnAccount>Jane Doe</NameOnAccount>
				<TransactionNumber>20130613-43</TransactionNumber>
				<Field1>museums</Field1>
				<Field2>art galleries</Field2>
				<Field3>zoos</Field3>
				<ReferenceNumber>T:UV3QBBKBA1</ReferenceNumber>
				<FaceAmount>$153.25</FaceAmount>
				<CollectionAmount>$153.25</CollectionAmount>
			</WSCollection>
			<WSCollection>
				<CollectionId>12233</CollectionId>
				<Location> Accounts Receivable (11111)</Location>
				<ReturnDate>6/13/2013 1:24:00 PM</ReturnDate>
				<NameOnAccount>Profit Stars</NameOnAccount>
				<TransactionNumber>{95cfce2e-3a53-4083-bffc-b541d66be67f}</TransactionNumber>
				<Field1/>
				<Field2/>
				<Field3/>
				<ReferenceNumber>T:12Y4BBKBA1</ReferenceNumber>
				<FaceAmount>$10.95</FaceAmount>
				<CollectionAmount>$10.95</CollectionAmount>
				</WSCollection>
			<WSCollection>
				<CollectionId>13322</CollectionId>
				<Location> Accounts Receivable (11111)</Location>
				<ReturnDate>6/13/2013 12:00:00 AM</ReturnDate>
				<NameOnAccount/>
				<TransactionNumber>{ef8a1725-b3f9-41de-900a-f3ac35281bcd}</TransactionNumber>
				<Field1/>
				<Field2/>
				<Field3/>
				<ReferenceNumber>T:AB1CD2BKBA1</ReferenceNumber>
				<FaceAmount>$75.00</FaceAmount>
				<CollectionAmount>$75.00</CollectionAmount>
			</WSCollection>
		</GetCollectionReportBuilderResult>
	</GetCollectionReportBuilderResponse>
	</soap:Body>
</soap:Envelope>