cURL
curl --request PUT \
--url https://api.example.com/invoices/{invoiceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-environment: <x-environment>' \
--data '
{
"date": "2023-12-25",
"currency": "<string>",
"dueDate": "2023-12-25",
"items": [
{
"quantity": 123,
"unitAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"taxCode": "<string>",
"discount": {
"percentage": 123,
"amount": 123
}
}
]
}
'import requests
url = "https://api.example.com/invoices/{invoiceId}"
payload = {
"date": "2023-12-25",
"currency": "<string>",
"dueDate": "2023-12-25",
"items": [
{
"quantity": 123,
"unitAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"taxCode": "<string>",
"discount": {
"percentage": 123,
"amount": 123
}
}
]
}
headers = {
"x-environment": "<x-environment>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-environment': '<x-environment>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
date: '2023-12-25',
currency: '<string>',
dueDate: '2023-12-25',
items: [
{
quantity: 123,
unitAmount: 123,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
description: '<string>',
sku: '<string>',
periodStart: '2023-12-25',
periodEnd: '2023-12-25',
taxCode: '<string>',
discount: {percentage: 123, amount: 123}
}
]
})
};
fetch('https://api.example.com/invoices/{invoiceId}', 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.example.com/invoices/{invoiceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'date' => '2023-12-25',
'currency' => '<string>',
'dueDate' => '2023-12-25',
'items' => [
[
'quantity' => 123,
'unitAmount' => 123,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'description' => '<string>',
'sku' => '<string>',
'periodStart' => '2023-12-25',
'periodEnd' => '2023-12-25',
'taxCode' => '<string>',
'discount' => [
'percentage' => 123,
'amount' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-environment: <x-environment>"
],
]);
$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.example.com/invoices/{invoiceId}"
payload := strings.NewReader("{\n \"date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"items\": [\n {\n \"quantity\": 123,\n \"unitAmount\": 123,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"taxCode\": \"<string>\",\n \"discount\": {\n \"percentage\": 123,\n \"amount\": 123\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-environment", "<x-environment>")
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.put("https://api.example.com/invoices/{invoiceId}")
.header("x-environment", "<x-environment>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"items\": [\n {\n \"quantity\": 123,\n \"unitAmount\": 123,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"taxCode\": \"<string>\",\n \"discount\": {\n \"percentage\": 123,\n \"amount\": 123\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/invoices/{invoiceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-environment"] = '<x-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"items\": [\n {\n \"quantity\": 123,\n \"unitAmount\": 123,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"taxCode\": \"<string>\",\n \"discount\": {\n \"percentage\": 123,\n \"amount\": 123\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"name": "<string>",
"billingAddress": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"county": "<string>",
"country": "<string>",
"state": "<string>"
}
},
"memo": "<string>",
"handle": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-12-25",
"dueDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"unitAmount": 123,
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"amount": 123,
"taxAmount": 123,
"tax": {
"taxable": true,
"taxCode": "<string>",
"taxRate": 123
},
"discount": {
"percentage": 123,
"amount": 123
}
}
],
"settlements": [
{
"date": "2023-12-25",
"amount": 123,
"reference": "<string>",
"note": "<string>"
}
],
"totalExclVat": 123,
"totalVat": 123,
"totalInclVat": 123,
"totalDue": 123
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Invoices
Put invoices
PUT
/
invoices
/
{invoiceId}
cURL
curl --request PUT \
--url https://api.example.com/invoices/{invoiceId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-environment: <x-environment>' \
--data '
{
"date": "2023-12-25",
"currency": "<string>",
"dueDate": "2023-12-25",
"items": [
{
"quantity": 123,
"unitAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"taxCode": "<string>",
"discount": {
"percentage": 123,
"amount": 123
}
}
]
}
'import requests
url = "https://api.example.com/invoices/{invoiceId}"
payload = {
"date": "2023-12-25",
"currency": "<string>",
"dueDate": "2023-12-25",
"items": [
{
"quantity": 123,
"unitAmount": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"sku": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"taxCode": "<string>",
"discount": {
"percentage": 123,
"amount": 123
}
}
]
}
headers = {
"x-environment": "<x-environment>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-environment': '<x-environment>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
date: '2023-12-25',
currency: '<string>',
dueDate: '2023-12-25',
items: [
{
quantity: 123,
unitAmount: 123,
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
description: '<string>',
sku: '<string>',
periodStart: '2023-12-25',
periodEnd: '2023-12-25',
taxCode: '<string>',
discount: {percentage: 123, amount: 123}
}
]
})
};
fetch('https://api.example.com/invoices/{invoiceId}', 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.example.com/invoices/{invoiceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'date' => '2023-12-25',
'currency' => '<string>',
'dueDate' => '2023-12-25',
'items' => [
[
'quantity' => 123,
'unitAmount' => 123,
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'description' => '<string>',
'sku' => '<string>',
'periodStart' => '2023-12-25',
'periodEnd' => '2023-12-25',
'taxCode' => '<string>',
'discount' => [
'percentage' => 123,
'amount' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-environment: <x-environment>"
],
]);
$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.example.com/invoices/{invoiceId}"
payload := strings.NewReader("{\n \"date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"items\": [\n {\n \"quantity\": 123,\n \"unitAmount\": 123,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"taxCode\": \"<string>\",\n \"discount\": {\n \"percentage\": 123,\n \"amount\": 123\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-environment", "<x-environment>")
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.put("https://api.example.com/invoices/{invoiceId}")
.header("x-environment", "<x-environment>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"items\": [\n {\n \"quantity\": 123,\n \"unitAmount\": 123,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"taxCode\": \"<string>\",\n \"discount\": {\n \"percentage\": 123,\n \"amount\": 123\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/invoices/{invoiceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-environment"] = '<x-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"items\": [\n {\n \"quantity\": 123,\n \"unitAmount\": 123,\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"periodStart\": \"2023-12-25\",\n \"periodEnd\": \"2023-12-25\",\n \"taxCode\": \"<string>\",\n \"discount\": {\n \"percentage\": 123,\n \"amount\": 123\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"name": "<string>",
"billingAddress": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"county": "<string>",
"country": "<string>",
"state": "<string>"
}
},
"memo": "<string>",
"handle": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-12-25",
"dueDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"unitAmount": 123,
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"amount": 123,
"taxAmount": 123,
"tax": {
"taxable": true,
"taxCode": "<string>",
"taxRate": 123
},
"discount": {
"percentage": 123,
"amount": 123
}
}
],
"settlements": [
{
"date": "2023-12-25",
"amount": 123,
"reference": "<string>",
"note": "<string>"
}
],
"totalExclVat": 123,
"totalVat": 123,
"totalInclVat": 123,
"totalDue": 123
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Headers
Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.
Path Parameters
Body
application/json
Response
OK
Show child attributes
Show child attributes
Unique invoice number.
Available options:
draft, booked Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
invoice, credit_note Available options:
settled, over_settled, under_settled, not_settled Was this page helpful?
⌘I

