Create credit note (draft)
curl --request POST \
--url https://api.piriod.com/creditnotes/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"invoice": "<string>",
"date": "2023-12-25",
"document": 123,
"note": "<string>",
"internal_note": "<string>",
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"retention": 123,
"discount": 123,
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"exempt": true,
"description": "<string>",
"tax": 123,
"tax_percent": 123,
"discount": 123,
"code": "<string>",
"code_scheme": "<string>",
"retention": 123,
"retention_percent": 0,
"retention_scheme": "subtotal"
}
]
}
'import requests
url = "https://api.piriod.com/creditnotes/"
payload = {
"invoice": "<string>",
"date": "2023-12-25",
"document": 123,
"note": "<string>",
"internal_note": "<string>",
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"retention": 123,
"discount": 123,
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"exempt": True,
"description": "<string>",
"tax": 123,
"tax_percent": 123,
"discount": 123,
"code": "<string>",
"code_scheme": "<string>",
"retention": 123,
"retention_percent": 0,
"retention_scheme": "subtotal"
}
]
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
invoice: '<string>',
date: '2023-12-25',
document: 123,
note: '<string>',
internal_note: '<string>',
amount: 123,
exempt: 123,
tax: 123,
tax_percent: 123,
subtotal: 123,
total: 123,
retention: 123,
discount: 123,
lines: [
{
name: '<string>',
amount: 123,
quantity: 123,
exempt: true,
description: '<string>',
tax: 123,
tax_percent: 123,
discount: 123,
code: '<string>',
code_scheme: '<string>',
retention: 123,
retention_percent: 0,
retention_scheme: 'subtotal'
}
]
})
};
fetch('https://api.piriod.com/creditnotes/', 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.piriod.com/creditnotes/",
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([
'invoice' => '<string>',
'date' => '2023-12-25',
'document' => 123,
'note' => '<string>',
'internal_note' => '<string>',
'amount' => 123,
'exempt' => 123,
'tax' => 123,
'tax_percent' => 123,
'subtotal' => 123,
'total' => 123,
'retention' => 123,
'discount' => 123,
'lines' => [
[
'name' => '<string>',
'amount' => 123,
'quantity' => 123,
'exempt' => true,
'description' => '<string>',
'tax' => 123,
'tax_percent' => 123,
'discount' => 123,
'code' => '<string>',
'code_scheme' => '<string>',
'retention' => 123,
'retention_percent' => 0,
'retention_scheme' => 'subtotal'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$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.piriod.com/creditnotes/"
payload := strings.NewReader("{\n \"invoice\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"document\": 123,\n \"note\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"retention\": 123,\n \"discount\": 123,\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"exempt\": true,\n \"description\": \"<string>\",\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123,\n \"code\": \"<string>\",\n \"code_scheme\": \"<string>\",\n \"retention\": 123,\n \"retention_percent\": 0,\n \"retention_scheme\": \"subtotal\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<api-key>")
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.piriod.com/creditnotes/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoice\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"document\": 123,\n \"note\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"retention\": 123,\n \"discount\": 123,\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"exempt\": true,\n \"description\": \"<string>\",\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123,\n \"code\": \"<string>\",\n \"code_scheme\": \"<string>\",\n \"retention\": 123,\n \"retention_percent\": 0,\n \"retention_scheme\": \"subtotal\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/creditnotes/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"document\": 123,\n \"note\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"retention\": 123,\n \"discount\": 123,\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"exempt\": true,\n \"description\": \"<string>\",\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123,\n \"code\": \"<string>\",\n \"code_scheme\": \"<string>\",\n \"retention\": 123,\n \"retention_percent\": 0,\n \"retention_scheme\": \"subtotal\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"invoice": "<string>",
"date": "2023-12-25",
"id": 123,
"document": 123,
"number": 123,
"note": "<string>",
"internal_note": "<string>",
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"retention": 123,
"discount": 123,
"biller_status": "<string>",
"tax_agency": {},
"local_file": "<string>",
"imported": true,
"test_mode": true,
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"exempt": true,
"id": 123,
"description": "<string>",
"tax": 123,
"tax_percent": 123,
"total": 123,
"discount": 123,
"code": "<string>",
"code_scheme": "<string>",
"retention": 123,
"retention_percent": 0,
"retention_scheme": "subtotal"
}
],
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Credit notes
Create credit note (draft)
Creates a credit note. If the related invoice or chosen document allows partial credit, the line totals are computed from the request; otherwise the lines mirror the invoice.
POST
/
creditnotes
/
Create credit note (draft)
curl --request POST \
--url https://api.piriod.com/creditnotes/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"invoice": "<string>",
"date": "2023-12-25",
"document": 123,
"note": "<string>",
"internal_note": "<string>",
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"retention": 123,
"discount": 123,
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"exempt": true,
"description": "<string>",
"tax": 123,
"tax_percent": 123,
"discount": 123,
"code": "<string>",
"code_scheme": "<string>",
"retention": 123,
"retention_percent": 0,
"retention_scheme": "subtotal"
}
]
}
'import requests
url = "https://api.piriod.com/creditnotes/"
payload = {
"invoice": "<string>",
"date": "2023-12-25",
"document": 123,
"note": "<string>",
"internal_note": "<string>",
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"retention": 123,
"discount": 123,
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"exempt": True,
"description": "<string>",
"tax": 123,
"tax_percent": 123,
"discount": 123,
"code": "<string>",
"code_scheme": "<string>",
"retention": 123,
"retention_percent": 0,
"retention_scheme": "subtotal"
}
]
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
invoice: '<string>',
date: '2023-12-25',
document: 123,
note: '<string>',
internal_note: '<string>',
amount: 123,
exempt: 123,
tax: 123,
tax_percent: 123,
subtotal: 123,
total: 123,
retention: 123,
discount: 123,
lines: [
{
name: '<string>',
amount: 123,
quantity: 123,
exempt: true,
description: '<string>',
tax: 123,
tax_percent: 123,
discount: 123,
code: '<string>',
code_scheme: '<string>',
retention: 123,
retention_percent: 0,
retention_scheme: 'subtotal'
}
]
})
};
fetch('https://api.piriod.com/creditnotes/', 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.piriod.com/creditnotes/",
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([
'invoice' => '<string>',
'date' => '2023-12-25',
'document' => 123,
'note' => '<string>',
'internal_note' => '<string>',
'amount' => 123,
'exempt' => 123,
'tax' => 123,
'tax_percent' => 123,
'subtotal' => 123,
'total' => 123,
'retention' => 123,
'discount' => 123,
'lines' => [
[
'name' => '<string>',
'amount' => 123,
'quantity' => 123,
'exempt' => true,
'description' => '<string>',
'tax' => 123,
'tax_percent' => 123,
'discount' => 123,
'code' => '<string>',
'code_scheme' => '<string>',
'retention' => 123,
'retention_percent' => 0,
'retention_scheme' => 'subtotal'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$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.piriod.com/creditnotes/"
payload := strings.NewReader("{\n \"invoice\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"document\": 123,\n \"note\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"retention\": 123,\n \"discount\": 123,\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"exempt\": true,\n \"description\": \"<string>\",\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123,\n \"code\": \"<string>\",\n \"code_scheme\": \"<string>\",\n \"retention\": 123,\n \"retention_percent\": 0,\n \"retention_scheme\": \"subtotal\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<api-key>")
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.piriod.com/creditnotes/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invoice\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"document\": 123,\n \"note\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"retention\": 123,\n \"discount\": 123,\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"exempt\": true,\n \"description\": \"<string>\",\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123,\n \"code\": \"<string>\",\n \"code_scheme\": \"<string>\",\n \"retention\": 123,\n \"retention_percent\": 0,\n \"retention_scheme\": \"subtotal\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/creditnotes/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoice\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"document\": 123,\n \"note\": \"<string>\",\n \"internal_note\": \"<string>\",\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"retention\": 123,\n \"discount\": 123,\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"exempt\": true,\n \"description\": \"<string>\",\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123,\n \"code\": \"<string>\",\n \"code_scheme\": \"<string>\",\n \"retention\": 123,\n \"retention_percent\": 0,\n \"retention_scheme\": \"subtotal\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"invoice": "<string>",
"date": "2023-12-25",
"id": 123,
"document": 123,
"number": 123,
"note": "<string>",
"internal_note": "<string>",
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"retention": 123,
"discount": 123,
"biller_status": "<string>",
"tax_agency": {},
"local_file": "<string>",
"imported": true,
"test_mode": true,
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"exempt": true,
"id": 123,
"description": "<string>",
"tax": 123,
"tax_percent": 123,
"total": 123,
"discount": 123,
"code": "<string>",
"code_scheme": "<string>",
"retention": 123,
"retention_percent": 0,
"retention_scheme": "subtotal"
}
],
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Authorizations
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Headers
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Body
application/json
Invoice ID this credit note adjusts.
Credit-note document type. Optional; the biller may assign one at finalize.
Maximum string length:
64Maximum string length:
1024Available options:
%, $ Show child attributes
Show child attributes
Response
Credit note created.
Invoice ID this credit note adjusts.
Credit-note document type. Optional; the biller may assign one at finalize.
Maximum string length:
64Maximum string length:
1024Available options:
%, $ Available options:
draft, finalized, cancelled Show child attributes
Show child attributes
⌘I