Invoices

Create a credit note (Gutschrift) for an issued invoice

Creates a credit note linked to the invoice, in the profile's credit note number series, with the invoice's client, currency and VAT settings. Without items it credits the whole invoice (every line with its quantity negated). issue: true issues it right away: in double-entry mode revenue, receivable and output VAT are reversed on the credit note date, which is also the VAT period of the correction. settle: true (implies issue) sets it off against the invoice's open amount; issue + settle on a full credit cancels the invoice in one step. An invoice can no longer be issued with a negative total: this is the way to correct one.

post/invoices/{id}/credit-note

Request

  • Base URL: https://api.lumabill.ch/v1
  • URL: https://api.lumabill.ch/v1/invoices/{id}/credit-note
  • Auth: HTTP bearer

Request body

itemsobject[]

Credited lines with NEGATIVE quantities (default - the invoice's lines negated)

datestring date

Credit note date (default today)

issueboolean
settleboolean
exchangeRatenumber double

Foreign-currency credit note only: CHF per 1 unit of its currency, stored as a manual rate, exactly like exchangeRate on an invoice. Omit to use the ESTV/BAZG rate of the credit note date; issuing without any rate is refused with 400 FX_RATE_UNAVAILABLE (nothing written).

Response

Credit note created

idstring uuid
invoiceNumberstring nullable

null for a draft credit note (numbered in the credit note series when issued)

status'DRAFT' | 'SENT'
sourceInvoiceIdstring uuid

Example response

{
  "invoiceNumber": "GS-001",
  "allocations": [
    {
      "creditNoteNumber": "GS-001",
      "invoiceNumber": "RE-011",
      "amount": 250
    }
  ]
}

Changes

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