List AR Invoices
This example uses the new Query function to list AR invoices based on attributes of associated customers.
In addition, the query uses a
sum aggregate operator to provide information about how much a given customer owes across all invoices.
- You have downloaded or cloned the examples for the Sage Intacct SDK for PHP and run
- You successfully ran the getting started example—in particular, you set up the
.credentials.inifile required by
- The company you are using has multiple AR invoices, and you have list and view permissions for AR invoices and customers.
Examine the code
Look at the
try block in
query.php. Here we build up a query function that will list AR invoices based on attributes of associated customers. Specifically, we’ll look for AR invoices where the customer ID starts with
The code first constructs an
OrOperator, seeking customer IDs that start with
$filter = new OrOperator([ ( new Filter('CUSTOMERID') )->like('c%'), ( new Filter('CUSTOMERID') )->like('1%') ]);
OrderBuilder sets a a descending sort order based on the value of
$order = ( new OrderBuilder())->descending('CUSTOMERID')->getOrders();
SelectBuilder chooses two fields to return,
CUSTOMERNAME, and includes the
sum aggregate operator for
TOTALDUE. When used in a Query of AR invoices, this adds the values of the
TOTALDUE parameters across all invoices. When using aggregate functions, the
fields in the select element are used to group the results. So, the results will be grouped by
$fields = ( new SelectBuilder() )->fields([ 'CUSTOMERID', 'CUSTOMERNAME' ]) ->sum('TOTALDUE') ->getFields();
Query constructor pulls the pieces together and specifies the target of the query,
ARINVOICE. The constructor also specifies a case insensitive filter and a pagesize of 100:
$res = ( new Query() )->select($fields) ->from('ARINVOICE') ->filter($filter) ->caseInsensitive(true) ->pageSize('100') ->orderBy($order);
Run the example
query.phpfile in a terminal:
Examine the output, which gives the total number of results and prints the first one.
The following sample result shows that YellowHammer (CUSTOMERID 10003) owes 15016.44 across all their invoices.
Success! Total number of results:2 First ARINVOICE result found: 'CUSTOMERID' => '10003' 'CUSTOMERNAME' => 'YellowHammer' 'SUM.TOTALDUE' => '15016.44' See the log file (logs/intacct.html) for the complete list of results.
If you don’t get any results, comment out the filter in the
Queryconstructor so that all ARINVOICE objects will be returned and rerun the the example.
Comment out the
sumaggregate operator and run the query again.
The number of results will increase because the AR invoices are not being categorized into groups according to the customer ID. Instead, each AR invoice is returned.
sumline and run the query again.
Open the generated
logs/intacct.htmlfile in an HTML browser and review the entries.
You should see information such as the following:
Note that the log file was created by the logger set up in the
bootstrap.phpin the project root
Try a different object
query.php to perform a different query. For example, you might want to calculate the total amount due to a given vendor across all the bills.
query.phpfile, change all occurrences of
Similarly, change all occurrences of
Run the file:
Examine the output, which will look something like this:
Success! Total number of results: 12 First ARINVOICE result found: 'VENDORID' => '20000' 'VENDORNAME' => 'Acme Co. 'SUM.TOTALDUE' => '418138.31' 'COUNT.RECORDNO' => '18' See the log file (logs/intacct.html) for the complete list of results.
(Optional) Update the the echo statements in the
elseblocks so that they are for APBILL instead of ARINVOICE objects.
- Try an example that creates, reads, updates, and deletes a customer.
- Browse the reference documentation for the SDK.