API Reference
Developer ConsoleAPI Status Page

Create invoice

post
https://api.wafeq.com/v1/invoices/

Endpoint for creating a new invoice.

Query Params
string

Comma-separated related objects to return in full instead of as IDs. Accepted values: attachments, branch, contact, contact.persons, journal, line_items, line_items.account, line_items.item, line_items.tax_rate, line_items.cost_center, project, warehouse, discount_cost_center. Nested relations are joined with a dot. Pass journal to replace the journal ID with its object (ID, date, currency, reference, notes and timestamps). Documents without a journal still return null. Journal line items are retrieved separately with GET /v1/journal-line-items/?journal={journal_id}.

Body Params

An invoice issued to a customer.

attachments
array of strings

Any files or documents attached to this invoice.

attachments
string | null

The branch associated with this invoice.

string
required

The contact (customer) associated with this invoice.

credit_notes
array of objects

The credit notes applied to this invoice. Sending this field replaces the whole set, and entries left out are unapplied. To apply, change or remove a single credit note, use /v1/invoice-credit-notes/.

credit_notes
string
enum
required

The currency code for the invoice.

View the enum reference

custom_fields
object

A mapping of custom field IDs to their values.

string

The account to which the discount will be booked, if applicable.

double
≥ 0

The discount amount to apply to the invoice.

string

The cost center associated with the discount, if applicable.

string | null

The tax exemption reason of the discount, when its tax rate takes one: a code that rate offers, or, on the KSA out-of-scope rate, the reason written out. null or "" clears the reason. Left out, a new discount, or one moved to another tax rate, takes the default of its tax rate, and any other discount keeps its reason.

string

The tax rate applied to the discount, if applicable: the ID of the tax rate (tax_…). List the tax rates of the organization with GET /v1/tax-rates/.

double | null

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

string
length ≤ 255

External identifier for the invoice.

date
required

The date when the invoice was issued.

date
required

The date by which the invoice should be paid.

string
required

The unique number assigned to this invoice.

boolean

Whether this invoice summarizes transactions over a period.

string
enum
Defaults to en

The language in which the invoice is written.

View the enum reference

Allowed:
line_items
array of objects
required

The individual line items included in this invoice.

line_items*
string

Additional notes or comments about the invoice.

string

The place of supply for UAE organizations. Must be one of: ABU_DHABI, AJMAN, DUBAI, FUJAIRAH, RAS_AL_KHAIMAH, SHARJAH, UMM_AL_QUWAIN or OUTSIDE_UAE.

string | null

The project associated with this invoice, if applicable.

string

An optional purchase order number or code for this invoice.

string

An optional reference number or code for this invoice.

string
enum
Defaults to DRAFT

The current status of the invoice (draft, sent, or finalized).

View the enum reference

Allowed:
date | null

The end date of the period covered by this summary invoice. Required when is_summary is true.

date | null

The start date of the period covered by this summary invoice. Required when is_summary is true.

string
enum

Specifies whether the tax amount is inclusive or exclusive.

View the enum reference

Allowed:
string | null

The warehouse associated with this invoice, if applicable.

Headers
string

Client-provided UUID to uniquely identify a request

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Updated 25 days ago

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

Updated 25 days ago

Did this page help you?