Home / API / ASP.NET Web API Details

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

Description

Get Owed Invoices 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:
[
  {
    "accountid": 1,
    "accountnum": "sample string 2",
    "branchid": 3,
    "branchname": "sample string 4",
    "invoices": [
      {
        "invoiceid": 1,
        "invoicenum": "sample string 2",
        "invoicedate": "2025-04-20T03:38:05.0783189+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          },
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          }
        ]
      },
      {
        "invoiceid": 1,
        "invoicenum": "sample string 2",
        "invoicedate": "2025-04-20T03:38:05.0783189+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          },
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          }
        ]
      }
    ]
  },
  {
    "accountid": 1,
    "accountnum": "sample string 2",
    "branchid": 3,
    "branchname": "sample string 4",
    "invoices": [
      {
        "invoiceid": 1,
        "invoicenum": "sample string 2",
        "invoicedate": "2025-04-20T03:38:05.0783189+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          },
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          }
        ]
      },
      {
        "invoiceid": 1,
        "invoicenum": "sample string 2",
        "invoicedate": "2025-04-20T03:38:05.0783189+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          },
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-04-20T03:38:05.078833+00:00",
            "programsaledate": "2025-04-20T03:38:05.078833+00:00",
            "programsalespersonid": 1,
            "programsalesperson": "sample string 2",
            "programcategoryid": 1,
            "programcategory": "sample string 3",
            "programrouteid": 1,
            "programroute": "sample string 4",
            "programemployeeid": 1,
            "programemployee": "sample string 5"
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfdetailedowedinvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <detailedowedinvoice>
    <accountid>1</accountid>
    <accountnum>sample string 2</accountnum>
    <branchid>3</branchid>
    <branchname>sample string 4</branchname>
    <invoices>
      <detailedowedinvoice_invoice>
        <amount>1</amount>
        <amountowed>1</amountowed>
        <amountpaid>1</amountpaid>
        <invoicedate>2025-04-20T03:38:05.0783189+00:00</invoicedate>
        <invoiceid>1</invoiceid>
        <invoicenum>sample string 2</invoicenum>
        <owedage>1</owedage>
        <programs>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
        </programs>
      </detailedowedinvoice_invoice>
      <detailedowedinvoice_invoice>
        <amount>1</amount>
        <amountowed>1</amountowed>
        <amountpaid>1</amountpaid>
        <invoicedate>2025-04-20T03:38:05.0783189+00:00</invoicedate>
        <invoiceid>1</invoiceid>
        <invoicenum>sample string 2</invoicenum>
        <owedage>1</owedage>
        <programs>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
        </programs>
      </detailedowedinvoice_invoice>
    </invoices>
  </detailedowedinvoice>
  <detailedowedinvoice>
    <accountid>1</accountid>
    <accountnum>sample string 2</accountnum>
    <branchid>3</branchid>
    <branchname>sample string 4</branchname>
    <invoices>
      <detailedowedinvoice_invoice>
        <amount>1</amount>
        <amountowed>1</amountowed>
        <amountpaid>1</amountpaid>
        <invoicedate>2025-04-20T03:38:05.0783189+00:00</invoicedate>
        <invoiceid>1</invoiceid>
        <invoicenum>sample string 2</invoicenum>
        <owedage>1</owedage>
        <programs>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
        </programs>
      </detailedowedinvoice_invoice>
      <detailedowedinvoice_invoice>
        <amount>1</amount>
        <amountowed>1</amountowed>
        <amountpaid>1</amountpaid>
        <invoicedate>2025-04-20T03:38:05.0783189+00:00</invoicedate>
        <invoiceid>1</invoiceid>
        <invoicenum>sample string 2</invoicenum>
        <owedage>1</owedage>
        <programs>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
          <detailedowedinvoice_invoice_prorgram>
            <programcanceldate>2025-04-20T03:38:05.078833+00:00</programcanceldate>
            <programcategory>sample string 3</programcategory>
            <programcategoryid>1</programcategoryid>
            <programemployee>sample string 5</programemployee>
            <programemployeeid>1</programemployeeid>
            <programid>1</programid>
            <programname>sample string 1</programname>
            <programroute>sample string 4</programroute>
            <programrouteid>1</programrouteid>
            <programsaledate>2025-04-20T03:38:05.078833+00:00</programsaledate>
            <programsalesperson>sample string 2</programsalesperson>
            <programsalespersonid>1</programsalespersonid>
          </detailedowedinvoice_invoice_prorgram>
        </programs>
      </detailedowedinvoice_invoice>
    </invoices>
  </detailedowedinvoice>
</ArrayOfdetailedowedinvoice>