Skip to main content
POST
/
invoices
/
batch
/
tags
Tag multiple invoices
curl --request POST \
  --url https://api.syntage.com/invoices/batch/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "resources": [
    "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997"
  ],
  "tags": [
    "/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a"
  ]
}
'
import requests

url = "https://api.syntage.com/invoices/batch/tags"

payload = {
"resources": ["/invoices/91106968-1abd-4d64-85c1-4e73d96fb997"],
"tags": ["/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a"]
}
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({
resources: ['/invoices/91106968-1abd-4d64-85c1-4e73d96fb997'],
tags: ['/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a']
})
};

fetch('https://api.syntage.com/invoices/batch/tags', 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.syntage.com/invoices/batch/tags",
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([
'resources' => [
'/invoices/91106968-1abd-4d64-85c1-4e73d96fb997'
],
'tags' => [
'/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a'
]
]),
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.syntage.com/invoices/batch/tags"

payload := strings.NewReader("{\n \"resources\": [\n \"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997\"\n ],\n \"tags\": [\n \"/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a\"\n ]\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.syntage.com/invoices/batch/tags")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resources\": [\n \"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997\"\n ],\n \"tags\": [\n \"/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/invoices/batch/tags")

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 \"resources\": [\n \"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997\"\n ],\n \"tags\": [\n \"/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "resources": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tags": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
{
"message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json
resources
string<iri-reference>[]
required
write-only

Invoices to tag or untag, as IRI references

Required array length: 1 - 100 elements
Example:
[
"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997"
]
tags
string<iri-reference>[]
required
write-only

Tags to add or remove, as IRI references

Required array length: 1 - 50 elements
Example:
[
"/tags/018d9dd9-459f-768e-bc55-a8a72d0d3e9a"
]

Response

Result of a batch tag operation

resources
string<uuid>[]

IDs of the invoices the operation was applied to

tags
string<uuid>[]

IDs of the tags added or removed