Symphony API V1.0


Click here for a complete list of operations.

GetInvoiceDetails

This method can be used to retrieve the invoice details for the provided secure key

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
secureKey:

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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetInvoiceDetails"

<?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>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetInvoiceDetails xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <secureKey>string</secureKey>
    </GetInvoiceDetails>
  </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>
    <GetInvoiceDetailsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetInvoiceDetailsResult>
        <InvoiceReference>string</InvoiceReference>
        <InvoiceUrl>string</InvoiceUrl>
        <TotalGross>decimal</TotalGross>
        <TotalNet>decimal</TotalNet>
        <PaymentStatus>string</PaymentStatus>
        <InvoicePayments>
          <InvoicePaymentResponse>
            <PaymentDate>dateTime</PaymentDate>
            <Amount>decimal</Amount>
            <Status>string</Status>
          </InvoicePaymentResponse>
          <InvoicePaymentResponse>
            <PaymentDate>dateTime</PaymentDate>
            <Amount>decimal</Amount>
            <Status>string</Status>
          </InvoicePaymentResponse>
        </InvoicePayments>
        <DateCreated>dateTime</DateCreated>
        <Tax>decimal</Tax>
        <IsCreditNote>boolean</IsCreditNote>
        <BookingReference>string</BookingReference>
      </GetInvoiceDetailsResult>
    </GetInvoiceDetailsResponse>
  </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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.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>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetInvoiceDetails xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <secureKey>string</secureKey>
    </GetInvoiceDetails>
  </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>
    <GetInvoiceDetailsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetInvoiceDetailsResult>
        <InvoiceReference>string</InvoiceReference>
        <InvoiceUrl>string</InvoiceUrl>
        <TotalGross>decimal</TotalGross>
        <TotalNet>decimal</TotalNet>
        <PaymentStatus>string</PaymentStatus>
        <InvoicePayments>
          <InvoicePaymentResponse>
            <PaymentDate>dateTime</PaymentDate>
            <Amount>decimal</Amount>
            <Status>string</Status>
          </InvoicePaymentResponse>
          <InvoicePaymentResponse>
            <PaymentDate>dateTime</PaymentDate>
            <Amount>decimal</Amount>
            <Status>string</Status>
          </InvoicePaymentResponse>
        </InvoicePayments>
        <DateCreated>dateTime</DateCreated>
        <Tax>decimal</Tax>
        <IsCreditNote>boolean</IsCreditNote>
        <BookingReference>string</BookingReference>
      </GetInvoiceDetailsResult>
    </GetInvoiceDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /API/1_0/SOAP/SymphonyAPI.asmx/GetInvoiceDetails?secureKey=string HTTP/1.1
Host: developer.sym-online.com

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

<?xml version="1.0" encoding="utf-8"?>
<InvoiceDetailsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <InvoiceReference>string</InvoiceReference>
  <InvoiceUrl>string</InvoiceUrl>
  <TotalGross>decimal</TotalGross>
  <TotalNet>decimal</TotalNet>
  <PaymentStatus>string</PaymentStatus>
  <InvoicePayments>
    <InvoicePaymentResponse>
      <PaymentDate>dateTime</PaymentDate>
      <Amount>decimal</Amount>
      <Status>string</Status>
    </InvoicePaymentResponse>
    <InvoicePaymentResponse>
      <PaymentDate>dateTime</PaymentDate>
      <Amount>decimal</Amount>
      <Status>string</Status>
    </InvoicePaymentResponse>
  </InvoicePayments>
  <DateCreated>dateTime</DateCreated>
  <Tax>decimal</Tax>
  <IsCreditNote>boolean</IsCreditNote>
  <BookingReference>string</BookingReference>
</InvoiceDetailsResponse>

HTTP POST

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

POST /API/1_0/SOAP/SymphonyAPI.asmx/GetInvoiceDetails HTTP/1.1
Host: developer.sym-online.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<InvoiceDetailsResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <InvoiceReference>string</InvoiceReference>
  <InvoiceUrl>string</InvoiceUrl>
  <TotalGross>decimal</TotalGross>
  <TotalNet>decimal</TotalNet>
  <PaymentStatus>string</PaymentStatus>
  <InvoicePayments>
    <InvoicePaymentResponse>
      <PaymentDate>dateTime</PaymentDate>
      <Amount>decimal</Amount>
      <Status>string</Status>
    </InvoicePaymentResponse>
    <InvoicePaymentResponse>
      <PaymentDate>dateTime</PaymentDate>
      <Amount>decimal</Amount>
      <Status>string</Status>
    </InvoicePaymentResponse>
  </InvoicePayments>
  <DateCreated>dateTime</DateCreated>
  <Tax>decimal</Tax>
  <IsCreditNote>boolean</IsCreditNote>
  <BookingReference>string</BookingReference>
</InvoiceDetailsResponse>