A/P Payment

A/P Payment List

  1. Request Instruction
    HTTPS Method POST
    URL http://subdomain.supersuite.my/api/ap-payment/list
    Content Type  application/json
    Response Type JSON
    Parameter Description

    token: string is required.

    branch_ref_id: string.

    Request Headers

    {

        "Content-Type":"application/json"

    }

    Request Body

    {

       "token" : "B7ABD5DEEC6588997DE41B0FE0665",

       "branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"

    }

  2. Response JSON Format
    Successful Example

    {

        "status" : true,

        "data" : 

                 [

                     {

                          "ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",

                          "branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",

                          "doc_no" : "PV-00001",

                          "number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",

                          "date" : "2020-01-14",

                          "debtor_account_number" : "400-F001",

                          "project_id" : "1",

                          "department_id" : "",

                          "description" : "Deposit Payment",

                          "second_voucher_code" : "",

                          "amount" : "80.00",

                          "unapplied_payment" : "0.00",

                          "refund_amount" : "0.00",

                          "remark" : "",

                          "payments" : [

                                           {

                                            "payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",

                                              "chart_account_number" : "310-1000",

                                              "department_id" : "",

                                              "project_id" : "",

                                              "cheque_number" : "",

                                              "payment_amount" : "80.00",

                                              "bank_charge" : "10.00",

                                              "tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",

                                              "tax_rate" : "6.00",

                                              "tax_amount" : "0.60",

                                              "bank_charge_bill_number" : "",

                                              "float_day" : "1",

                                              "payment_by" : "Alex",

                                              "is_rchq" : "off",

                                              "rchq_date" : "",

                                           }

                                        ],

                          "knock_offs" : [

                                           {

                                              "ref_id" : "RRC1CD0066F81E3C27674B1BB8BC7F",

                                              "type" : "API",

                                              "date" : "2019-12-12",

                                              "doc_no" : "PI-00001",

                                              "supplier_no" : "",

                                              "org_amount" : "100.00",

                                              "outstanding" : "20.00",

                                              "discount_due" : "",

                                              "with_disc" : "off",

                                              "amount" : "80.00",

                                              "knock_off_date" : "2020-01-14",

                                           }

                                        ]

                     }

                 ]

    }

    Fail Example

    {

        "status" : false,

        "error" : "Token invalid. / No data found. "

    }

  3. Remark Property
    Is RCHQ

    Only Accept : on, off 

    With Disc

    Only Accept : on, off

Get A/P Payment

  1. Request Instruction
    HTTPS Method POST
    URL http://subdomain.supersuite.my/api/ap-payment/get-detail/<ref_id>
    Content Type  application/json
    Response Type JSON
    Parameter Description

    ref_id : string is required.

    token: string is required.

    Request Headers

    {

        "Content-Type":"application/json"

    }

    Request Body

    {

       "token" : "B7ABD5DEEC6588997DE41B0FE0665"

    }

  2. Response JSON Format
    Successful Example

    {

        "status" : true,

        "data" : 

                 [

                     {

                          "ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",

                          "branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",

                          "doc_no" : "PV-00001",

                          "number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",

                          "date" : "2020-01-14",

                          "debtor_account_number" : "400-F001",

                          "project_id" : "1",

                          "department_id" : "",

                          "description" : "Deposit Payment",

                          "second_voucher_code" : "",

                          "amount" : "80.00",

                          "unapplied_payment" : "0.00",

                          "refund_amount" : "0.00",

                          "remark" : "",

                          "payments" : [

                                           {

                                              "payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",

                                              "chart_account_number" : "310-1000",

                                              "department_id" : "",

                                              "project_id" : "",

                                              "cheque_number" : "",

                                              "payment_amount" : "80.00",

                                              "bank_charge" : "10.00",

                                              "tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",

                                              "tax_rate" : "6.00",

                                              "tax_amount" : "0.60",

                                              "bank_charge_bill_number" : "",

                                              "float_day" : "1",

                                              "payment_by" : "Alex",

                                              "is_rchq" : "off",

                                              "rchq_date" : "",

                                           }

                                        ],

                          "knock_offs" : [

                                           {

                                              "ref_id" : "RRC1CD0066F81E3C27674B1BB8BC7F",

                                              "type" : "ARI",

                                              "date" : "2019-12-12",

                                              "doc_no" : "PI-00001",

                                              "supplier_no" : "",

                                              "org_amount" : "100.00",

                                              "outstanding" : "20.00",

                                              "discount_due" : "",

                                              "with_disc" : "off",

                                              "amount" : "80.00",

                                              "knock_off_date" : "2020-01-14",

                                           }

                                        ]

                     }

                 ]

    }

    Fail Example

    {

        "status" : false,

        "error" : "Token invalid. / Document does not existing."

    }

  3. Remark Property
    Is RCHQ

    Only Accept : on, off 

    With Disc

    Only Accept : on, off

