متدهای اشخاص
URL: https://api.hesabfa.com/v1/contact/get
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
code | کد شخص مورد نظر. |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', code: '00001' }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
Code | کد شخص |
Name | نام شخص |
Company | شرکت |
FirstName | نام |
LastName | نام خانوادگی |
ContactType | نوع شخص (جدول نوع اشخاص) |
NationalCode | کد/شناسه ملی |
EconomicCode | کد اقتصادی |
RegistrationNumber | شماره ثبت |
Address | آدرس شخص |
City | شهر |
State | استان |
PostalCode | کد پستی |
Phone | شماره تلفن |
Fax | شماره فکس |
Mobile | شماره موبایل |
ایمیل | |
Website | وب سایت |
RegistrationDate | تاریخ ثبت نام |
Note | یادداشت |
SharePercent | درصد سهام |
Liability | بدهکاری |
Credits | بستانکاری |
ContactCredit | اعتبار مالی |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت شخص: فعال یا غیرفعال |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result:{ Code: '0001', Name: 'شرکت توحید', Company: 'شرکت توحید', FirstName: 'محمد', LastName: 'محمدی', ContactType: 2, NationalCode: '65465465465', EconomicCode: '13232323221', RegistrationNumber: '9879898798798', Address: "", City: 'تهران', State: 'تهران', PostalCode: '2154665656', Phone: '02188664523', Fax: '02188664524', Mobile: '09361234567', Email: '[email protected]', Website: "", RegistrationDate: '2018/05/14 13:10:22', Note: "", SharePercent: 0, Liability: 0, Credits: 0, ContactCredit: 0, Tag: '', Active: true, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' } }
URL: https://api.hesabfa.com/v1/contact/getById
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
idList | id شخص یا اشخاص مورد نظر. |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', idList: [1,2,3] }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
Code | کد شخص |
Name | نام شخص |
Company | شرکت |
FirstName | نام |
LastName | نام خانوادگی |
ContactType | نوع شخص (جدول نوع اشخاص) |
NationalCode | کد/شناسه ملی |
EconomicCode | کد اقتصادی |
RegistrationNumber | شماره ثبت |
Address | آدرس شخص |
City | شهر |
State | استان |
PostalCode | کد پستی |
Phone | شماره تلفن |
Fax | شماره فکس |
Mobile | شماره موبایل |
ایمیل | |
Website | وب سایت |
RegistrationDate | تاریخ ثبت نام |
Note | یادداشت |
SharePercent | درصد سهام |
Liability | بدهکاری |
Credits | بستانکاری |
ContactCredit | اعتبار مالی |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت شخص: فعال یا غیرفعال |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result:{ Code: '0001', Name: 'شرکت توحید', Company: 'شرکت توحید', FirstName: 'محمد', LastName: 'محمدی', ContactType: 2, NationalCode: '65465465465', EconomicCode: '13232323221', RegistrationNumber: '9879898798798', Address: "", City: 'تهران', State: 'تهران', PostalCode: '2154665656', Phone: '02188664523', Fax: '02188664524', Mobile: '09361234567', Email: '[email protected]', Website: "", RegistrationDate: '2018/05/14 13:10:22', Note: "", SharePercent: 0, Liability: 0 Credits: 0, ContactCredit: 0, Tag: '', Active: true, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' } }
URL: https://api.hesabfa.com/v1/contact/getcontacts
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
پارامترهای اختیاری:
queryInfo | شی فیلتر و مرتب سازی (مشاهده توضیحات) |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', queryInfo:{ SortBy: 'Code', SortDesc: true, Take: 20, Skip: 0, Filters:[{ Property: 'Name', Operator: '*', Value: 'شرکت' } ] } }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
درون فیلد result آرایه ای از اشخاص قرار میگیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: { TotalCount:20, ------> تعداد کل FilteredCount:2, ------> تعداد فیلتر شده From:1, ------> شماره ردیف شروع To:2, ------> شماره ردیف خاتمه List:[{ ------> لیست اشخاص Code: '0001', Name: 'شرکت توحید', Company: 'شرکت توحید', FirstName: 'محمد', LastName: 'محمدی', ContactType: 2, NationalCode: '65465465465', EconomicCode: '13232323221', RegistrationNumber: '9879898798798', Address: "", City: 'تهران', State: 'تهران', PostalCode: '2154665656', Phone: '02188664523', Fax: '02188664524', Mobile: '09361234567', Email: '[email protected]', Website: "", RegistrationDate: '2018/05/14 13:10:22', Note: "", SharePercent: 0, Liability: 0, Credits: 0, ContactCredit: 0, Tag: '', Active: true, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' },{ Code: '0002', Name: 'شرکت آزمایشی', Company: 'شرکت آزمایشی', FirstName: 'رضا', LastName: 'محمدی', ContactType: 2, NationalCode: '65465465465', EconomicCode: '13232323221', RegistrationNumber: '9879898798798', Address: "", City: 'تهران', State: 'تهران', PostalCode: '2154665656', Phone: '02188664523', Fax: '02188664524', Mobile: '09361234567', Email: '[email protected]', Website: "", RegistrationDate: '2018/05/14 13:10:22', Note: "", SharePercent: 0, Liability: 0, Credits: 0, ContactCredit: 0, Tag: '', Active: false, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' }] } }
URL: https://api.hesabfa.com/v1/contact/save
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
contact |
شی نگهدارنده اطلاعات شخص شامل: |
* آیتم های ستاره دار ضروری هستند. | |
Code |
کد شخص در صورتی که کد شخص را وارد نکنید، شخص جدید ذخیره می شود. در صورتی که کد وارد شود و موجود باشد، اطلاعات ویرایش می شود. در صورتی که کد وارد شود و موجود نباشد، شخص با آن کد ذخیره خواهد شد. |
*Name | نام شخص |
Company | شرکت |
FirstName | نام |
LastName | نام خانوادگی |
* ContactType | نوع شخص (جدول نوع اشخاص) |
NationalCode | کد/شناسه ملی |
EconomicCode | کد اقتصادی |
RegistrationNumber | شماره ثبت |
Address | آدرس شخص |
City | شهر |
State | استان |
PostalCode | کد پستی |
Phone | شماره تلفن |
Fax | شماره فکس |
Mobile | شماره موبایل |
ایمیل | |
Website | وب سایت |
Note | یادداشت |
ContactCredit | اعتبار مالی |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت شخص: فعال یا غیرفعال |
NodeFamily |
دسته بندی شخص: یک فیلد متنی که به فرمت زیر می توان دسته بندی شخص را در آن تعریف کرد
"اشخاص: دسته 1: دسته 2: ..." |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', contact: { Code: '0001', Name: 'شرکت توحید', FirstName: 'محمد', LastName: 'محمدی', ContactType: 2, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' } }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن، شی شخص ذخیره شده یا ویرایش شده درون Result قرار می گیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: { Code: '0001', Name: 'شرکت توحید', Company: 'شرکت توحید', FirstName: 'محمد', LastName: 'محمدی', ContactType: 2, NationalCode: '65465465465', EconomicCode: '13232323221', RegistrationNumber: '9879898798798', Address: "", City: 'تهران', State: 'تهران', PostalCode: '2154665656', Phone: '02188664523', Fax: '02188664524', Mobile: '09361234567', Email: '[email protected]', Website: "", RegistrationDate: '2018/05/14 13:10:22', Note: "", SharePercent: 0, Liability: 0, Credits: 0, ContactCredit: 0, Tag: '', Active: true, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' } }
URL: https://api.hesabfa.com/v1/contact/batchsave
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
contacts |
لیستی از اشیاء نگهدارنده اطلاعات اشخاص شامل: |
* آیتم های ستاره دار ضروری هستند. | |
Code |
کد شخص در صورتی که کد شخص را وارد نکنید، شخص جدید ذخیره می شود. در صورتی که کد وارد شود و موجود باشد، اطلاعات ویرایش می شود. در صورتی که کد وارد شود و موجود نباشد، شخص با آن کد ذخیره خواهد شد. |
*Name | نام شخص |
Company | شرکت |
FirstName | نام |
LastName | نام خانوادگی |
* ContactType | نوع شخص (جدول نوع اشخاص) |
NationalCode | کد/شناسه ملی |
EconomicCode | کد اقتصادی |
RegistrationNumber | شماره ثبت |
Address | آدرس شخص |
City | شهر |
State | استان |
PostalCode | کد پستی |
Phone | شماره تلفن |
Fax | شماره فکس |
Mobile | شماره موبایل |
ایمیل | |
Website | وب سایت |
Note | یادداشت |
ContactCredit | اعتبار مالی |
Tag | فیلد متنی قابل استفاده توسط برنامه نویس |
Active | وضعیت شخص: فعال یا غیرفعال |
NodeFamily |
دسته بندی شخص: یک فیلد متنی که به فرمت زیر می توان دسته بندی شخص را در آن تعریف کرد
"اشخاص: دسته 1: دسته 2: ..." |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', contacts:[{ Code: '0001', Name: 'شرکت توحید', FirstName: 'محمد', LastName: 'محمدی', ContactType: 2, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' }, { Name: 'رضا علی پور', ContactType: 1 }] }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن، لیستی از اشخاص ذخیره شده یا ویرایش شده درون Result قرار می گیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: [{ Code: '0001', Name: 'شرکت توحید', Company: 'شرکت توحید', FirstName: 'محمد', LastName: 'محمدی', ContactType: 2, NationalCode: '65465465465', EconomicCode: '13232323221', RegistrationNumber: '9879898798798', Address: "", City: 'تهران', State: 'تهران', PostalCode: '2154665656', Phone: '02188664523', Fax: '02188664524', Mobile: '09361234567', Email: '[email protected]', Website: "", RegistrationDate: '2018/05/14 13:10:22', Note: "", SharePercent: 0, Liability: 0, Credits: 0, ContactCredit: 0, Tag: '', Active: true, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' }, { Code: '0005', Name: 'رضا علی پور', Company: '', FirstName: '', LastName: '', ContactType: 1, NationalCode: '', EconomicCode: '', RegistrationNumber: '', Address: "", City: '', State: '', PostalCode: '', Phone: '', Fax: '', Mobile: '', Email: '', Website: "", RegistrationDate: '2018/05/14 13:10:22', Note: "", SharePercent: 0, Liability: 0, Credits: 0, ContactCredit: 0, Tag: '', Active: false, NodeFamily: 'اشخاص:اشخاص حقوقی:سازمان ها' }] }
URL: https://api.hesabfa.com/v1/contact/delete
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
code | کد شخص مورد نظر. |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', code: '00001' }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
در صورت موفقیت آمیز بودن مقدار true درون Result قرار می گیرد. |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: true }
URL: https://api.hesabfa.com/v1/contact/getContactLink
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
code | کد شخص مورد نظر |
showAllAccounts | نمایش سایر حسابها(پیشفرض false) |
days | تعداد روز اعتبار (پیشفرض 30 روز) |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', code: '00001', showAllAccounts: true, days: 3 }
خروجی
آیتم های موجود در پاسخ:
Success ErrorCode ErrorMessage Result |
(مشاهده توضیحات) |
Link | لینک کارت حساب شخص |
مثال:
{ Success: true, ErrorCode: 0, ErrorMessage: "", Result: { Link: "https://app.hesabfa.com/public/contact/bfe03..." } }