GET api/Invoice/InvoiceList

Returns a list of invoices

Request Information

URI Parameters

Name Type Description Additional information
PageNumber integer

PageSize integer

InvoiceStatus string

InvoiceDateStart string

InvoiceDateEnd string

IssuedDateStart string

IssuedDateEnd string

Body Parameters

None

Response Information

Resource Description

List of invoices

InvoiceListPageResponse
Name Type Description Additional information
IsSuccessful boolean

Message string

PagePublishedAmount decimal number

TotalPublishedAmount integer

PageDiscountAmount decimal number

TotalDiscountAmount decimal number

PageInvoicedAmount decimal number

TotalInvoicedAmount decimal number

TotalInvoiceAmountOwed decimal number

Page integer

Count integer

TotalPage integer

TotalCount integer

List Collection of InvoiceListResponse

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "Message": "sample string 2",
  "PagePublishedAmount": 3.0,
  "TotalPublishedAmount": 4,
  "PageDiscountAmount": 5.0,
  "TotalDiscountAmount": 6.0,
  "PageInvoicedAmount": 7.0,
  "TotalInvoicedAmount": 8.0,
  "TotalInvoiceAmountOwed": 9.0,
  "Page": 10,
  "Count": 11,
  "TotalPage": 12,
  "TotalCount": 13,
  "List": [
    {
      "InvoiceRefNumber": "sample string 1",
      "InvoiceParentRefNumber": "sample string 2",
      "BusinessUnit": "sample string 3",
      "ClientDisplayName": "sample string 4",
      "InvoiceFriendlyStatus": "sample string 5",
      "Terms": "sample string 6",
      "StartDate": "2024-10-12T06:42:59.2348656+00:00",
      "EndDate": "2024-10-12T06:42:59.2348656+00:00",
      "DueDate": "2024-10-12T06:42:59.2348656+00:00",
      "IssuedDate": "2024-10-12T06:42:59.2348656+00:00",
      "ProcessPeriodType": "sample string 7",
      "TotalInvoicedAmount": 8.0,
      "TotalAverageAmount": 9.0,
      "TotalPublishedAmount": 10.0,
      "TotalInvoiceLinesCount": 11,
      "TotalDiscountAmount": 12.0,
      "InvoiceAmountOwed": 13.0
    },
    {
      "InvoiceRefNumber": "sample string 1",
      "InvoiceParentRefNumber": "sample string 2",
      "BusinessUnit": "sample string 3",
      "ClientDisplayName": "sample string 4",
      "InvoiceFriendlyStatus": "sample string 5",
      "Terms": "sample string 6",
      "StartDate": "2024-10-12T06:42:59.2348656+00:00",
      "EndDate": "2024-10-12T06:42:59.2348656+00:00",
      "DueDate": "2024-10-12T06:42:59.2348656+00:00",
      "IssuedDate": "2024-10-12T06:42:59.2348656+00:00",
      "ProcessPeriodType": "sample string 7",
      "TotalInvoicedAmount": 8.0,
      "TotalAverageAmount": 9.0,
      "TotalPublishedAmount": 10.0,
      "TotalInvoiceLinesCount": 11,
      "TotalDiscountAmount": 12.0,
      "InvoiceAmountOwed": 13.0
    }
  ]
}

application/xml, text/xml

Sample: 
<InvoiceListPageResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 2</Message>
  <PagePublishedAmount>3</PagePublishedAmount>
  <TotalPublishedAmount>4</TotalPublishedAmount>
  <PageDiscountAmount>5</PageDiscountAmount>
  <TotalDiscountAmount>6</TotalDiscountAmount>
  <PageInvoicedAmount>7</PageInvoicedAmount>
  <TotalInvoicedAmount>8</TotalInvoicedAmount>
  <TotalInvoiceAmountOwed>9</TotalInvoiceAmountOwed>
  <Page>10</Page>
  <Count>11</Count>
  <TotalPage>12</TotalPage>
  <TotalCount>13</TotalCount>
  <List>
    <InvoiceListResponse>
      <InvoiceRefNumber>sample string 1</InvoiceRefNumber>
      <InvoiceParentRefNumber>sample string 2</InvoiceParentRefNumber>
      <BusinessUnit>sample string 3</BusinessUnit>
      <ClientDisplayName>sample string 4</ClientDisplayName>
      <InvoiceFriendlyStatus>sample string 5</InvoiceFriendlyStatus>
      <Terms>sample string 6</Terms>
      <StartDate>2024-10-12T06:42:59.2348656+00:00</StartDate>
      <EndDate>2024-10-12T06:42:59.2348656+00:00</EndDate>
      <DueDate>2024-10-12T06:42:59.2348656+00:00</DueDate>
      <IssuedDate>2024-10-12T06:42:59.2348656+00:00</IssuedDate>
      <ProcessPeriodType>sample string 7</ProcessPeriodType>
      <TotalInvoicedAmount>8</TotalInvoicedAmount>
      <TotalAverageAmount>9</TotalAverageAmount>
      <TotalPublishedAmount>10</TotalPublishedAmount>
      <TotalInvoiceLinesCount>11</TotalInvoiceLinesCount>
      <TotalDiscountAmount>12</TotalDiscountAmount>
      <InvoiceAmountOwed>13</InvoiceAmountOwed>
    </InvoiceListResponse>
    <InvoiceListResponse>
      <InvoiceRefNumber>sample string 1</InvoiceRefNumber>
      <InvoiceParentRefNumber>sample string 2</InvoiceParentRefNumber>
      <BusinessUnit>sample string 3</BusinessUnit>
      <ClientDisplayName>sample string 4</ClientDisplayName>
      <InvoiceFriendlyStatus>sample string 5</InvoiceFriendlyStatus>
      <Terms>sample string 6</Terms>
      <StartDate>2024-10-12T06:42:59.2348656+00:00</StartDate>
      <EndDate>2024-10-12T06:42:59.2348656+00:00</EndDate>
      <DueDate>2024-10-12T06:42:59.2348656+00:00</DueDate>
      <IssuedDate>2024-10-12T06:42:59.2348656+00:00</IssuedDate>
      <ProcessPeriodType>sample string 7</ProcessPeriodType>
      <TotalInvoicedAmount>8</TotalInvoicedAmount>
      <TotalAverageAmount>9</TotalAverageAmount>
      <TotalPublishedAmount>10</TotalPublishedAmount>
      <TotalInvoiceLinesCount>11</TotalInvoiceLinesCount>
      <TotalDiscountAmount>12</TotalDiscountAmount>
      <InvoiceAmountOwed>13</InvoiceAmountOwed>
    </InvoiceListResponse>
  </List>
</InvoiceListPageResponse>