Retrieve Company Info

GET 
/accounting/company-info/:id

Retrieve Company Info with the given id.

Request

Path Parameters

id stringrequired

The ID of the company info.

Query Parameters

connectionId stringrequired

The ID of the connection.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

companyInfo

object

id string

remoteId string

companyName string

companyLegalName string

taxNumber

fiscalYearEndMonth

fiscalYearEndDay

currency string

companyUrls array

companyAddresses

object[]

Array [

addressType string

street1 string

street2 string

city string

state string

countrySubdivision string

zipCode string

]

companyPhoneNumbers

object[]

Array [

phoneNumber string

phoneNumberType string

]

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "companyInfo": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "1",
    "companyName": "Dave Testing",
    "companyLegalName": "John",
    "taxNumber": {},
    "fiscalYearEndMonth": {},
    "fiscalYearEndDay": {},
    "currency": "USD",
    "companyUrls": [
      null
    ],
    "companyAddresses": [
      {
        "addressType": "COMPANY",
        "street1": "testtt",
        "street2": "testtt",
        "city": "Palo Alto",
        "state": "CA",
        "countrySubdivision": "CA",
        "zipCode": "94303"
      }
    ],
    "companyPhoneNumbers": [
      {
        "phoneNumber": "+1 948-442-3532",
        "phoneNumberType": "PRIMARY"
      }
    ],
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:12:35.767Z",
    "updatedAt": "2024-02-22T13:45:31.210Z"
  }
}

Result

{
  "companyInfo": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "1",
    "companyName": "Dave Testing",
    "companyLegalName": "John",
    "taxNumber": null,
    "fiscalYearEndMonth": null,
    "fiscalYearEndDay": null,
    "currency": "USD",
    "companyUrls": [],
    "companyAddresses": [
        {
            "addressType": "COMPANY",
            "street1": "testtt",
            "street2": "testtt",
            "city": "Palo Alto",
            "state": "CA",
            "countrySubdivision": "CA",
            "zipCode": "94303"
        },
        {
            "addressType": "CUSTOMER_COMMUNICATION",
            "street1": "6401 Bluebonnet Blvd",
            "street2": "6401 Bluebonnet Blvd",
            "city": "Denver",
            "state": "4",
            "countrySubdivision": "4",
            "zipCode": "363001"
        },
        {
            "addressType": "LEGAL",
            "street1": "testtt",
            "street2": "testtt",
            "city": "Palo Alto",
            "state": "CA",
            "countrySubdivision": "CA",
            "zipCode": "94303"
        }
    ],
    "companyPhoneNumbers": [
        {
            "phoneNumber": "+1 948-442-3532",
            "phoneNumberType": "PRIMARY"
        }
    ],
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:12:35.767Z",
    "updatedAt": "2024-02-22T13:45:31.210Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...