Create a Company

Testing Env

https://demo.modaltrans.com

POST

/api/v1/companies

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "name": "Example Company",
    "tel": "1-927-409-2458",
    "company_type": "Trader",
    "fax": "1-927-409-2458",
    "email": "example@example.com",
    "country_id": "GB",
    "city_name": "London",
    "gmaps": false,
    "has_export": true,
    "export_countries": "AT,BE,CH,TR",
    "notes": "API Example",
    "export_notes": "consequat mollit irure in",
    "has_import": true,
    "import_countries": "AT,BE,CH,TR",
    "import_notes": "fugiat Excepteur amet in quis"

}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.modaltrans.com/api/v1/companies' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Example Company",
    "tel": "1-927-409-2458",
    "company_type": "Trader",
    "fax": "1-927-409-2458",
    "email": "example@example.com",
    "country_id": "GB",
    "city_name": "London",
    "gmaps": false,
    "has_export": true,
    "export_countries": "AT,BE,CH,TR",
    "notes": "API Example",
    "export_notes": "consequat mollit irure in",
    "has_import": true,
    "import_countries": "AT,BE,CH,TR",
    "import_notes": "fugiat Excepteur amet in quis"

}'

Responses

🟢201Created

application/json

Body

Example

[
    {
        "uuid": "string",
        "name": "string",
        "title": "string",
        "company_type": "string",
        "tel": "string",
        "fax": "string",
        "gsm": "string",
        "voip": "string",
        "email": "string",
        "website": "string",
        "sector": "string",
        "postcode": "string",
        "address": "string",
        "district": "string",
        "city_name": "string",
        "state": "string",
        "country_id": "string",
        "status": "string",
        "gmaps": true,
        "notes": "string",
        "company_no": "string",
        "eori_code": "string",
        "taxno": "string",
        "taxoffice": "string",
        "last_lead_date": "2019-08-24",
        "last_invoice_date": "2019-08-24",
        "company_group": "string",
        "has_export": true,
        "export_countries": [
            "[\"\", \"AT\", \"BE\", \"CH\", \"CZ\", \"DE\", \"FR\", \"IT\"]"
        ],
        "export_notes": "string",
        "has_import": true,
        "import_countries": "string",
        "import_notes": "string",
        "has_warehouse": true,
        "has_depot": true,
        "twitter": "string",
        "facebook": "string",
        "linkedin": "string",
        "business_type": "string",
        "has_domestic": true,
        "due_dets": "string",
        "curr": "string",
        "due_days": 0,
        "payment_notes": "string",
        "credit_limit": 0,
        "financial_status": "string",
        "financial_notes": "string",
        "invoice_type": "string",
        "financial_email": "string",
        "curr_type": "string",
        "debt_email": true,
        "remind_payment": "string",
        "information_email": "string",
        "invoice_notes": "string",
        "credit_limit_curr": "string",
        "iata_code": "string",
        "duns_code": "string",
        "edi_code": "string",
        "company_balance": [
            {
                "id": 0,
                "debit": 0,
                "credit": 0,
                "curr": "string",
                "debit_local": 0,
                "credit_local": 0
            }
        ]
    }
]

Modified at 2026-01-09 13:56:23

Retrieve a Company

Update a Company