GET api/ARStatement?User={User}&Pass={Pass}

Use this function to retrieve a Statement of Account for all open Accounts Receivable Items

Request Information

URI Parameters

Name	Description	Type	Additional information
User	Enter the Logon Code assigned to your account (1-8 characters)	string	Required
Pass	Enter the Password associated with your Logon Code	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns an XML/JSON representation of a client's Accounts Receivable status, based on an overall total of open balances on shipments, including a breakdown of each item contributing to that balance, along with a list of open, unapplied payments on file.

ARStatement

Name	Description	Type	Additional information
ErrorInfo	This field will be empty (blank) if the API was processed successfully; a non-blank entry will document the nature of the error(s) encountered during processing.	string	None.
Comment	Additional information; can further describe errors encountered in processing the request (when applicable), or can include additional supporting information, such as a count of line items for a statement that has successfully processed.	string	None.
Prepared	Documents the date on which this statement was prepared	string	None.
StatementTotal	Shows the total open balance due for this statement. Drill-down on Details for a breakdown of entries	string	None.
Unapplied	Shows the total amount of any unapplied payments (as a negative number, i.e. credit)	string	None.
Aging1	Represents the number of days that an open line item must be aged to be classified in this first overdue aging bucket.	integer	None.
Aging2	Represents the number of days that an open line item must be aged to be classified in this second overdue aging bucket.	integer	None.
Aging3	Represents the number of days that an open line item must be aged to be classified in this third overdue aging bucket.	integer	None.
Aging4	Represents the number of days that an open line item must be aged to be classified in this final overdue aging bucket.	integer	None.
Details	Documents the list of line items on the statement in support of the StatementTotal	Collection of ARLineItem	None.
OpenPayments	Documents the list of open payments on the account (not otherwise represented in the Statement itself)	Collection of ARLineItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorInfo": "sample string 1",
  "Comment": "sample string 2",
  "Prepared": "sample string 3",
  "StatementTotal": "sample string 4",
  "Unapplied": "sample string 5",
  "Aging1": 6,
  "Aging2": 7,
  "Aging3": 8,
  "Aging4": 9,
  "Details": [
    {
      "Reference": "sample string 1",
      "AgingDate": "sample string 2",
      "Description": "sample string 3",
      "Amount": "sample string 4",
      "OpenBalance": "sample string 5"
    },
    {
      "Reference": "sample string 1",
      "AgingDate": "sample string 2",
      "Description": "sample string 3",
      "Amount": "sample string 4",
      "OpenBalance": "sample string 5"
    }
  ],
  "OpenPayments": [
    {
      "Reference": "sample string 1",
      "AgingDate": "sample string 2",
      "Description": "sample string 3",
      "Amount": "sample string 4",
      "OpenBalance": "sample string 5"
    },
    {
      "Reference": "sample string 1",
      "AgingDate": "sample string 2",
      "Description": "sample string 3",
      "Amount": "sample string 4",
      "OpenBalance": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<ARStatement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <Aging1>6</Aging1>
  <Aging2>7</Aging2>
  <Aging3>8</Aging3>
  <Aging4>9</Aging4>
  <Comment>sample string 2</Comment>
  <Details>
    <ARLineItem>
      <AgingDate>sample string 2</AgingDate>
      <Amount>sample string 4</Amount>
      <Description>sample string 3</Description>
      <OpenBalance>sample string 5</OpenBalance>
      <Reference>sample string 1</Reference>
    </ARLineItem>
    <ARLineItem>
      <AgingDate>sample string 2</AgingDate>
      <Amount>sample string 4</Amount>
      <Description>sample string 3</Description>
      <OpenBalance>sample string 5</OpenBalance>
      <Reference>sample string 1</Reference>
    </ARLineItem>
  </Details>
  <ErrorInfo>sample string 1</ErrorInfo>
  <OpenPayments>
    <ARLineItem>
      <AgingDate>sample string 2</AgingDate>
      <Amount>sample string 4</Amount>
      <Description>sample string 3</Description>
      <OpenBalance>sample string 5</OpenBalance>
      <Reference>sample string 1</Reference>
    </ARLineItem>
    <ARLineItem>
      <AgingDate>sample string 2</AgingDate>
      <Amount>sample string 4</Amount>
      <Description>sample string 3</Description>
      <OpenBalance>sample string 5</OpenBalance>
      <Reference>sample string 1</Reference>
    </ARLineItem>
  </OpenPayments>
  <Prepared>sample string 3</Prepared>
  <StatementTotal>sample string 4</StatementTotal>
  <Unapplied>sample string 5</Unapplied>
</ARStatement>