LIlight
v1 - Invoice Receivables

Reverse invoice payment

Reverses a clearing applied to an invoice receivable — either a bank payment (BP) or a customer credit (CC) — identified by its accounting document ID. Use the List invoice payments endpoint to obtain the accountingDocumentId and type of the clearing to reverse. Reversing removes the clearing's effect from the ledger and transitions the invoice back to OPEN or PARTIALLY_PAID depending on the remaining outstanding balance. Optionally set shouldArchiveClearingDocument to also archive the underlying bank payment or customer credit.

post/v1/invoice-receivables/{invoiceReceivableId}/reverse-clearing

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

invoiceReceivableIdstring uuid required

Request body

clearingAccountingDocumentIdstring uuid

ID of the clearing accounting document to reverse — the bank payment or customer credit that was applied to this invoice receivable. Obtain it from the accountingDocumentId of an entry returned by the List invoice payments endpoint.

clearingType'BP' | 'CC'

Type of the clearing being reversed: BP for a bank payment or CC for a customer credit. Matches the type of the corresponding entry returned by the List invoice payments endpoint.

  • BP - Bank payment
  • CC - Customer credit

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

shouldArchiveClearingDocumentboolean

Whether to also archive the underlying clearing document (bank payment or customer credit) after reversing it.

Response

default response

idstring uuid

Unique identifier for the object

companyIdstring uuid

ID of the company

contractIdstring uuid nullable

ID of the contract, if this is invoice is linked to a contract

companyEntityIdstring uuid nullable

ID of the entity

amountinteger

Total invoice amount in smallest denomination, with discounts and tax applied

paymentType'AIRWALLEX' | 'BANK_TRANSFER' | 'DIRECT_DEBIT' | 'STRIPE' nullable

Payment type for the invoice

  • AIRWALLEX - Payment via Airwallex. A payment link will be displayed on the invoice
  • BANK_TRANSFER - Payment via bank transfer. Bank information will be displayed on the invoice
  • DIRECT_DEBIT - Payment via direct debit. A notice that the amount will be collected automatically will be displayed on the invoice
  • STRIPE - Payment via Stripe. A payment link will be sent to the customer

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

payeeBankAccountIdstring uuid nullable

ID of the bank account where money should be sent to

invoiceDatestring date nullable

Date the invoice was issued

effectiveInvoiceDatestring date

The invoice date shown to customers; falls back to the posting date when the invoice date is not set

postingDatestring date

Date the invoice is posted to the ledger (drives GL, VAT and revenue recognition)

dueDatestring date nullable

Date the invoice payment is due

netTermsinteger nullable

Number of days from the invoice date to when the invoice is due. Updating this field will automatically set the invoice due date

customerIdstring uuid nullable

ID of the customer

invoiceTemplateIdstring uuid nullable

ID of the invoice template

invoiceTemplateAdditionalTextstring nullable

Text that will added to the additional text section of the invoice template

invoiceNumberstring nullable

Invoice number. This number is guaranteed to be unique and sequential per entity. By default Light will generate this number when the invoice is opened, but you can provide your own custom number when creating or updating a draft invoice

type'STANDARD' | 'SELF_BILLED'

Who raised the invoice

  • STANDARD - The company raised the invoice
  • SELF_BILLED - The customer issued the invoice on the company's behalf and sent it in

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

state'CREATED' | 'DRAFT' | 'OPEN_IN_PROGRESS' | 'OPEN' | 'PAYMENT_PENDING' | 'PARTIALLY_PAID' | 'PAID' | 'REVERSED' | 'ARCHIVED'

The invoice state

  • CREATED - The invoice document was received and is waiting to be parsed. Next valid state is DRAFT
  • DRAFT - The invoice is in draft and can be modified. Next valid states are OPEN_IN_PROGRESS or ARCHIVED
  • OPEN_IN_PROGRESS - The invoice is being opened. Next valid state is OPEN or DRAFT
  • OPEN - The invoice is open. Next valid states are PAYMENT_PENDING, PARTIALLY_PAID, PAID or ARCHIVED
  • PAYMENT_PENDING - The payment was initiated by Light and is waiting to be collected. Next valid state is PAID
  • PARTIALLY_PAID - The invoice is partially paid. Next valid state is PAID
  • PAID - The invoice is fully paid
  • REVERSED - The invoice was reversed by a credit note and reissued as a new invoice; it is locked and cannot be modified
  • ARCHIVED - The invoice is archived and cannot be modified

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

openedAtstring date-time nullable

Timestamp when the invoice was opened

poNumberstring nullable

Purchase order number

referencestring nullable

Reference number for cross-referencing with procurement and invoicing workflows

paymentReferencestring nullable

Payment reference generated by Light for the customer's bank payment

descriptionstring nullable

Description of the invoice

currencystring
taxEngineName'AVATAX' | 'LIGHT' | 'SPHERE'

Name of the tax engine to be used

  • AVATAX - Avalara AvaTax will be used for tax calculations
  • LIGHT - Light built-in tax engine will be used for tax calculations
  • SPHERE - Sphere tax engine will be used for tax calculations

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

areLinesWithTaxboolean

Whether the invoice 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

localCurrencyFxRatenumber nullable

Custom foreign exchange rate for the ledger's local currency. If not provided Light uses official ECB rates

groupCurrencyFxRatenumber nullable

Custom foreign exchange rate for the ledger's group currency. If not provided Light uses official ECB rates

createdAtstring date-time

Timestamp when the invoice was created

updatedAtstring date-time

Timestamp when the invoice was last updated

updatedBystring uuid nullable

ID of the user who last updated the invoice

Example response

{
  "currency": "USD"
}

Changes

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