Partially update contract

curl --request PATCH \
  --url https://api.contracting.kukkingu.software/api/v1/contracts/{contractId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenant-id: <tenant-id>' \
  --data '
{
  "tenantAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
  "clientAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
  "name": "Standard Service Contract",
  "description": "This contract covers standard service terms and conditions.",
  "amountMinor": 5000,
  "currencyCode": "EUR",
  "contactPersonId": "con_xlbg6ubfio7tzvsijyp5794c",
  "billingContactId": "con_xlbg6ubfio7tzvsijyp5794c",
  "order": 13,
  "validFrom": "2023-10-05T14:48:00.000Z",
  "validTo": "2023-10-05T14:48:00.000Z"
}
'

import requests

url = "https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}"

payload = {
    "tenantAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "clientAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "name": "Standard Service Contract",
    "description": "This contract covers standard service terms and conditions.",
    "amountMinor": 5000,
    "currencyCode": "EUR",
    "contactPersonId": "con_xlbg6ubfio7tzvsijyp5794c",
    "billingContactId": "con_xlbg6ubfio7tzvsijyp5794c",
    "order": 13,
    "validFrom": "2023-10-05T14:48:00.000Z",
    "validTo": "2023-10-05T14:48:00.000Z"
}
headers = {
    "tenant-id": "<tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'tenant-id': '<tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    tenantAddressId: 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    clientAddressId: 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    name: 'Standard Service Contract',
    description: 'This contract covers standard service terms and conditions.',
    amountMinor: 5000,
    currencyCode: 'EUR',
    contactPersonId: 'con_xlbg6ubfio7tzvsijyp5794c',
    billingContactId: 'con_xlbg6ubfio7tzvsijyp5794c',
    order: 13,
    validFrom: '2023-10-05T14:48:00.000Z',
    validTo: '2023-10-05T14:48:00.000Z'
  })
};

fetch('https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}', 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.contracting.kukkingu.software/api/v1/contracts/{contractId}",
  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([
    'tenantAddressId' => 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    'clientAddressId' => 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    'name' => 'Standard Service Contract',
    'description' => 'This contract covers standard service terms and conditions.',
    'amountMinor' => 5000,
    'currencyCode' => 'EUR',
    'contactPersonId' => 'con_xlbg6ubfio7tzvsijyp5794c',
    'billingContactId' => 'con_xlbg6ubfio7tzvsijyp5794c',
    'order' => 13,
    'validFrom' => '2023-10-05T14:48:00.000Z',
    'validTo' => '2023-10-05T14:48:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "tenant-id: <tenant-id>"
  ],
]);

$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.contracting.kukkingu.software/api/v1/contracts/{contractId}"

	payload := strings.NewReader("{\n  \"tenantAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"clientAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"name\": \"Standard Service Contract\",\n  \"description\": \"This contract covers standard service terms and conditions.\",\n  \"amountMinor\": 5000,\n  \"currencyCode\": \"EUR\",\n  \"contactPersonId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"billingContactId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"order\": 13,\n  \"validFrom\": \"2023-10-05T14:48:00.000Z\",\n  \"validTo\": \"2023-10-05T14:48:00.000Z\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("tenant-id", "<tenant-id>")
	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.patch("https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}")
  .header("tenant-id", "<tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tenantAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"clientAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"name\": \"Standard Service Contract\",\n  \"description\": \"This contract covers standard service terms and conditions.\",\n  \"amountMinor\": 5000,\n  \"currencyCode\": \"EUR\",\n  \"contactPersonId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"billingContactId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"order\": 13,\n  \"validFrom\": \"2023-10-05T14:48:00.000Z\",\n  \"validTo\": \"2023-10-05T14:48:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}")

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

request = Net::HTTP::Patch.new(url)
request["tenant-id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tenantAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"clientAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"name\": \"Standard Service Contract\",\n  \"description\": \"This contract covers standard service terms and conditions.\",\n  \"amountMinor\": 5000,\n  \"currencyCode\": \"EUR\",\n  \"contactPersonId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"billingContactId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"order\": 13,\n  \"validFrom\": \"2023-10-05T14:48:00.000Z\",\n  \"validTo\": \"2023-10-05T14:48:00.000Z\"\n}"

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

{
  "data": {
    "id": "ctr_z23aoo8naxk68ewcr64tchh5",
    "client": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
    "tenantAddress": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "clientAddress": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "name": "Standard Service Contract",
    "amountMinor": 5000,
    "currencyCode": "EUR",
    "billingContactId": "con_xlbg6ubfio7tzvsijyp5794c",
    "createdAt": "2023-10-05T14:48:00.000Z",
    "updatedAt": "2023-10-05T14:48:00.000Z",
    "description": "This contract covers standard service terms and conditions.",
    "contactPersonId": "con_xlbg6ubfio7tzvsijyp5794c",
    "order": 13,
    "validFrom": "2023-10-05T14:48:00.000Z",
    "validTo": "2023-10-05T14:48:00.000Z"
  }
}

{
  "error": "ValidationError",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>",
      "constraint": "<string>"
    }
  ]
}

