einvois.io

Appearance

Supplier ​

Overview ​

The Supplier API enables the creation, retrieval, updating, and deletion of supplier records. This documentation provides detailed information on the endpoints, request and response formats, and field descriptions.

Create ​

Endpoint: /api/message/supplier_companies/{ Company } ​

This API will create a new supplier company.

  • Method: POST
  • Content-Type: application/json
  • Authentication: Bearer <token>

Request Body: ​

json
{
    "sup_company":"<supplier-company>",                //integer
    "sup_name": "<supplier-name>",                     //string
    "sup_tin": "<Supplier-TIN>",                       //string
    "sup_reg_nric": "<supplierr-NRIC>",                //string
    "sup_reg_brn": "<supplier-register-number>",       //string
    "sup_reg_passport": "<supplier-passport-number>",  //string
    "sup_reg_army": "<supplier-army-identification>",  //string
    "sup_sst": true ,                                  //boolean
    "sup_sst_reg": "<supplier-SST-registration>",      //string
    "sup_ttx": false,                                  //boolean
    "sup_ttx_no": "<supplier-tourism-tax-number>",     //string
    "sup_email": "<supplier-email-address>",           //string
    "sup_msic": "<supplier-MSIC-code>",                //string
    "sup_badsca": "<supplier-business-activity>",      //string
    "sup_adrs": "<supplier-address-code>",             //string
    "sup_cont_num": "<supplier-contact-number>",       //string
    "sup_sign": "<supplier-signature>",                //string
    "sup_bank_acc": "<supplier-bank-account-number>",  //string
    "con_buyer_code": "<consolidation-buyer-code>",    //string
    "classification": "<classification-mapping>",      //string
    "bus_2_cus": false,                                //boolean
    "cus_id":"<customer-id>",                          //integer
    "tin_vald": true,                                  //boolean
    "clas": false                                      //boolean
}

Fields Details: ​

Field NameDescriptionData TypeLength
sup_companyCompanyInteger4
sup_nameSupplierString300
sup_tinTINString14
sup_reg_nricNRICString12
sup_reg_brnRegistration NumberString20
sup_reg_passportPassport NumberString12
sup_reg_armyArmy IdentificationString12
sup_sstSST Applicable?Boolean1
sup_sst_regSST RegistrationString17
sup_ttxTourism Applicable?Boolean1
sup_ttx_noTourism Tax NumberString17
sup_emailE-mail AddressString320
sup_msicMSIC CodeString5
sup_badscaBusiness ActivityString300
sup_adrsAddress CodeString9
sup_cont_numContact NumberString15
sup_signDigital SignatureString1
sup_bank_accBank Account Numberstring150
con_buyer_codeConsolidation Buyer CodeString9
classificationClassification MappingString3
bus_2_cusB2CBoolean1
cus_idCustomer IDInteger10
tin_valdTINBoolean1
clasClassification DoneBoolean1

Response Body: (Status: 200) ​

json
{
        "bus_2_cus": false,
        "clas": true,
        "classification": "<classification-mapping>",
        "con_buyer_code": "<consolidation-buyer-code>",
        "created_timestamp": "<created-timestamp>",
        "created_user": "<created-user>",
        "cus_id": "<customer-id>",
        "sup_adrs": "<supplier-address-code>",
        "sup_badsca": "<supplier-business-activity>",
        "sup_bank_acc": "<supplier-bank-account-number>",
        "sup_company": "<supplier-company>",
        "sup_cont_num": "<supplier-contact-number>",
        "sup_email": "<supplier-email-address>",
        "sup_msic": "<supplier-MSIC-code>",
        "sup_name": "<supplier-name>",
        "sup_reg_army": "<supplier-army-identification>",
        "sup_reg_brn": "<supplier-register-number>",
        "sup_reg_nric": "<supplierr-NRIC>",
        "sup_reg_passport": "<supplier-passport-number>",
        "sup_sign": "<supplier-signature>",
        "sup_sst": false,
        "sup_sst_reg": "<supplier-SST-registration>",
        "sup_tin": "<Supplier-TIN>",
        "sup_ttx": false,
        "sup_ttx_no": "<supplier-tourism-tax-number>",
        "supplier_companies_id": "<supplier-companies-id>",
        "tin_vald": true,
        "updated_timestamp": null,
        "updated_user": null
}

Fields Details: ​

