POST api/v2/AR/CreateMiscARCharge

Create and post a new non taxable Miscellaneous A/R Charge or Convenience Fee.

Request Information

URI Parameters

None.

Body Parameters

MiscellaneousARCharge
NameDescriptionTypeAdditional information
CustomerId

Customer Id to charge.

 string

None.
ChargeDate

Date of charge. UTC format yyyy-MM-dd. Default is current day.

 string

None.
ChargeAmount

Amount of charge.

 decimal number

None.
ChargeDescription

A description of this misc charge. Default is "Miscellaneous Charge", or "Convenience Fee" if IsConvenienceFee is true.

 string

None.
LocationCode

Location code for this charge. Default is 1

 string

None.
IsConvenienceFee

Set to true if this charge is for a convenience fee, otherwise leave blank or set to false.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerId": "sample string 1",
  "ChargeDate": "sample string 2",
  "ChargeAmount": 3.0,
  "ChargeDescription": "sample string 4",
  "LocationCode": "sample string 5",
  "IsConvenienceFee": true
}

application/xml, text/xml

Sample: 
<MiscellaneousARCharge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <ChargeAmount>3</ChargeAmount>
  <ChargeDate>sample string 2</ChargeDate>
  <ChargeDescription>sample string 4</ChargeDescription>
  <CustomerId>sample string 1</CustomerId>
  <IsConvenienceFee>true</IsConvenienceFee>
  <LocationCode>sample string 5</LocationCode>
</MiscellaneousARCharge>

Response Information

Resource Description

PostARChargeResult
NameDescriptionTypeAdditional information
Posted

boolean

None.
InvoiceId

string

None.
ReturnCode

string

None.
ReturnDesc

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Posted": true,
  "InvoiceId": "sample string 2",
  "ReturnCode": "sample string 3",
  "ReturnDesc": "sample string 4"
}

application/xml, text/xml

Sample: 
<PostARChargeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <InvoiceId>sample string 2</InvoiceId>
  <Posted>true</Posted>
  <ReturnCode>sample string 3</ReturnCode>
  <ReturnDesc>sample string 4</ReturnDesc>
</PostARChargeResult>