POST
/
credit-notes
/
{creditNoteId}
/
void
Void credit note
curl --request POST \
  --url https://rest.taxes.provider.com/api/v1/credit-notes/{creditNoteId}/void \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "documentDateTime": "2022-11-01T05:12:08.131Z"
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

The json of all the parameters specified in authentication configuration of tax app will be sent by Chargebee.

Headers

​
merchant_id
string

Merchant's domain name will be sent by Chargebee

​
trace_id
string

Unique id of the request will be sent by Chargebee

Path Parameters

​
creditNoteId
string
required

The unique identifier of the credit note at the Tax Service Adapter or Tax Service Provider.

Query Parameters

​
invoiceId
string

The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider.

Body

application/json

The request to void an invoice or credit note.

​
documentDateTime
string<date-time>

The date and time at which the credit note was created in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT. In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC.

Response

Credit note voided successfully.