Partial update invoice (draft only)

curl --request PATCH \
  --url https://api.piriod.com/invoices/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-simple-workspace: <x-simple-workspace>' \
  --data '
{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "description": "<string>",
      "exempt": false,
      "tax": 123,
      "tax_percent": 123,
      "discount": 123,
      "code": "<string>",
      "code_scheme": "<string>",
      "plan": 123,
      "retention": 123,
      "retention_percent": 0,
      "retention_scheme": "subtotal",
      "unit_label": "<string>"
    }
  ],
  "due_date": "2023-12-25",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "subtotal": 123,
  "total": 123,
  "retention": 123,
  "discount": 123,
  "custom_change": 2,
  "subscription": 123,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.piriod.com/invoices/{id}/"

payload = {
    "customer": "<string>",
    "document": 123,
    "date": "2023-12-25",
    "lines": [
        {
            "name": "<string>",
            "amount": 123,
            "quantity": 123,
            "description": "<string>",
            "exempt": False,
            "tax": 123,
            "tax_percent": 123,
            "discount": 123,
            "code": "<string>",
            "code_scheme": "<string>",
            "plan": 123,
            "retention": 123,
            "retention_percent": 0,
            "retention_scheme": "subtotal",
            "unit_label": "<string>"
        }
    ],
    "due_date": "2023-12-25",
    "period_start": "2023-12-25",
    "period_end": "2023-12-25",
    "note": "<string>",
    "amount": 123,
    "exempt": 123,
    "tax": 123,
    "tax_percent": 123,
    "subtotal": 123,
    "total": 123,
    "retention": 123,
    "discount": 123,
    "custom_change": 2,
    "subscription": 123,
    "references": [
        {
            "date": "2023-12-25",
            "document": "<string>",
            "serial": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "x-simple-workspace": "<x-simple-workspace>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-simple-workspace': '<x-simple-workspace>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: '<string>',
    document: 123,
    date: '2023-12-25',
    lines: [
      {
        name: '<string>',
        amount: 123,
        quantity: 123,
        description: '<string>',
        exempt: false,
        tax: 123,
        tax_percent: 123,
        discount: 123,
        code: '<string>',
        code_scheme: '<string>',
        plan: 123,
        retention: 123,
        retention_percent: 0,
        retention_scheme: 'subtotal',
        unit_label: '<string>'
      }
    ],
    due_date: '2023-12-25',
    period_start: '2023-12-25',
    period_end: '2023-12-25',
    note: '<string>',
    amount: 123,
    exempt: 123,
    tax: 123,
    tax_percent: 123,
    subtotal: 123,
    total: 123,
    retention: 123,
    discount: 123,
    custom_change: 2,
    subscription: 123,
    references: [
      {
        date: '2023-12-25',
        document: '<string>',
        serial: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.piriod.com/invoices/{id}/', 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/invoices/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => '<string>',
    'document' => 123,
    'date' => '2023-12-25',
    'lines' => [
        [
                'name' => '<string>',
                'amount' => 123,
                'quantity' => 123,
                'description' => '<string>',
                'exempt' => false,
                'tax' => 123,
                'tax_percent' => 123,
                'discount' => 123,
                'code' => '<string>',
                'code_scheme' => '<string>',
                'plan' => 123,
                'retention' => 123,
                'retention_percent' => 0,
                'retention_scheme' => 'subtotal',
                'unit_label' => '<string>'
        ]
    ],
    'due_date' => '2023-12-25',
    'period_start' => '2023-12-25',
    'period_end' => '2023-12-25',
    'note' => '<string>',
    'amount' => 123,
    'exempt' => 123,
    'tax' => 123,
    'tax_percent' => 123,
    'subtotal' => 123,
    'total' => 123,
    'retention' => 123,
    'discount' => 123,
    'custom_change' => 2,
    'subscription' => 123,
    'references' => [
        [
                'date' => '2023-12-25',
                'document' => '<string>',
                'serial' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  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/invoices/{id}/"

	payload := strings.NewReader("{\n  \"customer\": \"<string>\",\n  \"document\": 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      \"code\": \"<string>\",\n      \"code_scheme\": \"<string>\",\n      \"plan\": 123,\n      \"retention\": 123,\n      \"retention_percent\": 0,\n      \"retention_scheme\": \"subtotal\",\n      \"unit_label\": \"<string>\"\n    }\n  ],\n  \"due_date\": \"2023-12-25\",\n  \"period_start\": \"2023-12-25\",\n  \"period_end\": \"2023-12-25\",\n  \"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  \"custom_change\": 2,\n  \"subscription\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.piriod.com/invoices/{id}/")
  .header("x-simple-workspace", "<x-simple-workspace>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": \"<string>\",\n  \"document\": 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      \"code\": \"<string>\",\n      \"code_scheme\": \"<string>\",\n      \"plan\": 123,\n      \"retention\": 123,\n      \"retention_percent\": 0,\n      \"retention_scheme\": \"subtotal\",\n      \"unit_label\": \"<string>\"\n    }\n  ],\n  \"due_date\": \"2023-12-25\",\n  \"period_start\": \"2023-12-25\",\n  \"period_end\": \"2023-12-25\",\n  \"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  \"custom_change\": 2,\n  \"subscription\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.piriod.com/invoices/{id}/")

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

request = Net::HTTP::Patch.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": \"<string>\",\n  \"document\": 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      \"code\": \"<string>\",\n      \"code_scheme\": \"<string>\",\n      \"plan\": 123,\n      \"retention\": 123,\n      \"retention_percent\": 0,\n      \"retention_scheme\": \"subtotal\",\n      \"unit_label\": \"<string>\"\n    }\n  ],\n  \"due_date\": \"2023-12-25\",\n  \"period_start\": \"2023-12-25\",\n  \"period_end\": \"2023-12-25\",\n  \"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  \"custom_change\": 2,\n  \"subscription\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "id": "<string>",
      "description": "<string>",
      "total": 123,
      "exempt": false,
      "tax": 123,
      "tax_percent": 123,
      "discount": 123,
      "code": "<string>",
      "code_scheme": "<string>",
      "plan": 123,
      "retention": 123,
      "retention_percent": 0,
      "retention_scheme": "subtotal",
      "unit_label": "<string>"
    }
  ],
  "id": "inv_01H8XYZ123ABC",
  "number": 123,
  "currency": "<string>",
  "due_date": "2023-12-25",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "subtotal": 123,
  "total": 123,
  "total_adjusted": 123,
  "retention": 123,
  "discount": 123,
  "custom_change": 2,
  "tax_agency": {},
  "local_file": "<string>",
  "subscription": 123,
  "imported": true,
  "uncollectible": "2023-11-07T05:31:56Z",
  "test_mode": true,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ],
  "payments": [
    {}
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

PATCH

invoices

{id}

Partial update invoice (draft only)

curl --request PATCH \
  --url https://api.piriod.com/invoices/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-simple-workspace: <x-simple-workspace>' \
  --data '
{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "description": "<string>",
      "exempt": false,
      "tax": 123,
      "tax_percent": 123,
      "discount": 123,
      "code": "<string>",
      "code_scheme": "<string>",
      "plan": 123,
      "retention": 123,
      "retention_percent": 0,
      "retention_scheme": "subtotal",
      "unit_label": "<string>"
    }
  ],
  "due_date": "2023-12-25",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "subtotal": 123,
  "total": 123,
  "retention": 123,
  "discount": 123,
  "custom_change": 2,
  "subscription": 123,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.piriod.com/invoices/{id}/"

payload = {
    "customer": "<string>",
    "document": 123,
    "date": "2023-12-25",
    "lines": [
        {
            "name": "<string>",
            "amount": 123,
            "quantity": 123,
            "description": "<string>",
            "exempt": False,
            "tax": 123,
            "tax_percent": 123,
            "discount": 123,
            "code": "<string>",
            "code_scheme": "<string>",
            "plan": 123,
            "retention": 123,
            "retention_percent": 0,
            "retention_scheme": "subtotal",
            "unit_label": "<string>"
        }
    ],
    "due_date": "2023-12-25",
    "period_start": "2023-12-25",
    "period_end": "2023-12-25",
    "note": "<string>",
    "amount": 123,
    "exempt": 123,
    "tax": 123,
    "tax_percent": 123,
    "subtotal": 123,
    "total": 123,
    "retention": 123,
    "discount": 123,
    "custom_change": 2,
    "subscription": 123,
    "references": [
        {
            "date": "2023-12-25",
            "document": "<string>",
            "serial": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "x-simple-workspace": "<x-simple-workspace>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-simple-workspace': '<x-simple-workspace>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: '<string>',
    document: 123,
    date: '2023-12-25',
    lines: [
      {
        name: '<string>',
        amount: 123,
        quantity: 123,
        description: '<string>',
        exempt: false,
        tax: 123,
        tax_percent: 123,
        discount: 123,
        code: '<string>',
        code_scheme: '<string>',
        plan: 123,
        retention: 123,
        retention_percent: 0,
        retention_scheme: 'subtotal',
        unit_label: '<string>'
      }
    ],
    due_date: '2023-12-25',
    period_start: '2023-12-25',
    period_end: '2023-12-25',
    note: '<string>',
    amount: 123,
    exempt: 123,
    tax: 123,
    tax_percent: 123,
    subtotal: 123,
    total: 123,
    retention: 123,
    discount: 123,
    custom_change: 2,
    subscription: 123,
    references: [
      {
        date: '2023-12-25',
        document: '<string>',
        serial: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.piriod.com/invoices/{id}/', 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/invoices/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => '<string>',
    'document' => 123,
    'date' => '2023-12-25',
    'lines' => [
        [
                'name' => '<string>',
                'amount' => 123,
                'quantity' => 123,
                'description' => '<string>',
                'exempt' => false,
                'tax' => 123,
                'tax_percent' => 123,
                'discount' => 123,
                'code' => '<string>',
                'code_scheme' => '<string>',
                'plan' => 123,
                'retention' => 123,
                'retention_percent' => 0,
                'retention_scheme' => 'subtotal',
                'unit_label' => '<string>'
        ]
    ],
    'due_date' => '2023-12-25',
    'period_start' => '2023-12-25',
    'period_end' => '2023-12-25',
    'note' => '<string>',
    'amount' => 123,
    'exempt' => 123,
    'tax' => 123,
    'tax_percent' => 123,
    'subtotal' => 123,
    'total' => 123,
    'retention' => 123,
    'discount' => 123,
    'custom_change' => 2,
    'subscription' => 123,
    'references' => [
        [
                'date' => '2023-12-25',
                'document' => '<string>',
                'serial' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  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/invoices/{id}/"

	payload := strings.NewReader("{\n  \"customer\": \"<string>\",\n  \"document\": 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      \"code\": \"<string>\",\n      \"code_scheme\": \"<string>\",\n      \"plan\": 123,\n      \"retention\": 123,\n      \"retention_percent\": 0,\n      \"retention_scheme\": \"subtotal\",\n      \"unit_label\": \"<string>\"\n    }\n  ],\n  \"due_date\": \"2023-12-25\",\n  \"period_start\": \"2023-12-25\",\n  \"period_end\": \"2023-12-25\",\n  \"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  \"custom_change\": 2,\n  \"subscription\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.piriod.com/invoices/{id}/")
  .header("x-simple-workspace", "<x-simple-workspace>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": \"<string>\",\n  \"document\": 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      \"code\": \"<string>\",\n      \"code_scheme\": \"<string>\",\n      \"plan\": 123,\n      \"retention\": 123,\n      \"retention_percent\": 0,\n      \"retention_scheme\": \"subtotal\",\n      \"unit_label\": \"<string>\"\n    }\n  ],\n  \"due_date\": \"2023-12-25\",\n  \"period_start\": \"2023-12-25\",\n  \"period_end\": \"2023-12-25\",\n  \"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  \"custom_change\": 2,\n  \"subscription\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.piriod.com/invoices/{id}/")

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

request = Net::HTTP::Patch.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": \"<string>\",\n  \"document\": 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      \"code\": \"<string>\",\n      \"code_scheme\": \"<string>\",\n      \"plan\": 123,\n      \"retention\": 123,\n      \"retention_percent\": 0,\n      \"retention_scheme\": \"subtotal\",\n      \"unit_label\": \"<string>\"\n    }\n  ],\n  \"due_date\": \"2023-12-25\",\n  \"period_start\": \"2023-12-25\",\n  \"period_end\": \"2023-12-25\",\n  \"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  \"custom_change\": 2,\n  \"subscription\": 123,\n  \"references\": [\n    {\n      \"date\": \"2023-12-25\",\n      \"document\": \"<string>\",\n      \"serial\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "customer": "<string>",
  "document": 123,
  "date": "2023-12-25",
  "lines": [
    {
      "name": "<string>",
      "amount": 123,
      "quantity": 123,
      "id": "<string>",
      "description": "<string>",
      "total": 123,
      "exempt": false,
      "tax": 123,
      "tax_percent": 123,
      "discount": 123,
      "code": "<string>",
      "code_scheme": "<string>",
      "plan": 123,
      "retention": 123,
      "retention_percent": 0,
      "retention_scheme": "subtotal",
      "unit_label": "<string>"
    }
  ],
  "id": "inv_01H8XYZ123ABC",
  "number": 123,
  "currency": "<string>",
  "due_date": "2023-12-25",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "note": "<string>",
  "amount": 123,
  "exempt": 123,
  "tax": 123,
  "tax_percent": 123,
  "subtotal": 123,
  "total": 123,
  "total_adjusted": 123,
  "retention": 123,
  "discount": 123,
  "custom_change": 2,
  "tax_agency": {},
  "local_file": "<string>",
  "subscription": 123,
  "imported": true,
  "uncollectible": "2023-11-07T05:31:56Z",
  "test_mode": true,
  "references": [
    {
      "date": "2023-12-25",
      "document": "<string>",
      "serial": "<string>",
      "description": "<string>"
    }
  ],
  "payments": [
    {}
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace

string

required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode

boolean

default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

string

required

Resource identifier.

Body

application/json

customer

string

required

Customer ID.

document

integer

required

Document type ID (fiscal document; depends on country).

date

string<date>

required

collection_method

enum<string>

required

Available options:

deferred,

deferred_dues,

automatically

lines

object[]

required

Show child attributes

due_date

string<date> | null

period_start

string<date> | null

period_end

string<date> | null

note

string | null

Maximum string length: 256

amount

number | null

Subtotal of taxable lines (computed).

exempt

number | null

Subtotal of tax-exempt lines (computed).

tax

number | null

Total tax (computed).

tax_percent

number | null

subtotal

number | null

total

number | null

Final amount (computed).

retention

number | null

discount

number | null

discount_scheme

enum<string> | null

Available options:

%,

$

custom_change

number | null

Custom currency conversion factor.

Required range: x >= 1

subscription

integer | null

Linked subscription ID when generated by a subscription cycle.

references

object[]

Show child attributes

Response

200 - application/json

Updated invoice.

customer

string

required

Customer ID.

document

integer

required

Document type ID (fiscal document; depends on country).

date

string<date>

required

collection_method

enum<string>

required

Available options:

deferred,

deferred_dues,

automatically

lines

object[]

required

Show child attributes

string

read-only

Example:

"inv_01H8XYZ123ABC"

number

integer

read-only

Sequence number assigned at finalize time.

currency

string

read-only

Currency code from the customer's currency.

due_date

string<date> | null

period_start

string<date> | null

period_end

string<date> | null

note

string | null

Maximum string length: 256

amount

number | null

Subtotal of taxable lines (computed).

exempt

number | null

Subtotal of tax-exempt lines (computed).

tax

number | null

Total tax (computed).

tax_percent

number | null

subtotal

number | null

total

number | null

Final amount (computed).

total_adjusted

number | null

read-only

retention

number | null

discount

number | null

discount_scheme

enum<string> | null

Available options:

%,

$

custom_change

number | null

Custom currency conversion factor.

Required range: x >= 1

status

enum<string>

read-only

Available options:

draft,

finalized,

paid,

cancelled,

uncollectible,

pending

biller_status

enum<string>

read-only

Available options:

pending,

queued,

succeeded,

failed,

processing

tax_agency

object

read-only

Tax-agency response payload (country-specific).

local_file

string<uri> | null

read-only

Signed URL to the fiscal PDF/XML when applicable.

subscription

integer | null

Linked subscription ID when generated by a subscription cycle.

imported

boolean

read-only

uncollectible

string<date-time> | null

read-only

test_mode

boolean

read-only

references

object[]

Show child attributes

payments

object[]

read-only

created

string<date-time>

read-only

updated

string<date-time>

read-only

Retrieve invoice Finalize invoice

Piriod API

Billing

Payments

Procurement

Collections

Partial update invoice (draft only)

Authorizations

Headers

Path Parameters

Body

Response