Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse

...

Base Url: /smartfin/api/v1/whitelist


Retrieve Company Data

...

GET /smartfin/api/v1/whitelist

...

Update / Insert Company Data

...

POST/smartfin/api/v1/whitelist

...

Code Block
update_list - array[object]

Response

Example:

Code Block
{
    "error_code": 0,
    "value": {
        "insert_list": [
            {
                "entity_id": 261485,
                "company_id": 119,
                "entity_name": "TEST_COMPANY_NAME",
                "entity_type": "COUNTERPARTY",
                "address": "2",
                "email": "2",
                "tel": "3",
                "country": "",
                "create_by": 2,
                "create_time": "2023-11-07 14:59:42",
                "update_by": "",
                "last_update_time": "2023-11-07 14:59:42",
                "user_id": 2,
                "credit_amt": "",
                "invoice_code": "",
                "invoice_add": "",
                "invoice_bank": "",
                "reg_no": "",
                "credit_ccy": "",
                "fax_no": "3",
                "invalid": "",
                "create_by_name": "test2",
                "update_by_name": ""
            }
        ],
        "update_list": {
            "updated": [
                {
                    "entity_id": 261472,
                    "company_id": 119,
                    "entity_name": "TEST_COMPANY_3",
                    "entity_type": "BROKER",
                    "address": "",
                    "email": "",
                    "tel": "",
                    "country": "",
                    "create_by": 2,
                    "create_time": "2023-11-02 14:39:54",
                    "update_by": 2,
                    "last_update_time": "2023-11-07 14:59:42",
                    "user_id": 2,
                    "credit_amt": "",
                    "invoice_code": "",
                    "invoice_add": "",
                    "invoice_bank": "",
                    "reg_no": "",
                    "credit_ccy": "",
                    "fax_no": "",
                    "invalid": "",
                    "create_by_name": "test2",
                    "update_by_name": "test2"
                }
            ],
            "failed": []
        }
    }
}

...

Warning

Insert process would fail if there is an existing company with the same entity_name, entity_type or same entity_name

Update process would fail if there is an existing company with the same entity_name, entity_type or same entity_name

Delete Company

...

DELETE/smartfin/api/v1/whitelist

...