Get accounting release template

GET

accounting-release-templates

{templateId}

curl --request GET \
  --url https://api.light.inc/v1/accounting-release-templates/{templateId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/accounting-release-templates/{templateId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/accounting-release-templates/{templateId}', 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/accounting-release-templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.light.inc/v1/accounting-release-templates/{templateId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/accounting-release-templates/{templateId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "method": "STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT",
  "type": "AR",
  "deferralAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "additionsAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "disposalAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "profitAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lossAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "initialAmountPercentage": 123,
  "residualAmountPercentage": 123,
  "residualAmount": 123,
  "reducingRate": 123,
  "accumulatePastReleasesEnabled": true,
  "defaultDuration": 123,
  "context": "<string>",
  "status": "ACTIVE",
  "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

templateId

string<uuid>

required

Response

default - application/json;charset=UTF-8

default response

string<uuid>

Unique identifier for the object

companyId

string<uuid>

ID of the company

createdBy

string<uuid>

ID of the user who created the template

name

string

Name of the template

method

enum<string>

How the amount is spread across the release schedule

STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT - An equal amount each period, with the first and last periods adjusted for partial months
REDUCING_BALANCE - A fixed fraction of the remaining balance each period, so the amount declines over time

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

Available options:

STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT,

REDUCING_BALANCE

type

enum<string>

The kind of document or asset this template applies to. Fixed at creation

AR - Accounts receivable. Releases deferred revenue on invoice receivables
AP - Accounts payable. Releases prepaid expenses on invoice payables, credit notes and card transactions
JE - Journal entries
CONTRACT - Contracts. Releases deferred revenue over the contract term
FIXED_ASSET - Fixed assets. Depreciates a capitalised asset over its useful life

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

Available options:

AR,

AP,

JE,

CONTRACT,

FIXED_ASSET

deferralAccountId

string<uuid>

ID of the ledger account holding the not-yet-released balance. Fixed at creation

contractAccountId

string<uuid> | null

ID of the ledger account used when the template is applied to a contract. Fixed at creation

additionsAccountId

string<uuid> | null

ID of the ledger account credited or debited by each generated release. Falls back to the deferral account when not set. Fixed at creation

disposalAccountId

string<uuid> | null

ID of the ledger account used when a fixed asset is disposed of. Fixed at creation

profitAccountId

string<uuid> | null

ID of the ledger account for a gain on disposal. Fixed at creation

lossAccountId

string<uuid> | null

ID of the ledger account for a loss on disposal. Fixed at creation

initialAmountPercentage

number | null

Fraction of the amount released in the first period, as a decimal between 0 and 1

residualAmountPercentage

number | null

Fraction of the amount left unreleased at the end of the schedule, as a decimal between 0 and 1

residualAmount

integer<int64> | null

Absolute amount in cents left unreleased at the end of the schedule. Only for the REDUCING_BALANCE method, and mutually exclusive with reducingRate

reducingRate

number | null

Fraction of the remaining balance released each period, as a decimal between 0 and 1. Only for the REDUCING_BALANCE method, and mutually exclusive with residualAmount

accumulatePastReleasesEnabled

boolean

Whether releases for periods that have already passed are posted as a single catch-up amount in the current period

defaultDuration

integer<int32> | null

Default number of months the release schedule runs for. Can be overridden per document

context

string | null

Free-text notes on the template

status

enum<string>

Template status

ACTIVE - The template can be assigned to new documents and contracts
ARCHIVED - The template is archived and can no longer be assigned. Existing releases are unaffected

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

Available options:

ACTIVE,

ARCHIVED

createdAt

string<date-time>

Timestamp when the template was created

updatedAt

string<date-time>

Timestamp when the template was last updated

⌘I

Get accounting release template

curl --request GET \
  --url https://api.light.inc/v1/accounting-release-templates/{templateId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/accounting-release-templates/{templateId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/accounting-release-templates/{templateId}', 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/accounting-release-templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.light.inc/v1/accounting-release-templates/{templateId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/accounting-release-templates/{templateId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "method": "STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT",
  "type": "AR",
  "deferralAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "additionsAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "disposalAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "profitAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lossAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "initialAmountPercentage": 123,
  "residualAmountPercentage": 123,
  "residualAmount": 123,
  "reducingRate": 123,
  "accumulatePastReleasesEnabled": true,
  "defaultDuration": 123,
  "context": "<string>",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Accounting Documents

Accounting Release Templates

Attachments

Authorization

Bank Accounts

Card Balance Accounts

Card Customers

Card Transactions

Cards

Companies

Contracts

Credit Notes

Custom Properties

Customer Credits

Customers

Entities

Exchange

Expenses

General Ledger Summary

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

Ledger Transactions

Ledger accounts

Products

Purchase Orders

Reimbursement categories

User Comments

Users

Vendors

Authorizations

Path Parameters

Response