Companies

Get all companies
Returns all company profiles of the enterprise, possibly filtered by identifiers, names or other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/companies/getAll
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ChainIds": [
        "1df21f06-0cfc-4960-9c58-a3bf1261663e",
        "5fcd1933-22f2-40b9-84da-7db04cbecec2"
    ],
    "Ids": [
        "3ed9e2f3-4bba-4df6-8d41-ab1b009b6425",
        "8a98965a-7c03-48a1-a28c-ab1b009b53c8"
    ],
    "Names": [
        "AC Company"
    ],
    "CreatedUtc": {
        "StartUtc": "2019-12-05T00:00:00Z",
        "EndUtc": "2019-12-10T00:00:00Z"
    },
    "UpdatedUtc": {
        "StartUtc": "2019-12-10T00:00:00Z",
        "EndUtc": "2019-12-17T00:00:00Z"
    },
    "ExternalIdentifiers": [
        "12345",
        "4312343"
    ],
    "Limitation": { "Count": 10 }
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainIds
array of string
optional, max 1000 items
Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
Ids
array of string
optional, max 1000 items
Unique identifiers of Companies.
Names
array of string
optional, max 1000 items
Names of Companies.
CreatedUtc
​Time interval​
optional, max length 3 months
Interval of Company creation date and time.
UpdatedUtc
​Time interval​
optional, max length 3 months
Interval of Company last update date and time.
ExternalIdentifiers
array of string
optional, max 1000 items
Identifiers of Company from external system.
Limitation
​Limitation​
required
Limitation on the quantity of customers returned.
Response
{
    "Companies": [
        {
            "Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
            "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
            "Name": "Sample Company 1",
            "IsActive": true,
            "Number": 11,
            "Identifier": null,
            "TaxIdentifier": null,
            "AdditionalTaxIdentifier": null,
            "ElectronicInvoiceIdentifier": null,
            "InvoiceDueInterval": "P2DT23H",
            "AccountingCode": null,
            "MotherCompanyId": null,
            "CreatedUtc": "2022-07-11T09:56:54Z",
            "UpdatedUtc": "2022-07-11T09:56:54Z",
            "AddressId": "bab7441c-4b82-43bc-8001-ab0400a346ec",
            "BillingCode": null,
            "Iata": "PAO",
            "Telephone": "111-222-333",
            "InvoicingEmail": "[email protected]",
            "ContacPerson": "Sample Person 1",
            "Contact": "Contact Info 1",
            "Notes": "Note 1",
            "Options": {
                "Invoiceable": true,
                "AddFeesToInvoices": true
            },
            "Department": "Sales",
            "DunsNumber": "123456789",
            "CreditRating": {
                "Basic": "PaymentRequiredUpfront"
            },
            "ReferenceIdentifier": "da34b396-77e3-495a-bd61-aecf00a3f19d",
            "WebsiteUrl": "https://www.mewssystems.com"
            "ExternalIdentifier": "company0001"
        },
        {
            "Id": "da34b396-41f7-47f6-8847-aecf00a3f19e",
            "ChainId": "5fcd1933-22f2-40b9-84da-7db04cbecec2",
            "Name": "Sample Company 2",
            "IsActive": true,
            "Number": 12,
            "Identifier": null,
            "TaxIdentifier": null,
            "AdditionalTaxIdentifier": null,
            "ElectronicInvoiceIdentifier": null,
            "InvoiceDueInterval": "P2DT23H",
            "AccountingCode": null,
            "MotherCompanyId": null,
            "CreatedUtc": "2022-07-11T09:56:54Z",
            "UpdatedUtc": "2022-07-11T09:56:54Z",
            "AddressId": null,
            "BillingCode": null,
            "Iata": "PAO",
            "Telephone": "111-222-333",
            "InvoicingEmail": "[email protected]",
            "ContacPerson": "Sample Person 2",
            "Contact": "Contact Info 2",
            "Notes": "Note 2",
            "Options": {
                "Invoiceable": true,
                "AddFeesToInvoices": false
            },
            "Department": "Accounting",
            "DunsNumber": "987654321",
            "CreditRating": {
                "Basic": "CreditOk"
            },
            "ReferenceIdentifier": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
            "WebsiteUrl": "https://www.mews.com"
            "ExternalIdentifier": "company0002"
        }
    ],
    "Cursor": "da34b396-41f7-47f6-8847-aecf00a3f19e"
}
Property
Type
Contract
Description
Companies
array of Company​
required
The company profiles of the enterprise.
Cursor
string
required
Unique identifier of the last and hence oldest company item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older companies. If Limitation is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.
Company
Property
Type
Contract
Description
Id
string
required
Unique identifier of the company.
ChainId
string
required
Unique identifier of the chain.
Name
string
required
Name of the company.
IsActive
boolean
required
Whether the company is still active.
Number
number
required
Unique number of the company.
Identifier
string
optional
Other identifier of the company, e.g. legal identifier.
TaxIdentifier
string
optional
Tax identification number of the company.
AdditionalTaxIdentifier
string
optional
Additional tax identifier of the company.
ElectronicInvoiceIdentifier
string
optional
Electronic invoice identifier of the company.
InvoiceDueInterval
string
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
AccountingCode
string
optional
Accounting code of the company.
MotherCompanyId
guid
optional
Unique identifier of mother company.
CreatedUtc
string
optional
Date of Company creation date and time.
UpdatedUtc
string
optional
Date of Company last update date and time.
AddressId
string
optional
Unique identifier of the company Address.
BillingCode
string
optional
Billing code of the company.
Iata
string
optional
Iata of the company.
Telephone
string
optional
Contact telephone number.
InvoicingEmail
string
optional
Email for issuing invoices to the company.
ContactPerson
string
optional
Contact person of the company.
Contact
string
optional
Other contact details, such as telephone, email or similar.
Notes
string
optional
Additional notes.
Options
​Company options​
required
Options of the company.
Department
string
optional
The internal segmentation of a company, e.g. sales department.
DunsNumber
string
optional
The Dun & Bradstreet unique 9-digit DUNS number.
CreditRating
​Credit rating​
optional
Credit rating to define creditworthiness of the company.
ReferenceIdentifier
string
optional
External system identifier - custom identifier used by an external system such as an external database.
WebsiteUrl
string
optional
The website url of the company.
ExternalIdentifier
string
optional, max 255 characters
Identifier of company from external system.
Company options
Property
Type
Contract
Description
Invoiceable
boolean
required
Whether the company is invoiceable or not.
AddFeesToInvoices
boolean
required
Whether the company has an additional fee applied for invoicing or not.
Credit rating
Property
Type
Contract
Description
Basic
string Credit rating basic​
optional
The level of creditworthiness of the company.
Credit rating basic
CreditOk
PaymentRequiredUpfront
LocalDecisionRequired
Add company
Adds a new company. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/companies/add
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
    "Name": "Mews",
    "Options": {
        "Invoiceable": true,
        "AddFeesToInvoices": true
    },
    "MotherCompanyId": null,
    "Identifier": null,
    "TaxIdentifier": null,
    "AdditionalTaxIdentifier": null,
    "BillingCode": null,
    "AccountingCode": null,
    "Address": null,
    "InvoiceDueInterval": "P2DT23H",
    "Telephone": "111-222-333",
    "ContacPerson": "SamplePerson",
    "Contact": "ContactInfo",
    "Notes": "Note1",
    "Iata": "PAO",
    "Department": "Sales",
    "DunsNumber": "987654321",
    "CreditRating": {
        "Basic": "CreditOk"
    },
    "ExternalIdentifier": "1234",
    "ReferenceIdentifier": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
    "WebsiteUrl": "https://www.mews.com"
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
Name
string
required
Name of the company.
Options
​Company options parameters​
required
Options of the company.
MotherCompanyId
string
optional
Unique identifier of the mother company.
Identifier
string
optional
Identifier of the company (e.g. legal identifier).
TaxIdentifier
string
optional
Tax identification number of the company.
AdditionalTaxIdentifier
string
optional
Additional tax identifer of the company.
BillingCode
string
optional
Billing code of the company.
AccountingCode
string
optional
Accounting code of the company.
Address
​Address parameters​
optional
Address of the company.
InvoiceDueInterval
string
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
ContactPerson
string
optional
Contact person of the company.
Contact
string
optional
Other contact details, such as telephone, email or similar.
Notes
string
optional
Notes of the company.
Iata
string
optional
Iata of the company.
Department
string
optional
The internal segmentation of a company, e.g. sales department.
DunsNumber
string
optional
The Dun & Bradstreet unique 9-digit DUNS number.
CreditRating
​Credit rating​
optional
Credit rating to define creditworthiness of the company.
ExternalIdentifier
string
optional, max 255 characters
Identifier of the company from external system.
ReferenceIdentifier
string
optional
External system identifier - custom identifier used by an external system such as an external database.
WebsiteUrl
string
optional
The website url of the company.
Company options parameters
Property
Type
Contract
Description
Invoiceable
boolean
required
Whether the company is invoiceable or not.
AddFeesToInvoices
boolean
required
Whether the company has an additional fee applied for invoicing or not.
Response
Same structure as in Get all companies operation.
Update company
Updates information of the company. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/companies/update
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
    "CompanyId": "7a1e4d67-d6a2-4a4c-a464-ab1100bea786",
    "Name": {
        "Value": "Sample company name"
    },
    "Options": {
        "Invoiceable": {
            "Value": true
        },
        "AddFeesToInvoices": {
            "Value": false
        }
    },
    "MotherCompanyId": {
        "Value": "ff649bce-0c4b-4395-9cdd-02039acb7cb3"
    },
    "Identifier": null,
    "TaxIdentifier": null,
    "AdditionalTaxIdentifier": null,
    "BillingCode": null,
    "AccountingCode": null,
    "InvoiceDueInterval": {
        "Value": "P2DT23H"
    },
    "ContactPerson": {
        "Value": "John Snow"
    },
    "Contact": {
        "Value": "John Snow"
    },
    "Notes": {
        "Value": "Notes"
    },
    "Iata": {
        "Value": "PAO"
    },
    "Department": {
        "Value": "Marketing"
    },
    "DunsNumber": {
        "Value": "123456789"
    },
    "CreditRating": {
        "Basic": {
            "Value": "PaymentRequiredUpfront"
        }
    },
    "ExternalIdentifier": {
        "Value": "4321"
    },
    "ReferenceIdentifier": {
        "Value": "ff64395-9cdd-4395-9cdd-02039acb7cb3"
    },
    "WebsiteUrl": {
        "Value": "https://www.mews.com"
    }
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ChainId
string
optional
Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
CompanyId
string
required
Unique identifier of the Company.
Name
​String update value​
optional
Name of the company (or null if the name should not be updated).
Options
​Options update value​
optional
Options of the company.
MotherCompanyId
​String update value​
optional
Unique identifier of the mother company (or null if the mother company should not be updated).
Identifier
​String update value​
optional
Identifier of the company, e.g. legal identifier (or null if the identifier should not be updated).
TaxIdentifier
​String update value​
optional
Tax identification number of the company (or null if the tax identifier should not be updated).
AdditionalTaxIdentifier
​String update value​
optional
Additional tax identifer of the company (or null if the additional tax identifier should not be updated).
BillingCode
​String update value​
optional
Billing code of the company (or null if the billing code should not be updated).
AccountingCode
​String update value​
optional
Accounting code of the company (or null if the acounting code should not be updated).
InvoiceDueInterval
​String update value​
optional
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
ContactPerson
​String update value​
optional
Contact person of the company.
Contact
​String update value​
optional
Other contact details, such as telephone, email or similar.
Notes
​String update value​
optional
Notes of the company.
Iata
​String update value​
optional
Iata of the company.
Department
​String update value​
optional
The internal segmentation of a company, e.g. sales department.
DunsNumber
​String update value​
optional
The Dun & Bradstreet unique 9-digit DUNS number.
CreditRating
​Credit rating update value​
optional
Credit rating to define creditworthiness of the company.
ExternalIdentifier
string
​String update value​
optional
ReferenceIdentifier
​String update value​
optional
External system identifier - custom identifier used by an external system such as an external database.
WebsiteUrl
​String update value​
optional
The website url of the company.
Company options update value
Property
Type
Contract
Description
Invoiceable
​Bool update value​
optional
Whether the company is invoiceable or not.
AddFeesToInvoices
​Bool update value​
optional
Whether the company has an additional fee applied for invoicing or not.
Credit rating update value
Property
Type
Contract
Description
Basic
​string update value with possible values of Credit rating basic​
optional
The level of creditworthiness of the company.
Response
Same structure as in Get all companies operation.

