List objects

get

https://api.wafeq.com/v2/expense/

Query Params

amount

number

branch__in

array of strings

The unique identifier of the branch. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

branch__in

claim_status__in

array of strings

The status of the document. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

claim_status__in

contact__in

array of strings

The unique identifier of the contact. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

contact__in

date__gte

date

The minimum date of the document.

date__lte

date

The maximum date of the document.

extra_fields

array of strings

The extra fields to include in the response.

extra_fields

keyword

string

The search term, based on fields:

account.name.ar - The name (arabic) of the account/category (contains, case-insensitive).
account.name.en - The name (english) of the account/category (contains, case-insensitive).
amount - The amount of the expense (contains, case-insensitive).
contact.code - The code (external identifier) of the contact of the document (contains, case-insensitive).
contact.name.ar - The name (arabic) of the contact of the document (contains, case-insensitive).
contact.name.en - The name (english) of the contact of the document (contains, case-insensitive).
notes - The description/notes of the expense (contains, case-insensitive).
paid_through_account.name.ar - The name (arabic) of the paid through account (contains, case-insensitive).
paid_through_account.name.en - The name (english) of the paid through account (contains, case-insensitive).
project.name.ar - The name (arabic) of the project (contains, case-insensitive).
project.name.en - The name (english) of the project (contains, case-insensitive).
reference - The reference number of the document (contains, case-insensitive).
serial_number - The unique serial number of the expense document (contains, case-insensitive).
tax_rate.name.ar - The name (arabic) of the tax rate (contains, case-insensitive).
tax_rate.name.en - The name (english) of the tax rate (contains, case-insensitive).

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

ordering

array of strings

The custom ordering of the results. The default ordering is by created_ts descending.

amount - The amount of the document.
-amount - The amount of the document. (descending)
created_ts - The timestamp (ISO 8601) in UTC when the document was created.
-created_ts - The timestamp (ISO 8601) in UTC when the document was created. (descending)
date - The date of the document.
-date - The date of the document. (descending)
reference - The code that references the document
-reference - The code that references the document (descending)

ordering

project__in

array of strings

The unique identifier of the project. Multiple values may be provided. The special value 'null' may be provided to filter for null values.

project__in

status__in

array of strings or null

The posting status of the document (DRAFT or POSTED). Multiple values may be provided. The special value 'null' may be provided to filter for null values.

status__in

Allowed:

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200