Powersoft 365 API Documentation

customer


Changelog

November 23, 2025
  • POST method new object b2b_info marking the customer as B2B and supply the corresponding details.
  • New PATCH method to update the customer based on fields list.

GET /customer

To get a specific customer.

/customer?token=XXXXX&customer_code_365=00100001


POST /customer

To create a regular customer.


To create a B2B customer.


field type description
api_credentials
token string Credentials provided by Powersoft that allow access to the API
customer
customer_code string The unique code of the customer in your system.
is_company bool If the customer is a company then true. If the customer is a person then false.
company_name string If is_company == true, then the company name, else "".
last_name string If is_company == false, then the surname of the person, else "".
first_name string If is_company == false, then the first name of the person, else "".
store_code_365 string The store code in 365 to which this customer belongs to.
active bool If the customer is active, then true, else false.
date_of_birth string If there is a date of birth, then pass the date as a string in the required format. Else ""
gender string M - male, F - female, O - other, or "" - none
tel_1 string The telephone 1 of the customer. Pass "" if none.
tel_2 string The telephone 2 of the customer. Pass "" if none.
fax string The fax of the customer. Pass "" if none.
mobile string The mobile number of the customer. Pass "" if none.
sms string The mobile which the customer receives sms messages. Pass "" if none.
email string The email address of the customer. Pass "" if none.
website string The website address of the customer. Pass "" if none.
category_code_365 string The category code in 365 to which this customer belongs to. Pass "" if none.
category_code_2_365 string The category 2 code in 365 to which this customer belongs to. Pass "" if none.
company_activity_code_365 string The company activity code in 365 to which this customer belongs to. Pass "" if none.
agent_code_365 string The agent code in 365 to which this customer belongs to. Pass "" if none.
credit_limit_amount decimal If the customer is not allowed to buy on credit, pass 0.00. If the customer is allowed to buy on credit, then pass the maximum amount that he is allowed to buy on credit.
vat_registration_number string The VAT registration number of the customer. Pass "" if none.
customer_id string If is_company== true, then pass the registration number of the company. If is_company==false, then pass the personal identification number of the customer. Pass "" if none.
tax_office string The tax office of the customer. Pass "" if none.
remarks string Any notes about the customer. Pass "" if none.
address_line_1 string The address line 1.eg. Street number and name. Pass "" if none.
address_line_2 string The address line 2. Pass "" if none.
address_line_3 string The address line 3. Pass "" if none.
postal_code string The postal code of the customer. Pass "" if none.
town string The town of the customer. Pass "" if none.
country_code_iso2 string The 2 digit ISO code of the country. eg CY for Cyprus. Pass "" if none.
contact_last_name string Any relevant contact person. Their last name. Pass "" if none.
contact_first_name string Any relevant contact person. Their first name. Pass "" if none.
default_price int 0-10 or 72-80 or 97-99 or 87-88. The default price indicator which this customer gets charged for an item. 0 = Customer gets charged the store default price. 1-10, the customer gets charged the specific price. 72-80, the customer gets charged the discount price 2-10 over price 1. 87 - Weighted Average Cost, 88 - Average Cost, 98 - Last Discount, 97 - Last Price, 99 - Latest Cost
loyalty_factor decimal The loyalty factor for this customer. If the customer earns the same loyalty as the item loyalty factor, pass 1. If the customer does not earn points, then pass 0. Otherwise, pass the loyalty factor required.
from_mobile_device boolean A flag that specifies the customer has been created on a mobile device. The field is optional and if is not provided the default value is false.
text_field_1_value string The extra text field 1 for this customer. Not required.
text_field_2_value string The extra text field 2 for this customer. Not required.
text_field_3_value string The extra text field 3 for this customer. Not required.
text_field_4_value string The extra text field 4 for this customer. Not required.
text_field_5_value string The extra text field 5 for this customer. Not required.
number_field_1_value decimal The extra number field 1 for this customer. Not required.
number_field_2_value decimal The extra number field 2 for this customer. Not required.
number_field_3_value decimal The extra number field 3 for this customer. Not required.
number_field_4_value decimal The extra number field 4 for this customer. Not required.
number_field_5_value decimal The extra number field 5 for this customer. Not required.
date_field_1_value string The extra date field 1 for this customer. Not required.
date_field_2_value string The extra date field 2 for this customer. Not required.
date_field_3_value string The extra date field 3 for this customer. Not required.
date_field_4_value string The extra date field 4 for this customer. Not required.
date_field_5_value string The extra date field 5 for this customer. Not required.
b2b_info
user_name_365 string The unique user name for b2b_user. Required.
user_password string Password for b2b_user in 64 base format. Required.
max_items_to_order string Maximum items to order. Pass integer value as string. Optionally.
max_time_to_order string Maximum time to order. Optionally.
text_field_01_value string Text field 1. Optionally.
text_field_02_value string Text field 2. Optionally.
text_field_03_value string Text field 3. Optionally.
text_field_04_value string Text field 4. Optionally.
text_field_05_value string Text field 5. Optionally.
text_field_06_value string Text field 6. Optionally.
text_field_07_value string Text field 7. Optionally.
text_field_08_value string Text field 8. Optionally.
text_field_09_value string Text field 9. Optionally.
text_field_10_value string Text field 10. Optionally.
number_field_01_value decimal Number field 1. Optionally.
number_field_02_value decimal Number field 2. Optionally.
number_field_03_value decimal Number field 3. Optionally.
number_field_04_value decimal Number field 4. Optionally.
number_field_05_value decimal Number field 5. Optionally.
number_field_06_value decimal Number field 6. Optionally.
number_field_07_value decimal Number field 7. Optionally.
number_field_08_value decimal Number field 8. Optionally.
number_field_09_value decimal Number field 9. Optionally.
number_field_10_value decimal Number field 10. Optionally.
boolean_field_01_value boolean Boolean field 1. Optionally.
boolean_field_02_value boolean Boolean field 2. Optionally.
boolean_field_03_value boolean Boolean field 3. Optionally.
boolean_field_04_value boolean Boolean field 4. Optionally.
boolean_field_05_value boolean Boolean field 5. Optionally.
boolean_field_06_value boolean Boolean field 6. Optionally.
boolean_field_07_value boolean Boolean field 7. Optionally.
boolean_field_08_value boolean Boolean field 8. Optionally.
boolean_field_09_value boolean Boolean field 9. Optionally.
boolean_field_10_value boolean Boolean field 10. Optionally.
date_field_01_value string Date field 1 in format yyyy-mm-dd. Optionally.
date_field_02_value string Date field 2 in format yyyy-mm-dd. Optionally.
date_field_03_value string Date field 3 in format yyyy-mm-dd. Optionally.
date_field_04_value string Date field 4 in format yyyy-mm-dd. Optionally.
date_field_05_value string Date field 5 in format yyyy-mm-dd. Optionally.

