v1 - Credit Notes

Update credit note line

Updates a line item on a credit note in draft status. Fields sent as null clear the value; omitted fields remain unchanged.

patch/v1/credit-notes/{creditNoteId}/lines/{lineId}

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

creditNoteIdstring uuid required
lineIdstring uuid required

Request body

descriptionstring nullable

Line description

ledgerTaxIdstring uuid nullable

ID of the tax code

ledgerAccountIdstring uuid nullable

ID of the ledger account

accrualTemplateIdstring uuid nullable

ID of the accrual template

accrualStartDatestring date nullable

Start date for accrual

accrualEndDatestring date nullable

End date for accrual

Response

default response

idstring uuid

Unique identifier for the object

companyIdstring uuid

ID of the company

creditNoteIdstring uuid

ID of the credit note this line belongs to

descriptionstring nullable

Description of the credit note line item

ledgerTaxIdstring uuid nullable

ID of the tax code

ledgerAccountIdstring uuid nullable

ID of the ledger account

costCenterIdstring uuid nullable

ID of the cost center

createdAtstring date-time

Timestamp when the credit note line item was created

updatedAtstring date-time

Timestamp when the credit note line item 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

accrualDefaultDurationinteger nullable

Default duration for accrual in months

Changes

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