POST v1/ReverseCharges?preview={preview}

Documentation for 'Post'.

Request Information

Parameters

NameDescriptionAdditional information
reverseCharge 
Documentation for 'reverseCharge'.

Define this parameter in the request body.
preview 
Documentation for 'preview'.

Define this parameter in the request URI.

Request body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "chargeId": 1,
  "reverseChargeOption": "sample string 2",
  "reverseChargeAmount": 1.0,
  "reference": "sample string 3"
}

application/xml, text/xml

Sample:
Click to beautify! 
<ReverseCharge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post">
  <ChargeId>1</ChargeId>
  <Reference>sample string 3</Reference>
  <ReverseChargeAmount>1</ReverseChargeAmount>
  <ReverseChargeOption>sample string 2</ReverseChargeOption>
</ReverseCharge>

application/x-www-form-urlencoded

Sample:
Click to beautify!

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "reference": "sample string 1",
  "amount": 2.0,
  "originalChargeId": 3,
  "reverseChargePreview": {
    "chargeAmount": 1.0,
    "discountAmount": 1.0,
    "taxAmount": 1.0,
    "netChargeAmount": 2.0,
    "netInvoiceAmount": 3.0,
    "outstandingBalance": 4.0,
    "reversalAmountWarningFlag": true,
    "milestonesRemaining": 6
  },
  "quickBooksId": 1,
  "quickBooksAttemptNumber": 4,
  "id": 5,
  "uri": "sample string 6"
}

application/xml, text/xml

Sample:
Click to beautify! 
<ReverseCharge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <Id>5</Id>
  <Uri>sample string 6</Uri>
  <Amount>2</Amount>
  <OriginalChargeId>3</OriginalChargeId>
  <QuickBooksAttemptNumber>4</QuickBooksAttemptNumber>
  <QuickBooksId>1</QuickBooksId>
  <Reference>sample string 1</Reference>
  <ReverseChargePreview>
    <ChargeAmount>1</ChargeAmount>
    <DiscountAmount>1</DiscountAmount>
    <MilestonesRemaining>6</MilestonesRemaining>
    <NetChargeAmount>2</NetChargeAmount>
    <NetInvoiceAmount>3</NetInvoiceAmount>
    <OutstandingBalance>4</OutstandingBalance>
    <ReversalAmountWarningFlag>true</ReversalAmountWarningFlag>
    <TaxAmount>1</TaxAmount>
  </ReverseChargePreview>
</ReverseCharge>