GetInvoiceTransformationResultsForCustomers


 

Overview

Quick Links

Retrieves Invoice Transformation Results from the system based on a set of criteria that include one or more customer codes. The results contain information about the invoice transformations, but not the actual file content. The actual file content can be retrieved using the GetInvoiceTransformationResultFile call.

Resource Information

Request Format XML
Response Format XML

Request Header

Name Type Description
String String Authentication Token

Request Body

Name Type Description
customerCodes List Of String Select transformation results for these customers
createdFromDate String (Optionally) Select only invoice transformation results where the createdDate is greater than or equal to the date specified here. This should be in the format YYYY-MM-DD'T'HH:mm:SS
createdToDate String (Optional) Select only invoice transformation results where the createdDate is less than or equal to the date specified hereThis should be in the format YYYY-MM-DD'T'HH:mm:SS
invoiceTransformationName String (Optional) Select only invoice transformation results where the transformation name, equals the specified value. The transformation name generally implies the transformation "type".

Response

Name Type Description
Result List of InvoiceTransformationResult The actual result. A list of Invoice Transformation Results that match the specified criteria.
ResultCode String String indicating the result. Either "Success" or "Error".
ResultMessage String Empty when call successful, error message otherwise.

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <String xmlns="System">42516122-cf11-4795-8da6-72a9637d224a</String>
  </s:Header>
  <s:Body>
    <GetInvoiceTransformationResultsForCustomers xmlns="http://tempuri.org/">
      <customerCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <d4p1:string>1</d4p1:string>
      </customerCodes>
      <createdFromDate>2014-11-05T00:00:00</createdFromDate>
      <createdToDate>2014-12-05T12:00:00</createdToDate>
      <invoiceTransformationName>TestTransformation</invoiceTransformationName>
    </GetInvoiceTransformationResultsForCustomers>
  </s:Body>
</s:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header />
  <s:Body>
    <GetInvoiceTransformationResultsForCustomersResponse xmlns="http://tempuri.org/">
      <GetInvoiceTransformationResultsForCustomersResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:InvoiceTransformationResult>
          <a:CreatedDate>2014-06-09T14:56:18.017+02:00</a:CreatedDate>
          <a:CustomerCode>1</a:CustomerCode>
          <a:CustomerName>John Smith</a:CustomerName>
          <a:Id>5395aef2be4c5c320807e684</a:Id>
          <a:InvoiceIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <b:string>538a521c749cd80cb461f0d8</b:string>
          </a:InvoiceIds>
          <a:InvoicePeriodEnd>2014-06-30T23:59:59.999+02:00</a:InvoicePeriodEnd>
          <a:InvoicePeriodStart>2014-06-01T00:00:00.000+02:00</a:InvoicePeriodStart>
          <a:InvoiceTemplateKey>testtemplate</a:InvoiceTemplateKey>
          <a:InvoiceTransformationId>53959d74be4c5c320807e676</a:InvoiceTransformationId>
          <a:InvoiceTransformationName>TestTransformation</a:InvoiceTransformationName>
          <a:IsGrouped>false</a:IsGrouped>
          <a:IsOutOfDate>false</a:IsOutOfDate>
          <a:Status>COMPLETE</a:Status>
        </a:InvoiceTransformationResult>
        <a:InvoiceTransformationResult>
          <a:CreatedDate>2014-06-09T14:56:18.016+02:00</a:CreatedDate>
          <a:CustomerCode>1</a:CustomerCode>
          <a:CustomerName>Roelof Spijker</a:CustomerName>
          <a:Id>5395aef2be4c5c320807e683</a:Id>
          <a:InvoiceIds xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <b:string>5361789c749cd80b2082558b</b:string>
          </a:InvoiceIds>
          <a:InvoicePeriodEnd>2014-05-31T23:59:59.999+02:00</a:InvoicePeriodEnd>
          <a:InvoicePeriodStart>2014-05-01T00:00:00.000+02:00</a:InvoicePeriodStart>
          <a:InvoiceTemplateKey>testtemplate</a:InvoiceTemplateKey>
          <a:InvoiceTransformationId>53959d74be4c5c320807e676</a:InvoiceTransformationId>
          <a:InvoiceTransformationName>TestTransformation</a:InvoiceTransformationName>
          <a:IsGrouped>false</a:IsGrouped>
          <a:IsOutOfDate>false</a:IsOutOfDate>
          <a:Status>COMPLETE</a:Status>
        </a:InvoiceTransformationResult>
      </GetInvoiceTransformationResultsForCustomersResult>
    </GetInvoiceTransformationResultsForCustomersResponse>
  </s:Body>
</s:Envelope>