WAwafeq
Credit Note Applications

Apply credit note to invoice

Changed on

Apply an amount of a credit note to an invoice of the same customer and currency. Both documents must be posted. The application posts a journal entry on its date, which defaults to the credit note's date and must fall in an open period, and lowers the balance of both documents. A credit note can be applied to the same invoice more than once.

post/invoice-credit-notes/

Request

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

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double required

The amount to apply. It must be positive.

credit_notestring required

The ID of the credit note to apply.

datestring date

The date the application is posted on. Defaults to the credit note's date and must fall in an open period.

invoicestring required

The ID of the invoice to apply the credit note to.

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