Create A/P Payment

  1. Request Instruction
    HTTPS Method POST
    URL http://subdomain.supersuite.my/api/ap-payment/create
    Content Type  application/json
    Response Type JSON
    Parameter Description

    token : string, is required.

    branch_ref_id : string, is required.

    doc_no : string,

    number_format_ref_id : string, is required.

    date : date, is required. (Format : Y-m-d)

    debtor_account_number : string, is required.

    project_id : int.

    department_id : int.

    description : string, is required.

    second_voucher_code : string.

    remark : text.

    payments : [

                        {

                          payment_method_ref_id : string, is required. 

                          department_id : int.

                          project_id : int.

                          cheque_number : string.

                          payment_amount : decimal, is required.

                          bank_charge : decimal.

                          tax_code_ref_id : string.

                          tax_rate : decimal.

                          tax_amount : decimal.

                          bank_charge_bill_number : string.

                          float_day : int.

                          payment_by : string, is required.

                          is_rchq : char (3), is required.

                          rchq_date : date. (Format : Y-m-d)

                        }

                      ],

    knock_offs : [

                          {

                            doc_no : string, is required.

                            with_disc : char (3).

                            amount : decimal, is required.

                            knock_off_date : date. (Format : Y-m-d)

                            discount_amount : decimal.

                          }

                        ]

    Request Headers

    {

        "Content-Type":"application/json"

    }

    Request Body

    {

       "token" : "B7ABD5DEEC6588997DE41B0FE0665",

       "branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",

       "doc_no" : "",

       "number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",

       "date" : "2020-01-14",

       "debtor_account_number" : "400-F001",

       "project_id" : "1",

       "department_id" : "",

       "description" : "Deposit Payment",

       "second_voucher_code" : "",

       "remark" : "",

       "payments" : [

                                 {

                                 "payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",

                                 "department_id" : "",

                                 "project_id" : "",

                                 "cheque_number" : "",

                                 "payment_amount" : "80.00",

                                 "bank_charge" : "10.00",

                                 "tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",

                                 "tax_rate" : "6.00",

                                 "tax_amount" : "0.60",

                                 "bank_charge_bill_number" : "",

                                 "float_day" : "1",

                                 "payment_by" : "Alex",

                                 "is_rchq" : "off",

                                 "rchq_date" : "",

                                 }

                               ],

       "knock_offs" : [

                               {

                               "doc_no" : "PI-00001",

                               "with_disc" : "off",

                               "amount" : "80.00",

                               "knock_off_date" : "2020-01-14",

                               "discount_amount" : "10.00,

                               }

                             ]

    }

  2. Response JSON Format
    Successful Example

    {

        "payment_doc_no" : "I-00001",

        "credit_note_doc_no" : "CN-00001",

        "payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",

    }

    OR

    {

        "payment_doc_no" : "I-00001",

        "payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",

    }

    Fail Example

    {

        "payment_doc_no" : false,

        "error" : "Token invalid. /  Document save fail."

    }

  3. Remark Property
    Doc No

    If doc no is empty, it will auto generate by system.

    Is RCHQ

    Only Accept : on, off 

    With Disc

    Only Accept : on, off

    Knock Offs > Discount Amount

    When discount amount is bigger than 0 , it will auto generate Credit Note after completed payment document. 

    * Remark : Every time save it will generate new Credit Note (IF discount amount > 0), IF want to do edit this credit note please manually edit it in this credit note document 

  4. Bold word is Important message. 

