POST api/UnappliedCashDetail

Creates an Unapplied Cash Detail record

Request Information

URI Parameters

None.

Body Parameters

UnappliedCashDetail
NameDescriptionTypeAdditional information
UnappliedCashDetailId

Sedona internal autonumber for the AR_Unapplied_Cash_Detail record (set automatically on POST)

integer

None.

UnappliedCashId

Foreign key from AR_Unapplied_Cash

integer

Required

Date

Defaults to today's date, but can be overridden

string

None.

TypeAIM

A = Advance Deposit; I = Invoice; M = Misc. Inc Account; set automatically on POST

string

None.

InvoiceNumber

value from AR_Invoice table; this is the Invoice_Number field, not the autonumber Invoice_Id; either InvoiceNumber or IncAccountCode or AdvanceDepostiId must be supplied, but only one

integer

None.

AdvanceDepositId

autonumber from AR_Advance_Deposit table; this is the Invoice_Number field, not the autonumber Invoice_Id; either InvoiceNumber or IncAccountCode or AdvanceDepostiId must be supplied, but only one

integer

None.

IncAccountCode

Income Account (from GL_Account) to apply to; either InvoiceNumber or IncAccountCode or AdvanceDepostiId must be supplied, but only one

string

None.

Amount

Amount

decimal number

Required

CategoryCode

Category from AR_Category table

string

Required

UserCode

the user making this change; defaults to UserCode value from config file if not set explicitly

string

String length: inclusive between 0 and 30

Request Formats

application/json, text/json

Sample:
{
  "UnappliedCashDetailId": 1,
  "UnappliedCashId": 1,
  "Date": "sample string 2",
  "TypeAIM": "sample string 3",
  "InvoiceNumber": 1,
  "AdvanceDepositId": 1,
  "IncAccountCode": "sample string 4",
  "Amount": 5.0,
  "CategoryCode": "sample string 6",
  "UserCode": "sample string 7"
}

application/xml, text/xml

Sample:
<UnappliedCashDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <AdvanceDepositId>1</AdvanceDepositId>
  <Amount>5</Amount>
  <CategoryCode>sample string 6</CategoryCode>
  <Date>sample string 2</Date>
  <IncAccountCode>sample string 4</IncAccountCode>
  <InvoiceNumber>1</InvoiceNumber>
  <TypeAIM>sample string 3</TypeAIM>
  <UnappliedCashDetailId>1</UnappliedCashDetailId>
  <UnappliedCashId>1</UnappliedCashId>
  <UserCode>sample string 7</UserCode>
</UnappliedCashDetail>

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 'UnappliedCashDetail'.

Response Information

Resource Description

UnappliedCashDetail
NameDescriptionTypeAdditional information
UnappliedCashDetailId

Sedona internal autonumber for the AR_Unapplied_Cash_Detail record (set automatically on POST)

integer

None.

UnappliedCashId

Foreign key from AR_Unapplied_Cash

integer

Required

Date

Defaults to today's date, but can be overridden

string

None.

TypeAIM

A = Advance Deposit; I = Invoice; M = Misc. Inc Account; set automatically on POST

string

None.

InvoiceNumber

value from AR_Invoice table; this is the Invoice_Number field, not the autonumber Invoice_Id; either InvoiceNumber or IncAccountCode or AdvanceDepostiId must be supplied, but only one

integer

None.

AdvanceDepositId

autonumber from AR_Advance_Deposit table; this is the Invoice_Number field, not the autonumber Invoice_Id; either InvoiceNumber or IncAccountCode or AdvanceDepostiId must be supplied, but only one

integer

None.

IncAccountCode

Income Account (from GL_Account) to apply to; either InvoiceNumber or IncAccountCode or AdvanceDepostiId must be supplied, but only one

string

None.

Amount

Amount

decimal number

Required

CategoryCode

Category from AR_Category table

string

Required

UserCode

the user making this change; defaults to UserCode value from config file if not set explicitly

string

String length: inclusive between 0 and 30

Response Formats

application/json, text/json

Sample:
{
  "UnappliedCashDetailId": 1,
  "UnappliedCashId": 1,
  "Date": "sample string 2",
  "TypeAIM": "sample string 3",
  "InvoiceNumber": 1,
  "AdvanceDepositId": 1,
  "IncAccountCode": "sample string 4",
  "Amount": 5.0,
  "CategoryCode": "sample string 6",
  "UserCode": "sample string 7"
}

application/xml, text/xml

Sample:
<UnappliedCashDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <AdvanceDepositId>1</AdvanceDepositId>
  <Amount>5</Amount>
  <CategoryCode>sample string 6</CategoryCode>
  <Date>sample string 2</Date>
  <IncAccountCode>sample string 4</IncAccountCode>
  <InvoiceNumber>1</InvoiceNumber>
  <TypeAIM>sample string 3</TypeAIM>
  <UnappliedCashDetailId>1</UnappliedCashDetailId>
  <UnappliedCashId>1</UnappliedCashId>
  <UserCode>sample string 7</UserCode>
</UnappliedCashDetail>