Platform API Endpoint: Search Organisation Customer Account Records

Before reading on please ensure that you have understood the following topics:

• Getting Started/Overview
• Personal Signing Up To SQUIZZ.com
• Registering An Organisation
• Organisational Data
• Organisation Settings
• Connecting Organisations
• Trading Tokens and Pricing
• Connecting Business Systems
• Integrate Software Into SQUIZZ.com
• Platform API

The SQUIZZ.com platform's API has an endpoint that allows an organisation to search for records within another connected organisation's business system, based on records associated to an assigned customer account. This may also be known as "Customer Account Enquiry". This endpoint allows an organisation to search for invoice, sales order, back order, transactions. credit and payment records, retrieved in realtime from a supplier organisation's connected business system. The records returned from endpoint are formatted as JSON data conforming to the "Ecommerce Standards Document" standards, with each document containing an array of zero or more records. The list of records found and returned is controlled by the supplying organisation's business system performing the search. This endpoint will return a list of records containing the overall details of each record. To retrieve the full details and any associated lines for each record call the Organisation Retrieve Customer Account Record API endpoint.

Notes

• A session must first be created in the API before calling the endpoint.
• The organisation calling the endpoint must be connected to the "supplying" organisation that is facilitating the record searching.
• The organisation calling the endpoint must be assigned to a customer account by the supplying organisation.
• A maximum of 100 search requests can be made against a supplying organisation within the last 15 minutes. This ensures the supplying organisation is not flooded with too many requests.
• It's recommended that the supplying organisation's returning the records may be sorting the records by the "most recent date created" by default. However some organisation systems may not be able to sort this way, with records appearing with no specific sorting.
• The supplying organisation being called to perform the record search must have enough trading tokens to allow the searches to occur, as outlined in the Trading Tokens and Pricing document.
• The supplying organisation being called to the perform the record search must have set up an integration with their own business system(s) to SQUIZZ.com, containing the customer account record data. This system must support receiving requests made by the SQUIZZ.com platform, as outlined in the Outgoing Request: Get Customer Account Enquiry Records endpoint. The SQUIZZ.com Connector software can be used by the supplying organisation to facilitate searching in their own business system. if the system does not provide its own web service or support the Ecommece Standards Documents standard.

HTTP Response

Native Coding Library Examples:

PHP | .NET | Java

HTTP Response Example:

The Search Organisation Customer Account Records API endpoint can be called by one organisation to search for a list of invoice records from within another connected organisation's business system, where the invoice records are associated with a specified customer account of the supplying organisation.

The endpoint will return a list of Customer Account Enquiry Invoice records in the Customer Account Enquiry Ecommerce Standards Document (ESD) JSON data format that the retrieving organisation has been given access to, based on the customer account that the supplying organisation has assigned to the retreiving organisation.

Within the retrieved Customer Account Enquiry JSON document, each invoice record is conforms to the Customer Account Enquiry Invoice ESD Record format.

Native Coding Library Examples:

PHP | .NET | Java

HTTP Request Raw Example:

HTTP Response Example:

Below is an example Customer Account Enquiry Invoice Document returned by the API endpoint.

The Search Organisation Customer Account Records API endpoint can be called by one organisation to search for a list of transaction records from within another connected organisation's business system, where the transaction records are associated with a specified customer account of the supplying organisation. Each transaction record defines the change in the customer account's balance, based on the type of transaction that has occurred. It may also indicate the type of record that is optionally linked to each transaction. The is the equivalance of looking at a bank statement to see the debits and credits made to a customer.

The endpoint will return a list of Customer Account Enquiry Transaction records in the Customer Account Enquiry Ecommerce Standards Document (ESD) JSON data format that the retrieving organisation has been given access to, based on the customer account that the supplying organisation has assigned to the retreiving organisation.

Within the retrieved Customer Account Enquiry JSON document, each transaction record conforms to the Customer Account Enquiry Transaction ESD Record format.

Native Coding Library Examples:

PHP | .NET | Java

The Search Organisation Customer Account Records API endpoint can be called by one organisation to search for a list of sales order records from within another connected organisation's business system, where the sales order records are associated with a specified customer account of the supplying organisation. Each sales order record defines a sale made against the customer account, for one or more quantities of goods and services. The sale may, or may not have yet be converted into an invoice, with the sales order representing an intention by a customer to make a transaction.

The endpoint will return a list of Customer Account Enquiry Sales Order records in the Customer Account Enquiry Ecommerce Standards Document (ESD) JSON data format that the retrieving organisation has been given access to, based on the customer account that the supplying organisation has assigned to the retreiving organisation.

Within the retrieved Customer Account Enquiry JSON document, each sales order record conforms to the Customer Account Enquiry Order Sale ESD Record format.

Native Coding Library Examples:

PHP | .NET | Java

The Search Organisation Customer Account Records API endpoint can be called by one organisation to search for a list of back order records from within another connected organisation's business system, where the back order records are associated with a specified customer account of the supplying organisation. Each back order record outlines where the supplying organisation has not had the goods or services available that a customer had purchased, and the supplier has had to order the goods or services from their own supplier. Typically back orders are associated to a sales order or invoice record. Once a supplying organisation has received the goods and services it typically allows the back order to be closed, allowing corresponding sales orders or invoices to be completed.

The endpoint will return a list of Customer Account Enquiry Back Order records in the Customer Account Enquiry Ecommerce Standards Document (ESD) JSON data format that the retrieving organisation has been given access to, based on the customer account that the supplying organisation has assigned to the retreiving organisation.

Within the retrieved Customer Account Enquiry JSON document, each back order record conforms to the Customer Account Enquiry Back Order ESD Record format

Native Coding Library Examples:

PHP | .NET | Java

The Search Organisation Customer Account Records API endpoint can be called by one organisation to search for a list of credit records from within another connected organisation's business system, where the credit records are associated with a specified customer account of the supplying organisation. Each credit record defines a monetary amount that has been credited back to a customer, that may occur if a customer has been over charged, returned goods or services, or cancelled a sales order or invoice that wsa previously paid for.

The endpoint will return a list of Customer Account Enquiry Credit records in the Customer Account Enquiry Ecommerce Standards Document (ESD) JSON data format that the retrieving organisation has been given access to, based on the customer account that the supplying organisation has assigned to the retreiving organisation.

Within the retrieved Customer Account Enquiry JSON document, each credit record conforms to the Customer Account Enquiry Credit ESD Record format.

Native Coding Library Examples:

PHP | .NET | Java

The Search Organisation Customer Account Records API endpoint can be called by one organisation to search for a list of payment records from within another connected organisation's business system, where the payment records are associated with a specified customer account of the supplying organisation. Each payment record defines a monetary amount that has been paid by a customer against the customer account. A payment record may have been applied against one or more invoices, or sales orders, and provides a credit against the customer account balance.

The endpoint will return a list of Customer Account Enquiry Payment records in the Customer Account Enquiry Ecommerce Standards Document (ESD) JSON data format that the retrieving organisation has been given access to, based on the customer account that the supplying organisation has assigned to the retreiving organisation.

Within the retrieved Customer Account Enquiry JSON document, each payment record conforms to the Customer Account Enquiry Payment ESD Record format.

Native Coding Library Examples:

PHP | .NET | Java