{
  "error": "Unauthorized",
  "message": "Unauthorized"
}

{
  "error": "Forbidden",
  "message": "Forbidden"
}

{
  "error": "NotFound",
  "message": "Not Found"
}

PATCH

api

contracts

{contractId}

Partially update contract

curl --request PATCH \
  --url https://api.contracting.kukkingu.software/api/v1/contracts/{contractId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenant-id: <tenant-id>' \
  --data '
{
  "tenantAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
  "clientAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
  "name": "Standard Service Contract",
  "description": "This contract covers standard service terms and conditions.",
  "amountMinor": 5000,
  "currencyCode": "EUR",
  "contactPersonId": "con_xlbg6ubfio7tzvsijyp5794c",
  "billingContactId": "con_xlbg6ubfio7tzvsijyp5794c",
  "order": 13,
  "validFrom": "2023-10-05T14:48:00.000Z",
  "validTo": "2023-10-05T14:48:00.000Z"
}
'

import requests

url = "https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}"

payload = {
    "tenantAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "clientAddressId": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "name": "Standard Service Contract",
    "description": "This contract covers standard service terms and conditions.",
    "amountMinor": 5000,
    "currencyCode": "EUR",
    "contactPersonId": "con_xlbg6ubfio7tzvsijyp5794c",
    "billingContactId": "con_xlbg6ubfio7tzvsijyp5794c",
    "order": 13,
    "validFrom": "2023-10-05T14:48:00.000Z",
    "validTo": "2023-10-05T14:48:00.000Z"
}
headers = {
    "tenant-id": "<tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'tenant-id': '<tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    tenantAddressId: 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    clientAddressId: 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    name: 'Standard Service Contract',
    description: 'This contract covers standard service terms and conditions.',
    amountMinor: 5000,
    currencyCode: 'EUR',
    contactPersonId: 'con_xlbg6ubfio7tzvsijyp5794c',
    billingContactId: 'con_xlbg6ubfio7tzvsijyp5794c',
    order: 13,
    validFrom: '2023-10-05T14:48:00.000Z',
    validTo: '2023-10-05T14:48:00.000Z'
  })
};

fetch('https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}', 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.contracting.kukkingu.software/api/v1/contracts/{contractId}",
  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([
    'tenantAddressId' => 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    'clientAddressId' => 'adr_ekq4ymw1nyyd4b6k6f5tg3t6',
    'name' => 'Standard Service Contract',
    'description' => 'This contract covers standard service terms and conditions.',
    'amountMinor' => 5000,
    'currencyCode' => 'EUR',
    'contactPersonId' => 'con_xlbg6ubfio7tzvsijyp5794c',
    'billingContactId' => 'con_xlbg6ubfio7tzvsijyp5794c',
    'order' => 13,
    'validFrom' => '2023-10-05T14:48:00.000Z',
    'validTo' => '2023-10-05T14:48:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "tenant-id: <tenant-id>"
  ],
]);

