Service Provider API-Guide

Download As PDF

API Details for GET WorkOrder Invoice

consumes a collection of the JSON objects presenting the WorkOrder information with the invoice candidate. Returns an HTML formatted string containing a report about the Bulk Invoice Update process outcome. For more information please refer to the corresponding section of the “fmPilot 2 Service Provider API” document and corresponding source code.

GET api/WorkOrders/{id}/Invoice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None

Response Information

Resource Description

InvoiceFragment
NameDescriptionTypeAdditional information
InvoiceDate

date None.
BatchID

string None.
BatchDate

date None.
CheckNumber

string None.
CheckDate

date None.
CheckAmount

decimal number None.
CurrencyCode

string None.
Number

string None.
SubmittedDate

date None.
RejectedDate

date None.
ApprovedDate

date None.
SubTotal

decimal number None.
SalesTax

decimal number None.
VendorTotalTax

decimal number None.
Total

decimal number None.
TotalCost

decimal number None.
TotalLaborCost

decimal number None.
TotalPartsAndOtherCost

decimal number None.
TotalFreightCost

decimal number None.
TotalHandlingCost

decimal number None.
TotalMaterialCost

decimal number None.
TotalPartsCost

decimal number None.
TotalShippingCost

decimal number None.
Tax1ID

integer None.
Tax1Name

string None.
Tax1Value

decimal number None.
Tax2ID

integer None.
Tax2Name

string None.
Tax2Value

decimal number None.
Tax3ID

integer None.
Tax3Name

string None.
Tax3Value

decimal number None.
Tax4ID

integer None.
Tax4Name

string None.
Tax4Value

decimal number None.
Tax5ID

integer None.
Tax5Name

string None.
Tax5Value

decimal number None.
IsInactive

boolean None.
Currency

ICurrency None.
WorkOrder

IWorkOrder None.
VendorId

integer None.
Id

integer None.
CreateDateTime

date None.
CreateUser

string None.
Description

string None.
LocationNumber

string None.
VendorCompanyName

string None.
VendorCode

string None.
LineItems

Collection of LineItemFragment None.
Equipment

IVendorEquipment None.

Response Formats

application/json, text/json

