tools/sdk-php/list-vendors.md

metadata

title: List Vendors (Legacy) - Sage Intacct SDK for PHP | Sage Intacct Developer
url: https://developer.intacct.com/tools/sdk-php/list-vendors/

List Vendors (Legacy) - Sage Intacct SDK for PHP | Sage Intacct Developer

Overview

Getting Started

List AR Invoices

List Vendors (Legacy)

CRUD Customer

Custom Object Function

Troubleshooting

• Prerequisites
• Run the example
• Extra credit
  • Filter the results
  • Try a different object
• What’s next?

---

This example shows you how to:

• Execute a query to list vendors using the legacy ReadByQuery function.
• Read any additional paginated results from the query.

Important: Consider using the new Query function, which offers more advanced functionality.

---

Prerequisites

• You have downloaded or cloned the Sage Intacct SDK for PHP examples.
• You successfully ran the getting started example—in particular, you set up the .credentials.ini file required by bootstrap.php.
• The company you are using has multiple vendor records.
• The user you are using has list and view permissions for the vendor object.

---

Run the example

1. Run the PHP list-vendors.php file:

   php list-vendors.php
   

2. Observe the terminal output.

   The number of vendor records found and each page remaining echo to the terminal:

   Page 1 success! Number of vendor records found: 14. Number remaining: 12
   Page 2 success! Records remaining: 10
   Page 3 success! Records remaining: 8
   Page 4 success! Records remaining: 6
   Successfully read 4 pages
   

3. Open the generated logs/intacct.html file in your browser and review the entries.

   The file provides info and debug entries. The SDK provides a debug entry for each HTTP request/response (with the Sage Intacct endpoint).

   Note that the log file was created by the logger set in the client config.

---

Extra credit

Filter the results

1. Set a Intacct\Functions\Common\Query\QueryInterface on the ReadByQuery object to filter the number of results. For example, add the following to the example to list only active vendors:

   $where = new EqualToString();
   $where->setField('STATUS');
   $where->setValue('T');
   $query->setQuery($where);
   

Try a different object

1. Query for APBILL objects by changing the setObjectName call, as follows:

   $query->setObjectName('APBILL');
   

2. Modify the $query->setFields() array to return the information you want.

---

What’s next?

• Try an example that creates, reads, updates, and deletes a customer.
• Browse the reference documentation for the SDK.

Provide feedback