Add Client
This endpoint is used to add a client details for invoice plugin
Method
POST https://api.ninjapay.me/webextension/api/v1/fiat/invoice/client
Parameters
name :
(string, required)
- The name of the person.phone_code :
(string, required)
- The country code for the phone number.phone:
(string, required)
- The phone number of the person.email:
(string, required)
- The email address of the person.website:
(string)
- The website of the person or business.street_address :
(string)
- The street address of the person.state :
(string)
- The state where the person resides.city :
(string)
- The city where the person resides.country :
(string)
- The country where the person resides.zip_code :
(string)
- The postal code of the area where the person resides.details (array of objects) : An array containing additional details.
PAN :
(string)
- The PAN (Permanent Account Number) of the person.GST :
(string)
- The GST (Goods and Services Tax) number of the person or business.
Request Body
Body (application/json)
{
"name": "Aman", // The name of the person
"phone_code": "91", // The country code for the phone number
"phone": "9876543210", // The phone number of the person
"email": "aman@gmail.com", // The email address of the person
"website": "https://amanwebsite.com", // The website of the person or business
"street_address": "1234 Elm Street", // The street address of the person
"state": "Maharashtra", // The state where the person resides
"city": "Mumbai", // The city where the person resides
"country": "India", // The country where the person resides
"zip_code": "400001", // The postal code of the area where the person resides
"details": [
{
"PAN": "ABCDE1234F" // The PAN (Permanent Account Number) of the person
},
{
"GST": "27ABCDE1234F1Z5" // The GST (Goods and Services Tax) number of the person or business
}
]
}
Response
{
"status": true,
"data": {},
"message": "Client details added successfully"
}
Code Example
const options = {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'API_KEY' //Invoice key required
},
body: {
"name": "Aman", // The name of the person
"phone_code": "91", // The country code for the phone number
"phone": "9876543210", // The phone number of the person
"email": "aman@gmail.com", // The email address of the person
"website": "https://amanwebsite.com", // The website of the person or business
"street_address": "1234 Elm Street", // The street address of the person
"state": "Maharashtra", // The state where the person resides
"city": "Mumbai", // The city where the person resides
"country": "India", // The country where the person resides
"zip_code": "400001", // The postal code of the area where the person resides
"details": [
{
"PAN": "ABCDE1234F" // The PAN (Permanent Account Number) of the person
},
{
"GST": "27ABCDE1234F1Z5" // The GST (Goods and Services Tax) number of the person or business
}
]
}
};
fetch('https://api.ninjapay.me/webextension/api/v1/fiat/invoice/client', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
Last updated