Skip to main content
POST
/
api
/
credit-notes
/
validate-bulk-delete
Validates which credit notes can be deleted and returns the results.
curl --request POST \
  --url https://api.example.com/api/credit-notes/validate-bulk-delete \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "ids": [
    1,
    2,
    3
  ],
  "skipUndeletable": false
}
'
import requests

url = "https://api.example.com/api/credit-notes/validate-bulk-delete"

payload = {
"ids": [1, 2, 3],
"skipUndeletable": False
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ids: [1, 2, 3], skipUndeletable: false})
};

fetch('https://api.example.com/api/credit-notes/validate-bulk-delete', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/credit-notes/validate-bulk-delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
1,
2,
3
],
'skipUndeletable' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"organization-id: <organization-id>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/credit-notes/validate-bulk-delete"

payload := strings.NewReader("{\n \"ids\": [\n 1,\n 2,\n 3\n ],\n \"skipUndeletable\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/credit-notes/validate-bulk-delete")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n 1,\n 2,\n 3\n ],\n \"skipUndeletable\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/credit-notes/validate-bulk-delete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n 1,\n 2,\n 3\n ],\n \"skipUndeletable\": false\n}"

response = http.request(request)
puts response.read_body
{
  "deletableCount": 2,
  "nonDeletableCount": 1,
  "deletableIds": [
    1,
    2
  ],
  "nonDeletableIds": [
    3
  ]
}

Headers

Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
ids
number[]
required

Array of IDs to delete

Example:
[1, 2, 3]
skipUndeletable
boolean
default:false

When true, undeletable items will be skipped and only deletable ones will be removed.

Response

200 - application/json

Validation completed with counts and IDs of deletable and non-deletable credit notes.

deletableCount
number
required

Number of items that can be deleted

Example:

2

nonDeletableCount
number
required

Number of items that cannot be deleted

Example:

1

deletableIds
number[]
required

IDs of items that can be deleted

Example:
[1, 2]
nonDeletableIds
number[]
required

IDs of items that cannot be deleted

Example:
[3]