Contents x
    Get suppliers filtered and paged
    • 04 Sep 2024
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get suppliers filtered and paged

    • Updated on 04 Sep 2024
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/relations/suppliers/filter

    Get a paged list of existing suppliers, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint.

    Description

    Retrieve a paged list of existing suppliers, optionally filtered to the given parameters. The Bloxs relations-api offers 2 options to get suppliers filtered and paged. One is through the POST option, and as an alternative there is a GET operation available. The functional difference is that the POST option offers the ability to sort the results. Furthermore, the POST includes the parameters in the body whereas the GET includes them in the url.

    Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.

    A supplier encompasses all entities from which you receive invoices. For example, the tax authorities or a cleaning company. Also, for instance, the company from which you purchase office supplies. 

    Use Case

    The Bloxs user has an external App connected to Bloxs. Through this operation the user can display a paged list of suppliers & the related information. This operation can be used if the user wants to display multiple suppliers rather than just a specific one. If the user wants to display a single supplier the preference is to use the GET (suppliers) operation.   

    Request fields

    The request contains the following fields:

    FieldDescription
    pageSizeThe maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number).
    pageNumberThis allows the requesting party to specify which of the pages they want to receive.
    websiteWebsite of the supplier.
    externalAPIIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system.
    supplierTypeNameSupplier type. The enumeration can be set by the user in the admin module. In the administration, there is already a default list created by Bloxs, which can be modified by the user.
    nameName of the supplier. 
    isActive

    Boolean. 

    True: Active

    False: Inactive


    phoneNumberPhone number of the supplier.
    mobileNumberMobile phone number of the supplier.
    addressStreetThe street of the supplier.
    addressPostalCodeThe postal code of the supplier.
    addressCityThe place of residence of the supplier. 
    emailEmail of the supplier. 
    lastModifiedTimestamp of the last modification within Bloxs (determined by Bloxs).

    Response fields

    In addition to the fields in the request, the response also contains the fields in the table below.

    FieldDescription
    columnNameThe data field based on which sorting is applied. For example, if the results are sorted based on ascending name, columnName will contain the value 'name'.
    orderBased on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a).
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    pageSize
    integer (int32)

    The requested page size. Defaults to 100 when not given.

    Minimum1
    Maximum1000
    pageNumber
    integer (int32)

    The requested page number. Defaults to 1 when not given.

    Minimum1
    Maximum9999
    website
    string

    Optional filter on the website of the supplier.

    externalAPIIdentifier
    string

    Optional filter on the external API identifier of the supplier.

    reference
    string

    Optional filter on the reference of the supplier.

    supplierTypeName
    string

    Optional filter on the supplier type name of the supplier.

    name
    string

    Optional filter on the name of the supplier.

    isActive
    boolean

    Optional filter on the active state of the supplier.

    phoneNumber
    string

    Optional filter on the phone number of the supplier.

    mobileNumber
    string

    Optional filter on the mobile number of the supplier.

    addressStreet
    string

    Optional filter on the street of the address of the supplier.

    addressPostalCode
    string

    Optional filter on the postal code of the address of the supplier.

    addressCity
    string

    Optional filter on the city of the address of the supplier.

    email
    string

    Optional filter on the e-mail address of the supplier.

    lastModified
    string (date-time)

    Optional filter on the last modification date of the supplier.

    Responses
    200

    Success

    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)

    0 = Ascending

    1 = Descending

    Valid values[ \0\, \1\ ]
    suppliers
    Array of object (SupplierSearchResultFilter) | null
    object
    externalAPIIdentifier
    string | null
    reference
    string | null
    supplierTypeName
    string | null
    name
    string | null
    website
    string | null
    isActive
    boolean | null
    phoneNumber
    string | null
    mobileNumber
    string | null
    addressStreet
    string | null
    addressPostalCode
    string | null
    addressCity
    string | null
    primaryEmailAddresses
    string | null
    lastModified
    string (date-time) | null
    What's Next