WAwafeq
Credit Note Applications

Update credit note application

Changed on

Change the amount or date of an application in place. Its journal entry is updated rather than replaced. The credit note and invoice cannot change: to move an application, delete it and create another.

patch/invoice-credit-notes/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/invoice-credit-notes/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double

The new amount. It must be positive.

datestring date

The new date the application is posted on. It must fall in an open period.

Response

amountnumber double required

The amount of the credit note applied to the invoice.

created_tsstring date-time required

The timestamp in UTC when the credit note was applied.

credit_notestring required

The ID of the credit note applied.

datestring date required

The date the application is posted on.

idstring required

The ID of the application.

invoicestring required

The ID of the invoice the credit note is applied to.

journalstring nullable required

The ID of the journal entry the application posted, or null while either document is a draft. Use GET /v1/journal-line-items/?journal={journal_id} to retrieve the accounting entries.

modified_tsstring date-time required

The timestamp in UTC when the application last changed.

Changes