POST v1/Generic/InvoiceList

Request Information

URI Parameters

None.

Body Parameters

InvoiceListRequest
NameDescriptionTypeAdditional information
ShowPaid

boolean

None.
ShowInactive

boolean

None.
tableFilterModel

TableFilterModel

None.

Request Formats

application/json, text/json

Sample: 
{
  "ShowPaid": true,
  "ShowInactive": true,
  "tableFilterModel": {
    "Filters": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "First": 1,
    "Rows": 2,
    "SortField": "sample string 3",
    "SortOrder": 4,
    "MultiSortMeta": [
      {
        "Field": "sample string 1",
        "Order": 2
      },
      {
        "Field": "sample string 1",
        "Order": 2
      }
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InvoiceListRequest'.

Response Information

Resource Description

Collection of InvoiceListResponse
NameDescriptionTypeAdditional information
Guid

string

None.
InvoiceID

integer

None.
InvoiceNumber

string

None.
InvoiceNumberExt

string

None.
InvoiceNumberPlusExt

string

None.
InvoiceDate

date

None.
CustomerName

string

None.
InvoiceDueDate

date

None.
InvoiceStatus

string

None.
InvoiceAmount

decimal number

None.
CustomerNumber

integer

None.
InvoiceTitle

string

None.
TermsCode

string

None.
CustomerPaymentID

integer

None.
InvoiceAmountPaid

decimal number

None.
OrderID

integer

None.
OrderNumber

string

None.
CreatedBy

string

None.
InvoiceLineTypes

Collection of string

None.
ContactID

integer

None.
PaymentStatus

string

None.
InvoiceBalance

decimal number

None.
RequestType

string

None.
Active

boolean

None.
TotalRecords

integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Guid": "sample string 1",
    "InvoiceID": 2,
    "InvoiceNumber": "sample string 3",
    "InvoiceNumberExt": "sample string 4",
    "InvoiceNumberPlusExt": "sample string 5",
    "InvoiceDate": "2024-11-21T05:05:59.4550126-05:00",
    "CustomerName": "sample string 6",
    "InvoiceDueDate": "2024-11-21T05:05:59.4550126-05:00",
    "InvoiceStatus": "sample string 7",
    "InvoiceAmount": 8.0,
    "CustomerNumber": 9,
    "InvoiceTitle": "sample string 10",
    "TermsCode": "sample string 11",
    "CustomerPaymentID": 12,
    "InvoiceAmountPaid": 13.0,
    "OrderID": 14,
    "OrderNumber": "sample string 15",
    "CreatedBy": "sample string 16",
    "InvoiceLineTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "ContactID": 1,
    "PaymentStatus": "sample string 17",
    "InvoiceBalance": 18.0,
    "RequestType": "sample string 19",
    "Active": true,
    "TotalRecords": 21
  },
  {
    "Guid": "sample string 1",
    "InvoiceID": 2,
    "InvoiceNumber": "sample string 3",
    "InvoiceNumberExt": "sample string 4",
    "InvoiceNumberPlusExt": "sample string 5",
    "InvoiceDate": "2024-11-21T05:05:59.4550126-05:00",
    "CustomerName": "sample string 6",
    "InvoiceDueDate": "2024-11-21T05:05:59.4550126-05:00",
    "InvoiceStatus": "sample string 7",
    "InvoiceAmount": 8.0,
    "CustomerNumber": 9,
    "InvoiceTitle": "sample string 10",
    "TermsCode": "sample string 11",
    "CustomerPaymentID": 12,
    "InvoiceAmountPaid": 13.0,
    "OrderID": 14,
    "OrderNumber": "sample string 15",
    "CreatedBy": "sample string 16",
    "InvoiceLineTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "ContactID": 1,
    "PaymentStatus": "sample string 17",
    "InvoiceBalance": 18.0,
    "RequestType": "sample string 19",
    "Active": true,
    "TotalRecords": 21
  }
]

application/xml, text/xml

Sample: 
<ArrayOfInvoiceListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <InvoiceListResponse>
    <Guid>sample string 1</Guid>
    <InvoiceID>2</InvoiceID>
    <InvoiceNumber>sample string 3</InvoiceNumber>
    <InvoiceNumberExt>sample string 4</InvoiceNumberExt>
    <InvoiceNumberPlusExt>sample string 5</InvoiceNumberPlusExt>
    <InvoiceDate>2024-11-21T05:05:59.4550126-05:00</InvoiceDate>
    <CustomerName>sample string 6</CustomerName>
    <InvoiceDueDate>2024-11-21T05:05:59.4550126-05:00</InvoiceDueDate>
    <InvoiceStatus>sample string 7</InvoiceStatus>
    <InvoiceAmount>8</InvoiceAmount>
    <CustomerNumber>9</CustomerNumber>
    <InvoiceTitle>sample string 10</InvoiceTitle>
    <TermsCode>sample string 11</TermsCode>
    <CustomerPaymentID>12</CustomerPaymentID>
    <InvoiceAmountPaid>13</InvoiceAmountPaid>
    <OrderID>14</OrderID>
    <OrderNumber>sample string 15</OrderNumber>
    <CreatedBy>sample string 16</CreatedBy>
    <InvoiceLineTypes>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </InvoiceLineTypes>
    <ContactID>1</ContactID>
    <PaymentStatus>sample string 17</PaymentStatus>
    <InvoiceBalance>18</InvoiceBalance>
    <RequestType>sample string 19</RequestType>
    <Active>true</Active>
    <TotalRecords>21</TotalRecords>
  </InvoiceListResponse>
  <InvoiceListResponse>
    <Guid>sample string 1</Guid>
    <InvoiceID>2</InvoiceID>
    <InvoiceNumber>sample string 3</InvoiceNumber>
    <InvoiceNumberExt>sample string 4</InvoiceNumberExt>
    <InvoiceNumberPlusExt>sample string 5</InvoiceNumberPlusExt>
    <InvoiceDate>2024-11-21T05:05:59.4550126-05:00</InvoiceDate>
    <CustomerName>sample string 6</CustomerName>
    <InvoiceDueDate>2024-11-21T05:05:59.4550126-05:00</InvoiceDueDate>
    <InvoiceStatus>sample string 7</InvoiceStatus>
    <InvoiceAmount>8</InvoiceAmount>
    <CustomerNumber>9</CustomerNumber>
    <InvoiceTitle>sample string 10</InvoiceTitle>
    <TermsCode>sample string 11</TermsCode>
    <CustomerPaymentID>12</CustomerPaymentID>
    <InvoiceAmountPaid>13</InvoiceAmountPaid>
    <OrderID>14</OrderID>
    <OrderNumber>sample string 15</OrderNumber>
    <CreatedBy>sample string 16</CreatedBy>
    <InvoiceLineTypes>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </InvoiceLineTypes>
    <ContactID>1</ContactID>
    <PaymentStatus>sample string 17</PaymentStatus>
    <InvoiceBalance>18</InvoiceBalance>
    <RequestType>sample string 19</RequestType>
    <Active>true</Active>
    <TotalRecords>21</TotalRecords>
  </InvoiceListResponse>
</ArrayOfInvoiceListResponse>