GET v1/KeyInvoiceItems/GetDetails?branchFavourites={branchFavourites}

Returns a detailed list of KeyInvoiceItems.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
branchFavourites

branchFavourites=true : returns only the branch favourite invoice items branchFavourites=false : returns full list of invoice items under the company level

boolean

Default value is False

Body Parameters

None.


Response Information

Resource Description

Returns below in JSON format

Collection of KeyInvoiceItemDetailsListViewModel
NameDescriptionTypeAdditional information
TotalNumber

integer

None.

KeyInvoiceItems

Collection of KeyInvoiceItemDetailsViewModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "totalNumber": 1,
    "keyInvoiceItems": [
      {
        "keyInvoiceItemCode": 1,
        "clientInvoiceItemCode": 2,
        "description": "sample string 3",
        "cost": 4.1,
        "stills": true,
        "droneStills": 6,
        "droneVideos": 7,
        "retrofitAssessment": true,
        "elevatedStills": true,
        "floorplans": true,
        "virtualTours": true,
        "epc": true,
        "videos": true,
        "valuation": true,
        "verification": true,
        "viewing": true,
        "brochure": {
          "brochureStyleId": 1,
          "brochureStyleDescription": "sample string 2",
          "brochureStyleCode": "sample string 3",
          "finishId": 4,
          "finishDescription": "sample string 5",
          "foldId": 6,
          "foldDescription": "sample string 7",
          "orientation": "sample string 8",
          "pageSizeId": 9,
          "pageSizeDescription": "sample string 10",
          "pages": 11,
          "printQuantity": 12,
          "brochureTemplatesList": [
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        }
      },
      {
        "keyInvoiceItemCode": 1,
        "clientInvoiceItemCode": 2,
        "description": "sample string 3",
        "cost": 4.1,
        "stills": true,
        "droneStills": 6,
        "droneVideos": 7,
        "retrofitAssessment": true,
        "elevatedStills": true,
        "floorplans": true,
        "virtualTours": true,
        "epc": true,
        "videos": true,
        "valuation": true,
        "verification": true,
        "viewing": true,
        "brochure": {
          "brochureStyleId": 1,
          "brochureStyleDescription": "sample string 2",
          "brochureStyleCode": "sample string 3",
          "finishId": 4,
          "finishDescription": "sample string 5",
          "foldId": 6,
          "foldDescription": "sample string 7",
          "orientation": "sample string 8",
          "pageSizeId": 9,
          "pageSizeDescription": "sample string 10",
          "pages": 11,
          "printQuantity": 12,
          "brochureTemplatesList": [
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        }
      }
    ]
  },
  {
    "totalNumber": 1,
    "keyInvoiceItems": [
      {
        "keyInvoiceItemCode": 1,
        "clientInvoiceItemCode": 2,
        "description": "sample string 3",
        "cost": 4.1,
        "stills": true,
        "droneStills": 6,
        "droneVideos": 7,
        "retrofitAssessment": true,
        "elevatedStills": true,
        "floorplans": true,
        "virtualTours": true,
        "epc": true,
        "videos": true,
        "valuation": true,
        "verification": true,
        "viewing": true,
        "brochure": {
          "brochureStyleId": 1,
          "brochureStyleDescription": "sample string 2",
          "brochureStyleCode": "sample string 3",
          "finishId": 4,
          "finishDescription": "sample string 5",
          "foldId": 6,
          "foldDescription": "sample string 7",
          "orientation": "sample string 8",
          "pageSizeId": 9,
          "pageSizeDescription": "sample string 10",
          "pages": 11,
          "printQuantity": 12,
          "brochureTemplatesList": [
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        }
      },
      {
        "keyInvoiceItemCode": 1,
        "clientInvoiceItemCode": 2,
        "description": "sample string 3",
        "cost": 4.1,
        "stills": true,
        "droneStills": 6,
        "droneVideos": 7,
        "retrofitAssessment": true,
        "elevatedStills": true,
        "floorplans": true,
        "virtualTours": true,
        "epc": true,
        "videos": true,
        "valuation": true,
        "verification": true,
        "viewing": true,
        "brochure": {
          "brochureStyleId": 1,
          "brochureStyleDescription": "sample string 2",
          "brochureStyleCode": "sample string 3",
          "finishId": 4,
          "finishDescription": "sample string 5",
          "foldId": 6,
          "foldDescription": "sample string 7",
          "orientation": "sample string 8",
          "pageSizeId": 9,
          "pageSizeDescription": "sample string 10",
          "pages": 11,
          "printQuantity": 12,
          "brochureTemplatesList": [
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            },
            {
              "templateId": 1,
              "templateName": "sample string 2",
              "templateWidth": "sample string 3",
              "templateHeight": "sample string 4",
              "brochureStyleCode": "sample string 5",
              "thumbnailUrlsList": [
                "sample string 1",
                "sample string 2"
              ]
            }
          ]
        }
      }
    ]
  }
]