Create retention (draft)
curl --request POST \
--url https://api.piriod.com/retentions/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"supplier": "<string>",
"document": 123,
"number": 123,
"date": "2023-12-25",
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"description": "<string>",
"exempt": false,
"tax": 123,
"tax_percent": 123,
"discount": 123
}
],
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"discount": 123
}
'import requests
url = "https://api.piriod.com/retentions/"
payload = {
"supplier": "<string>",
"document": 123,
"number": 123,
"date": "2023-12-25",
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"description": "<string>",
"exempt": False,
"tax": 123,
"tax_percent": 123,
"discount": 123
}
],
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"discount": 123
}
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({
supplier: '<string>',
document: 123,
number: 123,
date: '2023-12-25',
lines: [
{
name: '<string>',
amount: 123,
quantity: 123,
description: '<string>',
exempt: false,
tax: 123,
tax_percent: 123,
discount: 123
}
],
amount: 123,
exempt: 123,
tax: 123,
tax_percent: 123,
subtotal: 123,
total: 123,
discount: 123
})
};
fetch('https://api.piriod.com/retentions/', 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/retentions/",
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([
'supplier' => '<string>',
'document' => 123,
'number' => 123,
'date' => '2023-12-25',
'lines' => [
[
'name' => '<string>',
'amount' => 123,
'quantity' => 123,
'description' => '<string>',
'exempt' => false,
'tax' => 123,
'tax_percent' => 123,
'discount' => 123
]
],
'amount' => 123,
'exempt' => 123,
'tax' => 123,
'tax_percent' => 123,
'subtotal' => 123,
'total' => 123,
'discount' => 123
]),
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/retentions/"
payload := strings.NewReader("{\n \"supplier\": \"<string>\",\n \"document\": 123,\n \"number\": 123,\n \"date\": \"2023-12-25\",\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"description\": \"<string>\",\n \"exempt\": false,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123\n }\n ],\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"discount\": 123\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/retentions/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"supplier\": \"<string>\",\n \"document\": 123,\n \"number\": 123,\n \"date\": \"2023-12-25\",\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"description\": \"<string>\",\n \"exempt\": false,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123\n }\n ],\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"discount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/retentions/")
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 \"supplier\": \"<string>\",\n \"document\": 123,\n \"number\": 123,\n \"date\": \"2023-12-25\",\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"description\": \"<string>\",\n \"exempt\": false,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123\n }\n ],\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"discount\": 123\n}"
response = http.request(request)
puts response.read_body{
"supplier": "<string>",
"document": 123,
"number": 123,
"date": "2023-12-25",
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"id": 123,
"description": "<string>",
"exempt": false,
"tax": 123,
"tax_percent": 123,
"total": 123,
"discount": 123
}
],
"id": 123,
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"discount": 123,
"biller_status": "<string>",
"tax_agency": {},
"local_file": "<string>",
"imported": true,
"test_mode": true,
"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."
]
}Retentions
Create retention (draft)
POST
/
retentions
/
Create retention (draft)
curl --request POST \
--url https://api.piriod.com/retentions/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"supplier": "<string>",
"document": 123,
"number": 123,
"date": "2023-12-25",
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"description": "<string>",
"exempt": false,
"tax": 123,
"tax_percent": 123,
"discount": 123
}
],
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"discount": 123
}
'import requests
url = "https://api.piriod.com/retentions/"
payload = {
"supplier": "<string>",
"document": 123,
"number": 123,
"date": "2023-12-25",
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"description": "<string>",
"exempt": False,
"tax": 123,
"tax_percent": 123,
"discount": 123
}
],
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"discount": 123
}
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({
supplier: '<string>',
document: 123,
number: 123,
date: '2023-12-25',
lines: [
{
name: '<string>',
amount: 123,
quantity: 123,
description: '<string>',
exempt: false,
tax: 123,
tax_percent: 123,
discount: 123
}
],
amount: 123,
exempt: 123,
tax: 123,
tax_percent: 123,
subtotal: 123,
total: 123,
discount: 123
})
};
fetch('https://api.piriod.com/retentions/', 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/retentions/",
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([
'supplier' => '<string>',
'document' => 123,
'number' => 123,
'date' => '2023-12-25',
'lines' => [
[
'name' => '<string>',
'amount' => 123,
'quantity' => 123,
'description' => '<string>',
'exempt' => false,
'tax' => 123,
'tax_percent' => 123,
'discount' => 123
]
],
'amount' => 123,
'exempt' => 123,
'tax' => 123,
'tax_percent' => 123,
'subtotal' => 123,
'total' => 123,
'discount' => 123
]),
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/retentions/"
payload := strings.NewReader("{\n \"supplier\": \"<string>\",\n \"document\": 123,\n \"number\": 123,\n \"date\": \"2023-12-25\",\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"description\": \"<string>\",\n \"exempt\": false,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123\n }\n ],\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"discount\": 123\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/retentions/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"supplier\": \"<string>\",\n \"document\": 123,\n \"number\": 123,\n \"date\": \"2023-12-25\",\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"description\": \"<string>\",\n \"exempt\": false,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123\n }\n ],\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"discount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/retentions/")
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 \"supplier\": \"<string>\",\n \"document\": 123,\n \"number\": 123,\n \"date\": \"2023-12-25\",\n \"lines\": [\n {\n \"name\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"description\": \"<string>\",\n \"exempt\": false,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"discount\": 123\n }\n ],\n \"amount\": 123,\n \"exempt\": 123,\n \"tax\": 123,\n \"tax_percent\": 123,\n \"subtotal\": 123,\n \"total\": 123,\n \"discount\": 123\n}"
response = http.request(request)
puts response.read_body{
"supplier": "<string>",
"document": 123,
"number": 123,
"date": "2023-12-25",
"lines": [
{
"name": "<string>",
"amount": 123,
"quantity": 123,
"id": 123,
"description": "<string>",
"exempt": false,
"tax": 123,
"tax_percent": 123,
"total": 123,
"discount": 123
}
],
"id": 123,
"amount": 123,
"exempt": 123,
"tax": 123,
"tax_percent": 123,
"subtotal": 123,
"total": 123,
"discount": 123,
"biller_status": "<string>",
"tax_agency": {},
"local_file": "<string>",
"imported": true,
"test_mode": true,
"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
Withholding-tax document issued against a supplier.
Supplier ID.
Retention document type.
Show child attributes
Show child attributes
Available options:
%, $ Response
Retention created.
Withholding-tax document issued against a supplier.
Supplier ID.
Retention document type.
Show child attributes
Show child attributes
Available options:
%, $ Available options:
draft, finalized, cancelled ⌘I
