POST Deposits/Deposit?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

DepositDTO

Name	Type	Additional information
DepositID	integer	None.
ID	integer	None.
BUID	integer	None.
BusinessUnitName	string	None.
EntityID	integer	None.
EntityName	NameDTO	None.
ClientOrderID	integer	None.
FunderRuleID	integer	None.
BillingRateID	integer	None.
ClientOrderDescription	string	None.
FunderID	integer	None.
FunderName	string	None.
GroupID	integer	None.
GroupName	string	None.
DepositTransactionTypeID	integer	None.
DepositTransactionTypeDescription	string	None.
PaymentTransactionTypeID	integer	None.
PaymentTransactionTypeDescription	string	None.
DepositStatus	DepositStatus	None.
DepositDate	date	None.
DepositAccount	string	None.
DepositAmount	decimal number	None.
DepositBalance	decimal number	None.
IsRefundable	boolean	None.
IsSettleableToInvoice	boolean	None.
PaymentMethod	PaymentMethod	None.
DrawerName	string	None.
ChequeNumber	string	None.
BankName	string	None.
BankBranch	string	None.
IsDepositSlip	boolean	None.
DepartureDateUtc	date	None.
NoticeDate	date	None.
NoticePeriodEndDate	date	None.
BalanceUsedForInterestCalculation	decimal number	None.
BaseInterestRate	decimal number	None.
MaximumPermissibleInterestRate	decimal number	None.
InterestPeriodStartDate	date	None.
InterestPeriodStopDate	date	None.
PayeeName	string	None.
PayeeAddress	string	None.
Comments	string	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
BalanceLastUpdated	date	None.
Type	DepositType	None.
ParentDepositID	integer	None.
SplitDepositActionType	SplitDepositActionType	None.
DirectDebitProcessingDate	date	None.
IsAccrualReversed	boolean	None.
AccrualReversedDate	date	None.
ReversedAmount	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "depositID": 1,
  "id": 1,
  "buid": 2,
  "businessUnitName": "sample string 3",
  "entityID": 4,
  "entityName": {
    "lastName": "sample string 1",
    "firstName": "sample string 2",
    "preferredName": "sample string 3",
    "middleName": "sample string 4",
    "prefix": "sample string 5",
    "suffix": "sample string 6",
    "summary": "sample string 1, sample string 2 (sample string 3)"
  },
  "clientOrderID": 1,
  "funderRuleID": 1,
  "billingRateID": 1,
  "clientOrderDescription": "sample string 5",
  "funderID": 1,
  "funderName": "sample string 6",
  "groupID": 1,
  "groupName": "sample string 7",
  "depositTransactionTypeID": 8,
  "depositTransactionTypeDescription": "sample string 9",
  "paymentTransactionTypeID": 10,
  "paymentTransactionTypeDescription": "sample string 11",
  "depositStatus": 1,
  "depositDate": "2024-12-04T08:03:17.6998022+00:00",
  "depositAccount": "sample string 13",
  "depositAmount": 14.0,
  "depositBalance": 15.0,
  "isRefundable": true,
  "isSettleableToInvoice": true,
  "paymentMethod": 10,
  "drawerName": "sample string 18",
  "chequeNumber": "sample string 19",
  "bankName": "sample string 20",
  "bankBranch": "sample string 21",
  "isDepositSlip": true,
  "departureDateUtc": "2024-12-04T08:03:17.6998022+00:00",
  "noticeDate": "2024-12-04T08:03:17.6998022+00:00",
  "noticePeriodEndDate": "2024-12-04T08:03:17.6998022+00:00",
  "balanceUsedForInterestCalculation": 1.0,
  "baseInterestRate": 1.0,
  "maximumPermissibleInterestRate": 1.0,
  "interestPeriodStartDate": "2024-12-04T08:03:17.6998022+00:00",
  "interestPeriodStopDate": "2024-12-04T08:03:17.6998022+00:00",
  "payeeName": "sample string 23",
  "payeeAddress": "sample string 24",
  "comments": "sample string 25",
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T08:03:17.6998022+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:03:17 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:03:17.6998022+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:03:17 AM"
  },
  "balanceLastUpdated": "2024-12-04T08:03:17.6998022+00:00",
  "type": 1,
  "parentDepositID": 1,
  "splitDepositActionType": 1,
  "directDebitProcessingDate": "2024-12-04T08:03:17.6998022+00:00",
  "isAccrualReversed": true,
  "accrualReversedDate": "2024-12-04T08:03:17.6998022+00:00",
  "reversedAmount": 1.0
}

application/xml, text/xml

Sample:

<DepositDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Billings.Models">
  <AccrualReversedDate>2024-12-04T08:03:17.6998022+00:00</AccrualReversedDate>
  <BUID>2</BUID>
  <BalanceLastUpdated>2024-12-04T08:03:17.6998022+00:00</BalanceLastUpdated>
  <BalanceUsedForInterestCalculation>1</BalanceUsedForInterestCalculation>
  <BankBranch>sample string 21</BankBranch>
  <BankName>sample string 20</BankName>
  <BaseInterestRate>1</BaseInterestRate>
  <BillingRateID>1</BillingRateID>
  <BusinessUnitName>sample string 3</BusinessUnitName>
  <ChequeNumber>sample string 19</ChequeNumber>
  <ClientOrderDescription>sample string 5</ClientOrderDescription>
  <ClientOrderID>1</ClientOrderID>
  <Comments>sample string 25</Comments>
  <Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
    <d2p1:DateUtc>2024-12-04T08:03:17.6998022+00:00</d2p1:DateUtc>
    <d2p1:UserName>sample string 2</d2p1:UserName>
  </Created>
  <DepartureDateUtc>2024-12-04T08:03:17.6998022+00:00</DepartureDateUtc>
  <DepositAccount>sample string 13</DepositAccount>
  <DepositAmount>14</DepositAmount>
  <DepositBalance>15</DepositBalance>
  <DepositDate>2024-12-04T08:03:17.6998022+00:00</DepositDate>
  <DepositID>1</DepositID>
  <DepositStatus>Draft</DepositStatus>
  <DepositTransactionTypeDescription>sample string 9</DepositTransactionTypeDescription>
  <DepositTransactionTypeID>8</DepositTransactionTypeID>
  <DirectDebitProcessingDate>2024-12-04T08:03:17.6998022+00:00</DirectDebitProcessingDate>
  <DrawerName>sample string 18</DrawerName>
  <EntityID>4</EntityID>
  <EntityName xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:LastName>sample string 1</d2p1:LastName>
    <d2p1:MiddleName>sample string 4</d2p1:MiddleName>
    <d2p1:PreferredName>sample string 3</d2p1:PreferredName>
    <d2p1:Prefix>sample string 5</d2p1:Prefix>
    <d2p1:Suffix>sample string 6</d2p1:Suffix>
  </EntityName>
  <FunderID>1</FunderID>
  <FunderName>sample string 6</FunderName>
  <FunderRuleID>1</FunderRuleID>
  <GroupID>1</GroupID>
  <GroupName>sample string 7</GroupName>
  <InterestPeriodStartDate>2024-12-04T08:03:17.6998022+00:00</InterestPeriodStartDate>
  <InterestPeriodStopDate>2024-12-04T08:03:17.6998022+00:00</InterestPeriodStopDate>
  <IsAccrualReversed>true</IsAccrualReversed>
  <IsDepositSlip>true</IsDepositSlip>
  <IsRefundable>true</IsRefundable>
  <IsSettleableToInvoice>true</IsSettleableToInvoice>
  <LastUpdated xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
    <d2p1:DateUtc>2024-12-04T08:03:17.6998022+00:00</d2p1:DateUtc>
    <d2p1:UserName>sample string 2</d2p1:UserName>
  </LastUpdated>
  <MaximumPermissibleInterestRate>1</MaximumPermissibleInterestRate>
  <NoticeDate>2024-12-04T08:03:17.6998022+00:00</NoticeDate>
  <NoticePeriodEndDate>2024-12-04T08:03:17.6998022+00:00</NoticePeriodEndDate>
  <ParentDepositID>1</ParentDepositID>
  <PayeeAddress>sample string 24</PayeeAddress>
  <PayeeName>sample string 23</PayeeName>
  <PaymentMethod>Cash</PaymentMethod>
  <PaymentTransactionTypeDescription>sample string 11</PaymentTransactionTypeDescription>
  <PaymentTransactionTypeID>10</PaymentTransactionTypeID>
  <RecordState>Active</RecordState>
  <ReversedAmount>1</ReversedAmount>
  <SplitDepositActionType>AddNewDeposit</SplitDepositActionType>
  <Type>Deposit</Type>
</DepositDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��U�n�0~ç
KS�I�$�tـkW����
�%���E�l�=�^a��?q����e~$��#M����1P+��,���X���p���J
�.�tW��x[V�
"�P��h�b�N�u�0ܼԾ��b�=.����=hFh��D{�-�
Z�a�@>�@'Y�j�N+�(�w	��7�o(}��z1W�$����t�5�̽�ƐK�(`����"h��,�4��z��U�VB-�h|ٸV�V�3�l�`�L[���uY���ٺ��ZR��>�P�4}�y�󶪫��HL
ɒlx�fG�p��&�`���O��Q�e��d�$�9�����=�>E����x�ӜnKO�U�9�>�\�͡�`����\�{#�lJ�wgD��@�kO���w��Õ/r�]��v���O)i�s�����AVig��J��T.C���K��)�6���Џ:�P�E��y݉����v�`�g��W��4�(g6�J_�� _�ͅ�VR�Z�dc����a�Y{m��4(о޲��
A��G؀�a�ZаI��PQU+y#�Q��-:u��=��اYdt�f���pE�䎦�a���Ʋ��fξ�d�.*�vZ�-}IԈ٫�-�ܘ��X/5I�!,��
��.cgi��gj��6�i���!%6!ە�O�����A

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/x-compressed-json

Sample:

Sample not available.