PATCH /customer

To modify an existing customer based on a fields list.

field type description
api_credentials
token string Credentials provided by Powersoft that allow access to the API
customer
customer_code_365 string The unique code of the customer in Powersoft365.
fields_list
field_name string The name of the field. Here is the list of the fields that are allowed to be changed.
field_value the type is determined by the field that is updated The new value of the field.

PUT /customer

To modify an existing customer. All the fields are required and changed. Use the PATCH method to update only the relevant fields.

field type description
api_credentials
token string Credentials provided by Powersoft that allow access to the API
customer
customer_code_365 string The unique code of the customer in Powersoft365.
is_company bool If the customer is a company then true. If the customer is a person then false.
company_name string If is_company == true, then the company name, else "".
last_name string If is_company == false, then the surname of the person, else "".
first_name string If is_company == false, then the first name of the person, else "".
store_code_365 string The store code in 365 to which this customer belongs to.
active bool If the customer is active, then true, else false.
date_of_birth string If there is a date of birth, then pass the date as a string in the required format. Else ""
gender string M - male, F - female, O - Other, or "" - none
tel_1 string The telephone 1 of the customer. Pass "" if none.
tel_2 string The telephone 2 of the customer. Pass "" if none.
fax string The fax of the customer. Pass "" if none.
mobile string The mobile number of the customer. Pass "" if none.
sms string The mobile which the customer receives sms messages. Pass "" if none.
email string The email address of the customer. Pass "" if none.
website string The website address of the customer. Pass "" if none.
category_code_365 string The category code in 365 to which this customer belongs to. Pass "" if none.
category_code_2_365 string The category 2 code in 365 to which this customer belongs to. Pass "" if none.
company_activity_code_365 string The company activity code in 365 to which this customer belongs to. Pass "" if none.
credit_limit_amount decimal If the customer is not allowed to buy on credit, pass 0.00. If the customer is allowed to buy on credit, then pass the maximum amount that he is allowed to buy on credit.
vat_registration_number string The VAT registration number of the customer. Pass "" if none.
customer_id string If is_company== true, then pass the registration number of the company. If is_company==false, then pass the personal identification number of the customer. Pass "" if none.
tax_office string The tax office of the customer. Pass "" if none.
remarks string Any notes about the customer. Pass "" if none.
address_line_1 string The address line 1.eg. Street number and name. Pass "" if none.
address_line_2 string The address line 2. Pass "" if none.
address_line_3 string The address line 3. Pass "" if none.
postal_code string The postal code of the customer. Pass "" if none.
town string The town of the customer. Pass "" if none.
agent_code_365 string The agent code in 365 to which this customer belongs to. Pass "" if none.
country_code_iso2 string The 2 digit ISO code of the country. eg CY for Cyprus. Pass "" if none.
contact_last_name string Any relevant contact person. Their last name. Pass "" if none.
contact_first_name string Any relevant contact person. Their first name. Pass "" if none.
default_price int 0-10. The default price indicator which this customer gets charged for an item. 0 = Customer gets charged the store default price. 1-10, the customer gets charged the specific price.
loyalty_factor decimal The loyalty factor for this customer. If the customer earns the same loyalty as the item loyalty factor, pass 1. If the customer does not earn points, then pass 0. Otherwise, pass the loyalty factor required.
text_field_1_value string The extra text field 1 for this customer. Not required.
text_field_2_value string The extra text field 2 for this customer. Not required.
text_field_3_value string The extra text field 3 for this customer. Not required.
text_field_4_value string The extra text field 4 for this customer. Not required.
text_field_5_value string The extra text field 5 for this customer. Not required.
number_field_1_value decimal The extra number field 1 for this customer. Not required.
number_field_2_value decimal The extra number field 2 for this customer. Not required.
number_field_3_value decimal The extra number field 3 for this customer. Not required.
number_field_4_value decimal The extra number field 4 for this customer. Not required.
number_field_5_value decimal The extra number field 5 for this customer. Not required.
date_field_1_value string The extra date field 1 for this customer. Not required.
date_field_2_value string The extra date field 2 for this customer. Not required.
date_field_3_value string The extra date field 3 for this customer. Not required.
date_field_4_value string The extra date field 4 for this customer. Not required.
date_field_5_value string The extra date field 5 for this customer. Not required.

Returns

All methods return the standard api_response object. When a new record is created/updated, the Powersoft365 code is returned in the response_id field.