GET api/projects/{projectId}/worksheets

Get project worksheets

Request Information

URI Parameters

NameDescriptionTypeAdditional information
projectId

Project ID

string

Required

Body Parameters

None.

Response Information

Resource Description

the worksheets

Collection of WorksheetDTO
NameDescriptionTypeAdditional information
Name string

None.

Type string

None.

TaxName string

None.

TaxRate string

None.

TotalSalesAmount string

None.

TotalCostAmount string

None.

TotalTaxAmount string

None.

TotalSalesTaxAmount string

None.

BillTo string

None.

ShipTo string

None.

CurrencySymbol string

None.

CurrencySymbolOnLeft boolean

None.

IsUseTax boolean

None.

FreightAmount string

None.

DiscountAmount string

None.

DepositAmount string

None.

Instruction string

None.

VisibleProperties Collection of string

None.

GroupedProperties Collection of string

None.

Items Collection of WorksheetItemDTO

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Type": "sample string 2",
    "TaxName": "sample string 3",
    "TaxRate": "sample string 4",
    "TotalSalesAmount": "sample string 5",
    "TotalCostAmount": "sample string 6",
    "TotalTaxAmount": "sample string 7",
    "TotalSalesTaxAmount": "sample string 8",
    "BillTo": "sample string 9",
    "ShipTo": "sample string 10",
    "CurrencySymbol": "sample string 11",
    "CurrencySymbolOnLeft": true,
    "IsUseTax": true,
    "FreightAmount": "sample string 14",
    "DiscountAmount": "sample string 15",
    "DepositAmount": "sample string 16",
    "Instruction": "sample string 17",
    "VisibleProperties": [
      "sample string 1",
      "sample string 2"
    ],
    "GroupedProperties": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ProdCategory": "sample string 25",
        "FloorName": "sample string 1",
        "RoomName": "sample string 2",
        "ItemName": "sample string 3",
        "TradeType": "sample string 26",
        "Description": "sample string 4",
        "SourceShapes": "sample string 7",
        "Vendor": "sample string 5",
        "VendorSku": "sample string 6",
        "Unit": "sample string 8",
        "Qty": "sample string 9",
        "ExtraQty": "sample string 10",
        "CostPrice": "sample string 11",
        "SalesPrice": "sample string 12",
        "Markup": "sample string 13",
        "ProfitMargin": "sample string 14",
        "CostAmount": "sample string 15",
        "SalesAmount": "sample string 16",
        "IsLabor": true,
        "Taxable": true,
        "TaxAmount": "sample string 19",
        "SalesTaxAmount": "sample string 20",
        "AssignUnitQty": "sample string 21",
        "WasteRatio": "sample string 22",
        "WasteAddon": "sample string 23",
        "BasePerimeter": "sample string 24"
      },
      {
        "ProdCategory": "sample string 25",
        "FloorName": "sample string 1",
        "RoomName": "sample string 2",
        "ItemName": "sample string 3",
        "TradeType": "sample string 26",
        "Description": "sample string 4",
        "SourceShapes": "sample string 7",
        "Vendor": "sample string 5",
        "VendorSku": "sample string 6",
        "Unit": "sample string 8",
        "Qty": "sample string 9",
        "ExtraQty": "sample string 10",
        "CostPrice": "sample string 11",
        "SalesPrice": "sample string 12",
        "Markup": "sample string 13",
        "ProfitMargin": "sample string 14",
        "CostAmount": "sample string 15",
        "SalesAmount": "sample string 16",
        "IsLabor": true,
        "Taxable": true,
        "TaxAmount": "sample string 19",
        "SalesTaxAmount": "sample string 20",
        "AssignUnitQty": "sample string 21",
        "WasteRatio": "sample string 22",
        "WasteAddon": "sample string 23",
        "BasePerimeter": "sample string 24"
      }
    ]
  },
  {
    "Name": "sample string 1",
    "Type": "sample string 2",
    "TaxName": "sample string 3",
    "TaxRate": "sample string 4",
    "TotalSalesAmount": "sample string 5",
    "TotalCostAmount": "sample string 6",
    "TotalTaxAmount": "sample string 7",
    "TotalSalesTaxAmount": "sample string 8",
    "BillTo": "sample string 9",
    "ShipTo": "sample string 10",
    "CurrencySymbol": "sample string 11",
    "CurrencySymbolOnLeft": true,
    "IsUseTax": true,
    "FreightAmount": "sample string 14",
    "DiscountAmount": "sample string 15",
    "DepositAmount": "sample string 16",
    "Instruction": "sample string 17",
    "VisibleProperties": [
      "sample string 1",
      "sample string 2"
    ],
    "GroupedProperties": [
      "sample string 1",
      "sample string 2"
    ],
    "Items": [
      {
        "ProdCategory": "sample string 25",
        "FloorName": "sample string 1",
        "RoomName": "sample string 2",
        "ItemName": "sample string 3",
        "TradeType": "sample string 26",
        "Description": "sample string 4",
        "SourceShapes": "sample string 7",
        "Vendor": "sample string 5",
        "VendorSku": "sample string 6",
        "Unit": "sample string 8",
        "Qty": "sample string 9",
        "ExtraQty": "sample string 10",
        "CostPrice": "sample string 11",
        "SalesPrice": "sample string 12",
        "Markup": "sample string 13",
        "ProfitMargin": "sample string 14",
        "CostAmount": "sample string 15",
        "SalesAmount": "sample string 16",
        "IsLabor": true,
        "Taxable": true,
        "TaxAmount": "sample string 19",
        "SalesTaxAmount": "sample string 20",
        "AssignUnitQty": "sample string 21",
        "WasteRatio": "sample string 22",
        "WasteAddon": "sample string 23",
        "BasePerimeter": "sample string 24"
      },
      {
        "ProdCategory": "sample string 25",
        "FloorName": "sample string 1",
        "RoomName": "sample string 2",
        "ItemName": "sample string 3",
        "TradeType": "sample string 26",
        "Description": "sample string 4",
        "SourceShapes": "sample string 7",
        "Vendor": "sample string 5",
        "VendorSku": "sample string 6",
        "Unit": "sample string 8",
        "Qty": "sample string 9",
        "ExtraQty": "sample string 10",
        "CostPrice": "sample string 11",
        "SalesPrice": "sample string 12",
        "Markup": "sample string 13",
        "ProfitMargin": "sample string 14",
        "CostAmount": "sample string 15",
        "SalesAmount": "sample string 16",
        "IsLabor": true,
        "Taxable": true,
        "TaxAmount": "sample string 19",
        "SalesTaxAmount": "sample string 20",
        "AssignUnitQty": "sample string 21",
        "WasteRatio": "sample string 22",
        "WasteAddon": "sample string 23",
        "BasePerimeter": "sample string 24"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfWorksheetDTO>
  <WorksheetDTO>
    <Name>sample string 1</Name>
    <Type>sample string 2</Type>
    <TaxName>sample string 3</TaxName>
    <TaxRate>sample string 4</TaxRate>
    <TotalSalesAmount>sample string 5</TotalSalesAmount>
    <TotalCostAmount>sample string 6</TotalCostAmount>
    <TotalTaxAmount>sample string 7</TotalTaxAmount>
    <TotalSalesTaxAmount>sample string 8</TotalSalesTaxAmount>
    <BillTo>sample string 9</BillTo>
    <ShipTo>sample string 10</ShipTo>
    <CurrencySymbol>sample string 11</CurrencySymbol>
    <CurrencySymbolOnLeft>true</CurrencySymbolOnLeft>
    <IsUseTax>true</IsUseTax>
    <FreightAmount>sample string 14</FreightAmount>
    <DiscountAmount>sample string 15</DiscountAmount>
    <DepositAmount>sample string 16</DepositAmount>
    <Instruction>sample string 17</Instruction>
    <VisibleProperties>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </VisibleProperties>
    <GroupedProperties>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </GroupedProperties>
    <Items>
      <WorksheetItemDTO>
        <FloorName>sample string 1</FloorName>
        <RoomName>sample string 2</RoomName>
        <ItemName>sample string 3</ItemName>
        <Description>sample string 4</Description>
        <Vendor>sample string 5</Vendor>
        <VendorSku>sample string 6</VendorSku>
        <SourceShapes>sample string 7</SourceShapes>
        <Unit>sample string 8</Unit>
        <Qty>sample string 9</Qty>
        <ExtraQty>sample string 10</ExtraQty>
        <CostPrice>sample string 11</CostPrice>
        <SalesPrice>sample string 12</SalesPrice>
        <Markup>sample string 13</Markup>
        <ProfitMargin>sample string 14</ProfitMargin>
        <CostAmount>sample string 15</CostAmount>
        <SalesAmount>sample string 16</SalesAmount>
        <IsLabor>true</IsLabor>
        <Taxable>true</Taxable>
        <TaxAmount>sample string 19</TaxAmount>
        <SalesTaxAmount>sample string 20</SalesTaxAmount>
        <AssignUnitQty>sample string 21</AssignUnitQty>
        <WasteRatio>sample string 22</WasteRatio>
        <WasteAddon>sample string 23</WasteAddon>
        <BasePerimeter>sample string 24</BasePerimeter>
        <ProdCategory>sample string 25</ProdCategory>
        <TradeType>sample string 26</TradeType>
      </WorksheetItemDTO>
      <WorksheetItemDTO>
        <FloorName>sample string 1</FloorName>
        <RoomName>sample string 2</RoomName>
        <ItemName>sample string 3</ItemName>
        <Description>sample string 4</Description>
        <Vendor>sample string 5</Vendor>
        <VendorSku>sample string 6</VendorSku>
        <SourceShapes>sample string 7</SourceShapes>
        <Unit>sample string 8</Unit>
        <Qty>sample string 9</Qty>
        <ExtraQty>sample string 10</ExtraQty>
        <CostPrice>sample string 11</CostPrice>
        <SalesPrice>sample string 12</SalesPrice>
        <Markup>sample string 13</Markup>
        <ProfitMargin>sample string 14</ProfitMargin>
        <CostAmount>sample string 15</CostAmount>
        <SalesAmount>sample string 16</SalesAmount>
        <IsLabor>true</IsLabor>
        <Taxable>true</Taxable>
        <TaxAmount>sample string 19</TaxAmount>
        <SalesTaxAmount>sample string 20</SalesTaxAmount>
        <AssignUnitQty>sample string 21</AssignUnitQty>
        <WasteRatio>sample string 22</WasteRatio>
        <WasteAddon>sample string 23</WasteAddon>
        <BasePerimeter>sample string 24</BasePerimeter>
        <ProdCategory>sample string 25</ProdCategory>
        <TradeType>sample string 26</TradeType>
      </WorksheetItemDTO>
    </Items>
  </WorksheetDTO>
  <WorksheetDTO>
    <Name>sample string 1</Name>
    <Type>sample string 2</Type>
    <TaxName>sample string 3</TaxName>
    <TaxRate>sample string 4</TaxRate>
    <TotalSalesAmount>sample string 5</TotalSalesAmount>
    <TotalCostAmount>sample string 6</TotalCostAmount>
    <TotalTaxAmount>sample string 7</TotalTaxAmount>
    <TotalSalesTaxAmount>sample string 8</TotalSalesTaxAmount>
    <BillTo>sample string 9</BillTo>
    <ShipTo>sample string 10</ShipTo>
    <CurrencySymbol>sample string 11</CurrencySymbol>
    <CurrencySymbolOnLeft>true</CurrencySymbolOnLeft>
    <IsUseTax>true</IsUseTax>
    <FreightAmount>sample string 14</FreightAmount>
    <DiscountAmount>sample string 15</DiscountAmount>
    <DepositAmount>sample string 16</DepositAmount>
    <Instruction>sample string 17</Instruction>
    <VisibleProperties>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </VisibleProperties>
    <GroupedProperties>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </GroupedProperties>
    <Items>
      <WorksheetItemDTO>
        <FloorName>sample string 1</FloorName>
        <RoomName>sample string 2</RoomName>
        <ItemName>sample string 3</ItemName>
        <Description>sample string 4</Description>
        <Vendor>sample string 5</Vendor>
        <VendorSku>sample string 6</VendorSku>
        <SourceShapes>sample string 7</SourceShapes>
        <Unit>sample string 8</Unit>
        <Qty>sample string 9</Qty>
        <ExtraQty>sample string 10</ExtraQty>
        <CostPrice>sample string 11</CostPrice>
        <SalesPrice>sample string 12</SalesPrice>
        <Markup>sample string 13</Markup>
        <ProfitMargin>sample string 14</ProfitMargin>
        <CostAmount>sample string 15</CostAmount>
        <SalesAmount>sample string 16</SalesAmount>
        <IsLabor>true</IsLabor>
        <Taxable>true</Taxable>
        <TaxAmount>sample string 19</TaxAmount>
        <SalesTaxAmount>sample string 20</SalesTaxAmount>
        <AssignUnitQty>sample string 21</AssignUnitQty>
        <WasteRatio>sample string 22</WasteRatio>
        <WasteAddon>sample string 23</WasteAddon>
        <BasePerimeter>sample string 24</BasePerimeter>
        <ProdCategory>sample string 25</ProdCategory>
        <TradeType>sample string 26</TradeType>
      </WorksheetItemDTO>
      <WorksheetItemDTO>
        <FloorName>sample string 1</FloorName>
        <RoomName>sample string 2</RoomName>
        <ItemName>sample string 3</ItemName>
        <Description>sample string 4</Description>
        <Vendor>sample string 5</Vendor>
        <VendorSku>sample string 6</VendorSku>
        <SourceShapes>sample string 7</SourceShapes>
        <Unit>sample string 8</Unit>
        <Qty>sample string 9</Qty>
        <ExtraQty>sample string 10</ExtraQty>
        <CostPrice>sample string 11</CostPrice>
        <SalesPrice>sample string 12</SalesPrice>
        <Markup>sample string 13</Markup>
        <ProfitMargin>sample string 14</ProfitMargin>
        <CostAmount>sample string 15</CostAmount>
        <SalesAmount>sample string 16</SalesAmount>
        <IsLabor>true</IsLabor>
        <Taxable>true</Taxable>
        <TaxAmount>sample string 19</TaxAmount>
        <SalesTaxAmount>sample string 20</SalesTaxAmount>
        <AssignUnitQty>sample string 21</AssignUnitQty>
        <WasteRatio>sample string 22</WasteRatio>
        <WasteAddon>sample string 23</WasteAddon>
        <BasePerimeter>sample string 24</BasePerimeter>
        <ProdCategory>sample string 25</ProdCategory>
        <TradeType>sample string 26</TradeType>
      </WorksheetItemDTO>
    </Items>
  </WorksheetDTO>
</ArrayOfWorksheetDTO>