GET BankDeposit/GetDepositReport?includeDepositTicket={includeDepositTicket}&printLocationOfCheckingAccountProfitCenter={printLocationOfCheckingAccountProfitCenter}&depositGuid={depositGuid}&depositKey={depositKey}

Gets the requested deposit report

Request Information

URI Parameters

Name	Description	Type	Additional Information
includeDepositTicket	Option to include the deposit ticket in the response	boolean	Required
printLocationOfCheckingAccountProfitCenter	Setting for the header of the deposit report to use the Location of the Profit Center of the checking account	boolean	Required
depositGuid	The requested guid of the deposit to generage the document for (optional)	globally unique identifier
depositKey	The requested deposit key of the deposit to generage the document for (optional)	integer

Body Parameters

Response Information

Resource Description

Gets the requested deposit report

AgvBankDeposit

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
ErrorList	List of errors from the API	Collection of string
WarningList	List of warnings from the API	Collection of string
DepositGuid	The GUID of the deposit that is created	globally unique identifier
PreSignedUrl	The PreSigned URL to the deposit document	string

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "DepositGuid": "062bd232-f0a1-409b-97fa-c413d18501a0",
  "PreSignedUrl": "sample string 3"
}

application/xml, text/xml

Sample:

<AgvBankDeposit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.GL">
  <DepositGuid>062bd232-f0a1-409b-97fa-c413d18501a0</DepositGuid>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <PreSignedUrl>sample string 3</PreSignedUrl>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvBankDeposit>