Update contract line

PATCH

contracts

{contractId}

lines

{lineId}

Update contract line

curl --request PATCH \
  --url https://api.light.inc/v1/contracts/{contractId}/lines/{lineId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billingStart": "2023-12-25",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "valueIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "inlineValues": [
        "<string>"
      ]
    }
  ],
  "billingEnd": "2023-12-25",
  "discount": {
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "priceOverwrite": 123,
  "productNameOverwrite": "<string>",
  "quantity": 123,
  "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amortizationStartDate": "2023-12-25",
  "amortizationEndDate": "2023-12-25"
}
'

import requests

url = "https://api.light.inc/v1/contracts/{contractId}/lines/{lineId}"

payload = {
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billingStart": "2023-12-25",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customProperties": [
        {
            "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "valueIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "inlineValues": ["<string>"]
        }
    ],
    "billingEnd": "2023-12-25",
    "discount": {
        "startDate": "2023-12-25",
        "endDate": "2023-12-25"
    },
    "priceOverwrite": 123,
    "productNameOverwrite": "<string>",
    "quantity": 123,
    "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amortizationStartDate": "2023-12-25",
    "amortizationEndDate": "2023-12-25"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json;charset=UTF-8"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json;charset=UTF-8'},
  body: JSON.stringify({
    productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billingStart: '2023-12-25',
    accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    taxCodeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customProperties: [
      {
        groupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        valueIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        inlineValues: ['<string>']
      }
    ],
    billingEnd: '2023-12-25',
    discount: {startDate: '2023-12-25', endDate: '2023-12-25'},
    priceOverwrite: 123,
    productNameOverwrite: '<string>',
    quantity: 123,
    amortizationTemplateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    amortizationStartDate: '2023-12-25',
    amortizationEndDate: '2023-12-25'
  })
};

fetch('https://api.light.inc/v1/contracts/{contractId}/lines/{lineId}', 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.light.inc/v1/contracts/{contractId}/lines/{lineId}",
  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([
    'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'billingStart' => '2023-12-25',
    'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'taxCodeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customProperties' => [
        [
                'groupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'valueIds' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'inlineValues' => [
                                '<string>'
                ]
        ]
    ],
    'billingEnd' => '2023-12-25',
    'discount' => [
        'startDate' => '2023-12-25',
        'endDate' => '2023-12-25'
    ],
    'priceOverwrite' => 123,
    'productNameOverwrite' => '<string>',
    'quantity' => 123,
    'amortizationTemplateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'amortizationStartDate' => '2023-12-25',
    'amortizationEndDate' => '2023-12-25'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json;charset=UTF-8"
  ],
]);

$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.light.inc/v1/contracts/{contractId}/lines/{lineId}"

	payload := strings.NewReader("{\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingStart\": \"2023-12-25\",\n  \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"taxCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customProperties\": [\n    {\n      \"groupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"valueIds\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"inlineValues\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"billingEnd\": \"2023-12-25\",\n  \"discount\": {\n    \"startDate\": \"2023-12-25\",\n    \"endDate\": \"2023-12-25\"\n  },\n  \"priceOverwrite\": 123,\n  \"productNameOverwrite\": \"<string>\",\n  \"quantity\": 123,\n  \"amortizationTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amortizationStartDate\": \"2023-12-25\",\n  \"amortizationEndDate\": \"2023-12-25\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json;charset=UTF-8")

	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.light.inc/v1/contracts/{contractId}/lines/{lineId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json;charset=UTF-8")
  .body("{\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingStart\": \"2023-12-25\",\n  \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"taxCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customProperties\": [\n    {\n      \"groupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"valueIds\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"inlineValues\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"billingEnd\": \"2023-12-25\",\n  \"discount\": {\n    \"startDate\": \"2023-12-25\",\n    \"endDate\": \"2023-12-25\"\n  },\n  \"priceOverwrite\": 123,\n  \"productNameOverwrite\": \"<string>\",\n  \"quantity\": 123,\n  \"amortizationTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amortizationStartDate\": \"2023-12-25\",\n  \"amortizationEndDate\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/contracts/{contractId}/lines/{lineId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json;charset=UTF-8'
request.body = "{\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingStart\": \"2023-12-25\",\n  \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"taxCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customProperties\": [\n    {\n      \"groupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"valueIds\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"inlineValues\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"billingEnd\": \"2023-12-25\",\n  \"discount\": {\n    \"startDate\": \"2023-12-25\",\n    \"endDate\": \"2023-12-25\"\n  },\n  \"priceOverwrite\": 123,\n  \"productNameOverwrite\": \"<string>\",\n  \"quantity\": 123,\n  \"amortizationTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amortizationStartDate\": \"2023-12-25\",\n  \"amortizationEndDate\": \"2023-12-25\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billingStart": "2023-12-25",
  "billingEnd": "2023-12-25",
  "billingRecurrence": "ONE_TIME",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "avataxCode": "<string>",
  "discount": {
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "type": "PERCENTAGE"
  },
  "quantity": 123,
  "priceOverwrite": 123,
  "productNameOverwrite": "<string>",
  "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amortizationStartDate": "2023-12-25",
  "amortizationEndDate": "2023-12-25",
  "aiValueSuggestions": [
    {
      "field": "<string>",
      "fieldValues": [
        "<string>"
      ],
      "reasoning": "<string>"
    }
  ],
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupInternalName": "<string>",
      "values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "internalName": "<string>",
          "label": "<string>",
          "context": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

contractId

string<uuid>

required

lineId

string<uuid>

required

Body

application/json;charset=UTF-8

productId

string<uuid> | null

ID of the product

billingStart

string<date> | null

Date when billing starts for this line

accountId

string<uuid> | null

ID of the ledger account for this line

taxCodeId

string<uuid> | null

ID of the tax code to apply to this line

customProperties

(object | null)[] | null

List of custom properties to set on the contract or line

List of custom properties to set on the vendor. Replaces the existing set.

Show child attributes

billingRecurrence

enum<string> | null

Billing frequency for this line

ONE_TIME - The product is billed once
MONTHLY - The product is billed every month
QUARTERLY - The product is billed every three months
HALF_YEARLY - The product is billed every six months
YEARLY - The product is billed every year

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

billingEnd

string<date> | null

Date when billing ends for this line

discount

object | null

Discount to apply to this line (can be percentage or amount-based)

Show child attributes

priceOverwrite

integer<int64> | null

Custom price override in cents

productNameOverwrite

string | null

Custom product name override

quantity

number | null

Quantity of the product

amortizationTemplateId

string<uuid> | null

ID of the amortization template

amortizationStartDate

string<date> | null

Start date for amortization

amortizationEndDate

string<date> | null

End date for amortization

Response

default - application/json;charset=UTF-8

default response

string<uuid>

Unique identifier for the object

companyId

string<uuid>

ID of the company

contractId

string<uuid>

ID of the contract this line belongs to

productId

string<uuid>

ID of the product

billingStart

string<date> | null

Date when billing starts for this line

billingEnd

string<date> | null

Date when billing ends for this line

billingRecurrence

enum<string>

Billing frequency for this line

ONE_TIME - The product is billed once
MONTHLY - The product is billed every month
QUARTERLY - The product is billed every three months
HALF_YEARLY - The product is billed every six months
YEARLY - The product is billed every year

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

accountId

string<uuid> | null

ID of the account for bookkeeping

taxCodeId

string<uuid> | null

ID of the tax code

avataxCode

string | null

Avalara tax code

discount

object | null

Discount to apply to this line (can be percentage or amount-based)

Show child attributes

quantity

number | null

Quantity of the product

priceOverwrite

integer<int64> | null

Custom price override in cents

productNameOverwrite

string | null

Custom product name override

amortizationTemplateId

string<uuid> | null

ID of the amortization template

amortizationStartDate

string<date> | null

Start date for amortization

amortizationEndDate

string<date> | null

End date for amortization

aiValueSuggestions

(object | null)[] | null

AI-generated suggestions for this line

AI-generated suggestions for line item values (e.g. account, cost center, tax code).

Show child attributes

customProperties

(object | null)[] | null

List of custom properties associated with the line

Custom properties set on the vendor.

Show child attributes

createdAt

string<date-time>

Timestamp when the line was created

updatedAt

string<date-time>

Timestamp when the line was last updated

⌘I

Update contract line

curl --request PATCH \
  --url https://api.light.inc/v1/contracts/{contractId}/lines/{lineId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billingStart": "2023-12-25",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "valueIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "inlineValues": [
        "<string>"
      ]
    }
  ],
  "billingEnd": "2023-12-25",
  "discount": {
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "priceOverwrite": 123,
  "productNameOverwrite": "<string>",
  "quantity": 123,
  "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amortizationStartDate": "2023-12-25",
  "amortizationEndDate": "2023-12-25"
}
'

import requests

url = "https://api.light.inc/v1/contracts/{contractId}/lines/{lineId}"