Edit A/P Payment

  1. Request Instruction
    HTTPS Method POST
    URL http://subdomain.supersuite.my/api/ap-payment/edit/<ref_id>
    Content Type  application/json
    Response Type JSON
    Parameter Description

    ref_id : string, is required.

    token : string, is required.

    branch_ref_id : string, is required.

    number_format_ref_id : string, is required.

    doc_no : string, is required,

    date : date, is required. (Format : Y-m-d)

    debtor_account_number : string, is required.

    project_id : int.

    department_id : int.

    description : string, is required.

    second_voucher_code : string.

    remark : text.

    payments : [

                        {

                          payment_method_ref_id : string, is required. 

                          department_id : int.

                          project_id : int.

                          cheque_number : string.

                          payment_amount : decimal, is required.

                          bank_charge : decimal.

                          tax_code_ref_id : string.

                          tax_rate : decimal.

                          tax_amount : decimal.

                          bank_charge_bill_number : string.

                          float_day : int.

                          payment_by : string, is required.

                          is_rchq : char (3), is required.

                          rchq_date : date. (Format : Y-m-d)

                        }

                      ],

    knock_offs : [

                          {

                            doc_no : string, is required.

                            with_disc : char (3).

                            amount : decimal, is required.

                            knock_off_date : date. (Format : Y-m-d)

                            discount_amount : decimal.

                          }

                        ]

    Request Headers

    {

        "Content-Type":"application/json"

    }

    Request Body

    {

       "token" : "B7ABD5DEEC6588997DE41B0FE0665",

       "branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",

       "doc_no" : "PV-0001",

       "number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",

       "date" : "2020-01-14",

       "debtor_account_number" : "400-F001",

       "project_id" : "1",

       "department_id" : "",

       "description" : "Deposit Payment",

       "second_voucher_code" : "",

       "remark" : "",

       "payments" : [

                                 {

                                 "payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",

                                 "department_id" : "",

                                 "project_id" : "",

                                 "cheque_number" : "",

                                 "payment_amount" : "80.00",

                                 "bank_charge" : "10.00",

                                 "tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",

                                 "tax_rate" : "6.00",

                                 "tax_amount" : "0.60",

                                 "bank_charge_bill_number" : "",

                                 "float_day" : "1",

                                 "payment_by" : "Alex",

                                 "is_rchq" : "off",

                                 "rchq_date" : "",

                                 }

                               ],

       "knock_offs" : [

                               {

                               "doc_no" : "PI-00001",

                               "with_disc" : "off",

                               "amount" : "80.00",

                               "knock_off_date" : "2020-01-14",

                               "discount_amount" : "10.00,

                               }

                             ]

    }

  2. Response JSON Format
    Successful Example

    {

        "payment_doc_no" : "I-00001",

        "credit_note_doc_no" : "CN-00001",

        "payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",

    }

    OR

    {

        "payment_doc_no" : "I-00001",

        "payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",

    }

    Fail Example

    {

        "payment_doc_no" : false,

        "error" : "Token invalid. /  Document save fail."

    }

  3. Remark Property
    Is RCHQ

    Only Accept : on, off 

    With Disc

    Only Accept : on, off

    Knock Offs > Discount Amount

    When discount amount is bigger than 0 , it will auto generate Credit Note after completed payment document. 

    * Remark : Every time save it will generate new Credit Note (IF discount amount > 0), IF want to do edit this credit note please manually edit it in this credit note document 

  4. Bold word is Important message. 

Delete A/P Payment

  1. Request Instruction
    HTTPS Method POST
    URL http://subdomain.supersuite.my/api/ap-payment/delete/<ref_id>
    Content Type  application/json
    Response Type JSON
    Parameter Description

    ref_id: string, is required.

    token : string, is required.

    Request Headers

    {

        "Content-Type":"application/json"

    }

    Request Body

    {

       "token" : "B7ABD5DEEC6588997DE41B0FE0665",

    }

  2. Response JSON Format
    Successful Example

    {

        "status" : true,

    }

    Fail Example

    {

        "status" : false,

        "error" : "Token invalid. /  Document delete fail."

    }