API Reference
Developer Console

List objects

get
https://api.wafeq.com/v2/bills/
Query Params
account__in
array of strings

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

account__in
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
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
cost_center__in
array of strings

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

cost_center__in
date

The minimum date of the entity.

date

The maximum date of the entity.

date

The minimum due date of the entity.

date

The maximum due date of the entity.

extra_fields
array of strings

The extra fields to include in the response.

extra_fields
boolean

Filter by overdue status. True for overdue, False for not overdue.

string

The search term, based on fields:

  • 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).
  • number - The unique number of the document (contains, case-insensitive).
  • reference - The reference number of the document (contains, case-insensitive).
integer

Number of results to return per page.

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.

  • 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)
  • modified_ts - The timestamp (ISO 8601) in UTC when the document was last modified.
  • -modified_ts - The timestamp (ISO 8601) in UTC when the document was last modified. (descending)
  • number - The number of the document.
  • -number - The number of the document. (descending)
ordering
Allowed:
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

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

status__in
Allowed:
Response

Updated about 1 hour ago

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

Updated about 1 hour ago

Did this page help you?