payload = {
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billingStart": "2023-12-25",
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customProperties": [
        {
            "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "valueIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "inlineValues": ["<string>"]
        }
    ],
    "billingEnd": "2023-12-25",
    "discount": {
        "startDate": "2023-12-25",
        "endDate": "2023-12-25"
    },
    "priceOverwrite": 123,
    "productNameOverwrite": "<string>",
    "quantity": 123,
    "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amortizationStartDate": "2023-12-25",
    "amortizationEndDate": "2023-12-25"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json;charset=UTF-8"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json;charset=UTF-8'},
  body: JSON.stringify({
    productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billingStart: '2023-12-25',
    accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    taxCodeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customProperties: [
      {
        groupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        valueIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        inlineValues: ['<string>']
      }
    ],
    billingEnd: '2023-12-25',
    discount: {startDate: '2023-12-25', endDate: '2023-12-25'},
    priceOverwrite: 123,
    productNameOverwrite: '<string>',
    quantity: 123,
    amortizationTemplateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    amortizationStartDate: '2023-12-25',
    amortizationEndDate: '2023-12-25'
  })
};

fetch('https://api.light.inc/v1/contracts/{contractId}/lines/{lineId}', 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.light.inc/v1/contracts/{contractId}/lines/{lineId}",
  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([
    'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'billingStart' => '2023-12-25',
    'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'taxCodeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customProperties' => [
        [
                'groupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'valueIds' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'inlineValues' => [
                                '<string>'
                ]
        ]
    ],
    'billingEnd' => '2023-12-25',
    'discount' => [
        'startDate' => '2023-12-25',
        'endDate' => '2023-12-25'
    ],
    'priceOverwrite' => 123,
    'productNameOverwrite' => '<string>',
    'quantity' => 123,
    'amortizationTemplateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'amortizationStartDate' => '2023-12-25',
    'amortizationEndDate' => '2023-12-25'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json;charset=UTF-8"
  ],
]);

$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.light.inc/v1/contracts/{contractId}/lines/{lineId}"

	payload := strings.NewReader("{\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingStart\": \"2023-12-25\",\n  \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"taxCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customProperties\": [\n    {\n      \"groupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"valueIds\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"inlineValues\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"billingEnd\": \"2023-12-25\",\n  \"discount\": {\n    \"startDate\": \"2023-12-25\",\n    \"endDate\": \"2023-12-25\"\n  },\n  \"priceOverwrite\": 123,\n  \"productNameOverwrite\": \"<string>\",\n  \"quantity\": 123,\n  \"amortizationTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amortizationStartDate\": \"2023-12-25\",\n  \"amortizationEndDate\": \"2023-12-25\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json;charset=UTF-8")

	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.light.inc/v1/contracts/{contractId}/lines/{lineId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json;charset=UTF-8")
  .body("{\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingStart\": \"2023-12-25\",\n  \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"taxCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customProperties\": [\n    {\n      \"groupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"valueIds\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"inlineValues\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"billingEnd\": \"2023-12-25\",\n  \"discount\": {\n    \"startDate\": \"2023-12-25\",\n    \"endDate\": \"2023-12-25\"\n  },\n  \"priceOverwrite\": 123,\n  \"productNameOverwrite\": \"<string>\",\n  \"quantity\": 123,\n  \"amortizationTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amortizationStartDate\": \"2023-12-25\",\n  \"amortizationEndDate\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/contracts/{contractId}/lines/{lineId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json;charset=UTF-8'
request.body = "{\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingStart\": \"2023-12-25\",\n  \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"taxCodeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customProperties\": [\n    {\n      \"groupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"valueIds\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"inlineValues\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"billingEnd\": \"2023-12-25\",\n  \"discount\": {\n    \"startDate\": \"2023-12-25\",\n    \"endDate\": \"2023-12-25\"\n  },\n  \"priceOverwrite\": 123,\n  \"productNameOverwrite\": \"<string>\",\n  \"quantity\": 123,\n  \"amortizationTemplateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"amortizationStartDate\": \"2023-12-25\",\n  \"amortizationEndDate\": \"2023-12-25\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billingStart": "2023-12-25",
  "billingEnd": "2023-12-25",
  "billingRecurrence": "ONE_TIME",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "avataxCode": "<string>",
  "discount": {
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "type": "PERCENTAGE"
  },
  "quantity": 123,
  "priceOverwrite": 123,
  "productNameOverwrite": "<string>",
  "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amortizationStartDate": "2023-12-25",
  "amortizationEndDate": "2023-12-25",
  "aiValueSuggestions": [
    {
      "field": "<string>",
      "fieldValues": [
        "<string>"
      ],
      "reasoning": "<string>"
    }
  ],
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupInternalName": "<string>",
      "values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "internalName": "<string>",
          "label": "<string>",
          "context": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Accounting Documents

Attachments

Authorization

Bank Accounts

Card Balance Accounts

Card Customers

Card Transactions

Cards

Companies

Contracts

Credit Notes

Custom Properties

Customer Credits

Customers

Entities

Exchange

Expenses

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

Ledger Transactions

Ledger accounts

Products

Purchase Orders

User Comments

Users

Vendors

Authorizations

Path Parameters

Body

Response