Zola Suite Client Portal API

GetStartDepositDataRequestInvoiceLink

The following routes are available for this service:
POST	/api2/deposits/start/InvoiceLink

**GetStartDepositDataRequestInvoiceLink** Parameters:
Name	Parameter	Data Type	Required
PayablesKeys	body	IEnumerable<PayableKey>	No
Key	body	string	No
isAPXPayment	body	bool	No

**PayableKey** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Amount	form	decimal	No
SharedObjectType	form	string	No
IsTrust	form	bool	No
IsSurchargeTransferEnabled	form	bool	No

**DepositDto** Parameters:
Name	Parameter	Data Type	Required
Amount	form	decimal	No
CreditCardInfo	form	ClientCard	No
ResponseStatus	form	ResponseStatus	No
payNowTokenId	form	string	No

**ClientCard** Parameters:
Name	Parameter	Data Type	Required
amountInCent	form	int	No
name	form	string	No
number	form	string	No
expMonth	form	int	No
expYear	form	int	No
address	form	string	No
city	form	string	No
state	form	string	No
cvv	form	string	No
postalCode	form	string	No
secretKey	form	string	No
LawPayToken	form	string	No
NotStoredLawPayToken	form	string	No
SaveCardEnabled	form	bool	No
ClientId	form	int?	No
ClientType	form	int?	No
CardType	form	string	No
IsDefault	form	bool	No
DateAdded	form	DateTime	No
CardId	form	int	No
PaymentToken	form	string	No
FirmId	form	int	No
UserId	form	int	No
Email	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api2/deposits/start/InvoiceLink HTTP/1.1 
Host: zolacaseway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetStartDepositDataRequestInvoiceLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClientPortalService.Invoices">
  <Key>String</Key>
  <PayablesKeys xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClientPortalService.Common" i:nil="true" />
  <isAPXPayment>false</isAPXPayment>
</GetStartDepositDataRequestInvoiceLink>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DepositDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClientPortalService.Common">
  <Amount>0</Amount>
  <CreditCardInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Omnizant_BL.LawPay">
    <d2p1:CardId>0</d2p1:CardId>
    <d2p1:CardType>String</d2p1:CardType>
    <d2p1:ClientId>0</d2p1:ClientId>
    <d2p1:ClientType>0</d2p1:ClientType>
    <d2p1:DateAdded>0001-01-01T00:00:00</d2p1:DateAdded>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirmId>0</d2p1:FirmId>
    <d2p1:IsDefault>false</d2p1:IsDefault>
    <d2p1:LawPayToken>String</d2p1:LawPayToken>
    <d2p1:NotStoredLawPayToken>String</d2p1:NotStoredLawPayToken>
    <d2p1:PaymentToken>String</d2p1:PaymentToken>
    <d2p1:SaveCardEnabled>false</d2p1:SaveCardEnabled>
    <d2p1:UserId>0</d2p1:UserId>
    <d2p1:address>String</d2p1:address>
    <d2p1:amountInCent>0</d2p1:amountInCent>
    <d2p1:city>String</d2p1:city>
    <d2p1:cvv>String</d2p1:cvv>
    <d2p1:expMonth>0</d2p1:expMonth>
    <d2p1:expYear>0</d2p1:expYear>
    <d2p1:name>String</d2p1:name>
    <d2p1:number>String</d2p1:number>
    <d2p1:postalCode>String</d2p1:postalCode>
    <d2p1:secretKey>String</d2p1:secretKey>
    <d2p1:state>String</d2p1:state>
  </CreditCardInfo>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <payNowTokenId>String</payNowTokenId>
</DepositDto>