-
Notifications
You must be signed in to change notification settings - Fork 2
Get Data Documentation Business Partner
seansimit edited this page Jul 6, 2022
·
11 revisions
Using CURL in terminal console to retrieve the Business Partner data. (* If there is no data in the data column, user may direct remove the column from the get data array.) {yourtoken} : Get your Token here
curl --header "Content-Type: application/x-www-form-urlencoded" \
--request POST \
--data '
{
"action":"getBpartnerData",
"module":"bpartner",
"token":"{yourtoken}",
"uid":"{youruid}",
"org":"{yourorg}",
"branch":"{yourbranch}",
"data":
{
"bpartner_id":"",
"bpartner_no":"",
"fetchall_bp":""
}
}
' \
https://simbiz_system_url/simbiz/api.php
The available field for retrieve Business Partner Data
| Required field for calling API | ||||
|---|---|---|---|---|
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | bpartner_id | varchar (50) | Y | Backend ID for the business partner (* will pick either one between bpartner_id and bpartner_no, bpartner_id will be the first priority) |
| 2 | bpartner_no | varchar (50) | Y | Business Partner No (* will pick either one between bpartner_id and bpartner_no, bpartner_no will be the second priority) |
| 3 | fetchall_bp | smallint (1) | Fetch all Business Partner (put value 1 for turn on,fetchall_bp will be the third priority) | |
| Business Partner Header Data | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Business Partner ID | varchar(50) | Y | Backend ID for the business partner (* will pick either one between bpartner_id and bpartner_no, bpartner_id will be the first priority) |
| 2 | Business Partner No | varchar(50) | Y | Business Partner No (* will pick either one between bpartner_id and bpartner_no, bpartner_id will be the first priority) |
| 3 | Business Partner Name | varchar(255) | Business Partner's name (Personal/Company) | |
| 4 | URL | varchar(255) | Business Partner's personal/company website's link | |
| 5 | Business Partner Group | varchar(50) | Business Partner's Group | |
| 6 | Industry | varchar(50) | Business Partner's business industry | |
| 7 | User Group | varchar(50) | ||
| 8 | Bank | varchar(30) | Business Partner's bank account name | |
| 9 | Account No | varchar(30) | Business Partner's bank account number | |
| 10 | Account Name | varchar(50) | Business Partner's bank account name | |
| 11 | Alternate Name | varchar(40) | Business Partner's alternate name | |
| 12 | Company No | varchar(20) | Business Partner's register number | |
| 13 | Remarks | varchar(40) | Business Partner's remark | |
| 14 | Description | text | Business Partner's description | |
| 15 | GST No | varchar(50) | Business Partner's GST number | |
| 16 | Registered Date | date | The date of register in the system | |
| 17 | Document Date | date | ||
| 18 | Seq No | int(11) | Sequence Number | |
| 19 | Is Active | smallint(1) | (Active[1]/not active [0]) | |
| 20 | Created | datetime | Business Partner's created date in the system | |
| 21 | Created By | varchar(50) | Business Partner's creator | |
| 22 | Updated | datetime | Business Partner's last updated date | |
| 23 | Updated By | varchar(50) | Business Partner's last updated user | |
| 24 | Organization | int(11) | Business Partner was created under which organization | |
| 25 | Branch | int(11) | Business Partner was created under which branch | |
| 26 | Business Partner Logo | text | Business Partner's logo | |
| 27 | Business Partner IC | varchar(50) | Business Partner's IC number | |
| 28 | Member Group | varchar(50) | Business Partner's membership group (for membership function) | |
| 29 | Giro Bank | varchar(100) | Business Partner's GIRO bank's name | |
| 30 | Giro Account No | varchar(30) | Business Partner's GIRO bank's account number | |
| Business Partner Line Data | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Business Partner Line ID | varchar(255) | Y | Business Partner's Line ID |
| 2 | Currency Code | varchar(50) | Business Partner's preferred transaction currency | |
| 3 | Delivery Term | varchar(255) | Business Partner's preferred delivery term | |
| 4 | Tax | varchar(255) | ||
| 5 | Sales Term | varchar(255) | Business Partner's preferred sales term | |
| 6 | Purchase Term | varchar(255) | Business Partner's preferred purchase term | |
| 7 | Sales Price Tag | varchar(255) | ||
| 8 | Purchase Price Tag | varchar(255) | ||
| 9 | Is Debtor | varchar(255) | is debtor? (yes[1]/no[0]) | |
| 10 | Outstanding_FromDebtor | |||
| 11 | Is Creditor | varchar(255) | is creditor? (yes[1]/no[0]) | |
| 12 | Outstanding_FromCreditor | |||
| 13 | Debtor Account | varchar(255) | Business Partner's Debtor account | |
| 14 | Creditor Account | varchar(255) | Business Partner's Creditor account | |
| 15 | Sales Agent | varchar(255) | Sales person who bring in the business partner | |
| 16 | Employee | varchar(255) | ||
| 17 | Term Control | varchar(255) | Business Partner's term control | |
| 18 | Link Organization | varchar(255) | Link business partner to another organization (generate opposite function) | |
| 19 | Link Branch | varchar(255) | Link business partner to another organization's branch (generate opposite function) | |
| 20 | Created | datetime | Business Partner's details created date in the system | |
| 21 | Created By | varchar(255) | Business Partner's details creator | |
| 22 | Updated | varchar(255) | Business Partner's details last updated date | |
| 23 | Updated By | datetime | Business Partner's details last updated user | |
| 24 | Organization | int(11) | Business Partner details was created under which organization | |
| 25 | Branch | int(11) | Business Partner details was created under which branch | |
| 26 | Sell Price List | varchar(255) | Sell price list that assign to the business partner | |
| 27 | Purchase Price List | varchar(255) | Purchase price list that assign to the business partner | |
| 28 | Purchase Limit | decimal(12,2) NULL | Purchase limit set on the business partner | |
| 29 | Sales Limit | decimal(12,2) NULL | Sales limit set on the business partner | |
| 30 | Is Control Sales Limit | smallint(1) NULL | Yes [1] / No [0] | |
| 31 | Is Control Sales Term | smallint(1) NULL | Yes [1] / No [0] | |
| 32 | Is Control Purchase Limit | smallint(1) NULL | Yes [1] / No [0] | |
| 33 | Is Control Purchase Term | smallint(1) NULL | Yes [1] / No [0] | |
| 34 | Current Sales Amount | decimal(12,2) NULL | Business Partner's current sales amount | |
| 35 | Current Purchase Amount | decimal(12,2) NULL | Business Partner's current purchase amount | |
| Business Partner Address data | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Address ID | varchar(50) | Y | Business partner's address id |
| 2 | Address Name | varchar(255) | Y | Business partner's address name |
| 3 | Seq No | varchar(255) | Sequence number | |
| 4 | Address | varchar(255) | Business partner's full address | |
| 5 | Tel 1 | varchar(255) | Business partner's telephone number 1 | |
| 6 | Tel 2 | varchar(255) | Business partner's telephone number 2 | |
| 7 | Fax | varchar(255) | Business partner's fax number | |
| 8 | Description | text | Business partner's address's description | |
| 9 | Sales Agent | varchar(50) | Sales person who bring in the business partner | |
| 10 | Is Shipment | smallint(1) | Business partner's address for shipment purpose? (yes[1]/no[0]) | |
| 11 | Is Invoice | smallint(1) | Business partner's address is for invoice purpose? (yes[1]/no[0]) | |
| 12 | Is Active | smallint(1) | (Active[1]/not active [0]) | |
| 13 | Created | datetime | Business Partner's details created date in the system | |
| 14 | Created By | varchar(50) | Business Partner's details creator | |
| 15 | Updated | datetime | Business Partner's details last updated date | |
| 16 | Updated By | varchar(50) | Business Partner's details last updated user | |
| 17 | Organization | int(11) | Business Partner details was created under which organization | |
| 18 | Branch | int(11) | Business Partner details was created under which branch | |
| 19 | Delivery Term | varchar(50) | Business Partner's preferred delivery term | |
| Business Partner Contacts data | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Contact ID | varchar(50) | Y | Business Partner's contact person's ID |
| 2 | Contact Code | varchar(20) NULL | Y | Business Partner's contact person's code |
| 3 | Contact Name | varchar(60) | Y | Business Partner's contact person's name |
| 4 | Contact Group | varchar(50) | ||
| 5 | Alternate Name | varchar(60) | Contact person's alternate name | |
| 6 | Description | varchar(255) | Business Partner's contact person description | |
| 7 | Greeting | varchar(40) | Business Partner's greeting (Mr/Mrs) | |
| 8 | varchar(60) | Contact person's email address | ||
| 9 | HP No | varchar(20) | Contact person's handphone number 1 | |
| 10 | HP No 2 | varchar(50) | Contact person's handphone number 2 | |
| 11 | Fax | varchar(20) | Contact person's fax number | |
| 12 | Position | varchar(30) | Contact person's position in the company | |
| 13 | Department | varchar(30) | Contact person's department in the company | |
| 14 | User ID | varchar(50) | ||
| 15 | Join Date | date NULL | ||
| 16 | Expired Date | date NULL | ||
| 17 | IC No | varchar(50) | ||
| 18 | Race | varchar(50) | Contact person's race | |
| 19 | City | varchar(200) | Contact person's address city | |
| 20 | Street | varchar(200) | Contact person's address street | |
| 21 | Post Code | int(50) | Contact person's address postcode | |
| 22 | Country | int(50) | Contact person's address country | |
| 23 | Gender | varchar(20) | Contact person's gender | |
| 24 | Language | varchar(20) | Contact person's preferred language | |
| 25 | Date of Birth | date | Contact person's date of birth | |
| 26 | Last Transaction Date | date | Contact person's last transaction date | |
| 27 | Current Point | int(11) | Contact person's current available point (only in POS) | |
| 28 | Created | datetime | Contact person's created date in the system | |
| 29 | Created By | varchar(50) | Contact person's creator | |
| 30 | Updated | datetime | Contact person's last updated date | |
| 31 | Updated By | varchar(50) | Contact person's last updated user | |
| 32 | Organization | int(11) | Business Partner details was created under which organization | |
| 33 | Branch | int(11) | Business Partner details was created under which branch | |
| 34 | Seq No | smallint(6) [10] | Sequence Number | |
| 35 | Is Active | smallint(6) | (Active[1]/not active [0]) |
"status": "OK",
"msg": "OK",
"data": {
"Business Partner Profile": {
"Business Partner ID": "1-1-2332",
"Business Partner No": "S0001",
"Business Partner Name": "SIMIT SDN BHD",
"URL": "",
"Business Partner Group": "GROUP A",
"Industry": null,
"Bank": "",
"Account No": "",
"Account Name": "",
"Alternate Name": "",
"Company No": "",
"Remarks": "",
"Description": "",
"GST No": "",
"Registered Date": "0000-00-00",
"Document Date": "0000-00-00",
"Seq No": "0",
"Is Active": "1",
"Created": "2019-02-07 16:24:18",
"Created By": "admin",
"Updated": "2019-04-26 11:50:05",
"Updated By": "admin",
"Business Partner Logo": "",
"Business Partner IC": "",
"Member Group": null,
"Giro Bank": "",
"Giro Account No": ""
},
"Business Partner Line Detail": {
"Business Partner Line ID": "1-1-2332-1549527858715",
"Currency Code": "MYR",
"Delivery Term": null,
"Tax": null,
"Sales Term": null,
"Purchase Term": null,
"Sales Price Tag": null,
"Purchase Price Tag": null,
"Is Debtor": "1",
"Outstanding_FromDebtor": "7822.50",
"Is Creditor": "1",
"Outstanding_FromCreditor": "0.00",
"Debtor Account": "DEBTOR ACCOUNT",
"Debtor Account ID": "1-1-411",
"Debtor Account Code": "3000\/P00",
"Creditor Account": "CREDITOR",
"Creditor Account ID": "1-1-1006",
"Creditor Account Code": "4000\/002",
"Sales Agent": null,
"Term Control": "",
"Link Organization": null,
"Link Branch": null,
"Created": "2019-02-07 16:24:18",
"Created By": "admin",
"Updated": "2019-04-26 11:50:05",
"Updated By": "admin",
"Organization": "SIMIT SDN BHD",
"Branch": "HQ",
"Sell Price List": "",
"Purchase Price List": "",
"Purchase Limit": "0.00",
"Sales Limit": "0.00",
"Is Control Sales Limit": "0",
"Is Control Sales Term": "0",
"Is Control Purchase Limit": "0",
"Is Control Purchase Term": "0"
},
"Business Partner Address": [
{
"Address ID": null,
"Address Name": null,
"Seq No": null,
"Address": null,
"Tel 1": null,
"Tel 2": null,
"Fax": null,
"Description": null,
"Sales Agent": null,
"Is Shipment": null,
"Is Invoice": null,
"Is Active": null,
"Created": null,
"Created By": null,
"Updated": null,
"Updated By": null
}
],
"Business Partner Contacts": [
{
"Contact ID": null,
"Contact Code": null,
"Contact Name": null,
"Alternate Name": null,
"Description": null,
"Greeting": null,
"Email": null,
"HP No": null,
"HP No 2": null,
"Fax": null,
"Position": null,
"Department": null,
"User ID": null,
"Join Date": null,
"Expired Date": null,
"IC No": null,
"Race": null,
"City": null,
"Street": null,
"Post Code": null,
"Country": null,
"Gender": null,
"Language": null,
"Date of Birth": null,
"Last Transaction Date": null,
"Current Point": null,
"Created": null,
"Created By": null,
"Updated": null,
"Updated By": null,
"Seq No": null,
"Is Active": null
}
]
}