Property	Type	Contract	Description
`ClientToken`	string	required	Token identifying the client application.
`AccessToken`	string	required	Access token of the client application.
`Client`	string	required	Name and version of the client application.
`ChainIds`	array of string	optional, max 1000 items	Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
`Ids`	array of string	optional, max 1000 items	Unique identifiers of Companies.
`Names`	array of string	optional, max 1000 items	Names of Companies.
`CreatedUtc`	Time interval	optional, max length 3 months	Interval of Company creation date and time.
`UpdatedUtc`	Time interval	optional, max length 3 months	Interval of Company last update date and time.
`ExternalIdentifiers`	array of string	optional, max 1000 items	Identifiers of Company from external system.
`Limitation`	Limitation	required	Limitation on the quantity of customers returned.

Property	Type	Contract	Description
`Companies`	array of Company	required	The company profiles of the enterprise.
`Cursor`	string	required	Unique identifier of the last and hence oldest company item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older companies. If Limitation is specified in the request message, then `Cursor` will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.

Property	Type	Contract	Description
`Id`	string	required	Unique identifier of the company.
`ChainId`	string	required	Unique identifier of the chain.
`Name`	string	required	Name of the company.
`IsActive`	boolean	required	Whether the company is still active.
`Number`	number	required	Unique number of the company.
`Identifier`	string	optional	Other identifier of the company, e.g. legal identifier.
`TaxIdentifier`	string	optional	Tax identification number of the company.
`AdditionalTaxIdentifier`	string	optional	Additional tax identifier of the company.
`ElectronicInvoiceIdentifier`	string	optional	Electronic invoice identifier of the company.
`InvoiceDueInterval`	string	optional	The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
`AccountingCode`	string	optional	Accounting code of the company.
`MotherCompanyId`	guid	optional	Unique identifier of mother company.
`CreatedUtc`	string	optional	Date of Company creation date and time.
`UpdatedUtc`	string	optional	Date of Company last update date and time.
`AddressId`	string	optional	Unique identifier of the company Address.
`BillingCode`	string	optional	Billing code of the company.
`Iata`	string	optional	Iata of the company.
`Telephone`	string	optional	Contact telephone number.
`InvoicingEmail`	string	optional	Email for issuing invoices to the company.
`ContactPerson`	string	optional	Contact person of the company.
`Contact`	string	optional	Other contact details, such as telephone, email or similar.
`Notes`	string	optional	Additional notes.
`Options`	Company options	required	Options of the company.
`Department`	string	optional	The internal segmentation of a company, e.g. sales department.
`DunsNumber`	string	optional	The Dun & Bradstreet unique 9-digit DUNS number.
`CreditRating`	Credit rating	optional	Credit rating to define creditworthiness of the company.
`ReferenceIdentifier`	string	optional	External system identifier - custom identifier used by an external system such as an external database.
`WebsiteUrl`	string	optional	The website url of the company.
`ExternalIdentifier`	string	optional, max 255 characters	Identifier of company from external system.

