INinvoiceninja
vendors

List vendors

Changed on

Lists vendors, search and filters allow fine grained lists to be generated.

Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available
get/api/v1/vendors

Request

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }
per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

sortstring[]

Order the list by choosing a column and direction. Each value uses the form column|asc or column|desc.

Single sort — for example sort=name|asc.

Multiple sorts — for example
sort[]=id|desc&sort[]=name|asc.

Vendors use vendor table columns and any relationship sorts implemented in VendorFilters (such as client.name or document counts where applicable). Unsupported keys are ignored.

[
  "name|asc",
  "id|desc"
]

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

A list of vendors

Example response

{
  "data": [
    {
      "id": "Opnel5aKBz",
      "user_id": "Opnel5aKBz",
      "assigned_user_id": "Opnel5aKBz",
      "contacts": [
        {
          "id": "Opnel5aKBz",
          "user_id": "Opnel5aKBz",
          "vendor_id": "Opnel5aKBz",
          "first_name": "Harry",
          "last_name": "Windsor",
          "contact_key": "JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a",
          "confirmation_code": "333-sdjkh34gbasd",
          "phone": "555-123-1234",
          "custom_value1": "2022-10-10",
          "custom_value2": "$1000",
          "email": "harry@windsor.com",
          "email_verified_at": 134341234234,
          "password": "*****",
          "is_primary": true,
          "created_at": 134341234234,
          "updated_at": 134341234234,
          "deleted_at": 134341234234,
          "send_email": true
        }
      ],
      "name": "Harry cafe de wheels",
      "classification": "individual",
      "website": "www.harry.com",
      "private_notes": "Shhh, do not tell the vendor",
      "industry_id": "1",
      "phone": "555-3434-3434",
      "currency_id": "4",
      "number": "11234",
      "is_deleted": true,
      "language_id": "1",
      "vendor_hash": "aaa-sss-www",
      "transaction_name": "aaa-sss-www",
      "last_login": 134341234234,
      "created_at": 134341234234,
      "updated_at": 134341234234,
      "display_name": "Bob the vendor",
      "public_notes": "These are public notes visible to vendors",
      "routing_id": "0088:12345678901"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes

  • 89876e7e51d6Revision changes
    • info

      added the new optional query request parameter sort

  • 69a36036d334Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status