Tenant credential
curl --request POST 'https://api.printools.io/v1/invoices/11111111-2222-3333-4444-555555555555/mark-paid' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"method":"example","reference":"example","paidAt":"2026-09-07T12:00:00.000Z"}'import requests
url = "https://api.printools.io/v1/invoices/{invoiceId}/mark-paid"
payload = {
"method": "example",
"reference": "example",
"paidAt": "2026-09-07T12:00:00.000Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({method: 'example', reference: 'example', paidAt: '2026-09-07T12:00:00.000Z'})
};
fetch('https://api.printools.io/v1/invoices/{invoiceId}/mark-paid', 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.printools.io/v1/invoices/{invoiceId}/mark-paid",
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([
'method' => 'example',
'reference' => 'example',
'paidAt' => '2026-09-07T12:00:00.000Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.printools.io/v1/invoices/{invoiceId}/mark-paid"
payload := strings.NewReader("{\n \"method\": \"example\",\n \"reference\": \"example\",\n \"paidAt\": \"2026-09-07T12:00:00.000Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.printools.io/v1/invoices/{invoiceId}/mark-paid")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"example\",\n \"reference\": \"example\",\n \"paidAt\": \"2026-09-07T12:00:00.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/invoices/{invoiceId}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"example\",\n \"reference\": \"example\",\n \"paidAt\": \"2026-09-07T12:00:00.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"quoteId": "<string>",
"invoiceRef": "<string>",
"currency": "<string>",
"subtotalCents": 123,
"gstCents": 123,
"amountCents": 123,
"status": "<string>",
"lineItemsSnapshot": "<unknown>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"contactId": "<string>",
"dueDate": "2023-12-25",
"notes": "<string>",
"pinchPaymentLinkUrl": "<string>",
"pinchPaymentId": "<string>",
"xeroInvoiceId": "<string>",
"qboSalesReceiptId": "<string>",
"xeroPaymentId": "<string>",
"xeroInvoiceUrl": "<string>",
"qboInvoiceId": "<string>",
"qboPaymentId": "<string>",
"qboInvoiceUrl": "<string>",
"paidMethod": "<string>",
"paidReference": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"pinchRefundId": "<string>",
"refundedAmountCents": 123,
"refundReason": "<string>",
"refundedAt": "2023-11-07T05:31:56Z",
"voidReason": "<string>",
"voidedAt": "2023-11-07T05:31:56Z",
"paymentClaimedAt": "2023-11-07T05:31:56Z",
"paymentClaimedMethod": "<string>",
"paymentClaimedReference": "<string>",
"paymentClaimedNote": "<string>"
}
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}Invoices
Record an invoice as paid
Requires the scope invoices.settle.
POST
/
v1
/
invoices
/
{invoiceId}
/
mark-paid
Tenant credential
curl --request POST 'https://api.printools.io/v1/invoices/11111111-2222-3333-4444-555555555555/mark-paid' \
--header 'X-API-Key: $PRINTOOLS_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"method":"example","reference":"example","paidAt":"2026-09-07T12:00:00.000Z"}'import requests
url = "https://api.printools.io/v1/invoices/{invoiceId}/mark-paid"
payload = {
"method": "example",
"reference": "example",
"paidAt": "2026-09-07T12:00:00.000Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({method: 'example', reference: 'example', paidAt: '2026-09-07T12:00:00.000Z'})
};
fetch('https://api.printools.io/v1/invoices/{invoiceId}/mark-paid', 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.printools.io/v1/invoices/{invoiceId}/mark-paid",
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([
'method' => 'example',
'reference' => 'example',
'paidAt' => '2026-09-07T12:00:00.000Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.printools.io/v1/invoices/{invoiceId}/mark-paid"
payload := strings.NewReader("{\n \"method\": \"example\",\n \"reference\": \"example\",\n \"paidAt\": \"2026-09-07T12:00:00.000Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.printools.io/v1/invoices/{invoiceId}/mark-paid")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"example\",\n \"reference\": \"example\",\n \"paidAt\": \"2026-09-07T12:00:00.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.printools.io/v1/invoices/{invoiceId}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"example\",\n \"reference\": \"example\",\n \"paidAt\": \"2026-09-07T12:00:00.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "OK",
"data": {
"id": "<string>",
"quoteId": "<string>",
"invoiceRef": "<string>",
"currency": "<string>",
"subtotalCents": 123,
"gstCents": 123,
"amountCents": 123,
"status": "<string>",
"lineItemsSnapshot": "<unknown>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"clientId": "<string>",
"contactId": "<string>",
"dueDate": "2023-12-25",
"notes": "<string>",
"pinchPaymentLinkUrl": "<string>",
"pinchPaymentId": "<string>",
"xeroInvoiceId": "<string>",
"qboSalesReceiptId": "<string>",
"xeroPaymentId": "<string>",
"xeroInvoiceUrl": "<string>",
"qboInvoiceId": "<string>",
"qboPaymentId": "<string>",
"qboInvoiceUrl": "<string>",
"paidMethod": "<string>",
"paidReference": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"pinchRefundId": "<string>",
"refundedAmountCents": 123,
"refundReason": "<string>",
"refundedAt": "2023-11-07T05:31:56Z",
"voidReason": "<string>",
"voidedAt": "2023-11-07T05:31:56Z",
"paymentClaimedAt": "2023-11-07T05:31:56Z",
"paymentClaimedMethod": "<string>",
"paymentClaimedReference": "<string>",
"paymentClaimedNote": "<string>"
}
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}{
"error": "<string>",
"message": "<string>",
"status": false
}Required scopes:
invoices.settle.Authorizations
tenantApiKeypartnerApiKey & partnerApiSecret & partnerBearer
Tenant credential. This is sufficient by itself.
Headers
Tenant credential: optional and, when sent, must equal the shop bound to the key. Partner credential: required; it selects an organisation the user previously authorised.
Optional client-generated key for write retries. Reusing it with a different request returns 409; a replay includes Idempotency-Replayed: true.
Required string length:
1 - 200Path Parameters
UUID.
Example:
"11111111-2222-3333-4444-555555555555"
Body
application/json
Was this page helpful?

