Reference for https://insync.ivendcloud.com:8642/iVendAPI/iVendAPI.svc/WebAPI/GetSurcharge/?id={ID}

Url: https://insync.ivendcloud.com:8642/iVendAPI/iVendAPI.svc/WebAPI/GetSurcharge/?id={ID}

HTTP Method: GET

This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.

Message direction Format Body
Request N/A The Request body is empty.
Response Xml Example,Schema
Response Json Example

The following is an example response Xml body:

<Surcharge xmlns="http://www.iVend.com/IIntegrationService/2010/12">
  <Message>String content</Message>
  <GenerateIntegrationEvent>true</GenerateIntegrationEvent>
  <EnterpriseName>String content</EnterpriseName>
  <UserFieldsList>
    <UserFields>
      <FieldName>String content</FieldName>
      <FieldValue>String content</FieldValue>
      <FieldType>String</FieldType>
    </UserFields>
    <UserFields>
      <FieldName>String content</FieldName>
      <FieldValue>String content</FieldValue>
      <FieldType>String</FieldType>
    </UserFields>
  </UserFieldsList>
  <Key>String content</Key>
  <Id>String content</Id>
  <Description>String content</Description>
  <AmountType>Amount</AmountType>
  <Amount>12678967.543233</Amount>
  <IsTaxable>true</IsTaxable>
  <TaxCodeId>String content</TaxCodeId>
  <PurchaseTaxCodeId>String content</PurchaseTaxCodeId>
  <IsDiscountable>true</IsDiscountable>
  <IsRefundable>true</IsRefundable>
  <Type>Freight</Type>
  <SurchargeKey>String content</SurchargeKey>
  <IsPaymentDiscountSurcharge>true</IsPaymentDiscountSurcharge>
  <SubsidiaryId>String content</SubsidiaryId>
</Surcharge>

The following is an example response Json body:

{
	"Message":"String content",
	"GenerateIntegrationEvent":true,
	"EnterpriseName":"String content",
	"UserFieldsList":[{
		"FieldName":"String content",
		"FieldValue":"String content",
		"FieldType":0
	}],
	"Key":"String content",
	"Id":"String content",
	"Description":"String content",
	"AmountType":0,
	"Amount":12678967.543233,
	"IsTaxable":true,
	"TaxCodeId":"String content",
	"PurchaseTaxCodeId":"String content",
	"IsDiscountable":true,
	"IsRefundable":true,
	"Type":0,
	"SurchargeKey":"String content",
	"IsPaymentDiscountSurcharge":true,
	"SubsidiaryId":"String content"
}

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://www.iVend.com/IIntegrationService/2010/12" elementFormDefault="qualified" targetNamespace="http://www.iVend.com/IIntegrationService/2010/12" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CXS.Platform.DomainObjects" />
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" />
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" />
  <xs:complexType name="Surcharge">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:BaseWrapper">
        <xs:sequence>
          <xs:element name="Id" nillable="true" type="xs:string" />
          <xs:element name="Description" nillable="true" type="xs:string" />
          <xs:element name="AmountType" xmlns:q1="http://schemas.datacontract.org/2004/07/CXS.Platform.DomainObjects" type="q1:AmountType" />
          <xs:element name="Amount" type="xs:decimal" />
          <xs:element minOccurs="0" name="IsTaxable" type="xs:boolean" />
          <xs:element minOccurs="0" name="TaxCodeId" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="PurchaseTaxCodeId" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="IsDiscountable" type="xs:boolean" />
          <xs:element minOccurs="0" name="IsRefundable" type="xs:boolean" />
          <xs:element minOccurs="0" name="Type" xmlns:q2="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" type="q2:SurchargeType" />
          <xs:element minOccurs="0" name="SurchargeKey" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="IsPaymentDiscountSurcharge" type="xs:boolean" />
          <xs:element minOccurs="0" name="SubsidiaryId" nillable="true" type="xs:string" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="Surcharge" nillable="true" type="tns:Surcharge" />
  <xs:complexType name="BaseWrapper">
    <xs:sequence>
      <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="GenerateIntegrationEvent" type="xs:boolean" />
      <xs:element minOccurs="0" name="EnterpriseName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="UserFieldsList" nillable="true" type="tns:ArrayOfUserFields" />
      <xs:element minOccurs="0" name="Key" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="BaseWrapper" nillable="true" type="tns:BaseWrapper" />
  <xs:complexType name="ArrayOfUserFields">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="UserFields" nillable="true" type="tns:UserFields" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfUserFields" nillable="true" type="tns:ArrayOfUserFields" />
  <xs:complexType name="UserFields">
    <xs:sequence>
      <xs:element name="FieldName" nillable="true" type="xs:string" />
      <xs:element name="FieldValue" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="FieldType" xmlns:q3="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" type="q3:UserDefinedFieldDataType" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="UserFields" nillable="true" type="tns:UserFields" />
</xs:schema>

Additional response Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CXS.Framework.Core" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
  <xs:simpleType name="UserDefinedFieldDataType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="String">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Int32">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Currency">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Decimal">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="DateTime">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="ValidValues">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Int64">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Boolean">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
      <xs:enumeration value="Image">
        <xs:annotation>
          <xs:appinfo>
            <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">11</EnumerationValue>
          </xs:appinfo>
        </xs:annotation>
      </xs:enumeration>
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="UserDefinedFieldDataType" nillable="true" type="tns:UserDefinedFieldDataType" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CXS.Platform.DomainObjects" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CXS.Platform.DomainObjects" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="AmountType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Amount" />
      <xs:enumeration value="Percent" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="AmountType" nillable="true" type="tns:AmountType" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CXS.SubSystem.Core" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="SurchargeType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Freight" />
      <xs:enumeration value="Deposit" />
      <xs:enumeration value="LateFees" />
      <xs:enumeration value="Cancellation" />
      <xs:enumeration value="Reschedule" />
      <xs:enumeration value="Others" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="SurchargeType" nillable="true" type="tns:SurchargeType" />
</xs:schema>

<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
  <tns:element name="schema">
    <tns:complexType />
  </tns:element>
</tns:schema>