POST api/{siteCode}/Financials/WriteJobChargesRecord

Writes a cost/charge record. It is essential that GetChargeDescriptions, GetPermittedCurrencyCodes and GetTaxCodes are run to validate the data prior to calling this method as no validation takes place on entry.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteCode	The site code.	integer	Required

Body Parameters

The list charge records.

Collection of ChargeRecord

Name	Description	Type	Additional information
JobNumber		string	Required
ChargeDescription	This value must have been validated against GetChargeDescriptions()	string	Required String length: inclusive between 0 and 40
NominalAccount	This value must have been validated against GetChargeDescriptions()	string	Required
Supplier	Supplier/Vendor name.	string	None.
CostCurrency	This value must have been validated against GetValidCurrencies()	string	Required String length: inclusive between 0 and 3
CostAmount		decimal number	Required
CostTaxAmount		decimal number	Required
CostTaxCode	This value must have been validated against GetTaxCodes()	string	Required String length: inclusive between 0 and 10
CostComment		string	String length: inclusive between 0 and 255
ChargeCurrency	This value must have been validated against GetValidCurrencies()	string	Required String length: inclusive between 0 and 3
ChargeAmount		decimal number	Required
ChargeTaxAmount		decimal number	Required
ChargeTaxCode	This value must have been validated against GetTaxCodes()	string	Required String length: inclusive between 0 and 10
ChargeComment		string	String length: inclusive between 0 and 255

Request Formats

application/json, text/json

Sample:

[
  {
    "JobNumber": "LHRI132435",
    "ChargeDescription": "Transportation",
    "NominalAccount": "4000/5000",
    "Supplier": null,
    "CostCurrency": "EUR",
    "CostAmount": 100.0,
    "CostTaxAmount": 0.0,
    "CostTaxCode": "T22",
    "CostComment": null,
    "ChargeCurrency": "GBP",
    "ChargeAmount": 125.47,
    "ChargeTaxAmount": 25.09,
    "ChargeTaxCode": "T1",
    "ChargeComment": null
  },
  {
    "JobNumber": "LHRI132435",
    "ChargeDescription": "Handling",
    "NominalAccount": "4001/5001",
    "Supplier": null,
    "CostCurrency": "EUR",
    "CostAmount": 10.0,
    "CostTaxAmount": 0.0,
    "CostTaxCode": "T22",
    "CostComment": null,
    "ChargeCurrency": "GBP",
    "ChargeAmount": 12.54,
    "ChargeTaxAmount": 2.51,
    "ChargeTaxCode": "T1",
    "ChargeComment": null
  }
]

application/xml, text/xml

Sample:

<ArrayOfChargeRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ChargeRecord>
    <JobNumber>LHRI132435</JobNumber>
    <ChargeDescription>Transportation</ChargeDescription>
    <NominalAccount>4000/5000</NominalAccount>
    <CostCurrency>EUR</CostCurrency>
    <CostAmount>100.00</CostAmount>
    <CostTaxAmount>0</CostTaxAmount>
    <CostTaxCode>T22</CostTaxCode>
    <ChargeCurrency>GBP</ChargeCurrency>
    <ChargeAmount>125.47</ChargeAmount>
    <ChargeTaxAmount>25.09</ChargeTaxAmount>
    <ChargeTaxCode>T1</ChargeTaxCode>
  </ChargeRecord>
  <ChargeRecord>
    <JobNumber>LHRI132435</JobNumber>
    <ChargeDescription>Handling</ChargeDescription>
    <NominalAccount>4001/5001</NominalAccount>
    <CostCurrency>EUR</CostCurrency>
    <CostAmount>10.00</CostAmount>
    <CostTaxAmount>0</CostTaxAmount>
    <CostTaxCode>T22</CostTaxCode>
    <ChargeCurrency>GBP</ChargeCurrency>
    <ChargeAmount>12.54</ChargeAmount>
    <ChargeTaxAmount>2.51</ChargeTaxAmount>
    <ChargeTaxCode>T1</ChargeTaxCode>
  </ChargeRecord>
</ArrayOfChargeRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WriteChargeRecordsResponse

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.