Service Provider API-Guide

Download As PDF

API WorkOrders Rates

Gets a WorkOrder specific rates for better preparing the line items data for invoices and quotes. Internally, the code uses LineItemRules.GetLineItemConfigurations and returns WorkOrder specific collection of rates in the following structure.

GET api/WorkOrders/{id}/Rates

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None

Response Information

Resource Description

Collection of FinanceLineItemConfiguration
NameDescriptionTypeAdditional information
RateCardId

integer None.
LineItemTypeId

integer None.
ChargeTypeId

integer None.
LineItemType

string None.
ChargeType

string None.
SkillLevel

string None.
Item

string None.
RateType

string None.
Option

string None.
RateValue

decimal number None.
IsLocked

boolean None.
ServiceDate

string None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "RateCardId": 1,
    "LineItemTypeId": 3,
    "ChargeTypeId": 3,
    "LineItemType": "sample string 4",
    "ChargeType": "sample string 5",
    "SkillLevel": "sample string 6",
    "Item": "sample string 8",
    "RateType": "sample string 8",
    "Option": "sample string 9",
    "RateValue": 10.0,
    "IsLocked": true,
    "ServiceDate": "sample string 12"
  },
  {
    "RateCardId": 1,
    "LineItemTypeId": 3,
    "ChargeTypeId": 3,
    "LineItemType": "sample string 4",
    "ChargeType": "sample string 5",
    "SkillLevel": "sample string 6",
    "Item": "sample string 8",
    "RateType": "sample string 8",
    "Option": "sample string 9",
    "RateValue": 10.0,
    "IsLocked": true,
    "ServiceDate": "sample string 12"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfFinanceLineItemConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.Entities.Financial">
  <FinanceLineItemConfiguration>
    <ChargeType>sample string 5</ChargeType>
    <ChargeTypeId>3</ChargeTypeId>
    <IsLocked>true</IsLocked>
    <Item>sample string 8</Item>
    <LineItemType>sample string 4</LineItemType>
    <LineItemTypeId>3</LineItemTypeId>
    <Option>sample string 9</Option>
    <RateCardId>1</RateCardId>
    <RateType>sample string 8</RateType>
    <RateValue>10</RateValue>
    <ServiceDate>sample string 12</ServiceDate>
    <SkillLevel>sample string 6</SkillLevel>
  </FinanceLineItemConfiguration>
  <FinanceLineItemConfiguration>
    <ChargeType>sample string 5</ChargeType>
    <ChargeTypeId>3</ChargeTypeId>
    <IsLocked>true</IsLocked>
    <Item>sample string 8</Item>
    <LineItemType>sample string 4</LineItemType>
    <LineItemTypeId>3</LineItemTypeId>
    <Option>sample string 9</Option>
    <RateCardId>1</RateCardId>
    <RateType>sample string 8</RateType>
    <RateValue>10</RateValue>
    <ServiceDate>sample string 12</ServiceDate>
    <SkillLevel>sample string 6</SkillLevel>
  </FinanceLineItemConfiguration>
</ArrayOfFinanceLineItemConfiguration>