Property	Type	Contract	Description
`Invoiceable`	boolean	required	Whether the company is invoiceable or not.
`AddFeesToInvoices`	boolean	required	Whether the company has an additional fee applied for invoicing or not.

Property	Type	Contract	Description
`Basic`	string Credit rating basic	optional	The level of creditworthiness of the company.

Property	Type	Contract	Description
`ClientToken`	string	required	Token identifying the client application.
`AccessToken`	string	required	Access token of the client application.
`Client`	string	required	Name and version of the client application.
`ChainId`	string	optional	Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
`Name`	string	required	Name of the company.
`Options`	Company options parameters	required	Options of the company.
`MotherCompanyId`	string	optional	Unique identifier of the mother company.
`Identifier`	string	optional	Identifier of the company (e.g. legal identifier).
`TaxIdentifier`	string	optional	Tax identification number of the company.
`AdditionalTaxIdentifier`	string	optional	Additional tax identifer of the company.
`BillingCode`	string	optional	Billing code of the company.
`AccountingCode`	string	optional	Accounting code of the company.
`Address`	Address parameters	optional	Address of the company.
`InvoiceDueInterval`	string	optional	The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
`ContactPerson`	string	optional	Contact person of the company.
`Contact`	string	optional	Other contact details, such as telephone, email or similar.
`Notes`	string	optional	Notes of the company.
`Iata`	string	optional	Iata of the company.
`Department`	string	optional	The internal segmentation of a company, e.g. sales department.
`DunsNumber`	string	optional	The Dun & Bradstreet unique 9-digit DUNS number.
`CreditRating`	Credit rating	optional	Credit rating to define creditworthiness of the company.
`ExternalIdentifier`	string	optional, max 255 characters	Identifier of the company from external system.
`ReferenceIdentifier`	string	optional	External system identifier - custom identifier used by an external system such as an external database.
`WebsiteUrl`	string	optional	The website url of the company.

