I. Giới thiệu
Tài liệu này dành cho các nhà phát triển ứng dụng muốn ứng dụng của mình có thể kết nối với hệ thống phần mềm AMIS CRM . Tài liệu sẽ mô tả phương thức kết nối giữa các ứng dụng từ Client (máy chủ/máy trạm của Khách hàng) tới service của hệ thống AMIS CRM .
1.1. Thông tin cần trước khi kết nối
| Thông tin | Giá trị | Diễn giải |
| userName | userName | Tài khoản MISAID |
| password | password | Mật khẩu tài khoản |
| client_id | Quản trị ứng dụng CRM phải vào ứng dụng CRM thực hiện kết nối và thay đổi thông tin thiết lập AppID của ứng dụng. | |
| client_secret | Quản trị ứng dụng CRM phải vào ứng dụng CRM thực hiện chức năng Tạo mã mới. | |
| callback | Nếu đối tác/kh có nhu cầu nhận phản hồi từ hệ thống AMIS CRM, vui lòng build project callback/webhook và gửi cho MISA URL của callback/webhook | |
1.2. Thông tin chi tiết để kết nối
| Thông tin | Diễn giải |
| APICrmUrl | https://amisapp.misa.vn/crm/gc/api/public/api/v2 |
| Token url (lấy access_token) | /api/oauth/actopen/connect |
| Get dictionary (lấy danh sách danh mục) | /apir/sync/actopen/get_dictionary |
| Save dictionary (tạo danh mục) | /apir/sync/actopen/save_dictionary |
| Save voucher (tạo yêu cầu sinh CT) | /api/sync/actopen/save |
1.3. Mô tả cấu trúc của API
| Thông tin | Diễn giải |
| Url | Theo từng API cụ thể |
| Method | Get/Post (Theo từng API cụ thể) |
| Params | Không sử dụng |
| Header | X-MISA-AccessToken: {access_token} |
| Body | Content-Type: application/json (Theo từng API cụ thể) |
| Response | {
“success”:true/false, “code”: “Mã lỗi”, “ErrorMessage”: “Mô tả lỗi”, “Data”: “Dữ liệu phản hồi” } |
1.4. Hướng dẫn xử lý Response
| Thông tin | Diễn giải |
| HTTP status code | |
| 200 | OK
Cho biết request đã thành công. Chú ý: Với phương thức GET đồng nghĩa với việc dữ liệu trả về đã nằm trong response -> Client không phải handle gì thêm và có thể sử dụng luôn dữ liệu trả về. |
| 201 | CREATED
Tạo dữ liệu thành công. Sử dụng cho phương thức POST. |
| 400 | BAD REQUEST
Server không hiểu cú pháp của request. Chú ý: Trong cả các trường hợp validate thông tin input lỗi cũng trả về lỗi này. |
| 401 | UNAUTHORIZED
Hệ thống chưa được ủy quyền. |
| 403 | FORBIDDEN
Server từ chối yêu cầu ngay cả khi Client đã được ủy quyền |
| 404 | NOT FOUND
Server không tìm thấy bất kì tài nguyên nào liên quan tới request URL này. |
| 500 | INTERNAL SERVER ERROR
Có lỗi xảy ra phía máy chủ. |
| Xử lý response của API | |
| Response thành công | Được mô tả ở mỗi API |
| Response lỗi | Trả về cùng 1 định dạng, sau đây gọi là ResponseError
{ “ErrorCode“: “Mã lỗi“, “DevMsg“: “mô tả thông tin lỗi cho người phát triển“, “UserMsg“: “mô tả thông tin lỗi cho người dùng“, “TraceId“: “Mã để tra cứu thông tin“ } |
1.5. Các bước thực hiện
| Thông tin | Diễn giải |
| Thực hiện cấu hình kết nối | Thực hiện mở kết nối API, lấy được các thông tin client_id và client_secret |
| API lấy mã kết nối | Lấy được giá trị của token, sử dụng cho các API về sau |
| API sinh dữ liệu | Sinh ra các dữ liệu trên hệ thống CRM (Khách hàng, đơn hàng, hàng hóa …) |
| API lấy dữ liệu | Lấy dữ liệu từ hệ thống CRM về ERP (Khách hàng, đơn hàng, hàng hóa …) |
| Postman tham khảo | – Tải về |
II. API lấy mã kết nối
Sử dụng khi kết nối với ứng dụng AMIS CRM để lấy token phục vụ cho các hàm xử lý nghiệp vụ
| Thông tin | Diễn giải |
| URL | {APICrmUrl}/Account |
| Method | Post |
| Body request | {
“client_id“: “{client_id}”, “client_secret“: “{client_secret}” } |
| Response | {
“success“: true/false, //trạng thái trả về của server “code“: <trạng thái trả về của resquest>, “data“: “token trả về” } |
| Lưu ý | Lưu lại thông tin của token ở data (token có hạn 24h) |
| Mã lỗi thường gặp |
III. API sinh dữ liệu
1. Thêm mới
| Thông tin | Diễn giải |
| URL | {APICrmUrl}/{Select}
Select: Product: Hàng hóa Contacts: Liên hệ Customers: Khách hàng SaleOrders: Đơn hàng Stocks: Kho hàng |
| Method | Post |
| Header | Authorization: giá trị token lấy ở bước II
Clientid: AppID lấy từ thiết lập trên AMIS CRM |
| Body request | [
{Select1}, {Select2}, … {SelectN}, ] |
| Response | {
“success“: true, “code“: “”,<mã lỗi nếu có> “data“: “<Danh sách kết quả trả về>” } |
| Mô tả đối tượng | Xem mô tả của từng đối tượng sử dụng |
| Mã lỗi thường gặp |
2. Sửa
| Thông tin | Diễn giải |
| URL | {APICrmUrl}/{Select}
Select: Product: Hàng hóa Contacts: Liên hệ Customers: Khách hàng SaleOrders: Đơn hàng Stocks: Kho hàng |
| Method | PUT |
| Header | Authorization: giá trị token lấy ở bước II
Clientid: AppID lấy từ thiết lập trên AMIS CRM |
| Body request | [
{Select1}, {Select2}, … {SelectN}, ] Lưu ý: truyền đúng ID của đối tượng muốn cập nhật, chỉ truyền lên những thông tin sửa, những thông tin không truyền lên mặc định không sửa |
| Response | {
“success“: true, “code“: “”,<mã lỗi nếu có> “data“: “<Danh sách kết quả trả về>” } |
| Mô tả đối tượng | Xem mô tả của từng đối tượng sử dụng |
| Mã lỗi thường gặp |
3. Xóa
| Thông tin | Diễn giải |
| URL | {APICrmUrl}/{Select}
Select: Product: Hàng hóa Contacts: Liên hệ Customers: Khách hàng SaleOrders: Đơn hàng Stocks: Kho hàng |
| Method | DELETE |
| Header | Authorization: giá trị token lấy ở bước II
Clientid: AppID lấy từ thiết lập trên AMIS CRM |
| Body request | [
{ID1}, {ID2}, … {IDN}, ] Lưu ý: truyền đúng ID của đối tượng muốn xóa |
| Response | {
“success“: true, “code“: “”,<mã lỗi nếu có> “data“: “<Danh sách kết quả trả về>” } |
| Mô tả đối tượng | Xem mô tả của từng đối tượng sử dụng |
| Mã lỗi thường gặp |
IV. API lấy dữ liệu
4.1. Lấy danh sách phân trang
| Thông tin | Diễn giải |
| URL | {APICrmUrl}/{Select}
Select: Product: Hàng hóa Contacts: Liên hệ Customers: Khách hàng SaleOrders: Đơn hàng Stocks: Kho hàng |
| Method | GET |
| Header | Authorization: giá trị token lấy ở bước II
Clientid: AppID lấy từ thiết lập trên AMIS CRM |
| Params request | {
“page”: trang muốn xem “pageSize”: số lượng bản ghi của trang, mặc định 10, tối đa 100 “orderBy”: sắp xếp theo trường, mặc định modified_date “isDescending”: thứ tự sắp xếp, mặc định true } |
| Response | {
“success“: true, “code“: “”,<mã lỗi nếu có> “data“: “<Danh sách kết quả trả về>” } |
| Mô tả đối tượng | Xem mô tả của từng đối tượng sử dụng |
| Mã lỗi thường gặp |
4.2. Lấy thông tin theo trường dữ liệu
| Thông tin | Diễn giải |
| URL | {APICrmUrl}/{Select}/{Field}
Select: Product: Hàng hóa Contacts: Liên hệ Customers: Khách hàng SaleOrders: Đơn hàng Stocks: Kho hàng Field: ID: mã duy nhất Code: mã quy định Ví dụ: {APICrmUrl}/Product/ID – lấy hàng hóa theo ID |
| Method | GET |
| Header | Authorization: giá trị token lấy ở bước II
Clientid: AppID lấy từ thiết lập trên AMIS CRM |
| Params request | ID: key của dữ liệu muốn lấy
Code: mã của dữ liệu muốn lấy Lưu ý: lấy theo Field nào thì truyền Params đó |
| Response | {
“success“: true, “code“: “”,<mã lỗi nếu có> “data“: “<Danh sách kết quả trả về>” } |
| Mô tả đối tượng | Xem mô tả của từng đối tượng sử dụng |
| Mã lỗi thường gặp |
V. Mô tả đối tượng
5.1. Hàng hóa
| Tên trường | Kiểu dữ liệu | Bắt Buộc | Ghi chú |
| Thông tin chung | |||
| id | Integer | x | Mã định danh duy nhất của sản phẩm hoặc hàng hóa |
| product_code | String | Mã hàng hóa | |
| product_name | String | Tên của sản phẩm hoặc hàng hóa | |
| usage_unit | String | Đơn vị tính | |
| product_properties | String | Tính chất | |
| source | String | Nguồn gốc | |
| product_category | String | Loại hàng hóa | |
| default_stock | String | Kho ngầm định | |
| sale_description | String | Diễn giải | |
| quantity_formula | String | Công thức tính toán số lượng (nếu có) | |
| tag | String | Thẻ hoặc nhãn dán liên quan đến sản phẩm (nếu có) | |
| is_follow_serial_number | Boolean | Chỉ báo xem sản phẩm có theo dõi theo số serial hay không | |
| Thông tin giá | |||
| unit_price | Decimal | Đơn giá bán | |
| purchased_price | Decimal | Đơn giá mua | |
| unit_price1 | Decimal | Đơn giá bán 2 | |
| unit_price2 | Decimal | Đơn giá bán 1 | |
| tax | String | Thuế GTGT | |
| unit_price_fixed | Decimal | Đơn giá bán cố định | |
| price_after_tax | Boolean | Giá bán là đơn giá sau thuế | |
| is_use_tax | Boolean | Ngầm định ghi nhận DS trước thuế | |
| unit_cost | Decimal | Đơn giá chi phí của sản phẩm | |
| Thông tin bảo hành | |||
| warranty_period | String | Thời hạn bảo hành | |
| warranty_description | String | Nội dung bảo hành | |
| Thông tin mô tả | |||
| description | String | Mô tả | |
| Thông tin hệ thống | |||
| owner_name | String | Chủ sở hữu | |
| organization_unit_name | String | Đơn vị | |
| created_by | String | Người tạo | |
| created_date | DateTime | Ngày tạo | |
| modified_by | String | Người sửa | |
| modified_date | DateTime | Ngày sửa | |
| is_public | Boolean | Dùng chung | |
| inactive | Boolean | Ngừng theo dõi | |
| form_layout | String | Bố cục | |
| is_set_product | Boolean | Là combo hàng hóa | |
| Thông tin khác | |||
| custom_field[x] (x: giá trị số) | Tự định nghĩa | Trường tùy chỉnh tự định nghĩa, x là số của trường, ví dụ: custom_field23 | |
5.2 Khách hàng
| Tên trường | Kiểu dữ liệu | Bắt Buộc | Ghi chú |
| Thông tin chung | |||
| account_number | String | Mã khách hàng | |
| account_name | String | Tên khách hàng | |
| account_short_name | String | Tên viết tắt | |
| lead_source | String | Nguồn gốc | |
| number_of_days_owed | Integer | Số ngày được nợ | |
| tax_code | String | Mã số thuế | |
| office_tel | String | Điện thoại | |
| parent_account_name | String | Đơn vị chủ quản | |
| account_type | String | Loại khách hàng | |
| gender | String | Giới tính | |
| office_email | String | ||
| business_type | String | Loại hình | |
| sector_name | String | Lĩnh vực | |
| industry | String | Ngành hàng | |
| Thông tin giao hàng | |||
| shipping_country | String | Quốc gia | |
| shipping_province | String | Tỉnh/Thành phố | |
| shipping_district | String | Quận/Huyện (Giao hàng) | |
| shipping_ward | String | Phường/Xã (Giao hàng) | |
| shipping_street | String | Số nhà, Đường phố (Giao hàng) | |
| shipping_code | String | Mã vùng (Giao hàng) | |
| shipping_address | String | Địa chỉ (Giao hàng) | |
| Thông tin hóa đơn | |||
| billing_country | String | Quốc gia (Hóa đơn) | |
| billing_province | String | Mã vùng (Hóa đơn) | |
| billing_district | String | Quận/Huyện (Hóa đơn) | |
| billing_ward | String | Tỉnh/Thành phố (Hóa đơn) | |
| billing_street | String | Số nhà, Đường phố (Hóa đơn) | |
| billing_code | String | Phường/Xã (Hóa đơn) | |
| billing_address | String | Địa chỉ (Hóa đơn) | |
| Thông tin bổ sung | |||
| bank_account | String | Tài khoản ngân hàng | |
| customer_since_date | DateTime | Là khách hàng từ | |
| celebrate_date | DateTime | Ngày thành lập/Ngày sinh | |
| no_of_employee_name | String | Quy mô nhân sự | |
| annual_revenue | String | Doanh thu | |
| website | String | Website | |
| debt | Decimal | Cộng nợ | |
| debt_limit | Decimal | Hạn mức nợ | |
| Thông tin hệ thống | |||
| owner_name | String | Chủ sở hữu | |
| organization_unit_name | String | Đơn vị | |
| created_by | String | Người tạo | |
| created_date | DateTime | Ngày tạo | |
| modified_by | String | Người sửa | |
| modified_date | DateTime | Ngày sửa | |
| is_public | Boolean | Dùng chung | |
| form_layout | Boolean | Bố cục | |
| form_layout | String | Ngày tương tác gần nhất | |
| is_set_product | Boolean | Điểm khách hàng | |
| is_personal | Boolean | Là KH cá nhân | |
| inactive | Boolean | Ngừng theo dõi | |
| is_distributor | Boolean | Là nhà phân phối | |
| related_users | String | Người liên quan | |
| Thông tin thống kê mua hàng | |||
| total_score | Decimal | Tổng điểm | |
| purchase_date_recent | DateTime | Ngày mua gần đây | |
| Thông tin khác (Thông tin này KH cần định tự định nghĩa) | |||
| custom_field[x] (x: giá trị số) | Tự định nghĩa | Trường tùy chỉnh tự định nghĩa, x là số của trường, ví dụ: custom_field23 | |
5.3. Đơn đặt hàng
| Tên trường | Kiểu dữ liệu | Bắt Buộc | Ghi chú |
| Thông tin chung | |||
| un_invoiced_amount | Decimal | Giá trị chưa xuất hóa đơn = Giá trị thanh lý – Giá trị đã xuất hóa đơn | |
| total_summary | Decimal | Tổng tiền => tổng hợp từ bảng hàng hóa lên | |
| balance_receipt_amount | Decimal | Còn phải thu = Giá trị thanh lý – Thực thu | |
| tax_summary | Decimal | Tiền thuế => tổng hợp từ bảng hàng hóa lên | |
| discount_summary | Decimal | Tiền chiết khấu => tổng hợp từ bảng hàng hóa lên | |
| to_currency_summary | Decimal | Thành tiền => tổng hợp từ bảng hàng hóa lên | |
| shipping_amount_summary | Decimal | Số lượng giao => tổng hợp từ bảng hàng hóa lên | |
| liquidate_amount | Decimal | Giá trị thanh lý | |
| to_currency_summary_oc | Decimal | Thành tiền nguyên tệ => tổng hợp từ bảng hàng hóa lên | |
| discount_summary_oc | Decimal | Tiền chiết khấu nguyên tệ => tổng hợp từ bảng hàng hóa lên | |
| tax_summary_oc | Decimal | Tiền thuế nguyên tệ => tổng hợp từ bảng hàng hóa lên | |
| total_summary_oc | Decimal | Tổng tiền nguyên tệ => tổng hợp từ bảng hàng hóa lên | |
| liquidate_amount_oc | Decimal | Giá trị thanh lý nguyên tệ | |
| sale_order_amount_oc | Decimal | Giá trị đơn hàng nguyên tệ | |
| total_receipted_amount_oc | Decimal | Thực thu nguyên tệ | |
| balance_receipt_amount_oc | Decimal | Còn phải thu nguyên tệ = Giá trị thanh lý nguyên tệ – Thực thu nguyên tệ | |
| to_currency_after_discount_summary | Decimal | Thành tiền sau CK => tổng hợp từ bảng hàng hóa lên | |
| to_currency_oc_after_discount_summary | Decimal | Thành tiền nguyên tệ sau CK => tổng hợp từ bảng hàng hóa lên | |
| amount_summary | Decimal | Số lượng => tổng hợp từ bảng hàng hóa lên | |
| usage_unit_amount_summary | Decimal | SL theo ĐVTC => tổng hợp từ bảng hàng hóa lên | |
| approved_status | String | Trạng thái phê duyệt
– Chờ duyệt – Đã duyệt – Từ chối |
|
| approver | String | Người duyệt | |
| approved_date | DateTime | Ngày duyệt | |
| is_sync_price_after_discount | Boolean | Đồng bộ đơn giá sau CK | |
| related_users | String | Người liên quan | |
| is_use_currency | Boolean | Đánh dấu sử dụng ngoại tệ | |
| sale_order_no | String | Số hợp đồng | |
| account_name | String | Khách hàng | |
| due_date | DateTime | Hạn thanh toán | |
| sale_order_amount | Decimal | Giá trị đơn hàng | |
| sale_order_name | String | Diễn giải | |
| parent_name | String | Đơn hàng cha | |
| book_date | DateTime | Ngày ghi sổ | |
| quote_name | String | Báo giá | |
| number_of_days_owed | Integer | Số ngày được nợ | |
| campaign_name | String | Chiến dịch | |
| contact_name | String | Liên hệ | |
| sale_order_type | String | Loại đơn hàng
– Bán mới – Nâng cấp – Gia hạn/Cập nhật – Dịch vụ đào tạo – Dịch vụ tư vấn triển khai – Dịch vụ khác |
|
| deadline_date | DateTime | Hạn giao hàng | |
| opportunity_name | String | Cơ hội | |
| invoice_date | DateTime | Ngày hóa đơn | |
| exchange_rate | Decimal | Tỷ giá | |
| currency_type | String | Loại tiền
– VND – USD – EUR – GBP – MYR – MMK – CNY – JPY |
|
| un_subcrible | Boolean | Ngừng theo dõi | |
| phone | String | Điện thoại | |
| sale_order_product_mappings | List<Item> | Danh sách hàng hóa | |
| Thông tin hàng hóa <Item> | |||
| product_code | String | Mã hàng hóa | |
| to_currency_oc | Thành tiền nguyên tệ =
– Nếu Đơn giá sau thuế > 0 => (Đơn giá sau thuế * Số lượng) / (1 + Thuế suất / 100) – else => Đơn giá * Số lượng |
||
| total_oc | Decimal | Tổng tiền nguyên tệ = Thành tiền nguyên tệ – Tiền chiết khấu nguyên tệ + Tiền thuế nguyên tệ | |
| description | String | Diễn giải/ mô tả | |
| amount | Decimal | Số lượng | |
| stock_name | String | Kho | |
| price | Decimal | Thành tiền | |
| unit | String | Đơn vị tính | |
| usage_unit | String | Đơn vị tính chính | |
| discount | Decimal | Tiền chiết khấu | |
| discount_percent | Decimal | Tỷ lệ chết khấu | |
| ratio | Decimal | Tỷ lệ | |
| tax | Decimal | Tiền thuế | |
| tax_percent | String | Thuế suất | |
| operator | String | Toán tử
– Nhân – Chia |
|
| price_after_discount | Decimal | Đơn giá sau CK = Đơn giá * (1 – Tỷ lệ chiết khấu / 100) | |
| to_currency_oc_after_discount | Decimal | Thành tiền nguyên tệ sau CK = Thành tiền nguyên tệ – Tiền chiết khấu nguyên tệ | |
| usage_unit_amount | Decimal | SL theo ĐVTC | |
| usage_unit_price | Decimal | Đơn giá theo ĐVTC | |
| price | Decimal | Đơn giá | |
| is_promotion | Boolean | Hàng KM | |
| description_product | String | Mô tả | |
| batch_number | String | Số lô | |
| expire_date | DateTime | Hàn sử dụng | |
| exist_amount | Decimal | ĐG tồn theo lô | |
| discount_oc | Decimal | Tiền chiết khấu nguyên tệ =
– Nếu Đơn giá sau thuế > 0 => (Đơn giá sau thuế * Số lượng) / (1 + Thuế suất / 100) * Tỷ lệ chiết khấu / 100 – else => Đơn giá * Số lượng * Tỷ lệ chiết khấu / 100 |
|
| tax_oc | Decimal | Tiền thuế nguyên tệ | |
| to_currency | Decimal | Thành tiền | |
| total | Decimal | Tổng tiền | |
| shipping_amount | Decimal | Số lượng giao | |
| price_after_tax | Decimal | Đơn giá sau thuế | |
| sort_order | Decimal | STT | |
| height | Decimal | Chiều cao | |
| width | Decimal | Chiều rộng | |
| length | Decimal | Chiều dài | |
| radius | Decimal | Bán kính | |
| mass | Decimal | Lượng | |
| to_currency_after_discount | Decimal | Thành tiền sau CK = Thành tiền – Tiền chiết khấu | |
| quantity_ordered | Decimal | Số lượng đặt | |
| Thông tin tình trạng thực hiện đơn hàng | |||
| sale_order_date | DateTime | Ngày đặt hàng | |
| revenue_status | String | Tình trạng ghi doanh số
– Bản nháp – Đề nghị ghi – Đã ghi – Từ chối ghi |
|
| total_receipted_amount | Decimal | Thực thu | |
| delivery_date | DateTime | Ngày giao hàng | |
| book_date | DateTime | Ngày ghi sổ | |
| status | String | Tình trạng
– Chưa thực hiện – Đang thực hiện – Đã thực hiện – Đã hủy bỏ – Đã giao đủ hàng |
|
| paid_date | DateTime | Ngày thanh toán | |
| invoiced_amount_oc | Decimal | Giá trị đã xuất hóa đơn | |
| sale_order_process_cost | Decimal | Dự kiến chi | |
| delivery_status | String | Tình trạng giao hàng
– Chưa giao hàng – Đã giao hàng – Đang giao hàng |
|
| is_invoiced | Boolean | Đã xuất hóa đơn | |
| pay_status | String | Tình trạng thanh toán
– Chưa thanh toán – Đã thanh toán – Đã thanh toán một phần |
|
| Thông tin giao hàng | |||
| shipping_country | String | Quốc gia (Giao hàng) | |
| shipping_province | String | Tỉnh/Thành phố (Giao hàng) | |
| shipping_district | String | Quận/Huyện (Giao hàng) | |
| shipping_ward | String | Phường/Xã (Giao hàng) | |
| shipping_street | String | Số nhà, Đường phố (Giao hàng) | |
| shipping_code | String | Mã vùng (Giao hàng) | |
| shipping_address | String | Địa chỉ (Giao hàng) | |
| ? | String | Đơn vị vận chuyển | |
| ? | String | Mã vận đơn | |
| shipping_contact_name | String | Người nhận hàng | |
| Thông tin hóa đơn | |||
| billing_account | String | Khách hàng (Hóa đơn) | |
| billing_contact | String | Người mua hàng | |
| billing_country | String | Quốc gia (Hóa đơn) | |
| billing_province | String | Tỉnh/Thành phố (Hóa đơn) | |
| billing_district | String | Quận/Huyện (Hóa đơn) | |
| billing_ward | String | Phường/Xã (Hóa đơn) | |
| billing_street | String | Số nhà, Đường phố (Hóa đơn) | |
| billing_code | String | Mã vùng (Hóa đơn) | |
| billing_address | String | Địa chỉ (Hóa đơn) | |
| Thông tin mô tả | |||
| description | String | Mô tả | |
| Thông tin hệ thống | |||
| owner_name | String | Người thực hiện xem trong Thiết lập => Người dùng | |
| created_date | DateTime | Ngày tạo (ko đc phép truyền khi thực hiện method POST) | |
| recorded_sale_users_name | String | Nhân viên được ghi DS | |
| created_by | DateTime | Người tạo (ko đc phép truyền khi thực hiện method POST) | |
| organization_unit_name | String | Đơn vị | |
| recorded_sale_organization_unit_name | String | Đơn vị được ghi DS | |
| modified_by | String | Ngày sửa (ko đc phép truyền khi thực hiện method POST) | |
| modified_date | DateTime | Người sửa (ko đc phép truyền khi thực hiện method POST) | |
| is_public | Boolean | Dùng chung | |
| form_layout | String | Bố cục xem trong Thiết lập => Phân hệ và trường => Đơn hàng | |
| related_users | String | Người liên quan | |
| ? | Đối tác/CTV giới thiệu | ||
| ? | Điểm đơn hàng | ||
| is_sync_price_after_discount | Boolean | Đồng bộ đơn giá sau CK 1 | |
| is_parent_sale_order | Là đơn hàng cha | ||
| Thông tin khác (Thông tin này KH cần định tự định nghĩa) | |||
| custom_field[x] (x: giá trị số) | Tự định nghĩa | Trường tùy chỉnh tự định nghĩa, x là số của trường, ví dụ: custom_field23 | |
5.4. Kho
| Tên trường | Kiểu dữ liệu | Bắt Buộc | Ghi chú |
| Thông tin chung | |||
| contact_code | String | Mã liên hệ | |
| first_name | String | Họ và đệm | |
| last_name | String | Tên | |
| contact_name | String | Họ và tên | |
| description | String | Mô tả | |
| account_type | String | Phân loại khách hàng | |
| account_name | String | Tổ chức | |
| email_opt_out | Boolean | Không gửi mail | |
| salutation | String | Xưng hô | |
| mobile | String | ĐT di động | |
| title | String | Chức danh | |
| office_tel | String | ĐT cơ quan | |
| phone_opt_out | Boolean | Không gọi điện | |
| office_email | String | Email cơ quan | |
| other_phone | String | Điện thoại khác | |
| zalo | String | Zalo | |
| String | Email cá nhân | ||
| lead_source | String | Nguồn gốc | |
| department | String | Phòng ban | |
| Thông tin khác | |||
| date_of_birth | DateTime | Ngày sinh | |
| gender | String | Giới tính | |
| married_status | String | Tình trạng hôn nhân | |
| String | |||
| bank_account | String | Tài khoản ngân hàng | |
| bank_name | String | Mở tại ngân hàng | |
| custom_field[x] (x: giá trị số) | Tự định nghĩa | Trường tùy chỉnh tự định nghĩa, x là số của trường, ví dụ: custom_field23 | |
| Thông tin địa chỉ | |||
| mailing_country | String | Quốc gia | |
| mailing_province | String | Tỉnh/Thành phố | |
| mailing_district | String | Quận/Huyện | |
| mailing_ward | String | Phường/Xã | |
| mailing_street | String | Số nhà, Đường phố | |
| mailing_zip | String | Mã vùng | |
| mailing_address | String | Địa chỉ | |
| Thông tin địa chỉ giao hàng | |||
| shipping_country | String | Quốc gia (Giao hàng) | |
| shipping_province | String | Tỉnh/Thành phố (Giao hàng) | |
| shipping_district | String | Quận/Huyện (Giao hàng) | |
| shipping_ward | String | Phường/Xã (Giao hàng) | |
| shipping_street | String | Số nhà, Đường phố (Giao hàng) | |
| shipping_zip | String | Mã vùng (Giao hàng) | |
| shipping_address | String | Địa chỉ (Giao hàng) | |
| shipping_long | String | Kinh độ (Giao hàng) | |
| shipping_lat | String | Vĩ độ (Giao hàng) | |
| Thông tin hệ thống | |||
| owner_name | String | Chủ sở hữu | |
| organization_unit_name | String | Đơn vị | |
| created_by | String | Người tạo | |
| created_date | DateTime | Ngày tạo | |
| modified_by | String | Người sửa | |
| modified_date | DateTime | Ngày sửa | |
| is_public | Boolean | Dùng chung | |
| form_layout | String | Bố cục | |
| total_score | String | Điểm liên hệ | |
| inactive | Boolean | Ngừng theo dõi | |
| Thông tin khác | |||
| custom_field[x] (x: giá trị số) | Tự định nghĩa | Trường tùy chỉnh tự định nghĩa, x là số của trường, ví dụ: custom_field23 | |
VI. Mã lỗi thường gặp
| Mã lỗi | Mô tả | Phương án xử lý |
| Exception | Lỗi chưa xác định được nguyên nhân | |
| InvalidAppID | Lỗi sai AppID (có thể do đang không sử dụng đúng appid do AMIS kế toán cung cấp cho dự án) | |
| InvalidToken | Lỗi do token không hợp lệ | Lấy lại token |
| ExpiredToken | Lỗi do token đã hết hạn (khi xảy ra lỗi này thì cần phải gọi lại hàm connect để lấy lại token mới nhất) | |
| InvalidParam | Tham số không hợp lệ | |
| IsCreatedVoucher | Đã sinh chứng từ kế toán | |
| VoucherNotFound | Không tìm thấy đề nghị sinh chứng từ kế toán | |
| DBAmisNotConnectDBACT | Chưa thiết lập kết nối với dữ liệu kế toán nào | |
| InvalidAccessToken | Lỗi do mã truy cập không hợp lệ | |
| AppIDDisconnect | Đã ngắt kết nối ứng dụng |



