GET api/v2/AR/CustomerARInquiry?CustomerId={CustomerId}&InvoiceDate={InvoiceDate}

Retrieves A/R information and open invoices for a single customer or all customers.

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerId	Specific customer to retrieve. Leave blank to retrieve all.	string	Default value is
InvoiceDate	Retrieve open invoices from on or after this date. Leave blank to retrieve all open invoices.	string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerARInquiry

Name	Description	Type	Additional information
CustomerId	Customer ID	string	None.
FirstName	Customer First Name	string	None.
LastName	Customer Last Name	string	None.
CompanyName	Customer Company Name	string	None.
CurrentBalance	Customer current A/R balance.	decimal number	None.
OpenARInvoices	List of Customers open (unpaid) invoices.	Collection of Invoice	None.
PendingPayments	List of any pending (unapplied) payments.	Collection of CustomerPayment	None.
LastPayment		LastPayment	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomerId": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "CompanyName": "sample string 4",
    "CurrentBalance": 5.0,
    "OpenARInvoices": [
      {
        "Id": "sample string 1",
        "CustomerId": "sample string 2",
        "Amount": 1.0,
        "InvoiceAmount": 1.0,
        "InvoiceBalance": 1.0,
        "DueDate": "sample string 3",
        "Description": "sample string 4",
        "LocationCode": "sample string 5",
        "UnAppliedPayment": true,
        "Installments": [
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          },
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          }
        ]
      },
      {
        "Id": "sample string 1",
        "CustomerId": "sample string 2",
        "Amount": 1.0,
        "InvoiceAmount": 1.0,
        "InvoiceBalance": 1.0,
        "DueDate": "sample string 3",
        "Description": "sample string 4",
        "LocationCode": "sample string 5",
        "UnAppliedPayment": true,
        "Installments": [
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          },
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          }
        ]
      }
    ],
    "PendingPayments": [
      {
        "BatchId": "sample string 1",
        "PaymentDate": "sample string 2",
        "TotalPaymentAmt": 3.0,
        "ReferenceNum": "sample string 4",
        "PostedDate": "sample string 5",
        "PaymentDetails": [
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          },
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          }
        ]
      },
      {
        "BatchId": "sample string 1",
        "PaymentDate": "sample string 2",
        "TotalPaymentAmt": 3.0,
        "ReferenceNum": "sample string 4",
        "PostedDate": "sample string 5",
        "PaymentDetails": [
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          },
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          }
        ]
      }
    ],
    "LastPayment": {
      "PaymentActions": [
        {
          "Action": "sample string 1",
          "InvoiceId": "sample string 2",
          "AmountApplied": 3.0
        },
        {
          "Action": "sample string 1",
          "InvoiceId": "sample string 2",
          "AmountApplied": 3.0
        }
      ],
      "PaymentDate": "sample string 1",
      "PaymentAmount": 2.0,
      "PaymentMethod": "sample string 3",
      "CCLastFour": "sample string 4"
    }
  },
  {
    "CustomerId": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "CompanyName": "sample string 4",
    "CurrentBalance": 5.0,
    "OpenARInvoices": [
      {
        "Id": "sample string 1",
        "CustomerId": "sample string 2",
        "Amount": 1.0,
        "InvoiceAmount": 1.0,
        "InvoiceBalance": 1.0,
        "DueDate": "sample string 3",
        "Description": "sample string 4",
        "LocationCode": "sample string 5",
        "UnAppliedPayment": true,
        "Installments": [
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          },
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          }
        ]
      },
      {
        "Id": "sample string 1",
        "CustomerId": "sample string 2",
        "Amount": 1.0,
        "InvoiceAmount": 1.0,
        "InvoiceBalance": 1.0,
        "DueDate": "sample string 3",
        "Description": "sample string 4",
        "LocationCode": "sample string 5",
        "UnAppliedPayment": true,
        "Installments": [
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          },
          {
            "id": "sample string 1",
            "Amount": 1.0,
            "DueDate": "sample string 2"
          }
        ]
      }
    ],
    "PendingPayments": [
      {
        "BatchId": "sample string 1",
        "PaymentDate": "sample string 2",
        "TotalPaymentAmt": 3.0,
        "ReferenceNum": "sample string 4",
        "PostedDate": "sample string 5",
        "PaymentDetails": [
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          },
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          }
        ]
      },
      {
        "BatchId": "sample string 1",
        "PaymentDate": "sample string 2",
        "TotalPaymentAmt": 3.0,
        "ReferenceNum": "sample string 4",
        "PostedDate": "sample string 5",
        "PaymentDetails": [
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          },
          {
            "InvoiceId": "sample string 1",
            "TotalInvoiceAmt": 1.0,
            "PaymentAmount": 2.0,
            "InvoiceBalance": 1.0,
            "PaymentActionCode": "sample string 3",
            "PaymentActionDesc": "sample string 4",
            "DepositDoc": "sample string 5"
          }
        ]
      }
    ],
    "LastPayment": {
      "PaymentActions": [
        {
          "Action": "sample string 1",
          "InvoiceId": "sample string 2",
          "AmountApplied": 3.0
        },
        {
          "Action": "sample string 1",
          "InvoiceId": "sample string 2",
          "AmountApplied": 3.0
        }
      ],
      "PaymentDate": "sample string 1",
      "PaymentAmount": 2.0,
      "PaymentMethod": "sample string 3",
      "CCLastFour": "sample string 4"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerARInquiry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <CustomerARInquiry>
    <CompanyName>sample string 4</CompanyName>
    <CurrentBalance>5</CurrentBalance>
    <CustomerId>sample string 1</CustomerId>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <LastPayment>
      <CCLastFour>sample string 4</CCLastFour>
      <PaymentActions>
        <PaymentAction>
          <Action>sample string 1</Action>
          <AmountApplied>3</AmountApplied>
          <InvoiceId>sample string 2</InvoiceId>
        </PaymentAction>
        <PaymentAction>
          <Action>sample string 1</Action>
          <AmountApplied>3</AmountApplied>
          <InvoiceId>sample string 2</InvoiceId>
        </PaymentAction>
      </PaymentActions>
      <PaymentAmount>2</PaymentAmount>
      <PaymentDate>sample string 1</PaymentDate>
      <PaymentMethod>sample string 3</PaymentMethod>
    </LastPayment>
    <OpenARInvoices>
      <Invoice>
        <Amount>1</Amount>
        <CustomerId>sample string 2</CustomerId>
        <Description>sample string 4</Description>
        <DueDate>sample string 3</DueDate>
        <Id>sample string 1</Id>
        <Installments>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
        </Installments>
        <InvoiceAmount>1</InvoiceAmount>
        <InvoiceBalance>1</InvoiceBalance>
        <LocationCode>sample string 5</LocationCode>
        <UnAppliedPayment>true</UnAppliedPayment>
      </Invoice>
      <Invoice>
        <Amount>1</Amount>
        <CustomerId>sample string 2</CustomerId>
        <Description>sample string 4</Description>
        <DueDate>sample string 3</DueDate>
        <Id>sample string 1</Id>
        <Installments>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
        </Installments>
        <InvoiceAmount>1</InvoiceAmount>
        <InvoiceBalance>1</InvoiceBalance>
        <LocationCode>sample string 5</LocationCode>
        <UnAppliedPayment>true</UnAppliedPayment>
      </Invoice>
    </OpenARInvoices>
    <PendingPayments>
      <CustomerPayment>
        <BatchId>sample string 1</BatchId>
        <PaymentDate>sample string 2</PaymentDate>
        <PaymentDetails>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
        </PaymentDetails>
        <PostedDate>sample string 5</PostedDate>
        <ReferenceNum>sample string 4</ReferenceNum>
        <TotalPaymentAmt>3</TotalPaymentAmt>
      </CustomerPayment>
      <CustomerPayment>
        <BatchId>sample string 1</BatchId>
        <PaymentDate>sample string 2</PaymentDate>
        <PaymentDetails>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
        </PaymentDetails>
        <PostedDate>sample string 5</PostedDate>
        <ReferenceNum>sample string 4</ReferenceNum>
        <TotalPaymentAmt>3</TotalPaymentAmt>
      </CustomerPayment>
    </PendingPayments>
  </CustomerARInquiry>
  <CustomerARInquiry>
    <CompanyName>sample string 4</CompanyName>
    <CurrentBalance>5</CurrentBalance>
    <CustomerId>sample string 1</CustomerId>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <LastPayment>
      <CCLastFour>sample string 4</CCLastFour>
      <PaymentActions>
        <PaymentAction>
          <Action>sample string 1</Action>
          <AmountApplied>3</AmountApplied>
          <InvoiceId>sample string 2</InvoiceId>
        </PaymentAction>
        <PaymentAction>
          <Action>sample string 1</Action>
          <AmountApplied>3</AmountApplied>
          <InvoiceId>sample string 2</InvoiceId>
        </PaymentAction>
      </PaymentActions>
      <PaymentAmount>2</PaymentAmount>
      <PaymentDate>sample string 1</PaymentDate>
      <PaymentMethod>sample string 3</PaymentMethod>
    </LastPayment>
    <OpenARInvoices>
      <Invoice>
        <Amount>1</Amount>
        <CustomerId>sample string 2</CustomerId>
        <Description>sample string 4</Description>
        <DueDate>sample string 3</DueDate>
        <Id>sample string 1</Id>
        <Installments>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
        </Installments>
        <InvoiceAmount>1</InvoiceAmount>
        <InvoiceBalance>1</InvoiceBalance>
        <LocationCode>sample string 5</LocationCode>
        <UnAppliedPayment>true</UnAppliedPayment>
      </Invoice>
      <Invoice>
        <Amount>1</Amount>
        <CustomerId>sample string 2</CustomerId>
        <Description>sample string 4</Description>
        <DueDate>sample string 3</DueDate>
        <Id>sample string 1</Id>
        <Installments>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
          <InvoiceInstallment>
            <Amount>1</Amount>
            <DueDate>sample string 2</DueDate>
            <id>sample string 1</id>
          </InvoiceInstallment>
        </Installments>
        <InvoiceAmount>1</InvoiceAmount>
        <InvoiceBalance>1</InvoiceBalance>
        <LocationCode>sample string 5</LocationCode>
        <UnAppliedPayment>true</UnAppliedPayment>
      </Invoice>
    </OpenARInvoices>
    <PendingPayments>
      <CustomerPayment>
        <BatchId>sample string 1</BatchId>
        <PaymentDate>sample string 2</PaymentDate>
        <PaymentDetails>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
        </PaymentDetails>
        <PostedDate>sample string 5</PostedDate>
        <ReferenceNum>sample string 4</ReferenceNum>
        <TotalPaymentAmt>3</TotalPaymentAmt>
      </CustomerPayment>
      <CustomerPayment>
        <BatchId>sample string 1</BatchId>
        <PaymentDate>sample string 2</PaymentDate>
        <PaymentDetails>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
          <PaymentDetail>
            <DepositDoc>sample string 5</DepositDoc>
            <InvoiceBalance>1</InvoiceBalance>
            <InvoiceId>sample string 1</InvoiceId>
            <PaymentActionCode>sample string 3</PaymentActionCode>
            <PaymentActionDesc>sample string 4</PaymentActionDesc>
            <PaymentAmount>2</PaymentAmount>
            <TotalInvoiceAmt>1</TotalInvoiceAmt>
          </PaymentDetail>
        </PaymentDetails>
        <PostedDate>sample string 5</PostedDate>
        <ReferenceNum>sample string 4</ReferenceNum>
        <TotalPaymentAmt>3</TotalPaymentAmt>
      </CustomerPayment>
    </PendingPayments>
  </CustomerARInquiry>
</ArrayOfCustomerARInquiry>