Delete a credit note

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/credit_notes/cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.creditNotes.deleteCreditNote('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d');
console.log(response.data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.creditNotes().deleteCreditNote("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CreditNotes.DeleteCreditNoteAsync("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CreditNotes().DeleteCreditNote(context.Background(), "cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

DELETE

credit_notes

{credit_note_id}

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/credit_notes/cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.creditNotes.deleteCreditNote('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d');
console.log(response.data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.creditNotes().deleteCreditNote("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CreditNotes.DeleteCreditNoteAsync("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CreditNotes().DeleteCreditNote(context.Background(), "cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Deletes the credit note by its cn_ id or its code. A credit note with an active refund is refused with 400 and the code in_use. Your API client needs the DELETE_CREDIT_NOTE permission.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

credit_note_id

string

required

The credit note's id, which starts with cn_, or its code.

Response

The credit note is deleted. The response has no body.

Guides

API reference

Authorizations

Path Parameters

Response