Reference for https://api.circuitree.com/Accounting/UpsertPaymentMethod.json
Url: https://api.circuitree.com/Accounting/UpsertPaymentMethod.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:
<UpsertPaymentMethodRequest 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> <EFTAccount> <AccountNickname>String content</AccountNickname> <AccountNumber>String content</AccountNumber> <Address> <Address1 xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</Address1> <Address2 xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</Address2> <Address3 xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</Address3> <AddressTypeID xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">NotSet</AddressTypeID> <City xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</City> <CountryCode xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</CountryCode> <CountryName xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</CountryName> <IsPrimary xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">true</IsPrimary> <State xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</State> <UpdateAllEntities xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">true</UpdateAllEntities> <Zip xmlns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities">String content</Zip> </Address> <BankAccountTypeID>2147483647</BankAccountTypeID> <BankName>String content</BankName> <CCMonth>2147483647</CCMonth> <CCYear>2147483647</CCYear> <CardNumber>String content</CardNumber> <CardSecurityCode>String content</CardSecurityCode> <CardType>2147483647</CardType> <CheckNumber>String content</CheckNumber> <EFTAccountID>2147483647</EFTAccountID> <EntityID>9223372036854775807</EntityID> <IsCSVRequired>true</IsCSVRequired> <IsSelected>true</IsSelected> <Name>String content</Name> <OrgIDs> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int> </OrgIDs> <PaymentAmount>12678967.543233</PaymentAmount> <PaymentTypeID>2147483647</PaymentTypeID> <RoutingNumber>String content</RoutingNumber> </EFTAccount> </UpsertPaymentMethodRequest>
The following is an example request Json body:
{ "ApiToken":"String content", "EFTAccount":{ "AccountNickname":"String content", "AccountNumber":"String content", "Address":{ "Address1":"String content", "Address2":"String content", "Address3":"String content", "AddressTypeID":0, "City":"String content", "CountryCode":"String content", "CountryName":"String content", "IsPrimary":true, "State":"String content", "UpdateAllEntities":true, "Zip":"String content" }, "BankAccountTypeID":2147483647, "BankName":"String content", "CCMonth":2147483647, "CCYear":2147483647, "CardNumber":"String content", "CardSecurityCode":"String content", "CardType":2147483647, "CheckNumber":"String content", "EFTAccountID":2147483647, "EntityID":9223372036854775807, "IsCSVRequired":true, "IsSelected":true, "Name":"String content", "OrgIDs":[2147483647], "PaymentAmount":12678967.543233, "PaymentTypeID":2147483647, "RoutingNumber":"String content" } }
The following is an example response Xml body:
<UpsertPaymentMethodResult 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> </UpsertPaymentMethodResult>
The following is an example response Json body:
{ "StatusCode":0, "StatusMessage":"String content" }
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:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities" /> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="UpsertPaymentMethodRequest"> <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 minOccurs="0" name="EFTAccount" nillable="true" type="tns:EFTAccountModel" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="UpsertPaymentMethodRequest" nillable="true" type="tns:UpsertPaymentMethodRequest" /> <xs:complexType name="EFTAccountModel"> <xs:sequence> <xs:element minOccurs="0" name="AccountNickname" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="AccountNumber" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Address" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities" type="q2:PostalAddress" /> <xs:element minOccurs="0" name="BankAccountTypeID" type="xs:int" /> <xs:element minOccurs="0" name="BankName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CCMonth" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="CCYear" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="CardNumber" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CardSecurityCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CardType" type="xs:int" /> <xs:element minOccurs="0" name="CheckNumber" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="EFTAccountID" type="xs:int" /> <xs:element minOccurs="0" name="EntityID" type="xs:long" /> <xs:element minOccurs="0" name="IsCSVRequired" type="xs:boolean" /> <xs:element minOccurs="0" name="IsSelected" type="xs:boolean" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="OrgIDs" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfint" /> <xs:element minOccurs="0" name="PaymentAmount" type="xs:decimal" /> <xs:element minOccurs="0" name="PaymentTypeID" type="xs:int" /> <xs:element minOccurs="0" name="RoutingNumber" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="EFTAccountModel" nillable="true" type="tns:EFTAccountModel" /> </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 xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.Business.Components.API.Models.Entities" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/CircuiTree.Common.Enums" /> <xs:complexType name="PostalAddress"> <xs:sequence> <xs:element name="Address1" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Address2" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Address3" nillable="true" type="xs:string" /> <xs:element name="AddressTypeID" xmlns:q1="http://schemas.datacontract.org/2004/07/CircuiTree.Common.Enums" type="q1:AddressTypes" /> <xs:element minOccurs="0" name="City" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CountryCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CountryName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsPrimary" type="xs:boolean" /> <xs:element minOccurs="0" name="State" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="UpdateAllEntities" type="xs:boolean" /> <xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="PostalAddress" nillable="true" type="tns:PostalAddress" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/CircuiTree.Common.Enums" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/CircuiTree.Common.Enums" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="AddressTypes"> <xs:restriction base="xs:string"> <xs:enumeration value="NotSet" /> <xs:enumeration value="Home" /> <xs:enumeration value="Work" /> <xs:enumeration value="Alternate" /> <xs:enumeration value="School" /> </xs:restriction> </xs:simpleType> <xs:element name="AddressTypes" nillable="true" type="tns:AddressTypes" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfint"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" /> </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="UpsertPaymentMethodResult"> <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:extension> </xs:complexContent> </xs:complexType> <xs:element name="UpsertPaymentMethodResult" nillable="true" type="tns:UpsertPaymentMethodResult" /> </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>