Light APIv1.0.0

API / Reference / Credit Notes

Post credit note

POST https://api.light.inc/v1/credit-notes/{creditNoteId}/post

Posts the credit note to the ledger. The credit note must be in draft status with at least one line item. A valid companyEntityId, businessPartnerId, and currency are required. After posting, the credit note can be linked to invoice payables for balance clearing.

Beyond the listed prerequisites: the company must use Light's ledger (CREDIT_NOTE_CANNOT_BE_POSTED), amount must be set and non-zero and equal the sum of the lines' gross amounts (CREDIT_NOTE_VALIDATION_ERROR), the total must be a credit (CREDIT_NOTE_NEGATIVE_TOTAL_AMOUNT), and every line needs ledgerAccountId (CREDIT_NOTE_MISSING_FIELD). businessPartnerId is not actually checked here; it is required to link. The posting needs an open period and a payables control account for the entity. If the company auto-allocates credits, the response may already be PARTIALLY_CLEARED or CLEARED.

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

  • creditNoteId string · uuidrequired

Response

  • id string · uuid

    Unique identifier for the object

  • companyId string · uuid

    ID of the company

  • companyEntityId string · uuid

    ID of the entity

  • amount integer · int64

    Total credit note amount in cents

  • businessPartnerName string

    Name of the vendor

  • businessPartnerId string · uuid

    ID of the vendor

  • status string

    Status of the credit note

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

    One of DRAFT APPROVAL_PENDING APPROVED POSTED PARTIALLY_CLEARED CLEARED ARCHIVED

  • description string

    Description of the credit note

  • currency string

  • postingDate string · date

    Date when the credit note should be posted to the ledger

  • documentDate string · date

    Date when the credit note was issued

  • valuationDate string · date

    Date used when applying foreign exchange rate

  • areLinesWithTax boolean

    Whether the credit note line amount is inclusive of tax or not. True means tax is already included in the line amount and will not be added on top, false means tax will be added on top of the line amount

  • lines array of object

    List of credit note line items

    • id string · uuid

      Unique identifier for the object

    • companyId string · uuid

      ID of the company

    • creditNoteId string · uuid

      ID of the credit note 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 credit note 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

    • costCenterId string · uuid

      ID of the cost center

    • createdAt string · date-time

      Timestamp when the credit note line item was created

    • updatedAt string · date-time

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

  • createdAt string · date-time

    Timestamp when the credit note was created

  • updatedAt string · date-time

    Timestamp when the credit note was last updated

  • updatedBy string · uuid

    ID of the user who last updated the credit note

  • localCurrencyFxRate number

    FX rate applied for the ledger's local currency

    Echoes the override you sent; null when Light applies its own rate, not the rate that was applied.

  • groupCurrencyFxRate number

    FX rate applied for the ledger's group currency

    Echoes the override you sent; null when Light applies its own rate, not the rate that was applied.

  • senderEmail string

    The email of the user who sent the document that this credit note was created from

  • documentName string

    The name of the document that this credit note was created from