GET Service/Accessorial?Accessorial={Accessorial}&Effective={Effective}
Retrieve accessorial definitions, including information about calculation
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Accessorial |
Filter by accessorial code (optional) |
string |
None. |
Effective |
Effective date (optional) |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of AccessorialName | Description | Type | Additional information |
---|---|---|---|
Code |
Accessorial code |
string |
None. |
CodeName |
Accessorial name |
string |
None. |
Description |
Accessorial description |
string |
None. |
Calculation |
Accessorial calculation information |
string |
None. |
CustomRates |
Accessorial has custom rates |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Code": "sample string 1", "CodeName": "sample string 2", "Description": "sample string 3", "Calculation": "sample string 4", "CustomRates": true }, { "Code": "sample string 1", "CodeName": "sample string 2", "Description": "sample string 3", "Calculation": "sample string 4", "CustomRates": true } ]
application/xml, text/xml
Sample:
<ArrayOfAccessorial xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Accessorial> <Code>sample string 1</Code> <CodeName>sample string 2</CodeName> <Description>sample string 3</Description> <Calculation>sample string 4</Calculation> <CustomRates>true</CustomRates> </Accessorial> <Accessorial> <Code>sample string 1</Code> <CodeName>sample string 2</CodeName> <Description>sample string 3</Description> <Calculation>sample string 4</Calculation> <CustomRates>true</CustomRates> </Accessorial> </ArrayOfAccessorial>