Delete a purchase credit note

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchaseCreditNotes.deletePurchaseCreditNote('pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchaseCreditNotes->deletePurchaseCreditNote(
    'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print_r($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.purchaseCreditNotes().deletePurchaseCreditNote(
        "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchaseCreditNotes.DeletePurchaseCreditNoteAsync("pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchaseCreditNotes.deletePurchaseCreditNote(
  'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print(response.map);

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.PurchaseCreditNotes().DeletePurchaseCreditNote(context.Background(), "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", 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>"
    }
  ]
}

DELETE

purchase_credit_notes

{purchase_credit_note_id}

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchaseCreditNotes.deletePurchaseCreditNote('pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchaseCreditNotes->deletePurchaseCreditNote(
    'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print_r($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.purchaseCreditNotes().deletePurchaseCreditNote(
        "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchaseCreditNotes.DeletePurchaseCreditNoteAsync("pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchaseCreditNotes.deletePurchaseCreditNote(
  'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print(response.map);

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.PurchaseCreditNotes().DeletePurchaseCreditNote(context.Background(), "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", 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>"
    }
  ]
}

Deletes the purchase credit note, addressed by its pcn_ id only. The call returns 204 with no body. It needs the permission to delete purchase credit notes.

This call needs the permission to delete purchase credit notes. Without it the call returns 403.

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

purchase_credit_note_id

string

required

The purchase credit note's pcn_ id. A code returns 400.

Response

The purchase credit note is deleted.

Guides

API reference

Authorizations

Path Parameters

Response