Home / API / ASP.NET Web API Details

GET api/v1/Invoice/GetInvoiceDetailsByDateRange?from={from}&to={to}&companyid={companyid}&page={page}&pagelimit={pagelimit}

Description

Get Invoice Details by Date Range

Request Information

Parameters

NameDescriptionAdditional information
from

Define this parameter in the request URI.

to

Define this parameter in the request URI.

companyid

Define this parameter in the request URI.

page

Define this parameter in the request URI.

pagelimit

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "invoiceid": 1,
    "invoicenum": "sample string 2",
    "invoicedate": "2025-04-20T03:29:41.0031951+00:00",
    "invoiceage": 1,
    "utclastchanged": "2025-04-20T03:29:41.0031951+00:00",
    "utctimestamp": "2025-04-20T03:29:41.0031951+00:00",
    "invoicetype": "sample string 3",
    "batchid": 4,
    "branchid": 1,
    "branchname": "sample string 5",
    "accountid": 6,
    "accountnum": "sample string 7",
    "autopay": true,
    "activecreditcard": true,
    "udfdynamicid": "sample string 8",
    "customernotes": "sample string 9",
    "salespersonid": 10,
    "salesperson": "sample string 11",
    "completedemployeeid": 12,
    "completedemployeename": "sample string 13",
    "invoiceamount": 1.0,
    "originalamount": 1.0,
    "tax": 1.0,
    "lastpaymentdate": "2025-04-20T03:29:41.0031951+00:00",
    "discounts": 1.0,
    "prepay": 1.0,
    "credit": 1.0,
    "totaladjustments": 1.0,
    "checkpayments": 1.0,
    "creditcardpayments": 1.0,
    "totalpaid": 1.0,
    "invrouteid": 1,
    "invroutename": "sample string 14",
    "invoiceprograms": [
      {
        "programid": 1,
        "name": "sample string 1",
        "reportcategoryid": 1,
        "reportcategory": "sample string 2",
        "routeid": 1,
        "route": "sample string 3",
        "programannualvalue": 1.0,
        "programsalevalue": 1.0,
        "invoiceservices": [
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          }
        ]
      },
      {
        "programid": 1,
        "name": "sample string 1",
        "reportcategoryid": 1,
        "reportcategory": "sample string 2",
        "routeid": 1,
        "route": "sample string 3",
        "programannualvalue": 1.0,
        "programsalevalue": 1.0,
        "invoiceservices": [
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          }
        ]
      }
    ]
  },
  {
    "invoiceid": 1,
    "invoicenum": "sample string 2",
    "invoicedate": "2025-04-20T03:29:41.0031951+00:00",
    "invoiceage": 1,
    "utclastchanged": "2025-04-20T03:29:41.0031951+00:00",
    "utctimestamp": "2025-04-20T03:29:41.0031951+00:00",
    "invoicetype": "sample string 3",
    "batchid": 4,
    "branchid": 1,
    "branchname": "sample string 5",
    "accountid": 6,
    "accountnum": "sample string 7",
    "autopay": true,
    "activecreditcard": true,
    "udfdynamicid": "sample string 8",
    "customernotes": "sample string 9",
    "salespersonid": 10,
    "salesperson": "sample string 11",
    "completedemployeeid": 12,
    "completedemployeename": "sample string 13",
    "invoiceamount": 1.0,
    "originalamount": 1.0,
    "tax": 1.0,
    "lastpaymentdate": "2025-04-20T03:29:41.0031951+00:00",
    "discounts": 1.0,
    "prepay": 1.0,
    "credit": 1.0,
    "totaladjustments": 1.0,
    "checkpayments": 1.0,
    "creditcardpayments": 1.0,
    "totalpaid": 1.0,
    "invrouteid": 1,
    "invroutename": "sample string 14",
    "invoiceprograms": [
      {
        "programid": 1,
        "name": "sample string 1",
        "reportcategoryid": 1,
        "reportcategory": "sample string 2",
        "routeid": 1,
        "route": "sample string 3",
        "programannualvalue": 1.0,
        "programsalevalue": 1.0,
        "invoiceservices": [
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          }
        ]
      },
      {
        "programid": 1,
        "name": "sample string 1",
        "reportcategoryid": 1,
        "reportcategory": "sample string 2",
        "routeid": 1,
        "route": "sample string 3",
        "programannualvalue": 1.0,
        "programsalevalue": 1.0,
        "invoiceservices": [
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-04-20T03:29:41.0031951+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "tax": 4.0,
            "originalamount": 5.0,
            "completedamount": 6.0,
            "invoiceTotal": 7.0
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfinvoicewithdetailsmodel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <invoicewithdetailsmodel>
    <accountid>6</accountid>
    <accountnum>sample string 7</accountnum>
    <activecreditcard>true</activecreditcard>
    <autopay>true</autopay>
    <batchid>4</batchid>
    <branchid>1</branchid>
    <branchname>sample string 5</branchname>
    <checkpayments>1</checkpayments>
    <completedemployeeid>12</completedemployeeid>
    <completedemployeename>sample string 13</completedemployeename>
    <credit>1</credit>
    <creditcardpayments>1</creditcardpayments>
    <customernotes>sample string 9</customernotes>
    <discounts>1</discounts>
    <invoiceage>1</invoiceage>
    <invoiceamount>1</invoiceamount>
    <invoicedate>2025-04-20T03:29:41.0031951+00:00</invoicedate>
    <invoiceid>1</invoiceid>
    <invoicenum>sample string 2</invoicenum>
    <invoiceprograms>
      <invwdm_program>
        <invoiceservices>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
        </invoiceservices>
        <name>sample string 1</name>
        <programannualvalue>1</programannualvalue>
        <programid>1</programid>
        <programsalevalue>1</programsalevalue>
        <reportcategory>sample string 2</reportcategory>
        <reportcategoryid>1</reportcategoryid>
        <route>sample string 3</route>
        <routeid>1</routeid>
      </invwdm_program>
      <invwdm_program>
        <invoiceservices>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
        </invoiceservices>
        <name>sample string 1</name>
        <programannualvalue>1</programannualvalue>
        <programid>1</programid>
        <programsalevalue>1</programsalevalue>
        <reportcategory>sample string 2</reportcategory>
        <reportcategoryid>1</reportcategoryid>
        <route>sample string 3</route>
        <routeid>1</routeid>
      </invwdm_program>
    </invoiceprograms>
    <invoicetype>sample string 3</invoicetype>
    <invrouteid>1</invrouteid>
    <invroutename>sample string 14</invroutename>
    <lastpaymentdate>2025-04-20T03:29:41.0031951+00:00</lastpaymentdate>
    <originalamount>1</originalamount>
    <prepay>1</prepay>
    <salesperson>sample string 11</salesperson>
    <salespersonid>10</salespersonid>
    <tax>1</tax>
    <totaladjustments>1</totaladjustments>
    <totalpaid>1</totalpaid>
    <udfdynamicid>sample string 8</udfdynamicid>
    <utclastchanged>2025-04-20T03:29:41.0031951+00:00</utclastchanged>
    <utctimestamp>2025-04-20T03:29:41.0031951+00:00</utctimestamp>
  </invoicewithdetailsmodel>
  <invoicewithdetailsmodel>
    <accountid>6</accountid>
    <accountnum>sample string 7</accountnum>
    <activecreditcard>true</activecreditcard>
    <autopay>true</autopay>
    <batchid>4</batchid>
    <branchid>1</branchid>
    <branchname>sample string 5</branchname>
    <checkpayments>1</checkpayments>
    <completedemployeeid>12</completedemployeeid>
    <completedemployeename>sample string 13</completedemployeename>
    <credit>1</credit>
    <creditcardpayments>1</creditcardpayments>
    <customernotes>sample string 9</customernotes>
    <discounts>1</discounts>
    <invoiceage>1</invoiceage>
    <invoiceamount>1</invoiceamount>
    <invoicedate>2025-04-20T03:29:41.0031951+00:00</invoicedate>
    <invoiceid>1</invoiceid>
    <invoicenum>sample string 2</invoicenum>
    <invoiceprograms>
      <invwdm_program>
        <invoiceservices>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
        </invoiceservices>
        <name>sample string 1</name>
        <programannualvalue>1</programannualvalue>
        <programid>1</programid>
        <programsalevalue>1</programsalevalue>
        <reportcategory>sample string 2</reportcategory>
        <reportcategoryid>1</reportcategoryid>
        <route>sample string 3</route>
        <routeid>1</routeid>
      </invwdm_program>
      <invwdm_program>
        <invoiceservices>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
          <invwdm_services>
            <billamount>2</billamount>
            <completedamount>6</completedamount>
            <completeddate>2025-04-20T03:29:41.0031951+00:00</completeddate>
            <invoiceTotal>7</invoiceTotal>
            <originalamount>5</originalamount>
            <prodamount>3</prodamount>
            <saleamount>1</saleamount>
            <service>sample string 1</service>
            <tax>4</tax>
            <woeventid>1</woeventid>
            <woid>1</woid>
          </invwdm_services>
        </invoiceservices>
        <name>sample string 1</name>
        <programannualvalue>1</programannualvalue>
        <programid>1</programid>
        <programsalevalue>1</programsalevalue>
        <reportcategory>sample string 2</reportcategory>
        <reportcategoryid>1</reportcategoryid>
        <route>sample string 3</route>
        <routeid>1</routeid>
      </invwdm_program>
    </invoiceprograms>
    <invoicetype>sample string 3</invoicetype>
    <invrouteid>1</invrouteid>
    <invroutename>sample string 14</invroutename>
    <lastpaymentdate>2025-04-20T03:29:41.0031951+00:00</lastpaymentdate>
    <originalamount>1</originalamount>
    <prepay>1</prepay>
    <salesperson>sample string 11</salesperson>
    <salespersonid>10</salespersonid>
    <tax>1</tax>
    <totaladjustments>1</totaladjustments>
    <totalpaid>1</totalpaid>
    <udfdynamicid>sample string 8</udfdynamicid>
    <utclastchanged>2025-04-20T03:29:41.0031951+00:00</utclastchanged>
    <utctimestamp>2025-04-20T03:29:41.0031951+00:00</utctimestamp>
  </invoicewithdetailsmodel>
</ArrayOfinvoicewithdetailsmodel>