Home / API Documentation

Get Invoice Details by Date Range

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

Response Format:

application/json

Required Parameters Description Additional information
from
From Completed Date

Define this parameter in the request URI.

to
To Completed Date

Define this parameter in the request URI.

companyid
CompanyID

Define this parameter in the request URI.

application/json, text/json

Sample Response:
                        [
  {
    "invoiceid": 1,
    "invoicenum": "sample string 2",
    "invoicedate": "2025-02-23T06:31:37.2259463+00:00",
    "invoiceage": 1,
    "utclastchanged": "2025-02-23T06:31:37.2259463+00:00",
    "utctimestamp": "2025-02-23T06:31:37.2259463+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-02-23T06:31:37.2259463+00:00",
    "discounts": 1.0,
    "prepay": 1.0,
    "credit": 1.0,
    "totaladjustments": 1.0,
    "checkpayments": 1.0,
    "creditcardpayments": 1.0,
    "totalpaid": 1.0,
    "invrouteid": 14,
    "invroutename": "sample string 15",
    "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-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.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-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.0
          }
        ]
      }
    ]
  },
  {
    "invoiceid": 1,
    "invoicenum": "sample string 2",
    "invoicedate": "2025-02-23T06:31:37.2259463+00:00",
    "invoiceage": 1,
    "utclastchanged": "2025-02-23T06:31:37.2259463+00:00",
    "utctimestamp": "2025-02-23T06:31:37.2259463+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-02-23T06:31:37.2259463+00:00",
    "discounts": 1.0,
    "prepay": 1.0,
    "credit": 1.0,
    "totaladjustments": 1.0,
    "checkpayments": 1.0,
    "creditcardpayments": 1.0,
    "totalpaid": 1.0,
    "invrouteid": 14,
    "invroutename": "sample string 15",
    "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-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.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-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.0
          },
          {
            "woid": 1,
            "woeventid": 1,
            "service": "sample string 1",
            "saleamount": 1.0,
            "completeddate": "2025-02-23T06:31:37.2259463+00:00",
            "billamount": 2.0,
            "prodamount": 3.0,
            "completedamount": 4.0,
            "invoiceTotal": 5.0
          }
        ]
      }
    ]
  }
];