1. Companies
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
          GET
        • Retrieve a Company
          GET
        • Create a Company
          POST
        • Update a Company
          PATCH
        • Delete a Company
          DELETE
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Companies

Create a Company

Developing
Testing Env
https://demo.modaltrans.com
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
name
string 
required
Name of the company.
title
string 
optional
Title or designation of the company.
company_type
enum<string> 
optional
Type or category of the company.
Allowed values:
AgentAirlineCompetitorClearing AgentDepot/WarehousePartnerProspectsShipownerSupplierTrader(Exporter/Importer)
tel
string 
optional
Telephone number of the company.
fax
string 
optional
Fax number of the company.
gsm
string 
optional
GSM (mobile) number of the company.
voip
string 
optional
The VoIP number of the company.
email
string <email>
optional
Email address of the company.
website
string <uri>
optional
Website URL of the company.
sector
enum<string> 
optional
The industry in which the company operates.
Allowed values:
Aerospace, Defence IndustryAgricultureAir TransportAlcohol BeveragesAutomative, Car ManufacturingChemical & Related ManufacturingConstruction, Building Materials & EquipmentElectronics Manufacturing & EquipmentEnergy Production & ServicesFood & Beverage & Bars & RestaurantsGas & OilPharmaceuticals / Health Products & Medical SuppliesNewspaper, Magazine & Book PublishingRail TransportReal EstateRoad TransportSea TransportTextile, Clothing ManufacturingTobacco ProductsTransportation
postcode
string 
optional
Postcode of the company's address.
address
string 
optional
Full address of the company.
district
string 
optional
District or region of the company's location.
city_name
string 
required
City where the company is located.
state
string 
optional
State or province where the company is located.
country_id
string 
required
ID of the country where the company is located.
Examples:
TRGBUS
status
enum<string> 
optional
The status of the company.
Allowed values:
activeclosedcancelledpending
gmaps
boolean 
optional
Indicates whether Google Maps integration is enabled for the company's location.
notes
string 
optional
Additional notes or remarks about the company.
company_no
string 
optional
The registration number of the company.
eori_code
string 
optional
EORI code of the company.
taxno
string 
optional
Tax number of the company.
taxoffice
string 
optional
Tax office where the company is registered.
last_lead_date
string <date>
optional
Date of the last lead for the company.
last_invoice_date
string <date>
optional
Date of the last invoice issued by the company.
company_group
string 
optional
The group or category to which the company belongs.
has_export
boolean 
optional
Indicates whether the company is involved in exporting.
export_countries
string 
optional
A list of countries to which the company exports.
export_notes
string 
optional
Additional notes about the company's export activities.
has_import
boolean 
optional
Indicates whether the company is involved in importing.
import_countries
string 
optional
A list of countries from which the company imports.
import_notes
string 
optional
Additional notes about the company's import activities.
has_warehouse
boolean 
optional
Indicates whether the company has a warehouse.
has_depot
boolean 
optional
Indicates whether the company has a depot.
twitter
string <uri>
optional
The Twitter profile URL of the company.
facebook
string <uri>
optional
The Facebook profile URL of the company.
linkedin
string <uri>
optional
The LinkedIn profile URL of the company.
business_type
string 
optional
The type of business the company is engaged in.
has_domestic
boolean 
optional
Indicates whether the company is involved in domestic operations.
due_dets
string 
optional
Details about payment dues for the company.
curr
string 
optional
Currency in which the company operates.
<= 3 characters
Examples:
TRYUSDGBP
due_days
integer 
optional
Number of days until payment is due.
payment_notes
string 
optional
Additional notes about the company's payment terms.
credit_limit
number 
optional
Credit limit assigned to the company.
financial_status
string 
optional
Financial status of the company.
financial_notes
string 
optional
Additional notes regarding the company's finances.
invoice_type
string 
optional
The type of invoice used by the company.
financial_email
string <email>
optional
The email address for financial correspondence with the company.
financor_id
integer 
optional
The ID of the financial representative
finitem_id
integer 
optional
The ID of the financials
curr_type
enum<string> 
optional
Currency rate type of the financials
Allowed values:
SellingBuyingBanlnote SellingBanknote Buying
debt_email
boolean 
optional
Indicates whether the company has debt-related email.
remind_payment
string <email>
optional
The email address for debt notification.
information_email
string <email>
optional
The email address for general information correspondence.
invoice_notes
string 
optional
Additional notes related to invoices.
credit_limit_curr
string 
optional
The currency of the credit limit.
<= 3 characters
Examples:
TRYUSDGBP
iata_code
string 
optional
IATA code associated with the company.
duns_code
string 
optional
DUNS code of the company.
edi_code
string 
optional
EDI code of the company.
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 samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://demo.modaltrans.com/api/v1/companies' \
--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
array of:
uuid
string 
required
UUID of the company
name
string 
required
Name of the company
title
string 
required
Title of the company
company_type
string 
required
Type of the company
tel
string 
required
Telephone number of the company
fax
string 
required
Fax number of the company
gsm
string 
required
GSM number of the company
voip
string 
required
VOIP number of the company
email
string 
required
Email address of the company
website
string 
required
Website of the company
sector
string 
required
Sector in which the company operates
postcode
string 
required
Postal code of the company's address
address
string 
required
Address of the company
district
string 
required
District where the company is located
city_name
string 
required
City where the company is located
state
string 
required
State where the company is located
country_id
string 
required
Country ID for the company's location
status
string 
required
Status of the company
gmaps
boolean 
required
Indicates if the company is listed on Google Maps
notes
string 
required
Additional notes about the company
company_no
string 
required
Company No
eori_code
string 
required
EORI No of the company
taxno
string 
required
Tax No of the company
taxoffice
string 
required
Tax office of the company
last_lead_date
string <date>
required
Date of the last quote
last_invoice_date
string <date>
required
Date of the last invoice
company_group
string 
required
Company Group
has_export
boolean 
required
Indicates if the company has export operations
export_countries
array[string]
required
Countries to which the company exports
export_notes
string 
required
Notes about the company's export operations
has_import
boolean 
required
Indicates if the company has import operations
import_countries
string 
required
Countries from which the company imports
import_notes
string 
required
Notes about the company's import operations
has_warehouse
boolean 
required
Indicates if the company has a warehouse
has_depot
boolean 
required
Indicates if the company has a depot
twitter
string 
required
Twitter handle of the company
facebook
string 
required
Facebook page of the company
linkedin
string 
required
LinkedIn profile of the company
business_type
string 
required
Company Sector
has_domestic
boolean 
required
Indicates if the company has domestic operations
due_dets
string 
required
Due details of company.
curr
string 
required
Currency used by the company
due_days
integer 
required
Payment Term of the company
payment_notes
string 
required
Notes about payments
credit_limit
number 
required
Company Limit
financial_status
string 
required
Financial status of the company
financial_notes
string 
required
Notes about the financial status
invoice_type
string 
required
Type of invoice
financial_email
string 
required
Financial email address
curr_type
string 
required
Type of currency used
debt_email
boolean 
required
Debt email status
remind_payment
string 
required
Debt notifications detail
information_email
string 
required
Information email address of the company
invoice_notes
string 
required
Invoice notes of the company
credit_limit_curr
string 
required
Currency of the company limit
iata_code
string 
required
Carrier code of the company
duns_code
string 
required
DUNS number of the company
edi_code
string 
required
EDI code of the company
company_balance
array [object {6}] 
required
Balance details of the company
id
integer 
required
ID of the company balance record
debit
number 
required
Debit amount
credit
number 
required
Credit amount
curr
string 
required
Currency of the balance
debit_local
number 
required
Debit amount in local currency
credit_local
number 
required
Credit amount in local currency
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
            }
        ]
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠422Unprocessable Entity
Modified at 2024-08-26 09:13:26
Previous
Retrieve a Company
Next
Update a Company
Built with