Sample: 
{
  "InvoiceDate": "2025-11-02T01:49:25.1069212Z",
  "BatchID": "sample string 1",
  "BatchDate": "2025-11-02T01:49:25.1069212Z",
  "CheckNumber": "sample string 2",
  "CheckDate": "2025-11-02T01:49:25.1069212Z",
  "CheckAmount": 1.0,
  "CurrencyCode": "sample string 3",
  "Number": "sample string 8",
  "SubmittedDate": "2025-11-02T01:49:25.1069212Z",
  "RejectedDate": "2025-11-02T01:49:25.1069212Z",
  "ApprovedDate": "2025-11-02T01:49:25.1069212Z",
  "SubTotal": 1.0,
  "SalesTax": 1.0,
  "VendorTotalTax": 1.0,
  "Total": 1.0,
  "TotalCost": 1.0,
  "TotalLaborCost": 1.0,
  "TotalPartsAndOtherCost": 1.0,
  "TotalFreightCost": 1.0,
  "TotalHandlingCost": 1.0,
  "TotalMaterialCost": 1.0,
  "TotalPartsCost": 1.0,
  "TotalShippingCost": 1.0,
  "Tax1ID": 1,
  "Tax1Name": "sample string 9",
  "Tax1Value": 1.0,
  "Tax2ID": 1,
  "Tax2Name": "sample string 10",
  "Tax2Value": 1.0,
  "Tax3ID": 1,
  "Tax3Name": "sample string 11",
  "Tax3Value": 1.0,
  "Tax4ID": 1,
  "Tax4Name": "sample string 12",
  "Tax4Value": 1.0,
  "Tax5ID": 1,
  "Tax5Name": "sample string 13",
  "Tax5Value": 1.0,
  "IsInactive": true,
  "Currency": null,
  "WorkOrder": null,
  "VendorId": 15,
  "Id": 16,
  "CreateDateTime": "2025-11-02T01:49:25.1069212Z",
  "CreateUser": "sample string 18",
  "Description": "sample string 19",
  "LocationNumber": "sample string 21",
  "VendorCompanyName": "sample string 22",
  "VendorCode": "sample string 23",
  "LineItems": [
    {
      "IsIncurred": true,
      "Option": "sample string 13",
      "ChargeTypeId": 5,
      "PartBrand": "sample string 6",
      "PartModel": "sample string 7",
      "PartName": "sample string 8",
      "PartNumber": "sample string 9",
      "PartSKU": "sample string 10",
      "WarrantyInfo": "sample string 11",
      "Quantity": 1.0,
      "Item": "sample string 14",
      "UnitCost": 1.0,
      "ChargeType": "sample string 17",
      "Manufacturer": "sample string 18",
      "ManufacturerOther": "sample string 19",
      "OEMPart": "sample string 20",
      "OEMPartOther": "sample string 21",
      "ListPrice": 1.0,
      "PAPrice": 1.0,
      "ItemUrl": "sample string 22",
      "PricingPartNumber": "sample string 23",
      "Id": 25,
      "CreateDateTime": "2025-11-02T01:49:25.1069212Z",
      "CreateUser": "sample string 27",
      "Description": "sample string 28",
      "ServiceDate": "2025-11-02T01:49:25.1069212Z",
      "ServiceDateFormat": "sample string 29",
      "ShowServiceDate": true,
      "EquipmentID": 1,
      "EquipmentName": "sample string 30"
    },
    {
      "IsIncurred": true,
      "Option": "sample string 13",
      "ChargeTypeId": 5,
      "PartBrand": "sample string 6",
      "PartModel": "sample string 7",
      "PartName": "sample string 8",
      "PartNumber": "sample string 9",
      "PartSKU": "sample string 10",
      "WarrantyInfo": "sample string 11",
      "Quantity": 1.0,
      "Item": "sample string 14",
      "UnitCost": 1.0,
      "ChargeType": "sample string 17",
      "Manufacturer": "sample string 18",
      "ManufacturerOther": "sample string 19",
      "OEMPart": "sample string 20",
      "OEMPartOther": "sample string 21",
      "ListPrice": 1.0,
      "PAPrice": 1.0,
      "ItemUrl": "sample string 22",
      "PricingPartNumber": "sample string 23",
      "Id": 25,
      "CreateDateTime": "2025-11-02T01:49:25.1069212Z",
      "CreateUser": "sample string 27",
      "Description": "sample string 28",
      "ServiceDate": "2025-11-02T01:49:25.1069212Z",
      "ServiceDateFormat": "sample string 29",
      "ShowServiceDate": true,
      "EquipmentID": 1,
      "EquipmentName": "sample string 30"
    }
  ],
  "Equipment": null
}

application/xml, text/xml

