Light APIv1.0.0

API / Reference / Customer Credits

Create customer credit line

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

Creates a new line for the given customer credit

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

Request body

application/json;charset=UTF-8

  • productId string · uuid

    ID of the product

  • quantity number

    Quantity of the product

  • netTransactionAmount object

    • amount integer · int64

    • dcSign string

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

      One of D C

  • grossTransactionAmount object

    • amount integer · int64

    • dcSign string

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

      One of D C

  • taxTransactionAmount object

    • amount integer · int64

    • 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

  • customProperties array of object

    List of custom properties associated with the line

    • groupId string · uuid

    • valueIds array of string · uuid

    • inlineValues array of string

  • 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

    • dcSign string

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

      One of D C

  • netTransactionAmount object

    • amount integer · int64

    • 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

    • 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