POST v1/Generic/InvoiceList

Return all of New Invoices

This is secure method and requires below attributes in header

Authorization: PRC Authorize Token
Authorization: Midnight Authorize Token
MISKEY: MIS Key

Request Information

URI Parameters

None.

Body Parameters

InvoiceListRequest
NameDescriptionTypeAdditional information
ShowPaid

boolean

None.

ShowInactive

boolean

None.

tableFilterModel

PrimeNg lazy loading parameters

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

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-04-23T08:16:30.3079559-04:00",
    "CustomerName": "sample string 6",
    "InvoiceDueDate": "2024-04-23T08:16:30.3079559-04: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",
    "InvoiceLineType": "sample string 17",
    "ContactID": 1,
    "PaymentStatus": "sample string 18",
    "InvoiceBalance": 19.0,
    "RequestType": "sample string 20",
    "Active": true,
    "TotalRecords": 22
  },
  {
    "Guid": "sample string 1",
    "InvoiceID": 2,
    "InvoiceNumber": "sample string 3",
    "InvoiceNumberExt": "sample string 4",
    "InvoiceNumberPlusExt": "sample string 5",
    "InvoiceDate": "2024-04-23T08:16:30.3079559-04:00",
    "CustomerName": "sample string 6",
    "InvoiceDueDate": "2024-04-23T08:16:30.3079559-04: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",
    "InvoiceLineType": "sample string 17",
    "ContactID": 1,
    "PaymentStatus": "sample string 18",
    "InvoiceBalance": 19.0,
    "RequestType": "sample string 20",
    "Active": true,
    "TotalRecords": 22
  }
]

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-04-23T08:16:30.3079559-04:00</InvoiceDate>
    <CustomerName>sample string 6</CustomerName>
    <InvoiceDueDate>2024-04-23T08:16:30.3079559-04: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>
    <InvoiceLineType>sample string 17</InvoiceLineType>
    <ContactID>1</ContactID>
    <PaymentStatus>sample string 18</PaymentStatus>
    <InvoiceBalance>19</InvoiceBalance>
    <RequestType>sample string 20</RequestType>
    <Active>true</Active>
    <TotalRecords>22</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-04-23T08:16:30.3079559-04:00</InvoiceDate>
    <CustomerName>sample string 6</CustomerName>
    <InvoiceDueDate>2024-04-23T08:16:30.3079559-04: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>
    <InvoiceLineType>sample string 17</InvoiceLineType>
    <ContactID>1</ContactID>
    <PaymentStatus>sample string 18</PaymentStatus>
    <InvoiceBalance>19</InvoiceBalance>
    <RequestType>sample string 20</RequestType>
    <Active>true</Active>
    <TotalRecords>22</TotalRecords>
  </InvoiceListResponse>
</ArrayOfInvoiceListResponse>