POST api/v2/AR/RetrieveInvoices

Retrieves a list of A/R Invoices.

Request Information

URI Parameters

None.

Body Parameters

A list of one ore more Invoice Ids to retrieve.

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

Response Information

Resource Description

Collection of Invoice

Name	Description	Type	Additional information
Id	Invoice Id	string	None.
CustomerId	Customer Id	string	None.
Amount	Current unpaid invoice amount. Same as InvoiceBalance.	decimal number	None.
InvoiceAmount	Original Invoice Amount	decimal number	None.
InvoiceBalance	Current Invoice balance.	decimal number	None.
DueDate	Invoice payment due date.	string	None.
Description	Invoice description	string	None.
LocationCode	Invoice Location Code	string	None.
UnAppliedPayment	Payments have been made to the invoice, but not posted.	boolean	None.
Installments		Collection of InvoiceInstallment	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "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"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <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>
</ArrayOfInvoice>