Service Web Service

Service

Click here for a complete list of operations.

getMessages

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /TF.Server/Service.asmx HTTP/1.1
Host: mx.invoiceware.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/getMessages"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <getMessages xmlns="http://tempuri.org/">
      <owner>string</owner>
    </getMessages>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getMessagesResponse xmlns="http://tempuri.org/">
      <getMessagesResult>
        <Message>
          <Condition>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </Condition>
          <TransformCode>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCode>
          <TransformDescription>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformDescription>
          <TransformComments>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformComments>
          <TransformCustomReturn>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCustomReturn>
          <TransformType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformType>
          <TransformError>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformError>
          <TransformProcessType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformProcessType>
          <Code>string</Code>
          <Description>string</Description>
          <Comments>string</Comments>
          <CreationDate>dateTime</CreationDate>
          <Sent>boolean</Sent>
          <Error>boolean</Error>
          <GroupId>string</GroupId>
          <DocumentId>string</DocumentId>
          <Saved>boolean</Saved>
          <Type>string</Type>
          <CustomReturn>string</CustomReturn>
          <MessageId>string</MessageId>
          <MessageProperties>
            <MessageProperty xsi:nil="true" />
            <MessageProperty xsi:nil="true" />
          </MessageProperties>
          <ProcessType>int</ProcessType>
        </Message>
        <Message>
          <Condition>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </Condition>
          <TransformCode>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCode>
          <TransformDescription>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformDescription>
          <TransformComments>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformComments>
          <TransformCustomReturn>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCustomReturn>
          <TransformType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformType>
          <TransformError>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformError>
          <TransformProcessType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformProcessType>
          <Code>string</Code>
          <Description>string</Description>
          <Comments>string</Comments>
          <CreationDate>dateTime</CreationDate>
          <Sent>boolean</Sent>
          <Error>boolean</Error>
          <GroupId>string</GroupId>
          <DocumentId>string</DocumentId>
          <Saved>boolean</Saved>
          <Type>string</Type>
          <CustomReturn>string</CustomReturn>
          <MessageId>string</MessageId>
          <MessageProperties>
            <MessageProperty xsi:nil="true" />
            <MessageProperty xsi:nil="true" />
          </MessageProperties>
          <ProcessType>int</ProcessType>
        </Message>
      </getMessagesResult>
    </getMessagesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /TF.Server/Service.asmx HTTP/1.1
Host: mx.invoiceware.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <getMessages xmlns="http://tempuri.org/">
      <owner>string</owner>
    </getMessages>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getMessagesResponse xmlns="http://tempuri.org/">
      <getMessagesResult>
        <Message>
          <Condition>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </Condition>
          <TransformCode>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCode>
          <TransformDescription>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformDescription>
          <TransformComments>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformComments>
          <TransformCustomReturn>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCustomReturn>
          <TransformType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformType>
          <TransformError>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformError>
          <TransformProcessType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformProcessType>
          <Code>string</Code>
          <Description>string</Description>
          <Comments>string</Comments>
          <CreationDate>dateTime</CreationDate>
          <Sent>boolean</Sent>
          <Error>boolean</Error>
          <GroupId>string</GroupId>
          <DocumentId>string</DocumentId>
          <Saved>boolean</Saved>
          <Type>string</Type>
          <CustomReturn>string</CustomReturn>
          <MessageId>string</MessageId>
          <MessageProperties>
            <MessageProperty xsi:nil="true" />
            <MessageProperty xsi:nil="true" />
          </MessageProperties>
          <ProcessType>int</ProcessType>
        </Message>
        <Message>
          <Condition>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </Condition>
          <TransformCode>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCode>
          <TransformDescription>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformDescription>
          <TransformComments>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformComments>
          <TransformCustomReturn>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformCustomReturn>
          <TransformType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformType>
          <TransformError>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformError>
          <TransformProcessType>
            <Id>string</Id>
            <Name>string</Name>
            <Description>string</Description>
            <Code>string</Code>
          </TransformProcessType>
          <Code>string</Code>
          <Description>string</Description>
          <Comments>string</Comments>
          <CreationDate>dateTime</CreationDate>
          <Sent>boolean</Sent>
          <Error>boolean</Error>
          <GroupId>string</GroupId>
          <DocumentId>string</DocumentId>
          <Saved>boolean</Saved>
          <Type>string</Type>
          <CustomReturn>string</CustomReturn>
          <MessageId>string</MessageId>
          <MessageProperties>
            <MessageProperty xsi:nil="true" />
            <MessageProperty xsi:nil="true" />
          </MessageProperties>
          <ProcessType>int</ProcessType>
        </Message>
      </getMessagesResult>
    </getMessagesResponse>
  </soap12:Body>
</soap12:Envelope>