Invoice Parameters

2 minute read

Use this table as a reference to correctly fill out the body of the request to create an invoice. Please note that this table explains only parameters used in the example requests in our guides. To get the full model and parameter descriptions, see Swagger API Reference.

Parameter   Data type Description
InvoiceNumber   String The invoice identifier. Must be unique for each invoice.
WoIdentifier   String The work order identifier.
For providers: TrackingNumber or WorkOrderNumber
For subscribers: TrackingNumber or PurchaseNumber
InvoiceTax   Number The amount of the tax.
InvoiceTotal   Number The total amount of the invoice. Must be less than or equal to the work order NTE.
InvoiceTotal = LaborAmount + MaterialAmount + TravelAmount + FreightAmount + OtherAmount + InvoiceTax
InvoiceText   String The detailed description of the work completed.
InvoiceAmountsDetails   Object The list of the invoice charges.
  LaborAmount Number The amount of the labor charge. Must equal Labors.Amount.
  MaterialAmount Number The amount of the material charge. Must equal Materials.Amount.
  TravelAmount Number The amount of the trip charge.
  FreightAmount Number The amount of the freight charge.
  OtherAmount Number The amount of other charges. When you add this parameter, also specify InvoiceAmountsDetails.OtherDescription.
  OtherDescription String The description of other charges. Must not be empty if InvoiceAmountsDetails.OtherAmount is specified.
Valid values: Discount, Management Fee, Markup, Overhead & Profit, Rental Fee, Subcontractor Cost, Shipping & Handling.
Valid values for the Maintenance WO category: Agreed Price and all values mentioned above.
InvoiceTaxesDetails   Object The list of the invoice taxes.
LaborTax + MaterialTax + TravelTax + FreightTax + OtherTax = InvoiceTax
  LaborTax Number The amount of the labor tax.
  MaterialTax Number The amount of the material tax.
  TravelTax Number The amount of the travel tax.
  FreightTax Number The amount of the freight tax.
  OtherTax Number The amount of other taxes.
Tax2Details   Object The information on the additional tax. Only Canadian or European locations can have Tax2Details.
  Tax2Amount Number The amount of the additional tax.
  Tax2Name String The name of the additional tax, for example, VAT, HST, PST, or QST.
Labors   Array of objects The information on labor. Add a separate object for each worker. When two or more workers have the same SkillLevel, LaborType, and HourlyRate, use one object and specify NumOfTech.
  SkillLevel String The skill level of a worker.
Valid values:
1 Supervisor
2 Technician
3 Helper
  LaborType String The type of the pay rate.
Valid values:
1 Regular
2 Overtime
3 Double time
  NumOfTech String The number of workers.
  HourlyRate Number The worker hourly rate.
  Hours Number Total hours the worker spent to complete the work order.
  Amount Number The amount of the labor charge. The sum of all Amount parameters in the Labors array must equal InvoiceAmountsDetails.LaborAmount.
Materials   Array of objects The information on the materials used. Add a separate object for each material.
  Description String The name or description of the material. Length limit is 100 symbols.
  PartNum String The part, serial, or manufacturer number of the material. Length limit is 100 symbols.
  UnitType String A unit of measurement.
Valid values: 1 — Each; 2 — Box; 3 — Feet; 4 — Sqft; 5 — Lbs; 6 — Gal; 7 — Oz
Default value: 1
  UnitPrice Number The price per unit.
  Quantity Number The quantity of the material.
  Amount Number The amount of the material cost. The sum of all Amount parameters in the Materials array must equal InvoiceAmountsDetails.MaterialAmount.