Field NameDescriptionData TypeExample
bus_2_cusB2CBooleanfalse
clasClassification DoneBooleantrue
classificationClassification MappingString10
con_buyer_codeConsolidation Buyer CodeStringdfd332
created_timestampCreated TimestampString2024-04-23T12:14:43.642361Z
created_userCreated UserStringninja
cus_idCustomer IDInteger19
sup_adrsAddress CodeStringAAPR01
sup_badscaBusiness ActivityStringGrowing of leguminous crops
sup_bank_accBank Account Numberstring11776543
sup_companyCompanyInteger456
sup_cont_numContact NumberString66789324
sup_emailE-mail AddressStringguhelectronic@guh.com.my
sup_msicMSIC CodeString008645
sup_nameSupplierStringSales Industry
sup_reg_armyArmy IdentificationString786533
sup_reg_brnRegistration NumberString98745678
sup_reg_nricNRICString87234
sup_reg_passportPassport NumberString3895476
sup_signDigital SignatureStringd
sup_sstSST Applicable?Booleantrue
sup_sst_regSST RegistrationString893456
sup_tinTINString78345634
sup_ttxTourism Applicable?Booleanflase
sup_ttx_noTourism Tax NumberString345234
supplier_companies_idSupplier Companies IDString345234
tin_valdTINBooleantrue
updated_timestampUpdated TimestampStringnull
updated_userUpdated UserStringnull

Response Body: (Status: 401 - Unauthorized) ​

When there is no token or invalid token passed:

json
{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request) ​

When supplier company is already present in the database:

json
{
    "message": "Record already exists!"
}

Response Body: (Status: 400 - Bad Request) ​

When there is an invalid data type is passed:

json
{
    "message": "Invalid Data Type"
}

Response Body: (Status: 500 - Internal Server Error) ​

When the supplier company field is passed as an empty field:

json
{
    "message":  "Validation Errors|Validation 'isNotEmpty' failed for field 'sup_company'"
}

Update ​

Endpoint: /api/message/supplier_companies/{ Company } ​

This API will update a supplier company.

  • Method: PUT
  • Content-Type: application/json
  • Authentication: Bearer <token>

Request Body: ​

json
{
    "sup_company":"<supplier-company>",                //integer
    "sup_name": "<supplier-name>",                     //string
    "sup_tin": "<Supplier-TIN>",                       //string
    "sup_reg_nric": "<supplierr-NRIC>",                //string
    "sup_reg_brn": "<supplier-register-number>",       //string
    "sup_reg_passport": "<supplier-passport-number>",  //string
    "sup_reg_army": "<supplier-army-identification>",  //string
    "sup_sst": true ,                                  //boolean
    "sup_sst_reg": "<supplier-SST-registration>",      //string
    "sup_ttx": false,                                  //boolean
    "sup_ttx_no": "<supplier-tourism-tax-number>",     //string
    "sup_email": "<supplier-email-address>",           //string
    "sup_msic": "<supplier-MSIC-code>",                //string
    "sup_badsca": "<supplier-business-activity>",      //string
    "sup_adrs": "<supplier-address-code>",             //string
    "sup_cont_num": "<supplier-contact-number>",       //string
    "sup_sign": "<supplier-signature>",                //string
    "sup_bank_acc": "<supplier-bank-account-number>",  //string
    "con_buyer_code": "<consolidation-buyer-code>",    //string
    "classification": "<classification-mapping>",      //string
    "bus_2_cus": false,                                //boolean
    "cus_id":"<customer-id>",                          //integer
    "tin_vald": true,                                  //boolean
    "clas": false                                      //boolean
}

Response Body: (Status: 200) ​

json
{
        "bus_2_cus": false,
        "clas": true,
        "classification": "<classification-mapping>",
        "con_buyer_code": "<consolidation-buyer-code>",
        "created_timestamp": "<created-timestamp>",
        "created_user": "<created-user>",
        "cus_id": "<customer-id>",
        "sup_adrs": "<supplier-address-code>",
        "sup_badsca": "<supplier-business-activity>",
        "sup_bank_acc": "<supplier-bank-account-number>",
        "sup_company": "<supplier-company>",
        "sup_cont_num": "<supplier-contact-number>",
        "sup_email": "<supplier-email-address>",
        "sup_msic": "<supplier-MSIC-code>",
        "sup_name": "<supplier-name>",
        "sup_reg_army": "<supplier-army-identification>",
        "sup_reg_brn": "<supplier-register-number>",
        "sup_reg_nric": "<supplierr-NRIC>",
        "sup_reg_passport": "<supplier-passport-number>",
        "sup_sign": "<supplier-signature>",
        "sup_sst": false,
        "sup_sst_reg": "<supplier-SST-registration>",
        "sup_tin": "<Supplier-TIN>",
        "sup_ttx": false,
        "sup_ttx_no": "<supplier-tourism-tax-number>",
        "supplier_companies_id": "<supplier-companies-id>",
        "tin_vald": true,
        "updated_timestamp": "<updated-timestamp>",
        "updated_user": "<updated-user>"
}

Response Body: (Status: 401 - Unauthorized) ​

When there is no token or invalid token passed:

json
{
    "message": "Unauthorized!"
}

Response Body: (Status: 400 - Bad Request) ​

When there is an invalid data type is passed:

