Service Provider API-Guide

Download As PDF

Gets the possible tax information associated to the provided WorkOrder

Employs WorkOrderRules.GetLocationTaxation class/method returning the WorkOrder location specific taxation coefficients in the following structure.

GET api/WorkOrders/{id}/Taxes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None

Response Information

Resource Description

Collection of LocationTax
NameDescriptionTypeAdditional information
CurrencyCodeID

integer None.
CurrencyCode

string None.
TaxTypeID

integer None.
TaxTypeName

string None.
Id

integer None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CurrencyCodeID": 2,
    "CurrencyCode": "sample string 3",
    "TaxTypeID": 4,
    "TaxTypeName": "sample string 5",
    "Id": 6
  },
  {
    "CurrencyCodeID": 2,
    "CurrencyCode": "sample string 3",
    "TaxTypeID": 4,
    "TaxTypeName": "sample string 5",
    "Id": 6
  }
]

application/xml, text/xml

Sample: 
<ArrayOfLocationTax xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.Entities.Financial">
  <LocationTax>
    <CreateDateTime>2025-04-30T01:42:52.1004361+00:00</CreateDateTime>
    <CreateUser>sample string 8</CreateUser>
    <CurrencyCode>sample string 3</CurrencyCode>
    <CurrencyCodeID>2</CurrencyCodeID>
    <Id>6</Id>
    <LocationID>1</LocationID>
    <TaxTypeID>4</TaxTypeID>
    <TaxTypeName>sample string 5</TaxTypeName>
  </LocationTax>
  <LocationTax>
    <CreateDateTime>2025-04-30T01:42:52.1004361+00:00</CreateDateTime>
    <CreateUser>sample string 8</CreateUser>
    <CurrencyCode>sample string 3</CurrencyCode>
    <CurrencyCodeID>2</CurrencyCodeID>
    <Id>6</Id>
    <LocationID>1</LocationID>
    <TaxTypeID>4</TaxTypeID>
    <TaxTypeName>sample string 5</TaxTypeName>
  </LocationTax>
</ArrayOfLocationTax>