GET api/{siteCode}/Financials/GetChargeDescriptions?mode={mode}&jobNumber={jobNumber}

Gets a list of permissable charge descriptions and associated nominal account codes. If mode is empty then all records will be returned.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteCode

The site code.

integer

Required

mode

The mode of transportation. Argument must be included but value can be empty string to avoid filtering of results

string

Required

jobNumber

The job number.

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ChargeNameNominal
NameDescriptionTypeAdditional information
ChargeDescription

string

None.

NominalAccount

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ChargeDescription": "Transportation",
    "NominalAccount": "4000/5000"
  },
  {
    "ChargeDescription": "Handling",
    "NominalAccount": "4001/5001"
  }
]

application/xml, text/xml

Sample:
<ArrayOfChargeNameNominal xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ChargeNameNominal>
    <ChargeDescription>Transportation</ChargeDescription>
    <NominalAccount>4000/5000</NominalAccount>
  </ChargeNameNominal>
  <ChargeNameNominal>
    <ChargeDescription>Handling</ChargeDescription>
    <NominalAccount>4001/5001</NominalAccount>
  </ChargeNameNominal>
</ArrayOfChargeNameNominal>