API Reference

Create debit note

post
https://api.wafeq.com/v1/debit-notes/

Endpoint for creating a new debit note.

Body Params
attachments
array of strings

Any files or documents attached to this debit note.

attachments
string | null

The branch associated with this debit note.

string
required

The contact (customer) associated with this debit 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

date
required

The date when the debit note was issued.

string
required

The unique number assigned to this debit note.

double | null

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

string
length ≤ 255

External identifier for the debit note.

line_items
array of objects
required

The individual line items included in this debit note.

line_items*
string

Any additional notes or comments related to this debit note.

string
length ≤ 100

An optional order number associated with this debit note.

string | null

The project associated with this debit note, if applicable.

string

An optional reference number or code for this debit note.

string
enum
Defaults to DRAFT
  • DRAFT - DRAFT
  • POSTED - POSTED

Full information for Status313Enum

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

Full information for TaxAmountTypeEnum

Allowed:
Headers
string

Client-provided UUID to uniquely identify a request

Response

Updated 7 months ago

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