Create line
https://api.light.inc/v1/invoice-receivables/{invoiceReceivableId}/lines
Creates a new invoice line item
Permission: invoices:update (AR_CLERK, COMPANY_ADMIN, CONTROLLER)
Authorization
Send one of these on every request. See Authentication for how to get credentials.
- API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
- Bearer token
Path parameters
-
invoiceReceivableIdstring · uuidrequired
Request body
application/json;charset=UTF-8
-
productIdstring · uuidID of the product
-
quantitynumberQuantity of the product
-
taxCodeIdstring · uuidID of the tax code to apply to this line
-
accountIdstring · uuidID of the ledger account for this line
-
discountobjectDiscount to apply to this line (can be percentage or amount-based)
Note
Optional discount on the line, by percentage or by amount.
-
typestring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
PERCENTAGEAMOUNT
-
-
priceOverwriteinteger · int64Price overwrite in smallest denomination. If not provided, the product's default price will be used
-
productNameOverwritestringProduct name overwrite. If not provided, the product's default name will be used
-
taxAmountOverwriteinteger · int64Tax amount override in smallest denomination. Bypasses tax calculation and sets the exact tax amount for this line.
Requirements: The line must have a valid amount (product price or priceOverwrite must be set).
The taxAmount field in the response will reflect this override value.
Amounts use smallest denomination. Examples: GBP 42.15 = 4215, JPY 12345 = 12345, BHD 7.321 = 7321.
-
avataxCodestringAvalara tax code. Used when the invoice tax engine is AVATAX
-
billingStartstring · dateStart of the billing period for this line
-
billingEndstring · dateEnd of the billing period for this line
-
accrualTemplateIdstring · uuidID of the accrual/amortization template to apply to this line
-
accrualStartDatestring · dateStart date for accrual/amortization
-
accrualEndDatestring · dateEnd date for accrual/amortization
-
customPropertiesarray of objectList of custom properties to set on the invoice or line
-
groupIdstring · uuidID of the custom property group.
-
valueIdsarray of string · uuidIDs of the selected custom property values. It behaves as a PUT operation, so if empty the existing ones will be effectively deleted.
Note
Catalog value ids for this group. Required; send
[](with an emptyinlineValues) to clear the group.SINGLE_SELECTandMULTI_SELECTgroups accept nothing else. See Custom properties on writes. -
inlineValuesarray of stringInline custom property values (used for TEXT/NUMERIC/DATE/etc. groups). It behaves as a PUT operation, so if empty or null the existing ones will be effectively deleted.
Note
Literal values for
TEXT,NUMERIC,BOOLEANandDATEgroups, as strings (yyyy-MM-ddfor dates). Rejected on select groups withCUSTOM_PROPERTY_VALUE_TYPE_MISMATCH. See Custom properties on writes. -
attachmentIdsarray of string · uuidIDs of attachments to assign to an ATTACHMENT property on an existing vendor. Send valueIds as an empty list. Only one active attachment belonging to the vendor can be assigned per group. Clear the current file before assigning another. Create the vendor first, request POST /v1/attachments/upload-url with its resourceId, upload the file to the returned URL, then POST /v1/attachments with documentKey set to the returned key. Use the created attachment's id here in PUT or PATCH /v1/vendors/{vendorId}. A PATCH that sends only customProperties and changes only their files works in every vendor status. customProperties replaces the whole set, so send the vendor's other properties as they are, by valueIds. A PUT, or a PATCH that changes anything else, returns 400 while the vendor is IN_REVIEW, ONBOARDING or INACTIVE. An empty list clears the assignment without archiving the file.
-
Response
-
idstring · uuidUnique identifier for the object
-
companyIdstring · uuidID of the company
-
invoiceReceivableIdstring · uuidID of the invoice receivable this line belongs to
-
productIdstring · uuidID of the product
-
quantitynumberQuantity of the product
-
taxCodeIdstring · uuidID of the tax code
-
taxRatenumberCurrent nominal VAT rate of the assigned Light tax code as a fraction: 0.25 is 25%. Tax-code edits change this value, including on issued documents, without changing stored line amounts. This is not tax divided by net: posting rules, rounding and overrides can change that ratio. Excludes withholding. Null for an exempt tax code or when no Light tax code is assigned
-
taxCodestringCurrent short code of the assigned Light tax code. Null when no Light tax code is assigned
-
taxNamestringCurrent display name of the assigned Light tax code. Null when the name or tax code is absent
-
withholdingsarray of objectWithholdings recorded on this line. Later tax-code configuration edits do not change these snapshots. Empty when the line has none. These do not reduce the VAT or gross amounts
-
ratenumberRecorded withholding rate as a fraction: 0.20 is 20%
-
taxableBasePctnumberPercentage of the line net amount subject to withholding: 100 means the full net amount
-
amountinteger · int64Recorded withholding amount in the document currency's smallest denomination, using the same sign as the line's net amount. Negative for a reversing line
-
-
accountIdstring · uuidID of the ledger account
-
discountobjectDiscount to apply to this line (can be percentage or amount-based)
Note
Discount applied to the line, by percentage or by amount.
-
typestring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
PERCENTAGEAMOUNT
-
-
discountAmountinteger · int64Discount amount in smallest denomination
-
netAmountinteger · int64Net amount in smallest denomination after discount but before tax
Note
Signed: credit-side lines are positive, debit-side lines (a negative
priceOverwrite) are negative.discountAmountis unsigned. -
taxAmountinteger · int64Tax amount in smallest denomination
Note
Signed the same way as
netAmount: negative on a debit-side line. -
avataxCodestringAvalara tax code. Used when the invoice tax engine is
AVATAX -
billingStartstring · dateStart of the billing period
-
billingEndstring · dateEnd of the billing period
-
priceOverwriteinteger · int64Custom product price in smallest denomination. This overrides the default product's price
-
productNameOverwritestringCustom product name. This overrides the default product's name
-
createdAtstring · date-timeTimestamp when the line was created
-
updatedAtstring · date-timeTimestamp when the line was last updated
-
accrualTemplateIdstring · uuidID of the accrual template
-
accrualStartDatestring · dateStart date for accrual
-
accrualEndDatestring · dateEnd date for accrual
-
customPropertiesarray of objectList of custom properties associated with the line
-
groupIdstring · uuidID of the custom property group
-
groupInternalNamestringInternal name of the custom property group
-
valuesarray of objectList of values. Note that this will be a single value unless the group input type supports multiple values
-
idstring · uuidUnique identifier for the object
-
groupIdstring · uuidID of the custom property group
-
groupInternalNamestringInternal name of the custom property group
-
companyIdstring · uuidID of the company
-
internalNamestringInternal name of the custom property value
-
labelstringLabel of the custom property value
-
contextstringContext/description of the custom property value
-
createdAtstring · date-timeTimestamp when the custom property value was created
-
updatedAtstring · date-timeTimestamp when the custom property value was last updated
-
attachmentobjectFile assigned to an ATTACHMENT property. Null for other property types.
-
idstring · uuidAttachment ID. Use GET /v1/attachments/{attachmentId}/document to download the file.
-
fileNamestring -
contentTypestring
-
-
-