LIlight
v1 - Contracts

Create contract line

Creates a new contract line item

post/v1/contracts/{contractId}/lines

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

contractIdstring uuid required

Headers

X-Idempotency-Keystring

Request body

productIdstring uuid

ID of the product

billingStartstring date nullable

Date when billing starts for this line

billingEndstring date nullable

Date when billing ends for this line

billingRecurrence'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' nullable

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.

accountIdstring uuid nullable

ID of the ledger account for this line

taxCodeIdstring uuid nullable

ID of the tax code to apply to this line

avataxCodestring nullable

Avalara tax code. Used when the contract tax engine is AVATAX

quantitynumber nullable

Quantity of the product

priceOverwriteinteger nullable

Custom price override in cents

productNameOverwritestring nullable

Custom product name override

amortizationTemplateIdstring uuid nullable

ID of the amortization template

amortizationStartDatestring date nullable

Start date for amortization

amortizationEndDatestring date nullable

End date for amortization

Response

default response

idstring uuid

Unique identifier for the object

companyIdstring uuid

ID of the company

contractIdstring uuid

ID of the contract this line belongs to

productIdstring uuid

ID of the product

billingStartstring date nullable

Date when billing starts for this line

billingEndstring date nullable

Date when billing ends for this line

billingRecurrence'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY'

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.

accountIdstring uuid nullable

ID of the account for bookkeeping

taxCodeIdstring uuid nullable

ID of the tax code

avataxCodestring nullable

Avalara tax code

quantitynumber nullable

Quantity of the product

priceOverwriteinteger nullable

Custom price override in cents

productNameOverwritestring nullable

Custom product name override

amortizationTemplateIdstring uuid nullable

ID of the amortization template

amortizationStartDatestring date nullable

Start date for amortization

amortizationEndDatestring date nullable

End date for amortization

createdAtstring date-time

Timestamp when the line was created

updatedAtstring date-time

Timestamp when the line was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.