Create Customer Account
For Sales Transactions, a customer account is required.
The followings are required fields to set up a Customer Account.
• Business Name • Account No • Openning Date
ApiToken | String*(Required)API authorisation token obtained via authentication API. |
BusinessName | String (200)*(Required)The name of the person or organization. The maximum number of characters is 200. Alpha Numeric |
Title | String (50)(Optional)Contact Person Title. |
FirstName | String (100)(Optional)Contact Person First name. |
LastName | String (100)(Optional)Contact Person Last Name. |
AccountNo | String (50)*(Required)The customer account number is a unique identifier of each customer, it is used to generate an invoice against a particular customer. In case Auto Account Number is enabled, simply send a number and the System will allocate the Auto Account No. This will be returned in the success response. |
String (100)(Optional)The customer's email address. |
|
SMSMobile | String (11)(Optional)The mobile phone number on which SMS alerts will be sent on different transactions based on your SMS settings. Only relevant if the SMS module is enabled and SMS credit is purchased. The formate should be 923231230123 |
Mobile | String (100)(Optional)Mobile phone number. |
Phone | String (100)(Optional)Phone number. |
Website | String (200)(Optional)Website address of the customer. |
BillingAddress | String (500)(Optional)Billing address of the customer. |
City | String (100)(Optional)Address City. |
Province | String (100)(Optional)Address Province. |
PostalCode | String (20)(Optional)Address Postal code. |
Country | String (100)(Optional)Address Country. |
NTNNumber | String (20)(Optional)National Tax Number of the customer. |
CNIC | String (50)(Optional)Computerized National Identity Card of the customer. |
SalesTaxNumber | String (20)(Optional)Sales Tax Number of the customer. |
PaymentTerms | int(Optional)The number of days in which a payment is due. |
CreditLimit | decimal (15, 2)(Optional)The maximum credit amount allocated to a customer. |
Notes | String (500)(Optional)Notes |
OpeningDate | Date (YYYY-MM-DD)*(Required)Opening Balance Date. |
OpeningBalance | decimal (15, 2)(Optional)Opening Date will be used to record the opening balance. |
Field1 | String (50)(Optional)Fields linked with Customers allow filtering data of sales invoices and receipts. A total of 4 filters are allowed with every customer account. In case, fields are not defined previously, the system adds these automatically. Fields in FastAccounts work as a dropdown list. |
Field2 | String (50)(Optional)As decribed in Field 1 |
Field3 | String (50)(Optional)As decribed in Field 1 |
Field4 | String (50)(Optional)As decribed in Field 1 |
FieldA | String (100)(Optional)There are 4 optional text fields to save any additional data on customer records. |
FieldB | String (100)(Optional)As Field A |
FieldC | String (100)(Optional)As Field A |
FieldD | String (100)(Optional)As Field A |
IsSupplier | Enum(Optional)If you want to add a customer who is also a supplier, then the value of this field will be set to Yes. The default is No. |
Group | String (500)(Optional)The group name of the customer is only relevant if the Advanced Rights module is enabled and the Customers’ Groups are defined. |
Discount | decimal (3,2)(Optional)The discount percentage that is allocated to a customer. A number between 0 and 100. |
CurrencyCode | String (5)*(Optional)Required only when a foreign currency transaction is recorded. Currency of the Customer e.g. PKR or USD. The Code can be found in the Currencies List. In case omitted, it will be set as Base Currency linked with Company Account. |
ExchangeRate | decimal (15, 8)*(Optional)The exchange rate for the opening balance transaction. Required when a foreign currency transaction is recorded. |
{ "ApiToken": "6fcd41e45626947506089ee7e16d3bd7", "BusinessName": "1st4connect", "Title": "Mr.", "FirstName": "Waheed", "LastName": "Anjum", "AccountNo": "1006", "Email": "info@examplemail.com", "SMSMobile": "923084443779", "Mobile": "923084443779", "Phone": "042-111-008-339", "Website": "www.1st4connect.com", "BillingAddress": "43-B Abubakar Block New Garden Town", "City": "Lahore", "Province": "Punjab", "PostalCode": "54000", "Country": "Pakistan", "NTNNumber": "123456-7", "CNIC": "12345-1234577-9", "SalesTaxNumber": "123456-7", "PaymentTerms": "18", "CreditLimit": "50000", "Notes": "Test Notes", "OpeningDate": "2021-10-10", "OpeningBalance": "1000", "Field1": "F1", "Field2": "F2", "Field3": "F3", "Field4": "F4", "FieldA": "F A", "FieldB": "F B", "FieldC": "F C", "FieldD": "F D", "IsSupplier": "yes", "Group": "G1", "Discount": "10", "CurrencyCode" : "PKR", "ExchangeRate" : "1" }
https://api.fastaccounts.io/index.php/api/customer/add
{"Status":1,"Code":"200","Message":"The request was successfully completed.","CustomerAccountNo":"1006S"}
Status Code | Type | Message |
---|---|---|
200 | Success | The request was successfully completed. |
201 | Error | Invalid Key Details. |
202 | Error | Data is not valid in API request. |
203 | Error | Data is not valid in API products. |
204 | Error | Validation failed. |
205 | Error | Invalid IP Address. |
400 | Error | Bad Request. |
403 | Error | Forbidden. |
404 | Error | Not Found. |
500 | Error | Internal Server Error. |