The CompanyInfo object

A Rutter Company Info contains basic information about the business entity like their contact name, business name, and default currency.

Properties

idstring

The Rutter generated unique ID of the object.

platform_idstringnullable

The platform specific ID of the object.

currency_codeenum

The ISO 4217 currency code of the company.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
namestring

The DBA name of the company.

addressesarray

A list of addresses linked to the company.

String array.

legal_namestringnullable

The legal name of the company.

created_atstring

The ISO 8601 timestamp that the object was created.

updated_atstring

The ISO 8601 timestamp that the object was last updated.

last_synced_atstring

The ISO 8601 timestamp when the company info was last synced by Rutter.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example CompanyInfo Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "currency_code": "USD",
  "name": "Rutter API",
  "addresses": [
    "123 Rutter Road, San Francisco, CA 94110"
  ],
  "legal_name": "RutterAPI Inc.",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "last_synced_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

Fetch Company Info

GET /versioned/accounting/company_info
Supported for: Dynamics 365FreshBooksNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctWaveXeroZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    company_infoobject
    Show company_info attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "company_info": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "currency_code": "USD",
    "name": "Rutter API",
    "addresses": [
      "123 Rutter Road, San Francisco, CA 94110"
    ],
    "legal_name": "RutterAPI Inc.",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
Previous
Payouts