v1 - Invoice Receivables

Create line

Creates a new invoice line item

post/v1/invoice-receivables/{invoiceReceivableId}/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

invoiceReceivableIdstring uuid required

Request body

productIdstring uuid

ID of the product

quantitynumber

Quantity of the product

taxCodeIdstring uuid nullable

ID of the tax code to apply to this line

accountIdstring uuid nullable

ID of the ledger account for this line

priceOverwriteinteger nullable

Price overwrite in smallest denomination. If not provided, the product's default price will be used

productNameOverwritestring nullable

Product name overwrite. If not provided, the product's default name will be used

taxAmountOverwriteinteger nullable

Tax 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.

avataxCodestring nullable

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

billingStartstring date nullable

Start of the billing period for this line

billingEndstring date nullable

End of the billing period for this line

accrualTemplateIdstring uuid nullable

ID of the accrual/amortization template to apply to this line

accrualStartDatestring date nullable

Start date for accrual/amortization

accrualEndDatestring date nullable

End date for accrual/amortization

Response

default response

idstring uuid

Unique identifier for the object

companyIdstring uuid

ID of the company

invoiceReceivableIdstring uuid

ID of the invoice receivable this line belongs to

productIdstring uuid

ID of the product

quantitynumber

Quantity of the product

taxCodeIdstring uuid nullable

ID of the tax code

accountIdstring uuid nullable

ID of the ledger account

discountAmountinteger nullable

Discount amount in smallest denomination

netAmountinteger nullable

Net amount in smallest denomination after discount but before tax

taxAmountinteger nullable

Tax amount in smallest denomination

avataxCodestring nullable

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

billingStartstring date nullable

Start of the billing period

billingEndstring date nullable

End of the billing period

priceOverwriteinteger nullable

Custom product price in smallest denomination. This overrides the default product's price

productNameOverwritestring nullable

Custom product name. This overrides the default product's name

createdAtstring date-time

Timestamp when the line was created

updatedAtstring date-time

Timestamp when the line was last updated

accrualTemplateIdstring uuid nullable

ID of the accrual template

accrualStartDatestring date nullable

Start date for accrual

accrualEndDatestring date nullable

End date for accrual

Changes

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