Skip to main content
PATCH
Update customer credit line

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

customerCreditId
string<uuid>
required
lineId
string<uuid>
required

Body

application/json;charset=UTF-8
productId
string<uuid> | null

ID of the product

quantity
number | null

Quantity of the product

customProperties
(object | null)[] | null

List of custom properties associated with the line

List of custom properties to set on the vendor.

netTransactionAmount
object
grossTransactionAmount
object
taxTransactionAmount
object
description
string | null

Description of the customer credit line item

ledgerTaxId
string<uuid> | null

ID of the tax code

ledgerAccountId
string<uuid> | null

ID of the ledger account

avataxCode
string | null

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

accrualTemplateId
string<uuid> | null

ID of the accrual template

accrualStartDate
string<date> | null

Start date for accrual

accrualEndDate
string<date> | null

End date for accrual

Response

default - application/json;charset=UTF-8

default response

id
string<uuid>

Unique identifier for the object

companyId
string<uuid>

ID of the company

customerCreditId
string<uuid>

ID of the customer credit this line belongs to

grossTransactionAmount
object
netTransactionAmount
object
description
string | null

Description of the customer credit line item

ledgerTaxId
string<uuid> | null

ID of the tax code

taxTransactionAmount
object
ledgerAccountId
string<uuid> | null

ID of the ledger account

avataxCode
string | null

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

productId
string<uuid>

ID of the product

quantity
number

Quantity of the product

createdAt
string<date-time>

Timestamp when the customer credit was created

updatedAt
string<date-time>

Timestamp when the customer credit was last updated

accrualTemplateId
string<uuid> | null

ID of the accrual template

accrualStartDate
string<date> | null

Start date for accrual

accrualEndDate
string<date> | null

End date for accrual

accrualDefaultDuration
integer<int32> | null

Default duration for accrual in months