Estimates
Modify estimate
Edits the provided fields for the estimate with the given id. Any fields that are not provided are left unchanged.
PATCH
/
v1
/
estimates
/
{estimateId}
Modify estimate
curl --request PATCH \
--url https://api.infinity.swiss/v1/estimates/{estimateId} \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"template": "<string>",
"openingDate": "2023-12-25",
"positions": [
{
"type": "product",
"name": "<string>",
"singleAmount": 12000,
"quantity": 2,
"contraAccount": 5499,
"unit": "<string>",
"taxCode": "",
"articleNumber": "<string>",
"description": "<string>",
"date": "<string>",
"discountRate": 50,
"customTextColumns": {
"customTextColumn1": "<string>",
"customTextColumn2": "<string>",
"customTextColumn3": "<string>"
}
}
],
"recipient": "<string>",
"customRecipientText": "<string>",
"externalReference": "<string>",
"title": "<string>",
"payableInDays": 182,
"introductoryText": "<string>",
"closingText": "<string>",
"columns": [],
"originalCurrency": "<string>",
"exchangeRate": 123,
"isDraft": true
}
'import requests
url = "https://api.infinity.swiss/v1/estimates/{estimateId}"
payload = {
"template": "<string>",
"openingDate": "2023-12-25",
"positions": [
{
"type": "product",
"name": "<string>",
"singleAmount": 12000,
"quantity": 2,
"contraAccount": 5499,
"unit": "<string>",
"taxCode": "",
"articleNumber": "<string>",
"description": "<string>",
"date": "<string>",
"discountRate": 50,
"customTextColumns": {
"customTextColumn1": "<string>",
"customTextColumn2": "<string>",
"customTextColumn3": "<string>"
}
}
],
"recipient": "<string>",
"customRecipientText": "<string>",
"externalReference": "<string>",
"title": "<string>",
"payableInDays": 182,
"introductoryText": "<string>",
"closingText": "<string>",
"columns": [],
"originalCurrency": "<string>",
"exchangeRate": 123,
"isDraft": True
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template: '<string>',
openingDate: '2023-12-25',
positions: [
{
type: 'product',
name: '<string>',
singleAmount: 12000,
quantity: 2,
contraAccount: 5499,
unit: '<string>',
taxCode: '',
articleNumber: '<string>',
description: '<string>',
date: '<string>',
discountRate: 50,
customTextColumns: {
customTextColumn1: '<string>',
customTextColumn2: '<string>',
customTextColumn3: '<string>'
}
}
],
recipient: '<string>',
customRecipientText: '<string>',
externalReference: '<string>',
title: '<string>',
payableInDays: 182,
introductoryText: '<string>',
closingText: '<string>',
columns: [],
originalCurrency: '<string>',
exchangeRate: 123,
isDraft: true
})
};
fetch('https://api.infinity.swiss/v1/estimates/{estimateId}', 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.infinity.swiss/v1/estimates/{estimateId}",
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([
'template' => '<string>',
'openingDate' => '2023-12-25',
'positions' => [
[
'type' => 'product',
'name' => '<string>',
'singleAmount' => 12000,
'quantity' => 2,
'contraAccount' => 5499,
'unit' => '<string>',
'taxCode' => '',
'articleNumber' => '<string>',
'description' => '<string>',
'date' => '<string>',
'discountRate' => 50,
'customTextColumns' => [
'customTextColumn1' => '<string>',
'customTextColumn2' => '<string>',
'customTextColumn3' => '<string>'
]
]
],
'recipient' => '<string>',
'customRecipientText' => '<string>',
'externalReference' => '<string>',
'title' => '<string>',
'payableInDays' => 182,
'introductoryText' => '<string>',
'closingText' => '<string>',
'columns' => [
],
'originalCurrency' => '<string>',
'exchangeRate' => 123,
'isDraft' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <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.infinity.swiss/v1/estimates/{estimateId}"
payload := strings.NewReader("{\n \"template\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"positions\": [\n {\n \"type\": \"product\",\n \"name\": \"<string>\",\n \"singleAmount\": 12000,\n \"quantity\": 2,\n \"contraAccount\": 5499,\n \"unit\": \"<string>\",\n \"taxCode\": \"\",\n \"articleNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"date\": \"<string>\",\n \"discountRate\": 50,\n \"customTextColumns\": {\n \"customTextColumn1\": \"<string>\",\n \"customTextColumn2\": \"<string>\",\n \"customTextColumn3\": \"<string>\"\n }\n }\n ],\n \"recipient\": \"<string>\",\n \"customRecipientText\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"title\": \"<string>\",\n \"payableInDays\": 182,\n \"introductoryText\": \"<string>\",\n \"closingText\": \"<string>\",\n \"columns\": [],\n \"originalCurrency\": \"<string>\",\n \"exchangeRate\": 123,\n \"isDraft\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-token", "<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.infinity.swiss/v1/estimates/{estimateId}")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"positions\": [\n {\n \"type\": \"product\",\n \"name\": \"<string>\",\n \"singleAmount\": 12000,\n \"quantity\": 2,\n \"contraAccount\": 5499,\n \"unit\": \"<string>\",\n \"taxCode\": \"\",\n \"articleNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"date\": \"<string>\",\n \"discountRate\": 50,\n \"customTextColumns\": {\n \"customTextColumn1\": \"<string>\",\n \"customTextColumn2\": \"<string>\",\n \"customTextColumn3\": \"<string>\"\n }\n }\n ],\n \"recipient\": \"<string>\",\n \"customRecipientText\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"title\": \"<string>\",\n \"payableInDays\": 182,\n \"introductoryText\": \"<string>\",\n \"closingText\": \"<string>\",\n \"columns\": [],\n \"originalCurrency\": \"<string>\",\n \"exchangeRate\": 123,\n \"isDraft\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.infinity.swiss/v1/estimates/{estimateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"positions\": [\n {\n \"type\": \"product\",\n \"name\": \"<string>\",\n \"singleAmount\": 12000,\n \"quantity\": 2,\n \"contraAccount\": 5499,\n \"unit\": \"<string>\",\n \"taxCode\": \"\",\n \"articleNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"date\": \"<string>\",\n \"discountRate\": 50,\n \"customTextColumns\": {\n \"customTextColumn1\": \"<string>\",\n \"customTextColumn2\": \"<string>\",\n \"customTextColumn3\": \"<string>\"\n }\n }\n ],\n \"recipient\": \"<string>\",\n \"customRecipientText\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"title\": \"<string>\",\n \"payableInDays\": 182,\n \"introductoryText\": \"<string>\",\n \"closingText\": \"<string>\",\n \"columns\": [],\n \"originalCurrency\": \"<string>\",\n \"exchangeRate\": 123,\n \"isDraft\": true\n}"
response = http.request(request)
puts response.read_body{
"estimate": {
"id": "<string>",
"isDraft": true,
"number": "<string>",
"organisation": "<string>",
"template": "<string>",
"openingDate": "2023-12-25",
"dueDate": "2023-12-25",
"positions": [
{
"type": "product",
"name": "<string>",
"singleAmount": 12000,
"quantity": 2,
"contraAccount": 5499,
"id": "<string>",
"unit": "<string>",
"taxCode": "",
"articleNumber": "<string>",
"description": "<string>",
"date": "<string>",
"discountRate": 50,
"customTextColumns": {
"customTextColumn1": "<string>",
"customTextColumn2": "<string>",
"customTextColumn3": "<string>"
},
"totalAmount": 123,
"vatDebt": 123,
"originalCurrency": "<string>",
"exchangeRate": 123
}
],
"totalAmount": 123,
"totalNetAmount": 123,
"totalVatDebt": 123,
"status": "open",
"recipient": "<string>",
"customRecipientText": "<string>",
"externalReference": "<string>",
"title": "<string>",
"payableInDays": 123,
"introductoryText": "<string>",
"closingText": "<string>",
"amountMode": "gross",
"language": "de",
"originalCurrency": "<string>",
"exchangeRate": 123,
"columns": [
"quantity"
],
"emailDeliveries": [
{
"recipientEmail": "jsmith@example.com",
"status": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"publicPdfUrl": "<string>",
"signingPerson": "<string>",
"signedAt": "2023-11-07T05:31:56Z",
"invoicesFromQuote": [
"<string>"
]
}
}{
"code": "<string>",
"invalidFields": [
"<string>"
]
}{
"code": "general/unauthorised"
}{
"code": "customer-invoices/not-found"
}Only the fields provided in the request body are updated. Any field that is omitted is left unchanged. Unlike invoices, modifying an estimate never affects accounting transactions.
Authorizations
API token for authentication. Obtain from your Infinity account settings.
Path Parameters
The id of the specific estimate.
Body
application/json
The fields to update.
Request body for modifying an estimate. All fields are optional; omitted fields are left unchanged.
The id of the invoice template to render the document with. When omitted while creating an invoice or estimate, the organisation's default template is used. Use the invoice templates endpoint to list the available templates.
The opening date (issue date) of the document in YYYY-MM-DD format. For invoices, this is also the date used for the posted accounting transactions.
positions
(ProductPosition · object | DiscountPosition · object | TextPosition · object | SubtotalPosition · object)[]
The ordered list of positions on the document. At least one position is required, and discount positions must specify exactly one of percentage or amount.
A standard billable line item with a quantity, single amount, and contra account. Most invoice and estimate positions are of this type.
- ProductPosition
- DiscountPosition
- TextPosition
- SubtotalPosition
Show child attributes
Show child attributes
The id of the contact this document is addressed to. Required unless customRecipientText is provided.
An ad-hoc recipient text used when no contact is associated with the document.
Maximum string length:
2000An optional reference for this document in an external system.
Maximum string length:
128Optional document title displayed on the rendered output.
Maximum string length:
128Payment terms for this document in days from the opening date. Defaults to 30 on create.
Required range:
0 <= x <= 365Text rendered above the positions.
Maximum string length:
2000Text rendered below the positions.
Maximum string length:
2000Whether position amounts are entered gross (including VAT) or net (excluding VAT).
Available options:
gross, net The language used to render the document.
Available options:
de, en, fr, it The columns to render in the positions table. If not provided the template default is used.
A column that can be shown on the rendered invoice or estimate.
Available options:
quantity, unit, articleNumber, name, date, vatDebt, vatRate, singleAmount, totalAmount, discountRate, positionNumber, customTextColumn1, customTextColumn2, customTextColumn3 For foreign-currency documents: the 3-character ISO 4217 currency code the document is denominated in. Must be a currency code that is enabled in the organisation. When set without exchangeRate, the organisation's stored exchange rate for that currency is used.
Required string length:
3For foreign-currency documents: the conversion rate from the original currency to the primary accounting currency, expressed as 1 originalCurrency = X primaryCurrency. Optional when originalCurrency is set; if omitted, defaults to the organisation's stored exchange rate for that currency. Cannot be set without originalCurrency.
Response
Changes saved successfully.
The full representation of an estimate (quote).
Show child attributes
Show child attributes
⌘I
Modify estimate
curl --request PATCH \
--url https://api.infinity.swiss/v1/estimates/{estimateId} \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"template": "<string>",
"openingDate": "2023-12-25",
"positions": [
{
"type": "product",
"name": "<string>",
"singleAmount": 12000,
"quantity": 2,
"contraAccount": 5499,
"unit": "<string>",
"taxCode": "",
"articleNumber": "<string>",
"description": "<string>",
"date": "<string>",
"discountRate": 50,
"customTextColumns": {
"customTextColumn1": "<string>",
"customTextColumn2": "<string>",
"customTextColumn3": "<string>"
}
}
],
"recipient": "<string>",
"customRecipientText": "<string>",
"externalReference": "<string>",
"title": "<string>",
"payableInDays": 182,
"introductoryText": "<string>",
"closingText": "<string>",
"columns": [],
"originalCurrency": "<string>",
"exchangeRate": 123,
"isDraft": true
}
'import requests
url = "https://api.infinity.swiss/v1/estimates/{estimateId}"
payload = {
"template": "<string>",
"openingDate": "2023-12-25",
"positions": [
{
"type": "product",
"name": "<string>",
"singleAmount": 12000,
"quantity": 2,
"contraAccount": 5499,
"unit": "<string>",
"taxCode": "",
"articleNumber": "<string>",
"description": "<string>",
"date": "<string>",
"discountRate": 50,
"customTextColumns": {
"customTextColumn1": "<string>",
"customTextColumn2": "<string>",
"customTextColumn3": "<string>"
}
}
],
"recipient": "<string>",
"customRecipientText": "<string>",
"externalReference": "<string>",
"title": "<string>",
"payableInDays": 182,
"introductoryText": "<string>",
"closingText": "<string>",
"columns": [],
"originalCurrency": "<string>",
"exchangeRate": 123,
"isDraft": True
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template: '<string>',
openingDate: '2023-12-25',
positions: [
{
type: 'product',
name: '<string>',
singleAmount: 12000,
quantity: 2,
contraAccount: 5499,
unit: '<string>',
taxCode: '',
articleNumber: '<string>',
description: '<string>',
date: '<string>',
discountRate: 50,
customTextColumns: {
customTextColumn1: '<string>',
customTextColumn2: '<string>',
customTextColumn3: '<string>'
}
}
],
recipient: '<string>',
customRecipientText: '<string>',
externalReference: '<string>',
title: '<string>',
payableInDays: 182,
introductoryText: '<string>',
closingText: '<string>',
columns: [],
originalCurrency: '<string>',
exchangeRate: 123,
isDraft: true
})
};
fetch('https://api.infinity.swiss/v1/estimates/{estimateId}', 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.infinity.swiss/v1/estimates/{estimateId}",
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([
'template' => '<string>',
'openingDate' => '2023-12-25',
'positions' => [
[
'type' => 'product',
'name' => '<string>',
'singleAmount' => 12000,
'quantity' => 2,
'contraAccount' => 5499,
'unit' => '<string>',
'taxCode' => '',
'articleNumber' => '<string>',
'description' => '<string>',
'date' => '<string>',
'discountRate' => 50,
'customTextColumns' => [
'customTextColumn1' => '<string>',
'customTextColumn2' => '<string>',
'customTextColumn3' => '<string>'
]
]
],
'recipient' => '<string>',
'customRecipientText' => '<string>',
'externalReference' => '<string>',
'title' => '<string>',
'payableInDays' => 182,
'introductoryText' => '<string>',
'closingText' => '<string>',
'columns' => [
],
'originalCurrency' => '<string>',
'exchangeRate' => 123,
'isDraft' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <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.infinity.swiss/v1/estimates/{estimateId}"
payload := strings.NewReader("{\n \"template\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"positions\": [\n {\n \"type\": \"product\",\n \"name\": \"<string>\",\n \"singleAmount\": 12000,\n \"quantity\": 2,\n \"contraAccount\": 5499,\n \"unit\": \"<string>\",\n \"taxCode\": \"\",\n \"articleNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"date\": \"<string>\",\n \"discountRate\": 50,\n \"customTextColumns\": {\n \"customTextColumn1\": \"<string>\",\n \"customTextColumn2\": \"<string>\",\n \"customTextColumn3\": \"<string>\"\n }\n }\n ],\n \"recipient\": \"<string>\",\n \"customRecipientText\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"title\": \"<string>\",\n \"payableInDays\": 182,\n \"introductoryText\": \"<string>\",\n \"closingText\": \"<string>\",\n \"columns\": [],\n \"originalCurrency\": \"<string>\",\n \"exchangeRate\": 123,\n \"isDraft\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-token", "<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.infinity.swiss/v1/estimates/{estimateId}")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"positions\": [\n {\n \"type\": \"product\",\n \"name\": \"<string>\",\n \"singleAmount\": 12000,\n \"quantity\": 2,\n \"contraAccount\": 5499,\n \"unit\": \"<string>\",\n \"taxCode\": \"\",\n \"articleNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"date\": \"<string>\",\n \"discountRate\": 50,\n \"customTextColumns\": {\n \"customTextColumn1\": \"<string>\",\n \"customTextColumn2\": \"<string>\",\n \"customTextColumn3\": \"<string>\"\n }\n }\n ],\n \"recipient\": \"<string>\",\n \"customRecipientText\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"title\": \"<string>\",\n \"payableInDays\": 182,\n \"introductoryText\": \"<string>\",\n \"closingText\": \"<string>\",\n \"columns\": [],\n \"originalCurrency\": \"<string>\",\n \"exchangeRate\": 123,\n \"isDraft\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.infinity.swiss/v1/estimates/{estimateId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"positions\": [\n {\n \"type\": \"product\",\n \"name\": \"<string>\",\n \"singleAmount\": 12000,\n \"quantity\": 2,\n \"contraAccount\": 5499,\n \"unit\": \"<string>\",\n \"taxCode\": \"\",\n \"articleNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"date\": \"<string>\",\n \"discountRate\": 50,\n \"customTextColumns\": {\n \"customTextColumn1\": \"<string>\",\n \"customTextColumn2\": \"<string>\",\n \"customTextColumn3\": \"<string>\"\n }\n }\n ],\n \"recipient\": \"<string>\",\n \"customRecipientText\": \"<string>\",\n \"externalReference\": \"<string>\",\n \"title\": \"<string>\",\n \"payableInDays\": 182,\n \"introductoryText\": \"<string>\",\n \"closingText\": \"<string>\",\n \"columns\": [],\n \"originalCurrency\": \"<string>\",\n \"exchangeRate\": 123,\n \"isDraft\": true\n}"
response = http.request(request)
puts response.read_body{
"estimate": {
"id": "<string>",
"isDraft": true,
"number": "<string>",
"organisation": "<string>",
"template": "<string>",
"openingDate": "2023-12-25",
"dueDate": "2023-12-25",
"positions": [
{
"type": "product",
"name": "<string>",
"singleAmount": 12000,
"quantity": 2,
"contraAccount": 5499,
"id": "<string>",
"unit": "<string>",
"taxCode": "",
"articleNumber": "<string>",
"description": "<string>",
"date": "<string>",
"discountRate": 50,
"customTextColumns": {
"customTextColumn1": "<string>",
"customTextColumn2": "<string>",
"customTextColumn3": "<string>"
},
"totalAmount": 123,
"vatDebt": 123,
"originalCurrency": "<string>",
"exchangeRate": 123
}
],
"totalAmount": 123,
"totalNetAmount": 123,
"totalVatDebt": 123,
"status": "open",
"recipient": "<string>",
"customRecipientText": "<string>",
"externalReference": "<string>",
"title": "<string>",
"payableInDays": 123,
"introductoryText": "<string>",
"closingText": "<string>",
"amountMode": "gross",
"language": "de",
"originalCurrency": "<string>",
"exchangeRate": 123,
"columns": [
"quantity"
],
"emailDeliveries": [
{
"recipientEmail": "jsmith@example.com",
"status": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"publicPdfUrl": "<string>",
"signingPerson": "<string>",
"signedAt": "2023-11-07T05:31:56Z",
"invoicesFromQuote": [
"<string>"
]
}
}{
"code": "<string>",
"invalidFields": [
"<string>"
]
}{
"code": "general/unauthorised"
}{
"code": "customer-invoices/not-found"
}