$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.contracting.kukkingu.software/api/v1/contracts/{contractId}"

	payload := strings.NewReader("{\n  \"tenantAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"clientAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"name\": \"Standard Service Contract\",\n  \"description\": \"This contract covers standard service terms and conditions.\",\n  \"amountMinor\": 5000,\n  \"currencyCode\": \"EUR\",\n  \"contactPersonId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"billingContactId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"order\": 13,\n  \"validFrom\": \"2023-10-05T14:48:00.000Z\",\n  \"validTo\": \"2023-10-05T14:48:00.000Z\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("tenant-id", "<tenant-id>")
	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.patch("https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}")
  .header("tenant-id", "<tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tenantAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"clientAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"name\": \"Standard Service Contract\",\n  \"description\": \"This contract covers standard service terms and conditions.\",\n  \"amountMinor\": 5000,\n  \"currencyCode\": \"EUR\",\n  \"contactPersonId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"billingContactId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"order\": 13,\n  \"validFrom\": \"2023-10-05T14:48:00.000Z\",\n  \"validTo\": \"2023-10-05T14:48:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.contracting.kukkingu.software/api/v1/contracts/{contractId}")

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

request = Net::HTTP::Patch.new(url)
request["tenant-id"] = '<tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tenantAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"clientAddressId\": \"adr_ekq4ymw1nyyd4b6k6f5tg3t6\",\n  \"name\": \"Standard Service Contract\",\n  \"description\": \"This contract covers standard service terms and conditions.\",\n  \"amountMinor\": 5000,\n  \"currencyCode\": \"EUR\",\n  \"contactPersonId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"billingContactId\": \"con_xlbg6ubfio7tzvsijyp5794c\",\n  \"order\": 13,\n  \"validFrom\": \"2023-10-05T14:48:00.000Z\",\n  \"validTo\": \"2023-10-05T14:48:00.000Z\"\n}"

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

{
  "data": {
    "id": "ctr_z23aoo8naxk68ewcr64tchh5",
    "client": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
    "tenantAddress": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "clientAddress": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "name": "Standard Service Contract",
    "amountMinor": 5000,
    "currencyCode": "EUR",
    "billingContactId": "con_xlbg6ubfio7tzvsijyp5794c",
    "createdAt": "2023-10-05T14:48:00.000Z",
    "updatedAt": "2023-10-05T14:48:00.000Z",
    "description": "This contract covers standard service terms and conditions.",
    "contactPersonId": "con_xlbg6ubfio7tzvsijyp5794c",
    "order": 13,
    "validFrom": "2023-10-05T14:48:00.000Z",
    "validTo": "2023-10-05T14:48:00.000Z"
  }
}

{
  "error": "ValidationError",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>",
      "constraint": "<string>"
    }
  ]
}

{
  "error": "Unauthorized",
  "message": "Unauthorized"
}

{
  "error": "Forbidden",
  "message": "Forbidden"
}

{
  "error": "NotFound",
  "message": "Not Found"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

tenant-id

string

required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Path Parameters

contractId

string

required

The ID of the contract.

Example:

"ctr_z23aoo8naxk68ewcr64tchh5"

Body

application/json

Request body used to partially update an existing contract resource.

tenantAddressId

string

Identifier of the tenant-side address to display on this contract.

Minimum string length: 1

Example:

"adr_ekq4ymw1nyyd4b6k6f5tg3t6"

clientAddressId

string

Identifier of the client's address for the contract.

Minimum string length: 1

Example:

"adr_ekq4ymw1nyyd4b6k6f5tg3t6"

name

string

Contract name.

Required string length: 1 - 255

Example:

"Standard Service Contract"

description

string

Detailed contract description.

Example:

"This contract covers standard service terms and conditions."

amountMinor

integer

Monetary amount in minor units (e.g., cents).

Required range: 0 <= x <= 9007199254740991

Example:

5000

currencyCode

string

ISO 4217 currency code.

Required string length: 3

Example:

"EUR"

contactPersonId

string | null

Identifier of the primary contact person associated with this contract.

Minimum string length: 1

Example:

"con_xlbg6ubfio7tzvsijyp5794c"

billingContactId

string

Identifier of the billing contact for this contract, if different from the main contact.

Minimum string length: 1

Example:

"con_xlbg6ubfio7tzvsijyp5794c"

order

integer

Order of the resource for sorting purposes.

Required range: 0 <= x <= 9007199254740991

Example:

13

validFrom

string<date-time>

Contract validity start date.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2023-10-05T14:48:00.000Z"

validTo

string<date-time>

Contract validity end date.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2023-10-05T14:48:00.000Z"

Response

Default Response

Standard success response payload wrapped in a data property.

data

object

required

Contract resource returned by the API.

Show child attributes

Addresses

Assets

Billables

Clients

Contacts

Contracts

Docs

Health

Webhooks

Integrations

Invoices

Projects

Tenants

Time Entries

Users

Partially update contract

Authorizations

Headers

Path Parameters

Body

Response