Sign in

v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Get a list companies

Used to search for successfully onboarded companies.

get/onboarding/v2/companies

Query parameters

company_numberstring

Search by company number

country_codestring

Search by company country code

cursorstring

Define start company ID - used for pagination

date_fromstring

Search by transaction creation date - date from - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

date_tostring

Search by transaction creation date - date to - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

external_idstring

Search by company external unique identifier

limitinteger

Define page size - default 25 - used for pagination

namestring

Search by company name

reporting_date_fromstring

Reporting date for the transactions summary, it does not filter the companies but the transactions to be included in the summary - reporting date from - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

reporting_date_tostring

Reporting date for the transactions summary, it does not filter the companies but the transactions to be included in the summary - reporting date to - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

sortstring

Define sort order - default ascending

tax_credentials_statusstring

Search by status of company tax credentials

tax_numberstring

Search by company tax number

transactions_directionstring

Direction of the transactions generated by the company

Response

Ok - search finished successfully.

messagestring
statusstring

Example response

{
  "data": [
    {
      "address": {
        "address_line_1": "123 Main Street",
        "address_line_2": "Suite 400",
        "canton": "Zürich",
        "city": "San Francisco",
        "city_code": "SF123",
        "country_code": "US",
        "district": "Financial District",
        "neighbourhood": "Downtown",
        "number": "123",
        "postal_code": "94105",
        "prefix": "North",
        "province": "Ontario",
        "region": "Midwest",
        "state": "California",
        "suffix": "Avenue"
      },
      "contact_details": {
        "certified_email": "certified@company.com",
        "email": "contact@company.com",
        "phone_number": "+1-800-123-4567",
        "website": "https://www.company.com"
      },
      "tax_information": {
        "activity_code": "ACT-200",
        "additional_tax_numbers": [
          {
            "country_code": "US",
            "country_subdivision_code": "CA",
            "tax_number": "123456789"
          }
        ],
        "authorization_code": "AUTH-987654",
        "billing_file_number": "BFN-00123",
        "device_id": "DEVICE-456789",
        "document_type": "INVOICE",
        "eac_code": "6201",
        "point_of_sale": "POS-1001",
        "regime": "VAT",
        "tax_code": "TX-001",
        "tax_number": "123456789"
      }
    }
  ],
  "errors": [
    {
      "type": "validation"
    }
  ],
  "status": "success"
}