GET api/customeradvancedeposit/{id}
Returns a specific Customer Advance Deposit record by CustomerAdvanceDepositID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
CustomerAdvanceDepositID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CustomerAdvanceDepositName | Description | Type | Additional information |
---|---|---|---|
AdvanceDepositId |
Sedona internal autonumber for the Advance Deposit record |
integer |
None. |
DepositCheckId |
Foreign key from AR_Deposit_Check table |
integer |
None. |
CustomerId |
Foreign key from AR_Customer table |
integer |
Required |
DepositDate |
Defaults to today's date, but can be overridden |
string |
None. |
JobNumber |
Job_Code from OE_Job table |
string |
None. |
Amount | decimal number |
Required |
|
UsedAmount | decimal number |
None. |
|
UsedDate | string |
None. |
|
AdvanceDepositDetailItems |
list of Detail lines |
Collection of CustomerAdvanceDepositDetail |
Required |
Response Formats
application/json, text/json
Sample:
{ "AdvanceDepositId": 1, "DepositCheckId": 2, "CustomerId": 3, "DepositDate": "sample string 4", "JobNumber": "sample string 5", "Amount": 6.0, "UsedAmount": 7.0, "UsedDate": "sample string 8", "AdvanceDepositDetailItems": [ { "AdvanceDepositDetailId": 1, "AdvanceDepositId": 2, "Date": "sample string 3", "TypeUIM": "sample string 4", "UnappliedCashId": 1, "InvoiceNumber": 1, "IncomeAccountCode": "sample string 5", "Amount": 1.0, "CategoryCode": "sample string 6", "Reversed": "sample string 7", "UserCode": "sample string 8" }, { "AdvanceDepositDetailId": 1, "AdvanceDepositId": 2, "Date": "sample string 3", "TypeUIM": "sample string 4", "UnappliedCashId": 1, "InvoiceNumber": 1, "IncomeAccountCode": "sample string 5", "Amount": 1.0, "CategoryCode": "sample string 6", "Reversed": "sample string 7", "UserCode": "sample string 8" } ] }
application/xml, text/xml
Sample:
<CustomerAdvanceDeposit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <AdvanceDepositDetailItems> <CustomerAdvanceDepositDetail> <AdvanceDepositDetailId>1</AdvanceDepositDetailId> <AdvanceDepositId>2</AdvanceDepositId> <Amount>1</Amount> <CategoryCode>sample string 6</CategoryCode> <Date>sample string 3</Date> <IncomeAccountCode>sample string 5</IncomeAccountCode> <InvoiceNumber>1</InvoiceNumber> <Reversed>sample string 7</Reversed> <TypeUIM>sample string 4</TypeUIM> <UnappliedCashId>1</UnappliedCashId> <UserCode>sample string 8</UserCode> </CustomerAdvanceDepositDetail> <CustomerAdvanceDepositDetail> <AdvanceDepositDetailId>1</AdvanceDepositDetailId> <AdvanceDepositId>2</AdvanceDepositId> <Amount>1</Amount> <CategoryCode>sample string 6</CategoryCode> <Date>sample string 3</Date> <IncomeAccountCode>sample string 5</IncomeAccountCode> <InvoiceNumber>1</InvoiceNumber> <Reversed>sample string 7</Reversed> <TypeUIM>sample string 4</TypeUIM> <UnappliedCashId>1</UnappliedCashId> <UserCode>sample string 8</UserCode> </CustomerAdvanceDepositDetail> </AdvanceDepositDetailItems> <AdvanceDepositId>1</AdvanceDepositId> <Amount>6</Amount> <CustomerId>3</CustomerId> <DepositCheckId>2</DepositCheckId> <DepositDate>sample string 4</DepositDate> <JobNumber>sample string 5</JobNumber> <UsedAmount>7</UsedAmount> <UsedDate>sample string 8</UsedDate> </CustomerAdvanceDeposit>