Create credit note

post

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

Endpoint for creating a new credit note.

Body Params

Adds nested create feature

attachments

array of strings

Any files or documents attached to this credit note.

attachments

branch

string | null

The branch associated with this credit note.

contact

string

required

The contact associated with this credit note.

credit_note_date

date

required

The date when the credit note was issued.

credit_note_number

string

required

The unique number assigned to this credit note.

currency

string

enum

required

The currency used for this credit note.

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
AZN - AZN ман.
BAM - BAM KM
BDT - BDT ৳
BGN - BGN лв.
BHD - BHD د.ب.‏
BIF - BIF FBu
BND - BND $
BOB - BOB Bs
BRL - BRL R$
BWP - BWP P
BYN - BYN BYN
BZD - BZD $
CDF - CDF FrCD
CHF - CHF CHF
CLP - CLP $
CNY - CNY CN¥
COP - COP $
CRC - CRC ₡
CVE - CVE CV$
CZK - CZK Kč
DJF - DJF Fdj
DKK - DKK kr
DOP - DOP RD$
DZD - DZD د.ج.‏
EGP - EGP ج.م.‏
ERN - ERN Nfk
ETB - ETB Br
GBP - GBP £
GEL - GEL GEL
GHS - GHS GH₵
GNF - GNF FG
GTQ - GTQ Q
HKD - HKD $
HNL - HNL L
HRK - HRK kn
HUF - HUF Ft
IDR - IDR Rp
ILS - ILS ₪
INR - INR ₹
IQD - IQD د.ع.‏
IRR - IRR ﷼
ISK - ISK kr
JMD - JMD $
JOD - JOD د.أ.‏
JPY - JPY ￥
KES - KES Ksh
KHR - KHR ៛
KMF - KMF FC
KRW - KRW ₩
KWD - KWD د.ك.‏
KZT - KZT тңг.
LBP - LBP ل.ل.‏
LKR - LKR SL Re
LYD - LYD د.ل.‏
MAD - MAD د.م.‏
MDL - MDL MDL
MGA - MGA MGA
MKD - MKD MKD
MMK - MMK K
MOP - MOP MOP$
MUR - MUR MURs
MXN - MXN $
MYR - MYR RM
MZN - MZN MTn
NAD - NAD N$
NGN - NGN ₦
NIO - NIO C$
NOK - NOK kr
NPR - NPR नेरू
NZD - NZD $
OMR - OMR ر.ع.‏
PAB - PAB B/.
PEN - PEN S/.
PHP - PHP ₱
PKR - PKR ₨
PLN - PLN zł
PYG - PYG ₲
QAR - QAR ر.ق.‏
RON - RON RON
RSD - RSD дин.
RUB - RUB руб.
RWF - RWF FR
SDG - SDG SDG
SEK - SEK kr
SGD - SGD $
SOS - SOS Ssh
SYP - SYP ل.س.‏
THB - THB ฿
TND - TND د.ت.‏
TOP - TOP T$
TRY - TRY TL
TTD - TTD $
TWD - TWD NT$
TZS - TZS TSh
UAH - UAH ₴
UGX - UGX USh
UYU - UYU $
UZS - UZS UZS
VES - VES Bs.S.
VND - VND ₫
XAF - XAF FCFA
XOF - XOF CFA
YER - YER ر.ي.‏
ZAR - ZAR R
ZMW - ZMW ZK

custom_fields

object

A mapping of custom field IDs to their values.

discount_cost_center

string

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

exchange_rate

double | null

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

external_id

string

length ≤ 255

External identifier for the credit note.

language

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*

notes

string

Any additional notes or comments for this credit note.

place_of_supply

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

project

string | null

The project associated with this credit note, if applicable.

reference

string

An optional reference number or code for this credit note.

status

string

enum

Defaults to DRAFT

The current status of the credit note draft, sent, or finalized.

DRAFT - DRAFT
SENT - SENT
FINALIZED - FINALIZED

Allowed:

tax_amount_type

string

enum

Specifies whether the tax amount is inclusive or exclusive.

TAX_INCLUSIVE - inc. tax
TAX_EXCLUSIVE - exc. tax

Allowed:

warehouse

string | null

The warehouse associated with this credit note, if applicable.

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201