Service Provider API-Guide

Download As PDF

API Details for Post WorkOrder Invoice Bulk

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.

POST api/WorkOrders/Invoice/Bulk

Request Information

URI Parameters

None.

Body Parameters

Collection of BulkInvoiceRequest
NameDescriptionTypeAdditional information
WorkOrderNumber

string None.
InvoiceDate

date None.
InvoiceNumber

string None.
LaborRate

decimal number None.
LaborHours

decimal number None.
TotalLabor

decimal number None.
TotalMaterials

decimal number None.
SalesTax

decimal number None.
PST

decimal number None.
QST

decimal number None.
HST

decimal number None.
GST

decimal number None.
IVA

decimal number None.
InvoiceTotal

decimal number None.
Notes

string None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "WorkOrderNumber": "sample string 1",
    "InvoiceDate": "2025-04-30T01:54:08.3211801Z",
    "InvoiceNumber": "sample string 3",
    "LaborRate": 4.0,
    "LaborHours": 5.0,
    "TotalLabor": 6.0,
    "TotalMaterials": 7.0,
    "SalesTax": 8.0,
    "PST": 9.0,
    "QST": 10.0,
    "HST": 11.0,
    "GST": 12.0,
    "IVA": 13.0,
    "InvoiceTotal": 14.0,
    "Notes": "sample string 15"
  },
  {
    "WorkOrderNumber": "sample string 1",
    "InvoiceDate": "2025-04-30T01:54:08.3211801Z",
    "InvoiceNumber": "sample string 3",
    "LaborRate": 4.0,
    "LaborHours": 5.0,
    "TotalLabor": 6.0,
    "TotalMaterials": 7.0,
    "SalesTax": 8.0,
    "PST": 9.0,
    "QST": 10.0,
    "HST": 11.0,
    "GST": 12.0,
    "IVA": 13.0,
    "InvoiceTotal": 14.0,
    "Notes": "sample string 15"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBulkInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.Entities.Financial.Invoices">
  <BulkInvoiceRequest>
    <GST>12</GST>
    <HST>11</HST>
    <IVA>13</IVA>
    <InvoiceDate>2025-04-30T01:54:08.3211801+00:00</InvoiceDate>
    <InvoiceNumber>sample string 3</InvoiceNumber>
    <InvoiceTotal>14</InvoiceTotal>
    <LaborHours>5</LaborHours>
    <LaborRate>4</LaborRate>
    <Notes>sample string 15</Notes>
    <PST>9</PST>
    <QST>10</QST>
    <SalesTax>8</SalesTax>
    <TotalLabor>6</TotalLabor>
    <TotalMaterials>7</TotalMaterials>
    <WorkOrderNumber>sample string 1</WorkOrderNumber>
  </BulkInvoiceRequest>
  <BulkInvoiceRequest>
    <GST>12</GST>
    <HST>11</HST>
    <IVA>13</IVA>
    <InvoiceDate>2025-04-30T01:54:08.3211801+00:00</InvoiceDate>
    <InvoiceNumber>sample string 3</InvoiceNumber>
    <InvoiceTotal>14</InvoiceTotal>
    <LaborHours>5</LaborHours>
    <LaborRate>4</LaborRate>
    <Notes>sample string 15</Notes>
    <PST>9</PST>
    <QST>10</QST>
    <SalesTax>8</SalesTax>
    <TotalLabor>6</TotalLabor>
    <TotalMaterials>7</TotalMaterials>
    <WorkOrderNumber>sample string 1</WorkOrderNumber>
  </BulkInvoiceRequest>
</ArrayOfBulkInvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BulkInvoicingResponse
NameDescriptionTypeAdditional information
Result

boolean None.
ErrorMessage

string None.

Response Formats

application/json, text/json

Sample: 
{
  "Result": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<BulkInvoicingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fmPilot.Services.Accounts.DTO.Response">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result>true</Result>
</BulkInvoicingResponse>