POST PaymentDiscount/GetPaymentDiscount

Calculates payment discount.

Request Information

URI Parameters

Body Parameters

Name	Description	Type	Additional Information
TermType	Type of payment term - Accounts Payable (AP).	string	Required Max length: 2 Valid option: AP (default).
TermID	ID of the payment term.	string	Required Max length: 15
DocumentDate	Date of the document to calculate the discount from.	string	Required Data type: DateTime Format must be MM/dd/yyyy
TotalDollarAmount	Total dollar amount to calculate the discount on.	decimal number	Required Max length: 10 Max of 2 decimal places Must be filled out and numeric

Request Formats

application/json, text/json

Sample:

{
  "TermType": "sample string 1",
  "TermID": "sample string 2",
  "DocumentDate": "sample string 3",
  "TotalDollarAmount": 4.1
}

application/xml, text/xml

Sample:

<PaymentDiscount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.AR.Payment">
  <DocumentDate>sample string 3</DocumentDate>
  <TermID>sample string 2</TermID>
  <TermType>sample string 1</TermType>
  <TotalDollarAmount>4.1</TotalDollarAmount>
</PaymentDiscount>

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

Response Information

Resource Description

Calculates payment discount.

AgvPaymentDiscount

Name	Description	Type
Status	Status of the API call. 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
PaymentDiscounts	JSON dictionary of PaymentDiscounts.	ClsPaymentDiscounts

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "PaymentDiscounts": {
    "IfPaidBy1": "sample string 1",
    "IfPaidBy2": "sample string 2",
    "IfPaidBy3": "sample string 3",
    "IfPaidBy4": "sample string 4",
    "IfPaidBy5": "sample string 5",
    "IfPaidBy6": "sample string 6",
    "IfPaidBy7": "sample string 7",
    "IfPaidBy8": "sample string 8",
    "DeductAmount1": 9.1,
    "DeductAmount2": 10.1,
    "DeductAmount3": 11.1,
    "DeductAmount4": 12.1,
    "DeductAmount5": 13.1,
    "DeductAmount6": 14.1,
    "DeductAmount7": 15.1,
    "DeductAmount8": 16.1,
    "DeductPercent1": 17.1,
    "DeductPercent2": 18.1,
    "DeductPercent3": 19.1,
    "DeductPercent4": 20.1,
    "DeductPercent5": 21.1,
    "DeductPercent6": 22.1,
    "DeductPercent7": 23.1,
    "DeductPercent8": 24.1
  }
}

application/xml, text/xml

Sample:

<AgvPaymentDiscount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Payment">
  <Message>sample string 2</Message>
  <PaymentDiscounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.AR.Payment">
    <d2p1:DeductAmount1>9.1</d2p1:DeductAmount1>
    <d2p1:DeductAmount2>10.1</d2p1:DeductAmount2>
    <d2p1:DeductAmount3>11.1</d2p1:DeductAmount3>
    <d2p1:DeductAmount4>12.1</d2p1:DeductAmount4>
    <d2p1:DeductAmount5>13.1</d2p1:DeductAmount5>
    <d2p1:DeductAmount6>14.1</d2p1:DeductAmount6>
    <d2p1:DeductAmount7>15.1</d2p1:DeductAmount7>
    <d2p1:DeductAmount8>16.1</d2p1:DeductAmount8>
    <d2p1:DeductPercent1>17.1</d2p1:DeductPercent1>
    <d2p1:DeductPercent2>18.1</d2p1:DeductPercent2>
    <d2p1:DeductPercent3>19.1</d2p1:DeductPercent3>
    <d2p1:DeductPercent4>20.1</d2p1:DeductPercent4>
    <d2p1:DeductPercent5>21.1</d2p1:DeductPercent5>
    <d2p1:DeductPercent6>22.1</d2p1:DeductPercent6>
    <d2p1:DeductPercent7>23.1</d2p1:DeductPercent7>
    <d2p1:DeductPercent8>24.1</d2p1:DeductPercent8>
    <d2p1:IfPaidBy1>sample string 1</d2p1:IfPaidBy1>
    <d2p1:IfPaidBy2>sample string 2</d2p1:IfPaidBy2>
    <d2p1:IfPaidBy3>sample string 3</d2p1:IfPaidBy3>
    <d2p1:IfPaidBy4>sample string 4</d2p1:IfPaidBy4>
    <d2p1:IfPaidBy5>sample string 5</d2p1:IfPaidBy5>
    <d2p1:IfPaidBy6>sample string 6</d2p1:IfPaidBy6>
    <d2p1:IfPaidBy7>sample string 7</d2p1:IfPaidBy7>
    <d2p1:IfPaidBy8>sample string 8</d2p1:IfPaidBy8>
  </PaymentDiscounts>
  <Status>sample string 1</Status>
</AgvPaymentDiscount>