Platform API Endpoint: Retrieve Organisation Customer Account Record

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's "Retrieve Organisation Customer Account Record" endpoint allows an organisation to retrieve the details and lines for a record from another connected organisation's business sytem, based on a record associated to an assigned customer account. This endpoint allows an organisation to securely get the details for a invoice, sales order, back order, transactions. credit or payment record, retrieved in realtime from a supplier organisation's connected business system. The record returned from endpoint is formatted as JSON data conforming to the "Ecommerce Standards Document" standards, with the document containing an array of zero or one record. The record found and returned is controlled by the supplying organisation's business system performing the search. This endpoint may be called after a specific record has been found previously using the Search Organisation Customer Account Records 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.
• 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 Record 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 standards.

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 obtain a single invoice record from within another connected organisation's business system, where the invoice record is 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. The list of invoice records will only contain at most a single record.

Within the retrieved Customer Account Enquiry JSON document, the 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 get the fulll details of a single sales order record from within another connected organisation's business system, where the sales order record is associated with a specified customer account of the supplying organisation. The 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. A sales order may have 0 to many lines, with each line representing either a quantity of an item (product/service/goods) being purchased or a text line.

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. The list will contain at most a single sales order record.

Within the retrieved Customer Account Enquiry JSON document, the 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 retrieve the full details of a single back order record from within another connected organisation's business system, where the back order record is associated with a specified customer account of the supplying organisation. The 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 a back order is 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. A back order may have 0 to many lines, with each line representing either a quantity of an item (product/service/goods) being back ordered, or a text line.

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. The list will contain at most a single back order record.

Within the retrieved Customer Account Enquiry JSON document, the 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 retrieve the full details of a single credit record from within another connected organisation's business system, where the credit record is associated with a specified customer account of the supplying organisation. The 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. A credit may have 0 to many lines, with each line representing either a quantity of an item (product/service/goods) being credited back, or a text line.

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. The list will contain at most a single credit record.

Within the retrieved Customer Account Enquiry JSON document, the 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 retrieve the full details of a single payment record from within another connected organisation's business system, where the payment record is associated with a specified customer account of the supplying organisation. The 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. The list will contain at most a single payment record.

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