Get invoice payable line item

GET

invoice-payables

{invoicePayableId}

line-items

{lineItemId}

Get invoice payable line item

curl --request GET \
  --url https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId}"

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/invoice-payables/{invoicePayableId}/line-items/{lineItemId}', 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/invoice-payables/{invoicePayableId}/line-items/{lineItemId}",
  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/invoice-payables/{invoicePayableId}/line-items/{lineItemId}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId}")

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",
  "invoicePayableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "amount": 123,
  "netAmount": 123,
  "description": "<string>",
  "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxAmount": 123,
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amortizationStartDate": "2023-12-25",
  "amortizationEndDate": "2023-12-25",
  "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customPropertiesOld": {
    "items": {}
  },
  "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

invoicePayableId

string<uuid>

required

lineItemId

string<uuid>

required

Response

default - application/json;charset=UTF-8

default response

string<uuid>

ID of the invoice payable line item.

invoicePayableId

string<uuid>

ID of the invoice payable this line item belongs to.

type

enum<string>

Type of the invoice payable line item (vendor invoice or reimbursement).

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

Available options:

REIMBURSEMENT,

VENDOR_INVOICE

metadata

object

Metadata for the invoice payable line item (ERP-specific fields and context).

Show child attributes

amount

integer<int64> | null

Amount in cents, including tax. When lineItemsIncludeTax is true, amount represents the full tax-inclusive amount for this line.

netAmount

integer<int64> | null

Net line amount in cents, excluding tax. When lineItemsIncludeTax is false, netAmount represents the base amount on which tax is calculated.

description

string | null

Description of this invoice payable line item.

taxCodeId

string<uuid> | null

ID of the tax code applied to this line item.

taxAmount

integer<int64> | null

Tax amount in cents for this line item.

accountId

string<uuid> | null

ID of the ledger account used to book this line item.

costCenterId

string<uuid> | null

ID of the cost center associated with this line item, if applicable.

amortizationStartDate

string<date> | null

Start date for amortization of this line item.

amortizationEndDate

string<date> | null

End date for amortization of this line item.

amortizationTemplateId

string<uuid> | null

ID of the amortization template to use for this line item within Light Ledger.

customPropertiesOld

object | null

Legacy container for custom properties on this line item (deprecated/old format).

Show child attributes

aiValueSuggestions

(object | null)[] | null

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

Show child attributes

customProperties

(object | null)[] | null

Custom properties set on this invoice payable line item.

Custom properties set on the vendor.

Show child attributes

createdAt

string<date-time>

Timestamp when this invoice payable line item was created.

updatedAt

string<date-time>

Timestamp when this invoice payable line item was last updated.

Update invoice payable line itemUpdates an invoice payable line item

⌘I

Get invoice payable line item

curl --request GET \
  --url https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId}"

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/invoice-payables/{invoicePayableId}/line-items/{lineItemId}', 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/invoice-payables/{invoicePayableId}/line-items/{lineItemId}",
  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/invoice-payables/{invoicePayableId}/line-items/{lineItemId}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/invoice-payables/{invoicePayableId}/line-items/{lineItemId}")

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",
  "invoicePayableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "amount": 123,
  "netAmount": 123,
  "description": "<string>",
  "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxAmount": 123,
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amortizationStartDate": "2023-12-25",
  "amortizationEndDate": "2023-12-25",
  "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customPropertiesOld": {
    "items": {}
  },
  "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

Response