LIlight
v1 - Credit Notes

Get credit note

Returns a credit note by ID

get/v1/credit-notes/{creditNoteId}

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

creditNoteIdstring uuid required

Response

default response

idstring uuid

Unique identifier for the object

companyIdstring uuid

ID of the company

companyEntityIdstring uuid nullable

ID of the entity

amountinteger nullable

Total credit note amount in cents

businessPartnerNamestring nullable

Name of the vendor

businessPartnerIdstring uuid nullable

ID of the vendor

status'DRAFT' | 'APPROVAL_PENDING' | 'APPROVED' | 'POSTED' | 'PARTIALLY_CLEARED' | 'CLEARED' | 'ARCHIVED'

Status of the credit note

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

descriptionstring nullable

Description of the credit note

currencystring
postingDatestring date nullable

Date when the credit note should be posted to the ledger

documentDatestring date nullable

Date when the credit note was issued

valuationDatestring date nullable

Date used when applying foreign exchange rate

areLinesWithTaxboolean

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

createdAtstring date-time

Timestamp when the credit note was created

updatedAtstring date-time

Timestamp when the credit note was last updated

updatedBystring uuid nullable

ID of the user who last updated the credit note

localCurrencyFxRatenumber nullable

FX rate applied for the ledger's local currency

groupCurrencyFxRatenumber nullable

FX rate applied for the ledger's group currency

senderEmailstring nullable

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

documentNamestring nullable

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

Example response

{
  "currency": "USD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.