List Company Info

GET 
/accounting/company-info

Returns a list of Company Info.

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber int32

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

remoteId string

Used to filter company info with this third-party application ID.

companyName string

Used to filter company info with the exact company name.

companyNameContains string

Used to filter company info whose company names contain the provided value.

companyNameNotEquals string

Used to filter company info whose company name to exclude.

companyLegalName string

Used to filter company info with the exact company legal name.

companyLegalNameContains string

Used to filter company info whose company legal names contain the provided value.

companyLegalNameNotEquals string

Used to filter company info whose company legal name to exclude.

taxNumber string

Used to filter company info with the exact tax number.

taxNumberContains string

Used to filter company info whose tax numbers contain the provided value.

taxNumberNotEquals string

Used to filter company info whose tax number to exclude.

fiscalYearEndMonth int32

Used to filter company info with the exact month of the end of the fiscal year. Possible values: 1-12

fiscalYearEndDay int32

Used to filter company info with the exact day of the month of the end of the fiscal year. Possible values: 1-31

currency string

Used to filter company info with the exact currency.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

companyInfo

object[]

Array [

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...