Light APIv1.0.0

API / Reference / Customer Credits

Update customer credit line

PATCH https://api.light.inc/v1/customer-credits/{customerCreditId}/lines/{lineId}

Updates the given customer credit line

Only while the credit is DRAFT. null clears the amounts, description, ledgerTaxId, ledgerAccountId, avataxCode and the accrual fields, but leaves productId and quantity unchanged. Unknown line: CUSTOMER_CREDIT_LINE_NOT_FOUND.

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

  • customerCreditId string · uuidrequired

  • lineId string · uuidrequired

Request body

application/json;charset=UTF-8

  • productId string · uuid

    ID of the product

  • quantity number

    Quantity of the product

  • customProperties array of object

    List of custom properties associated with the line

    • groupId string · uuid

    • valueIds array of string · uuid

      Catalogue value ids for this group. Required; send [] (with an empty inlineValues) to clear the group. SINGLE_SELECT and MULTI_SELECT groups accept nothing else. See Custom properties on writes.

    • inlineValues array of string

      Literal values for TEXT, NUMERIC, BOOLEAN and DATE groups, as strings (yyyy-MM-dd for dates). Rejected on select groups with CUSTOM_PROPERTY_VALUE_TYPE_MISMATCH. See Custom properties on writes.

  • netTransactionAmount object

    • amount integer · int64

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of D C

  • grossTransactionAmount object

    • amount integer · int64

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of D C

  • taxTransactionAmount object

    • amount integer · int64

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of D C

  • description string

    Description of the customer credit line item

  • ledgerTaxId string · uuid

    ID of the tax code

  • ledgerAccountId string · uuid

    ID of the ledger account

  • avataxCode string

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

  • accrualTemplateId string · uuid

    ID of the accrual template

  • accrualStartDate string · date

    Start date for accrual

  • accrualEndDate string · date

    End date for accrual

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

    • amount integer · int64

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of D C

  • netTransactionAmount object

    • amount integer · int64

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of D C

  • description string

    Description of the customer credit line item

  • ledgerTaxId string · uuid

    ID of the tax code

  • taxTransactionAmount object

    • amount integer · int64

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of D C

  • ledgerAccountId string · uuid

    ID of the ledger account

  • avataxCode string

    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

    ID of the accrual template

  • accrualStartDate string · date

    Start date for accrual

  • accrualEndDate string · date

    End date for accrual

  • accrualDefaultDuration integer · int32

    Default duration for accrual in months