POST v1/ReverseCharges?preview={preview}

Request Information

URI Parameters

Name	Description	Type	Additional information
preview		boolean	Default value is False

Body Parameters

Common.Dto.Post.ReverseCharge

Name	Type	Additional information
chargeId	integer	None.
reverseChargeOption	string	None.
reverseChargeAmount	decimal number	Matching regular expression pattern: ^\d*.?\d{0,2}?$ Range: inclusive between 0.01 and 79228162514264337593543950335
reference	string	String length: inclusive between 0 and 500

Request Formats

application/json, text/json

Sample:

{
  "chargeId": 1,
  "reverseChargeOption": "sample string 2",
  "reverseChargeAmount": 1.0,
  "reference": "sample string 3"
}

Response Information

Resource Description

Common.Dto.Get.ReverseCharge

Name	Type	Additional information
reference	string	String length: inclusive between 0 and 500
amount	decimal number	Range: inclusive between 0.01 and 79228162514264337593543950335
originalChargeId	integer	None.
reverseChargePreview	Common.Dto.Get.ReverseChargePreview	None.
quickBooksId	integer	None.
quickBooksAttemptNumber	integer	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "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"
}