Property	Type	Contract	Description
`Invoiceable`	boolean	required	Whether the company is invoiceable or not.
`AddFeesToInvoices`	boolean	required	Whether the company has an additional fee applied for invoicing or not.

Property	Type	Contract	Description
`ClientToken`	string	required	Token identifying the client application.
`AccessToken`	string	required	Access token of the client application.
`Client`	string	required	Name and version of the client application.
`ChainId`	string	optional	Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
`CompanyId`	string	required	Unique identifier of the Company.
`Name`	String update value	optional	Name of the company (or `null` if the name should not be updated).
`Options`	Options update value	optional	Options of the company.
`MotherCompanyId`	String update value	optional	Unique identifier of the mother company (or `null` if the mother company should not be updated).
`Identifier`	String update value	optional	Identifier of the company, e.g. legal identifier (or `null` if the identifier should not be updated).
`TaxIdentifier`	String update value	optional	Tax identification number of the company (or `null` if the tax identifier should not be updated).
`AdditionalTaxIdentifier`	String update value	optional	Additional tax identifer of the company (or `null` if the additional tax identifier should not be updated).
`BillingCode`	String update value	optional	Billing code of the company (or `null` if the billing code should not be updated).
`AccountingCode`	String update value	optional	Accounting code of the company (or `null` if the acounting code should not be updated).
`InvoiceDueInterval`	String update value	optional	The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
`ContactPerson`	String update value	optional	Contact person of the company.
`Contact`	String update value	optional	Other contact details, such as telephone, email or similar.
`Notes`	String update value	optional	Notes of the company.
`Iata`	String update value	optional	Iata of the company.
`Department`	String update value	optional	The internal segmentation of a company, e.g. sales department.
`DunsNumber`	String update value	optional	The Dun & Bradstreet unique 9-digit DUNS number.
`CreditRating`	Credit rating update value	optional	Credit rating to define creditworthiness of the company.
`ExternalIdentifier`	string	String update value	optional
`ReferenceIdentifier`	String update value	optional	External system identifier - custom identifier used by an external system such as an external database.
`WebsiteUrl`	String update value	optional	The website url of the company.

Property	Type	Contract	Description
`Invoiceable`	Bool update value	optional	Whether the company is invoiceable or not.
`AddFeesToInvoices`	Bool update value	optional	Whether the company has an additional fee applied for invoicing or not.

Property	Type	Contract	Description
`Basic`	string update value with possible values of Credit rating basic	optional	The level of creditworthiness of the company.

Commands

Companionships

Last modified 2mo ago