API Reference

Update credit note

put
https://api.wafeq.com/v1/credit-notes//

Endpoint for updating an existing credit note.

Path Params
string
required
Body Params
attachments
array of strings

Any files or documents attached to this credit note.

attachments
string | null

The branch associated with this credit note.

string
required

The contact associated with this credit note.

date
required

The date when the credit note was issued.

string
required

The unique number assigned to this credit note.

string
enum
required
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

custom_fields
object

A mapping of custom field IDs to their values.

string

The cost center to which the discount is applied, if applicable.

double | null

The exchange rate to the organization base currency at the time of the document.

string
length ≤ 255

External identifier for the credit note.

string
enum
  • ar - Arabic
  • en - English

Full information for LanguageEnum

Allowed:
line_items
array of objects
required

The individual line items included in this credit note.

line_items*
string

Any additional notes or comments for this credit note.

string

Only required if your organization is in the UAE: one of ABU_DHABI, AJMAN, DUBAI, FUJAIRAH, RAS_AL_KHAIMAH, SHARJAH, UMM_AL_QUWAIN or OUTSIDE_UAE

string | null

The project associated with this credit note, if applicable.

string

An optional reference number or code for this credit note.

string
enum
Defaults to DRAFT
  • DRAFT - DRAFT
  • SENT - SENT
  • FINALIZED - FINALIZED

Full information for Status730Enum

Allowed:
string
enum
  • TAX_INCLUSIVE - inc. tax
  • TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

Allowed:
string | null

The warehouse associated with this credit note, if applicable.

Headers
string

Client-provided UUID to uniquely identify a request

Response

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago