GEgetpliant
Accounting Suppliers

List Suppliers

Changed on

Returns a list of suppliers. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.

get/accounting/suppliers

Request

Query parameters

organizationIdstring uuid required

The unique identifier of the organization.

status'ACTIVE' | 'INACTIVE'

The status to filter by.

limitinteger

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

pageinteger

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy'organizationId' | 'name' | 'createdAt'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort by.

Response

Ok

hasNextPageboolean

Indicates whether there is a next page available.

Changes