Did You Know?

Updated on October 22, 2024

Get Calculations

This domain serves for requests to get quote calculations.

Get Calculations

POSTRetrieves the details of a specific customer from the database based on the provided customer ID. If the customer is found, it returns the customer's details; otherwise, it returns a message indicating that no data was found.

Request Paramters
stringdomain Value should be customer Required
stringaction Value should be read Required
objectdata Contains input parameters. Required
intcustomer_id ID of the customer to be retrieved. Required
Sample Request Body
            
            {
                domain: "customer",
                action: "read",
                data: {
                    customer_id: 75
                }
            }
Response Paramters
stringstatus This indicate the status of the response. success is the expected value.
stringmessage This explains the reson for status.
objectdata This contain result data object of the API call.
intid The unique identifier for the customer record.
stringcustomer_no The customer number associated with the customer.
stringc_contact_name The contact name of the customer.
stringc_name_1 The first part of the customer name.
stringc_name_2 The second part of the customer name.
stringc_address_1 The first line of the customer's address.
stringc_address_2 The second line of the customer's address.
stringc_suburb The suburb of the customer's address.
stringc_postcode The postcode of the customer's address.
stringc_email The email address of the customer.
stringc_phone The phone number of the customer.
stringc_mobile The mobile number of the customer.
intc_discount The discount percentage for the customer.
stringc_method The method of interaction with the customer (e.g., online, offline).
stringc_notes Any notes related to the customer.
stringcreated_date The date and time when the customer record was created.
stringlast_updated_by The name of the user who last updated the customer record.
stringlast_updated_date The date and time when the customer record was last updated.
stringsubmitted_by The name of the user who submitted the customer record.
intuser_id The user ID associated with the customer record.
Sample Response
            
            {
                status: "success",
                data: {
                    id: 75,
                    customer_no: "C240048",
                    c_contact_name: "John Doe",
                    c_name_1: "TEST ABC",
                    c_name_2: "Department XYZ",
                    c_address_1: "123 Main Street",
                    c_address_2: "Apt 456",
                    c_suburb: "Anytown",
                    c_postcode: "12345",
                    c_email: "john.doe@example.com",
                    c_phone: "123-456-7890",
                    c_mobile: "987-654-3210",
                    c_discount: 0,
                    c_method: "online",
                    c_notes: "Some notes about the customer",
                    created_date: "2024-05-30 12:34:56",
                    last_updated_by: "Admin",
                    last_updated_date: "2024-05-30 12:34:56",
                    submitted_by: "Admin",
                    user_id: 69
                }
            }
Print
API END POINTS