POST BankDeposit/AddBankDeposit

Add a Bank Deposit

Request Information

URI Parameters

Body Parameters

The request object used to create the bank deposit

Name	Description	Type	Additional Information
DepositDate	Date of Deposit	date	Required
CheckingAccount	Checking Account of Deposit	string	Required
CashAccount	Cash Account of Deposit	string	Required
Description	Description of Deposit	string	Max length: 255
CashBackGL	Cash Back GL Account of Deposit	string
CashBackAmount	Cash Back Amount of Deposit	decimal number
MarkAsDeposited	True/False value if user wanted 'Mark Deposited' or not	boolean
IncludeDepositTicket	For the auto-created document - option to include the deposit ticket	boolean
PrintLocationOfCheckingAccountProfitCenter	For the auto-created document - option to use the location from the checking account profit center	boolean
PaymentPayMethodDtList	List of PaymentPayMethodsMY	Collection of globally unique identifier
JentryDtList	List of Jentrys "JE"	Collection of ClsBankDepositJentryDT
ManualDtList	List of Manual entires	Collection of ClsBankDepositManualDT

Request Formats

application/json, text/json

Sample:

{
  "DepositDate": "2025-05-15T14:48:31.8115976+00:00",
  "CheckingAccount": "sample string 4",
  "CashAccount": "sample string 5",
  "Description": "sample string 6",
  "CashBackGL": "sample string 7",
  "CashBackAmount": 8.1,
  "MarkAsDeposited": true,
  "IncludeDepositTicket": true,
  "PrintLocationOfCheckingAccountProfitCenter": true,
  "PaymentPayMethodDtList": [
    "63608750-b407-449a-bb1e-11c81402b368",
    "65553a2d-4d62-48e9-bf3c-e24cdddf0e08"
  ],
  "JentryDtList": [
    {
      "JentryGuid": "628e22c2-452d-49a6-a500-865e9c97c814",
      "CheckNumber": "sample string 2",
      "Comments": "sample string 3"
    },
    {
      "JentryGuid": "628e22c2-452d-49a6-a500-865e9c97c814",
      "CheckNumber": "sample string 2",
      "Comments": "sample string 3"
    }
  ],
  "ManualDtList": [
    {
      "Amount": 1.1,
      "CheckNumber": "sample string 2",
      "Comments": "sample string 3",
      "GLAcct": "sample string 4"
    },
    {
      "Amount": 1.1,
      "CheckNumber": "sample string 2",
      "Comments": "sample string 3",
      "GLAcct": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<ClsBankDeposit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <CashAccount>sample string 5</CashAccount>
  <CashBackAmount>8.1</CashBackAmount>
  <CashBackGL>sample string 7</CashBackGL>
  <CheckingAccount>sample string 4</CheckingAccount>
  <DepositDate>2025-05-15T14:48:31.8115976+00:00</DepositDate>
  <Description>sample string 6</Description>
  <IncludeDepositTicket>true</IncludeDepositTicket>
  <JentryDtList>
    <ClsBankDepositJentryDT>
      <CheckNumber>sample string 2</CheckNumber>
      <Comments>sample string 3</Comments>
      <JentryGuid>628e22c2-452d-49a6-a500-865e9c97c814</JentryGuid>
    </ClsBankDepositJentryDT>
    <ClsBankDepositJentryDT>
      <CheckNumber>sample string 2</CheckNumber>
      <Comments>sample string 3</Comments>
      <JentryGuid>628e22c2-452d-49a6-a500-865e9c97c814</JentryGuid>
    </ClsBankDepositJentryDT>
  </JentryDtList>
  <ManualDtList>
    <ClsBankDepositManualDT>
      <Amount>1.1</Amount>
      <CheckNumber>sample string 2</CheckNumber>
      <Comments>sample string 3</Comments>
      <GLAcct>sample string 4</GLAcct>
    </ClsBankDepositManualDT>
    <ClsBankDepositManualDT>
      <Amount>1.1</Amount>
      <CheckNumber>sample string 2</CheckNumber>
      <Comments>sample string 3</Comments>
      <GLAcct>sample string 4</GLAcct>
    </ClsBankDepositManualDT>
  </ManualDtList>
  <MarkAsDeposited>true</MarkAsDeposited>
  <PaymentPayMethodDtList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>63608750-b407-449a-bb1e-11c81402b368</d2p1:guid>
    <d2p1:guid>65553a2d-4d62-48e9-bf3c-e24cdddf0e08</d2p1:guid>
  </PaymentPayMethodDtList>
  <PrintLocationOfCheckingAccountProfitCenter>true</PrintLocationOfCheckingAccountProfitCenter>
</ClsBankDeposit>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsBankDeposit'.

Response Information

Resource Description

Add a Bank Deposit

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": "fb69c845-b0e9-42ac-b3d6-bd385db926e8",
  "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>fb69c845-b0e9-42ac-b3d6-bd385db926e8</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>