View Company

GET /company
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/company

Retrieves the details of a Company

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ company ]
An array of all created items.
Company
Name
Description
addressstring
Company address.


Example: Dragise Misovic 163b, Cacak, Serbia
billingbilling
Billing object.
Billing
Name
Description
addressobject
Billing address.
Name
Description
citystring
City location.


Example: Cacak
countrystring
Country location.


Example: RS
postal_codestring
Postal code.


Example: 32000
streetstring
Street location.


Example: Dragise Misovica 163b
emailstring
Billing emial address.


Example: [email protected]
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
domainstring
Company domain name.


Example: demo.app
emailstring
Company email address.


Example: [email protected]
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000163
logostring (uri)
Defines the logo of company.


Example: https://path/logo.jpeg
namestring
Full name of a company.


Example: Ocamba App
ownver_idstring
A unique owner identifier generated by the Ocamba platform.


Example: 10132163
preferencesmember-setting
Member settings object.
Member Settings
Name
Description
generalgeneral-setting
General settings object.
General Settings
Name
Description
currencystring
Currency which will be applied to all Ocamba platform transactions.


Example: EUR
date_formatstring
Date format which will be applied to the overall Ocamba UI.


Example: DD-MM-YYYY
first_week_daystring
First day of week which will be applied to the overall Ocamba UI.


Example: mon
number_formatobject

Name
Description
decimal_separatorstring
Separator represented as comma.


Example: ,
thousand_separatorstring
Separator represented as dot.


Example: .
themestring
Theme which will be applied to the overall Ocamba UI.


Example: light
time_formatstring
Time format which will be applied to the overall Ocamba UI.


Example: 24
timezoneinteger
Time zone which will be applied to the overall Ocamba UI.


Example: 1
securitysecurity-setting
Security settings object.
Security Settings
Name
Description
country_restrictions[ string ]
Array of countries allowed to access to the Ocamba platform.
ip_restrictions[ string ]
Array of unique IP addresses allowed to access to the Ocamba platform. Only IPv4 format is supported.
registration_numberstring
A unique registration number generated by the Ocamba platform.


Example: 12345
short_namestring
Short name of a company.


Example: OAPP
statusstring
Describe an account status.


Example: active

Possible values: active | deleted | suspended

Default: active
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
vat_idstring
Company VAT ID.


Example: 45
websitestring (uri)
Company website url.


Example: https://www.google.com
xero_idstring
A unique identifier from an external source.


Example: c13a387e-af72-475d-98ef-b03dfae8d750
totalinteger
A total number of items.


Example: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
            "id": "1234567",
            "name": "Ocamba App",
            "short_name": "OAPP",
            "domain": "ocamba.app",
            "status": "active",
            "logo": "https://dev-storage.ocamba.com/1234567/ocamba/company/logo/mickey-mouse.jpg",
            "create_time": "2021-01-20T14:50:46Z",
            "update_time": "2021-10-29T14:02:37Z"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "1000163",
      "ownver_id": "10132163",
      "xero_id": "c13a387e-af72-475d-98ef-b03dfae8d750",
      "name": "Ocamba App",
      "short_name": "OAPP",
      "status": "active",
      "domain": "demo.app",
      "registration_number": "12345",
      "vat_id": "45",
      "logo": "https://path/logo.jpeg",
      "address": "Dragise Misovic 163b, Cacak, Serbia",
      "email": "[email protected]",
      "website": "https://www.google.com",
      "preferences": {
        "general": {
          "theme": "light",
          "timezone": 1,
          "number_format": {
            "thousand_separator": ".",
            "decimal_separator": ","
          },
          "date_format": "DD-MM-YYYY",
          "time_format": "24",
          "first_week_day": "mon",
          "currency": "EUR"
        },
        "security": {
          "ip_restrictions": [
            [
              "1.1.1.1"
            ]
          ],
          "country_restrictions": [
            [
              "AF"
            ]
          ]
        }
      },
      "billing": {
        "email": "[email protected]",
        "address": {
          "street": "Dragise Misovica 163b",
          "city": "Cacak",
          "country": "RS",
          "postal_code": "32000"
        }
      },
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}