POST api/Charge/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
ShipmentGUID	string	None.
ChargeTypeID	integer	None.
Name	string	None.
Description	string	None.
Amount	decimal number	None.
TaxAmount	decimal number	None.
NetAmount	decimal number	None.
LockFlag	boolean	None.
CustomerID	integer	None.
GlAcctNumber	string	None.
CurrencyID	string	None.
SortOrder	integer	None.
ApplyFuelSurcharge	boolean	None.
ApplyCurrencySurcharge	boolean	None.
ApplySecuritySurcharge	boolean	None.
Taxable	boolean	None.
Discountable	boolean	None.
TaxCode	string	None.
Status	string	None.
CostClass	string	None.
CostTypeID	integer	None.
VendorID	integer	None.
EditStatus	string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ShipmentGUID": "sample string 2",
  "ChargeTypeID": 3,
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Amount": 6.0,
  "TaxAmount": 7.0,
  "NetAmount": 8.0,
  "LockFlag": true,
  "CustomerID": 10,
  "GlAcctNumber": "sample string 11",
  "CurrencyID": "sample string 12",
  "SortOrder": 13,
  "ApplyFuelSurcharge": true,
  "ApplyCurrencySurcharge": true,
  "ApplySecuritySurcharge": true,
  "Taxable": true,
  "Discountable": true,
  "TaxCode": "sample string 19",
  "Status": "sample string 20",
  "CostClass": "sample string 21",
  "CostTypeID": 1,
  "VendorID": 1,
  "EditStatus": "sample string 22"
}

application/xml, text/xml

Sample:

<CreateShipmentChargeParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Amount>6</Amount>
  <ApplyCurrencySurcharge>true</ApplyCurrencySurcharge>
  <ApplyFuelSurcharge>true</ApplyFuelSurcharge>
  <ApplySecuritySurcharge>true</ApplySecuritySurcharge>
  <ChargeTypeID>3</ChargeTypeID>
  <CostClass>sample string 21</CostClass>
  <CostTypeID>1</CostTypeID>
  <CurrencyID>sample string 12</CurrencyID>
  <CustomerID>10</CustomerID>
  <Description>sample string 5</Description>
  <Discountable>true</Discountable>
  <EditStatus>sample string 22</EditStatus>
  <GlAcctNumber>sample string 11</GlAcctNumber>
  <LockFlag>true</LockFlag>
  <Name>sample string 4</Name>
  <NetAmount>8</NetAmount>
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <SortOrder>13</SortOrder>
  <Status>sample string 20</Status>
  <TaxAmount>7</TaxAmount>
  <TaxCode>sample string 19</TaxCode>
  <Taxable>true</Taxable>
  <VendorID>1</VendorID>
  <auth>sample string 1</auth>
</CreateShipmentChargeParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful		boolean	None.
ErrorMessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>