json
{
    "message": "Invalid Data Type"
}

Response Body: (Status: 400 - Bad Request) ​

When you are trying to update the supplier company number:

json
{
    "message": "Record not found!"
}

Response Body: (Status: 500 - Internal Server Error) ​

When the supplier company field is passed as an empty field:

json
{
    "message":  "Validation Errors|Validation 'isNotEmpty' failed for field 'sup_company'"
}

Delete ​

Endpoint: /api/message/supplier_companies/{ Company }/{ record_id } ​

This API will delete a supplier company.

  • Method: DELETE
  • Authentication: Bearer <token>

Response Body: (Status: 200) ​

json
{
    "Message": "Message Deleted Sucessfully!"
}

Response Body: (Status: 401 - Unauthorized) ​

When there is no token or invalid token passed:

json
{
    "message": "Unauthorized!"
}

Response Body: (Status: 500 - Internal Server Error) ​

When invalid or wrong supplier companies id is paased:

json
{
    "Message": "Unable to Delete Record - Invalid Data Type"
}

Get ​

Endpoint: /api/message/supplier_companies/{ Company }/{ record_id } ​

This API will get a supplier company.

  • Method: GET
  • Authentication: Bearer <token>

Response Body: (Status: 200) ​

json
{
        "bus_2_cus": false,
        "clas": true,
        "classification": "<classification-mapping>",
        "con_buyer_code": "<consolidation-buyer-code>",
        "created_timestamp": "<created-timestamp>",
        "created_user": "<created-user>",
        "cus_id": "<customer-id>",
        "sup_adrs": "<supplier-address-code>",
        "sup_badsca": "<supplier-business-activity>",
        "sup_bank_acc": "<supplier-bank-account-number>",
        "sup_company": "<supplier-company>",
        "sup_cont_num": "<supplier-contact-number>",
        "sup_email": "<supplier-email-address>",
        "sup_msic": "<supplier-MSIC-code>",
        "sup_name": "<supplier-name>",
        "sup_reg_army": "<supplier-army-identification>",
        "sup_reg_brn": "<supplier-register-number>",
        "sup_reg_nric": "<supplierr-NRIC>",
        "sup_reg_passport": "<supplier-passport-number>",
        "sup_sign": "<supplier-signature>",
        "sup_sst": false,
        "sup_sst_reg": "<supplier-SST-registration>",
        "sup_tin": "<Supplier-TIN>",
        "sup_ttx": false,
        "sup_ttx_no": "<supplier-tourism-tax-number>",
        "supplier_companies_id": "<supplier-companies-id>",
        "tin_vald": true,
        "updated_timestamp": "<updated-timestamp>",
        "updated_user": "<updated-user>"
}

Response Body: (Status: 200) ​

When invalid or wrong supplier companies id is paased:

json
{
    "message": "null"
}

Response Body: (Status: 401 - Unauthorized) ​

When there is no token or invalid token passed:

json
{
    "message": "Unauthorized!"
}

Get All ​

Endpoint: /api/messages/supplier_companies/{ Company }/{ PageSize }/{ PageNumber } ​

This API will get all supplier companies.

  • Method: GET
  • Authentication: Bearer <token>

Response Body: (Status: 200) ​

json
[
    {
        "bus_2_cus": false,
        "clas": true,
        "classification": "<classification-mapping>",
        "con_buyer_code": "<consolidation-buyer-code>",
        "created_timestamp": "<created-timestamp>",
        "created_user": "<created-user>",
        "cus_id": "<customer-id>",
        "sup_adrs": "<supplier-address-code>",
        "sup_badsca": "<supplier-business-activity>",
        "sup_bank_acc": "<supplier-bank-account-number>",
        "sup_company": "<supplier-company>",
        "sup_cont_num": "<supplier-contact-number>",
        "sup_email": "<supplier-email-address>",
        "sup_msic": "<supplier-MSIC-code>",
        "sup_name": "<supplier-name>",
        "sup_reg_army": "<supplier-army-identification>",
        "sup_reg_brn": "<supplier-register-number>",
        "sup_reg_nric": "<supplierr-NRIC>",
        "sup_reg_passport": "<supplier-passport-number>",
        "sup_sign": "<supplier-signature>",
        "sup_sst": false,
        "sup_sst_reg": "<supplier-SST-registration>",
        "sup_tin": "<Supplier-TIN>",
        "sup_ttx": false,
        "sup_ttx_no": "<supplier-tourism-tax-number>",
        "supplier_companies_id": "<supplier-companies-id>",
        "tin_vald": true,
        "updated_timestamp": "<updated-timestamp>",
        "updated_user": "<updated-user>"
    },
    .
    .
    .
]

### Response Body: (Status: 401 - Unauthorized)
When there is no token or invalid token passed:

```json 
{
    "message": "Unauthorized!"
}