Issue
curl --request POST \
--url https://api.peachdeskai.com/api/v1/admin/credit-memos/issue \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"org_id": 123,
"amount_cents": 123,
"reason_code": "<string>",
"idempotency_key": "<string>",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
'import requests
url = "https://api.peachdeskai.com/api/v1/admin/credit-memos/issue"
payload = {
"org_id": 123,
"amount_cents": 123,
"reason_code": "<string>",
"idempotency_key": "<string>",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
org_id: 123,
amount_cents: 123,
reason_code: '<string>',
idempotency_key: '<string>',
invoice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>'
})
};
fetch('https://api.peachdeskai.com/api/v1/admin/credit-memos/issue', 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.peachdeskai.com/api/v1/admin/credit-memos/issue",
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([
'org_id' => 123,
'amount_cents' => 123,
'reason_code' => '<string>',
'idempotency_key' => '<string>',
'invoice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.peachdeskai.com/api/v1/admin/credit-memos/issue"
payload := strings.NewReader("{\n \"org_id\": 123,\n \"amount_cents\": 123,\n \"reason_code\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.peachdeskai.com/api/v1/admin/credit-memos/issue")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"org_id\": 123,\n \"amount_cents\": 123,\n \"reason_code\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peachdeskai.com/api/v1/admin/credit-memos/issue")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"org_id\": 123,\n \"amount_cents\": 123,\n \"reason_code\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": 123,
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_cents": 123,
"reason_code": "<string>",
"notes": "<string>",
"idempotency_key": "<string>",
"issued_by_user_id": 123,
"approved_by_user_id": 123,
"ledger_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"stripe_credit_note_id": "<string>",
"created_at": "<string>",
"applied_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}main
Issue
Issue a credit memo. Idempotent via idempotency_key.
POST
/
api
/
v1
/
admin
/
credit-memos
/
issue
Issue
curl --request POST \
--url https://api.peachdeskai.com/api/v1/admin/credit-memos/issue \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"org_id": 123,
"amount_cents": 123,
"reason_code": "<string>",
"idempotency_key": "<string>",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
'import requests
url = "https://api.peachdeskai.com/api/v1/admin/credit-memos/issue"
payload = {
"org_id": 123,
"amount_cents": 123,
"reason_code": "<string>",
"idempotency_key": "<string>",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
org_id: 123,
amount_cents: 123,
reason_code: '<string>',
idempotency_key: '<string>',
invoice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>'
})
};
fetch('https://api.peachdeskai.com/api/v1/admin/credit-memos/issue', 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.peachdeskai.com/api/v1/admin/credit-memos/issue",
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([
'org_id' => 123,
'amount_cents' => 123,
'reason_code' => '<string>',
'idempotency_key' => '<string>',
'invoice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.peachdeskai.com/api/v1/admin/credit-memos/issue"
payload := strings.NewReader("{\n \"org_id\": 123,\n \"amount_cents\": 123,\n \"reason_code\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.peachdeskai.com/api/v1/admin/credit-memos/issue")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"org_id\": 123,\n \"amount_cents\": 123,\n \"reason_code\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peachdeskai.com/api/v1/admin/credit-memos/issue")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"org_id\": 123,\n \"amount_cents\": 123,\n \"reason_code\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"invoice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": 123,
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_cents": 123,
"reason_code": "<string>",
"notes": "<string>",
"idempotency_key": "<string>",
"issued_by_user_id": 123,
"approved_by_user_id": 123,
"ledger_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"stripe_credit_note_id": "<string>",
"created_at": "<string>",
"applied_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Interactive user session: the login JWT, sent as Authorization: Bearer <token>.
Body
application/json
Credit amount in cents (positive)
One of: billing_error, service_credit, goodwill, disputed_charge, duplicate_charge, other
Caller-provided idempotency key (e.g. UUID)
Minimum string length:
1Response
Successful Response

