v1 - Customer Credits

Update customer credit line

Updates the given customer credit line

patch/v1/customer-credits/{customerCreditId}/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

customerCreditIdstring uuid required

lineIdstring uuid required

Request body

productIdstring uuid nullable

ID of the product

quantitynumber nullable

Quantity of the product

descriptionstring nullable

Description of the customer credit line item

ledgerTaxIdstring uuid nullable

ID of the tax code

ledgerAccountIdstring uuid nullable

ID of the ledger account

avataxCodestring nullable

Avalara tax code. Used when the customer credit tax engine is AVATAX

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

customerCreditIdstring uuid

ID of the customer credit this line belongs to

descriptionstring nullable

Description of the customer credit line item

ledgerTaxIdstring uuid nullable

ID of the tax code

ledgerAccountIdstring uuid nullable

ID of the ledger account

avataxCodestring nullable

Avalara tax code. Used when the customer credit tax engine is AVATAX

productIdstring uuid

ID of the product

quantitynumber

Quantity of the product

createdAtstring date-time

Timestamp when the customer credit was created

updatedAtstring date-time

Timestamp when the customer credit 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.