GET PaymentTerms/GetPaymentTerm/{id}?effectiveDate={effectiveDate}&activeDetailLineFilter={activeDetailLineFilter}

Returns a list of Payment Terms

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
id

The unique identifier of the Payment Term. (optional)

string

Default value is string.Empty

effectiveDate

The date the Payment Term becomes valid. (optional) MM-dd-yyyyy

string

Default value is string.Empty

activeDetailLineFilter

The type of Payment Term detail lines to include. The types are active, inactive, or all. (optional)

string

Default value is Active

Body Parameters

Response Information

Resource Description

Returns a list of Payment Terms

AgvPaymentTerms
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many Payment Terms.

string
PaymentTermList

JSON dictionary of Payment Terms.

Collection of clsPayTerm

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "PaymentTermList": [
    null,
    {
      "UUID": "486109ca-7f21-4e71-a36b-f3c99bc0b4c9",
      "ID": "sample string 1",
      "Description": "sample string 2",
      "EffectiveStartDate": "sample string 3",
      "EffectiveEndDate": "sample string 4",
      "TermType": "sample string 5",
      "DiscountTermsType": "sample string 6",
      "DiscountMethod": "sample string 7",
      "PaymentTermsType": "sample string 8",
      "DiscountDetails": [
        null,
        {
          "LineItem": 2,
          "DiscountPercent": 3.1,
          "NumberOfDays": 4,
          "DiscountDate": "sample string 5",
          "DayOfMonth": "sample string 6",
          "MonthsAhead": "sample string 7",
          "Active": true
        }
      ],
      "ScheduleDetails": [
        null,
        {
          "LineItem": 2,
          "PaymentAmount": 3.1,
          "Days": 4,
          "DiscountDate": "sample string 5",
          "DayOfMonth": "sample string 6",
          "MonthsAhead": "sample string 7"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<AgvPaymentTerms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.PaymentTerms">
  <Message>sample string 2</Message>
  <PaymentTermList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.Agv">
    <d2p1:PaymentTerm i:nil="true" />
    <d2p1:PaymentTerm>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:DiscountDetails>
        <d2p1:PaymentTermDisc i:nil="true" />
        <d2p1:PaymentTermDisc>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:DayOfMonth>sample string 6</d2p1:DayOfMonth>
          <d2p1:DiscountDate>sample string 5</d2p1:DiscountDate>
          <d2p1:DiscountPercent>3.1</d2p1:DiscountPercent>
          <d2p1:LineItem>2</d2p1:LineItem>
          <d2p1:MonthsAhead>sample string 7</d2p1:MonthsAhead>
          <d2p1:NumberOfDays>4</d2p1:NumberOfDays>
        </d2p1:PaymentTermDisc>
      </d2p1:DiscountDetails>
      <d2p1:DiscountMethod>sample string 7</d2p1:DiscountMethod>
      <d2p1:DiscountTermsType>sample string 6</d2p1:DiscountTermsType>
      <d2p1:EffectiveEndDate>sample string 4</d2p1:EffectiveEndDate>
      <d2p1:EffectiveStartDate>sample string 3</d2p1:EffectiveStartDate>
      <d2p1:ID>sample string 1</d2p1:ID>
      <d2p1:PaymentTermsType>sample string 8</d2p1:PaymentTermsType>
      <d2p1:ScheduleDetails>
        <d2p1:PaymentTermDT i:nil="true" />
        <d2p1:PaymentTermDT>
          <d2p1:DayOfMonth>sample string 6</d2p1:DayOfMonth>
          <d2p1:Days>4</d2p1:Days>
          <d2p1:DiscountDate>sample string 5</d2p1:DiscountDate>
          <d2p1:LineItem>2</d2p1:LineItem>
          <d2p1:MonthsAhead>sample string 7</d2p1:MonthsAhead>
          <d2p1:PaymentAmount>3.1</d2p1:PaymentAmount>
        </d2p1:PaymentTermDT>
      </d2p1:ScheduleDetails>
      <d2p1:TermType>sample string 5</d2p1:TermType>
      <d2p1:UUID>486109ca-7f21-4e71-a36b-f3c99bc0b4c9</d2p1:UUID>
    </d2p1:PaymentTerm>
  </PaymentTermList>
  <Status>sample string 1</Status>
</AgvPaymentTerms>