Transaction Extract Data APIs

TransactionDataExtract_SubmitRequest API

Use this SOAP API to get the transaction details from the Planful database. You can add filters to the API request and get filtered transaction data. The API call creates a job that extracts the data into an encrypted text file at a secure FTP location. This location is finalized when the Planful support team configures the APIs for your environment.

Sample API Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:TransactionDataExtract_SubmitRequest>
         <ns:LoginName>benbradley@planful.com</ns:LoginName>
         <ns:Password>password</ns:Password>
         <ns:TenantCode>TechOps</ns:TenantCode>
         <ns:Request>
            <ns:FilterCriteria>
               <ns:TransactionDateFrom>2020-03-25</ns:TransactionDateFrom>
               <ns:TransactionDateTo>2020-04-24</ns:TransactionDateTo>
               <ns:FieldFilters>
                  <ns:Field>
                     <ns:Name>Entity</ns:Name>
                     <ns:Operator>Equals</ns:Operator>
                     <ns:Values>
                        <ns:string>01</ns:string>
                     </ns:Values>
                  </ns:Field>
               </ns:FieldFilters>
            </ns:FilterCriteria>
         </ns:Request>
      </ns:TransactionDataExtract_SubmitRequest>
   </soapenv:Body>
</soapenv:Envelope>

As of today, this API supports the following filter criteria:

• From and To transaction dates, 
• Segment codes 
• Attributes 

Sample API 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>
      <TransactionDataExtract_SubmitRequestResponse xmlns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
         <TransactionDataExtract_SubmitRequestResult>
            <ReferenceId>a9e0d7fd-76d9-4657-a105-cb1b237312c3</ReferenceId>
            <Status>Submitted</Status>
            <Errors>
               <Error>
                  <Code> </Code>
                  <Message> </Message>
               </Error>
            </Errors>
         </TransactionDataExtract_SubmitRequestResult>
      </TransactionDataExtract_SubmitRequestResponse>
   </soap:Body>
</soap:Envelope>

TransactionDataExtract_RetrieveStatusResult API

You can use this SOAP API to get the actual status of the data extraction that was initiated using the TransactionDataExtract_SubmitRequest API. When an extraction request is submitted, a reference ID is generated and sent in the API response. You can use that reference ID to get the current status of that transaction data extract request.

Sample API Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:TransactionDataExtract_RetrieveStatus>
          <ns:LoginName>benbradley@planful.com</ns:LoginName>
         <ns:Password>password</ns:Password>
         <ns:TenantCode>TechOps</ns:TenantCode>
         <ns:Request>
            <ns:ReferenceId>a9e0d7fd-76d9-4657-a105-cb1b237312c3</ns:ReferenceId>
         </ns:Request>
      </ns:TransactionDataExtract_RetrieveStatus>
   </soapenv:Body>
</soapenv:Envelope>

Sample API 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>
      <TransactionDataExtract_RetrieveStatusResponse xmlns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
         <TransactionDataExtract_RetrieveStatusResult>
            <ReferenceId>a9e0d7fd-76d9-4657-a105-cb1b237312c3</ReferenceId>
            <Status>Completed</Status>
            <RowsProcessed>100</RowsProcessed>
            <ErrorReason/>
            <SubmissionDate>2020-10-20T02:36:08.38</SubmissionDate>
         </TransactionDataExtract_RetrieveStatusResult>
      </TransactionDataExtract_RetrieveStatusResponse>
   </soap:Body>
</soap:Envelope>