Home / API Documentation

Get Owed Invoices Details by Date Range

Method: GET api/v1/Invoice/GetOwedInvoicesDetailsByDate?from={from}&to={to}&companyid={companyid}

Response Format:

application/json

Required Parameters Description Additional information
from
From Invoice Date

Define this parameter in the request URI.

to
To Invoice Date

Define this parameter in the request URI.

companyid
CompanyID

Define this parameter in the request URI.

application/json, text/json

Sample Response:
                        [
  {
    "accountid": 1,
    "accountnum": "sample string 2",
    "branchid": 3,
    "branchname": "sample string 4",
    "invoices": [
      {
        "invoiceid": 1,
        "invoicenum": "sample string 2",
        "invoicedate": "2025-02-23T06:27:20.4004226+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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-02-23T06:27:20.4004226+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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-02-23T06:27:20.4004226+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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-02-23T06:27:20.4004226+00:00",
        "owedage": 1,
        "amount": 1.0,
        "amountpaid": 1.0,
        "amountowed": 1.0,
        "programs": [
          {
            "programid": 1,
            "programname": "sample string 1",
            "programcanceldate": "2025-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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-02-23T06:27:20.4004226+00:00",
            "programsaledate": "2025-02-23T06:27:20.4004226+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"
          }
        ]
      }
    ]
  }
];