Reference for https://api.circuitree.com/Accounting/GetItineraryBalance.json

Url: https://api.circuitree.com/Accounting/GetItineraryBalance.json

HTTP Method: POST

Message direction Format Body
Request Xml Example,Schema
Request Json Example
Response Xml Example,Schema
Response Json Example

The following is an example request Xml body:

<GetItineraryBalanceRequest xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Accounting">
  <ApiToken xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">String content</ApiToken>
  <ItineraryID>9223372036854775807</ItineraryID>
</GetItineraryBalanceRequest>

The following is an example request Json body:

{
	"ApiToken":"String content",
	"ItineraryID":9223372036854775807
}

The following is an example response Xml body:

<GetItineraryBalanceResult xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Accounting">
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">Unknown</StatusCode>
  <StatusMessage xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models">String content</StatusMessage>
  <Balance>12678967.543233</Balance>
  <BalanceDueDate>1999-05-31T11:20:00</BalanceDueDate>
  <Charges>
    <ChargeDetail>
      <Amount>12678967.543233</Amount>
      <ChargeDate>String content</ChargeDate>
      <Description>String content</Description>
    </ChargeDetail>
    <ChargeDetail>
      <Amount>12678967.543233</Amount>
      <ChargeDate>String content</ChargeDate>
      <Description>String content</Description>
    </ChargeDetail>
  </Charges>
  <ItineraryID>9223372036854775807</ItineraryID>
  <Payments>
    <PaymentDetail>
      <Amount>12678967.543233</Amount>
      <Description>String content</Description>
      <PaymentDate>String content</PaymentDate>
    </PaymentDetail>
    <PaymentDetail>
      <Amount>12678967.543233</Amount>
      <Description>String content</Description>
      <PaymentDate>String content</PaymentDate>
    </PaymentDetail>
  </Payments>
  <TotalCharges>12678967.543233</TotalCharges>
  <TotalPayments>12678967.543233</TotalPayments>
</GetItineraryBalanceResult>

The following is an example response Json body:

{
	"StatusCode":0,
	"StatusMessage":"String content",
	"Balance":12678967.543233,
	"BalanceDueDate":"\/Date(928167600000-0500)\/",
	"Charges":[{
		"Amount":12678967.543233,
		"ChargeDate":"String content",
		"Description":"String content"
	}],
	"ItineraryID":9223372036854775807,
	"Payments":[{
		"Amount":12678967.543233,
		"Description":"String content",
		"PaymentDate":"String content"
	}],
	"TotalCharges":12678967.543233,
	"TotalPayments":12678967.543233
}

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Accounting" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Accounting" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" />
  <xs:complexType name="GetItineraryBalanceRequest">
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" base="q1:BaseRequest">
        <xs:sequence>
          <xs:element name="ItineraryID" type="xs:long" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="GetItineraryBalanceRequest" nillable="true" type="tns:GetItineraryBalanceRequest" />
</xs:schema>

Additional request 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/CircuiTree.Business.Components.API.Models" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="BaseRequest">
    <xs:sequence>
      <xs:element name="ApiToken" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="BaseRequest" nillable="true" type="tns:BaseRequest" />
</xs:schema>

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

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Accounting" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.API.Web.Accounting" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" />
  <xs:complexType name="GetItineraryBalanceResult">
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" base="q1:BaseResult">
        <xs:sequence>
          <xs:element minOccurs="0" name="Balance" type="xs:decimal" />
          <xs:element minOccurs="0" name="BalanceDueDate" type="xs:dateTime" />
          <xs:element minOccurs="0" name="Charges" nillable="true" type="tns:ArrayOfChargeDetail" />
          <xs:element minOccurs="0" name="ItineraryID" type="xs:long" />
          <xs:element minOccurs="0" name="Payments" nillable="true" type="tns:ArrayOfPaymentDetail" />
          <xs:element minOccurs="0" name="TotalCharges" type="xs:decimal" />
          <xs:element minOccurs="0" name="TotalPayments" type="xs:decimal" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="GetItineraryBalanceResult" nillable="true" type="tns:GetItineraryBalanceResult" />
  <xs:complexType name="ArrayOfChargeDetail">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="ChargeDetail" nillable="true" type="tns:ChargeDetail" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfChargeDetail" nillable="true" type="tns:ArrayOfChargeDetail" />
  <xs:complexType name="ChargeDetail">
    <xs:sequence>
      <xs:element minOccurs="0" name="Amount" type="xs:decimal" />
      <xs:element minOccurs="0" name="ChargeDate" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ChargeDetail" nillable="true" type="tns:ChargeDetail" />
  <xs:complexType name="ArrayOfPaymentDetail">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="PaymentDetail" nillable="true" type="tns:PaymentDetail" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfPaymentDetail" nillable="true" type="tns:ArrayOfPaymentDetail" />
  <xs:complexType name="PaymentDetail">
    <xs:sequence>
      <xs:element minOccurs="0" name="Amount" type="xs:decimal" />
      <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="PaymentDate" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="PaymentDetail" nillable="true" type="tns:PaymentDetail" />
</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/CircuiTree.Business.Components.API.Models" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/CTS.Common" />
  <xs:complexType name="BaseResult">
    <xs:sequence>
      <xs:element minOccurs="0" name="StatusCode" xmlns:q1="http://schemas.datacontract.org/2004/07/CTS.Common" type="q1:Enums.APIStatusCodes" />
      <xs:element minOccurs="0" name="StatusMessage" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="BaseResult" nillable="true" type="tns:BaseResult" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CTS.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CTS.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="Enums.APIStatusCodes">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Unknown" />
      <xs:enumeration value="Success" />
      <xs:enumeration value="InvalidCredentials" />
      <xs:enumeration value="InvalidCompanyCode" />
      <xs:enumeration value="Configuration" />
      <xs:enumeration value="UnexpectedError" />
      <xs:enumeration value="Invalid" />
      <xs:enumeration value="Failed" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="Enums.APIStatusCodes" nillable="true" type="tns:Enums.APIStatusCodes" />
</xs:schema>

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