Sample: 
<InvoiceFragment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.Entities.Financial.Invoices">
  <ApprovedDate>2025-11-02T01:49:25.1069212+00:00</ApprovedDate>
  <BatchDate>2025-11-02T01:49:25.1069212+00:00</BatchDate>
  <BatchID>sample string 1</BatchID>
  <CheckAmount>1</CheckAmount>
  <CheckDate>2025-11-02T01:49:25.1069212+00:00</CheckDate>
  <CheckNumber>sample string 2</CheckNumber>
  <CreateDateTime>2025-11-02T01:49:25.1069212+00:00</CreateDateTime>
  <CreateUser>sample string 18</CreateUser>
  <Currency i:nil="true" />
  <CurrencyCode>sample string 3</CurrencyCode>
  <Description>sample string 19</Description>
  <Equipment i:nil="true" />
  <Id>16</Id>
  <InvoiceDate>2025-11-02T01:49:25.1069212+00:00</InvoiceDate>
  <IsInactive>true</IsInactive>
  <LineItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.Entities.Financial">
    <d2p1:LineItemFragment>
      <d2p1:ChargeType>sample string 17</d2p1:ChargeType>
      <d2p1:ChargeTypeId>5</d2p1:ChargeTypeId>
      <d2p1:ClientLineItemCost>1</d2p1:ClientLineItemCost>
      <d2p1:ClientQuantity>1</d2p1:ClientQuantity>
      <d2p1:ClientUnitCost>1</d2p1:ClientUnitCost>
      <d2p1:CreateDateTime>2025-11-02T01:49:25.1069212+00:00</d2p1:CreateDateTime>
      <d2p1:CreateUser>sample string 27</d2p1:CreateUser>
      <d2p1:Deactivate>true</d2p1:Deactivate>
      <d2p1:Description>sample string 28</d2p1:Description>
      <d2p1:EquipmentID>1</d2p1:EquipmentID>
      <d2p1:EquipmentName>sample string 30</d2p1:EquipmentName>
      <d2p1:Id>25</d2p1:Id>
      <d2p1:IsIncurred>true</d2p1:IsIncurred>
      <d2p1:IsMarkupOrTaxationLineItem>true</d2p1:IsMarkupOrTaxationLineItem>
      <d2p1:Item>sample string 14</d2p1:Item>
      <d2p1:ItemUrl>sample string 22</d2p1:ItemUrl>
      <d2p1:LaborRateType>sample string 14</d2p1:LaborRateType>
      <d2p1:LanguageId>3</d2p1:LanguageId>
      <d2p1:LineItemCost>1</d2p1:LineItemCost>
      <d2p1:LineItemTypeId>5</d2p1:LineItemTypeId>
      <d2p1:LineItemTypeName>sample string 17</d2p1:LineItemTypeName>
      <d2p1:ListPrice>1</d2p1:ListPrice>
      <d2p1:Manufacturer>sample string 18</d2p1:Manufacturer>
      <d2p1:ManufacturerOther>sample string 19</d2p1:ManufacturerOther>
      <d2p1:OEMPart>sample string 20</d2p1:OEMPart>
      <d2p1:OEMPartOther>sample string 21</d2p1:OEMPartOther>
      <d2p1:Option>sample string 13</d2p1:Option>
      <d2p1:PAPrice>1</d2p1:PAPrice>
      <d2p1:PartBrand>sample string 6</d2p1:PartBrand>
      <d2p1:PartModel>sample string 7</d2p1:PartModel>
      <d2p1:PartName>sample string 8</d2p1:PartName>
      <d2p1:PartNumber>sample string 9</d2p1:PartNumber>
      <d2p1:PartSKU>sample string 10</d2p1:PartSKU>
      <d2p1:PreMarkupLineItemCost>1</d2p1:PreMarkupLineItemCost>
      <d2p1:PreMarkupQuantity>1</d2p1:PreMarkupQuantity>
      <d2p1:PreMarkupUnitCost>1</d2p1:PreMarkupUnitCost>
      <d2p1:PricingPartNumber>sample string 23</d2p1:PricingPartNumber>
      <d2p1:Quantity>1</d2p1:Quantity>
      <d2p1:Removed>true</d2p1:Removed>
      <d2p1:ServiceDate>2025-11-02T01:49:25.1069212+00:00</d2p1:ServiceDate>
      <d2p1:ServiceDateFormat>sample string 29</d2p1:ServiceDateFormat>
      <d2p1:ShowServiceDate>true</d2p1:ShowServiceDate>
      <d2p1:SkillLevel>sample string 13</d2p1:SkillLevel>
      <d2p1:Submitted>true</d2p1:Submitted>
      <d2p1:UnitCost>1</d2p1:UnitCost>
      <d2p1:WarrantyInfo>sample string 11</d2p1:WarrantyInfo>
    </d2p1:LineItemFragment>
    <d2p1:LineItemFragment>
      <d2p1:ChargeType>sample string 17</d2p1:ChargeType>
      <d2p1:ChargeTypeId>5</d2p1:ChargeTypeId>
      <d2p1:ClientLineItemCost>1</d2p1:ClientLineItemCost>
      <d2p1:ClientQuantity>1</d2p1:ClientQuantity>
      <d2p1:ClientUnitCost>1</d2p1:ClientUnitCost>
      <d2p1:CreateDateTime>2025-11-02T01:49:25.1069212+00:00</d2p1:CreateDateTime>
      <d2p1:CreateUser>sample string 27</d2p1:CreateUser>
      <d2p1:Deactivate>true</d2p1:Deactivate>
      <d2p1:Description>sample string 28</d2p1:Description>
      <d2p1:EquipmentID>1</d2p1:EquipmentID>
      <d2p1:EquipmentName>sample string 30</d2p1:EquipmentName>
      <d2p1:Id>25</d2p1:Id>
      <d2p1:IsIncurred>true</d2p1:IsIncurred>
      <d2p1:IsMarkupOrTaxationLineItem>true</d2p1:IsMarkupOrTaxationLineItem>
      <d2p1:Item>sample string 14</d2p1:Item>
      <d2p1:ItemUrl>sample string 22</d2p1:ItemUrl>
      <d2p1:LaborRateType>sample string 14</d2p1:LaborRateType>
      <d2p1:LanguageId>3</d2p1:LanguageId>
      <d2p1:LineItemCost>1</d2p1:LineItemCost>
      <d2p1:LineItemTypeId>5</d2p1:LineItemTypeId>
      <d2p1:LineItemTypeName>sample string 17</d2p1:LineItemTypeName>
      <d2p1:ListPrice>1</d2p1:ListPrice>
      <d2p1:Manufacturer>sample string 18</d2p1:Manufacturer>
      <d2p1:ManufacturerOther>sample string 19</d2p1:ManufacturerOther>
      <d2p1:OEMPart>sample string 20</d2p1:OEMPart>
      <d2p1:OEMPartOther>sample string 21</d2p1:OEMPartOther>
      <d2p1:Option>sample string 13</d2p1:Option>
      <d2p1:PAPrice>1</d2p1:PAPrice>
      <d2p1:PartBrand>sample string 6</d2p1:PartBrand>
      <d2p1:PartModel>sample string 7</d2p1:PartModel>
      <d2p1:PartName>sample string 8</d2p1:PartName>
      <d2p1:PartNumber>sample string 9</d2p1:PartNumber>
      <d2p1:PartSKU>sample string 10</d2p1:PartSKU>
      <d2p1:PreMarkupLineItemCost>1</d2p1:PreMarkupLineItemCost>
      <d2p1:PreMarkupQuantity>1</d2p1:PreMarkupQuantity>
      <d2p1:PreMarkupUnitCost>1</d2p1:PreMarkupUnitCost>
      <d2p1:PricingPartNumber>sample string 23</d2p1:PricingPartNumber>
      <d2p1:Quantity>1</d2p1:Quantity>
      <d2p1:Removed>true</d2p1:Removed>
      <d2p1:ServiceDate>2025-11-02T01:49:25.1069212+00:00</d2p1:ServiceDate>
      <d2p1:ServiceDateFormat>sample string 29</d2p1:ServiceDateFormat>
      <d2p1:ShowServiceDate>true</d2p1:ShowServiceDate>
      <d2p1:SkillLevel>sample string 13</d2p1:SkillLevel>
      <d2p1:Submitted>true</d2p1:Submitted>
      <d2p1:UnitCost>1</d2p1:UnitCost>
      <d2p1:WarrantyInfo>sample string 11</d2p1:WarrantyInfo>
    </d2p1:LineItemFragment>
  </LineItems>
  <LocationNumber>sample string 21</LocationNumber>
  <Number>sample string 8</Number>
  <RejectedDate>2025-11-02T01:49:25.1069212+00:00</RejectedDate>
  <SalesTax>1</SalesTax>
  <SubTotal>1</SubTotal>
  <SubmittedDate>2025-11-02T01:49:25.1069212+00:00</SubmittedDate>
  <Tax1ID>1</Tax1ID>
  <Tax1Name>sample string 9</Tax1Name>
  <Tax1Value>1</Tax1Value>
  <Tax2ID>1</Tax2ID>
  <Tax2Name>sample string 10</Tax2Name>
  <Tax2Value>1</Tax2Value>
  <Tax3ID>1</Tax3ID>
  <Tax3Name>sample string 11</Tax3Name>
  <Tax3Value>1</Tax3Value>
  <Tax4ID>1</Tax4ID>
  <Tax4Name>sample string 12</Tax4Name>
  <Tax4Value>1</Tax4Value>
  <Tax5ID>1</Tax5ID>
  <Tax5Name>sample string 13</Tax5Name>
  <Tax5Value>1</Tax5Value>
  <Total>1</Total>
  <TotalCost>1</TotalCost>
  <TotalFreightCost>1</TotalFreightCost>
  <TotalHandlingCost>1</TotalHandlingCost>
  <TotalLaborCost>1</TotalLaborCost>
  <TotalMaterialCost>1</TotalMaterialCost>
  <TotalPartsAndOtherCost>1</TotalPartsAndOtherCost>
  <TotalPartsCost>1</TotalPartsCost>
  <TotalShippingCost>1</TotalShippingCost>
  <VendorCode>sample string 23</VendorCode>
  <VendorCompanyName>sample string 22</VendorCompanyName>
  <VendorId>15</VendorId>
  <VendorTotalTax>1</VendorTotalTax>
  <WorkOrder i:nil="true" />
</InvoiceFragment>