Company info

Explore commerce Info endpoints in Swagger.

Overview

In the Codat system, company information includes standard commercial details about a linked company, such as their address, phone number, and company registration.

Data model

Field

Type

Description

companyName

string

Name of the linked company.

companyLegalName

string

Registered legal name of the linked company.

addresses

An array of Addresses.

phoneNumbers

An array of Phone numbers.

webLinks

An array of Web links.

registrationNumber

string

Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House.

baseCurrency

string
See currency

Currency set in the commerce platform of the linked company. Used by the currency rate.

accountBalances

An array of Account balances.

sourceUrls

dictionary of strings

URL addresses for the source of commerce data.

createdDate

string
See date

Date the linked company was created in the commerce platform.

modifiedDate

string
See date

Date the record was last updated in the Codat system.

sourceModifiedDate

string
See date

Date the record was last changed in the commerce system.

Addresses

Field

Type

Description

type

string

Type of address, either:

  • Billing
  • Delivery
  • Unknown

line1

string

Line 1 of the address for the linked company.

line2

string

Line 2 of the address for the linked company.

city

string

City address of the linked company.

region

string

Regional address of the linked company.

country

string

Country address of the linked company.

postalCode

string

Postal code or zip code address of the linked company.

Phone numbers

Field

Type

Description

number

string

Phone number of the linked company.

type

string

Type of phone number, either:

  • Primary
  • Landline
  • Mobile
  • Fax
  • Unknown

Web links

Field

Type

Description

type

string

Type of web link, either:

  • Website
  • Social
  • Unknown

url

string

URL of a web link for a linked company.

Account balances

A company can have more than one account balance record as their balance is split by currency. There will only be one account balance record per currency.

Field

Type

Description

available

decimal

The current balance. These funds are available to be transferred or paid out.

pending

decimal

Funds that are not yet available to be transferred or paid out.

reserved

decimal

Funds reserved as holdings by the payment processor or gateway.

currency

string

The currency of the balance.

Example data

{
  "companyInfo": {
    "companyName": "Default Test Account",
    "addresses": [
      {
        "type": "Unknown",
        "line1": "12 Downing St",
        "city": "London",
        "country": "GB",
        "postalCode": "SW1A 2AA"
      }
    ],
    "phoneNumbers": [
      {
        "number": "+442012345678",
        "type": "Unknown"
      }
    ],
    "webLinks": [
      {
        "type": "Website",
        "url": "https://codat.io"
      },
    ],
    "baseCurrency": "GBP",
    "accountBalances": [
      {
        "available": 100.00,
        "pending": 12.32,
        "reserved": 2.00,
        "currency": "GBP"
      }
    ],
    "sourceUrls": {
      "url1": "https://connect.sandbox.com/v2/customers",
      "url2": "https://connect.sandbox.com/v2/disputes",
    },
    "createdDate": "2021-04-28T15:25:17.119Z",
    "modifiedDate": "2021-04-28T15:25:17.119Z",
    "sourceModifiedDate": "2021-04-28T15:25:17.119Z"
  }
}

Did this page help you?