GET CustomerPayoff/GetCustomerPayoff?CustID={CustID}&AsOfDate={AsOfDate}&DueBefore={DueBefore}&MaximizeDiscounts={MaximizeDiscounts}&IncludeUAC={IncludeUAC}&StockClassification={StockClassification}

Returns the customers payoff amount and open invoices that make up the payoff amount.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
CustID

Cust id to get the payoff amount for.

string

Required

AsOfDate

Used to specify the invoice discount used in the payoff calculation. Format MM-dd-yyyy.

string

Required

DueBefore

Used to include invoices before this date in the payoff calculation.

string

Required

MaximizeDiscounts

True or False depending on whether or not to look at just the invoice split due date or the invoice split due date and the invoice split discount dates. (optional)

boolean

Default value is False

IncludeUAC

True or False depending on whether or not to include unapplied cash in the payoff amount. (optional)

boolean

Default value is False

StockClassification

Stock classification used to get patronage balances (optional)

string

Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns the customers payoff amount and open invoices that make up the payoff amount.

AgvCustomerPayoff
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
CustID

Customer id.

string
CustomerName

Customer name.

string
Regular

Customer's regular amount.

decimal number
UnappliedCash

Customer's unapplied cash amount.

decimal number
Prepay

Customer's prepay amount.

decimal number
FinanceCharge

Customer's finance charge amount.

decimal number
PayoffAmount

Customer's payoff amount.

decimal number
BudgetDue

Customer's memo invoices due.

decimal number
BudgetBalance

Customer's budget balance.

decimal number
PatronageBalance

Customer's Stock Classification Total

decimal number
InvoiceData

JSON dictionary of InvoiceData.

Collection of InvoiceData
MemoInvoiceData

JSON dictionary of MemoInvoiceData.

Collection of MemoInvoiceData

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "CustID": "sample string 3",
  "CustomerName": "sample string 4",
  "Regular": 5.1,
  "UnappliedCash": 6.1,
  "Prepay": 7.1,
  "FinanceCharge": 8.1,
  "PayoffAmount": 9.1,
  "BudgetDue": 10.1,
  "BudgetBalance": 11.1,
  "PatronageBalance": 1.1,
  "InvoiceData": [
    {
      "InvoiceLocation": "sample string 1",
      "InvoiceNumber": "sample string 2",
      "InvoiceDate": "sample string 3",
      "DueDate": "sample string 4",
      "AmountDue": 5.1,
      "FincanceChargeYN": 6,
      "Discount": 7.1
    },
    {
      "InvoiceLocation": "sample string 1",
      "InvoiceNumber": "sample string 2",
      "InvoiceDate": "sample string 3",
      "DueDate": "sample string 4",
      "AmountDue": 5.1,
      "FincanceChargeYN": 6,
      "Discount": 7.1
    }
  ],
  "MemoInvoiceData": [
    {
      "InvoiceDate": "sample string 1",
      "InvoiceNumber": "sample string 2",
      "DueDate": "sample string 3",
      "Gross": 4.1,
      "UnpaidAmount": 5.1,
      "DiscountDate": "sample string 6",
      "Discount": 7.1,
      "Payment": 8.1
    },
    {
      "InvoiceDate": "sample string 1",
      "InvoiceNumber": "sample string 2",
      "DueDate": "sample string 3",
      "Gross": 4.1,
      "UnpaidAmount": 5.1,
      "DiscountDate": "sample string 6",
      "Discount": 7.1,
      "Payment": 8.1
    }
  ]
}

application/xml, text/xml

Sample:
<AgvCustomerPayoff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Customer">
  <BudgetBalance>11.1</BudgetBalance>
  <BudgetDue>10.1</BudgetDue>
  <CustID>sample string 3</CustID>
  <CustomerName>sample string 4</CustomerName>
  <FinanceCharge>8.1</FinanceCharge>
  <InvoiceData>
    <InvoiceData>
      <AmountDue>5.1</AmountDue>
      <Discount>7.1</Discount>
      <DueDate>sample string 4</DueDate>
      <FincanceChargeYN>6</FincanceChargeYN>
      <InvoiceDate>sample string 3</InvoiceDate>
      <InvoiceLocation>sample string 1</InvoiceLocation>
      <InvoiceNumber>sample string 2</InvoiceNumber>
    </InvoiceData>
    <InvoiceData>
      <AmountDue>5.1</AmountDue>
      <Discount>7.1</Discount>
      <DueDate>sample string 4</DueDate>
      <FincanceChargeYN>6</FincanceChargeYN>
      <InvoiceDate>sample string 3</InvoiceDate>
      <InvoiceLocation>sample string 1</InvoiceLocation>
      <InvoiceNumber>sample string 2</InvoiceNumber>
    </InvoiceData>
  </InvoiceData>
  <MemoInvoiceData>
    <MemoInvoiceData>
      <Discount>7.1</Discount>
      <DiscountDate>sample string 6</DiscountDate>
      <DueDate>sample string 3</DueDate>
      <Gross>4.1</Gross>
      <InvoiceDate>sample string 1</InvoiceDate>
      <InvoiceNumber>sample string 2</InvoiceNumber>
      <Payment>8.1</Payment>
      <UnpaidAmount>5.1</UnpaidAmount>
    </MemoInvoiceData>
    <MemoInvoiceData>
      <Discount>7.1</Discount>
      <DiscountDate>sample string 6</DiscountDate>
      <DueDate>sample string 3</DueDate>
      <Gross>4.1</Gross>
      <InvoiceDate>sample string 1</InvoiceDate>
      <InvoiceNumber>sample string 2</InvoiceNumber>
      <Payment>8.1</Payment>
      <UnpaidAmount>5.1</UnpaidAmount>
    </MemoInvoiceData>
  </MemoInvoiceData>
  <Message>sample string 2</Message>
  <PatronageBalance>1.1</PatronageBalance>
  <PayoffAmount>9.1</PayoffAmount>
  <Prepay>7.1</Prepay>
  <Regular>5.1</Regular>
  <Status>sample string 1</Status>
  <UnappliedCash>6.1</UnappliedCash>
</AgvCustomerPayoff>