GET api/Companies

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Company
NameDescriptionTypeAdditional information
CompanyId

globally unique identifier

None.

CompanyName

string

None.

CompanyCode

string

None.

Address

string

None.

City

string

None.

State

string

None.

ZipCode

string

None.

Website

string

None.

Phone

string

None.

IndustryId

globally unique identifier

None.

QuickBooksFile

string

None.

email

string

None.

ChargeAccounts

Collection of ChargeAccount

None.

ChargeCards

Collection of ChargeCard

None.

CompanyUsers

Collection of CompanyUser

None.

deviceCompanies

Collection of deviceCompany

None.

Items

Collection of Item

None.

ItemTypes

Collection of ItemType

None.

Locations

Collection of Location

None.

PaymentTypes

Collection of PaymentType

None.

PriceSheets

Collection of PriceSheet

None.

Roles

Collection of Role

None.

UserPermissions

Collection of UserPermission

None.

Wallets

Collection of Wallet

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "CompanyId": "1d0cf044-b6df-4067-b318-47444f6f086e",
    "CompanyName": "sample string 2",
    "CompanyCode": "sample string 3",
    "Address": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Website": "sample string 8",
    "Phone": "sample string 9",
    "IndustryId": "980f49cb-83ab-497b-8c45-c631d0140ce9",
    "QuickBooksFile": "sample string 10",
    "email": "sample string 11",
    "ChargeAccounts": [
      {
        "$id": "2",
        "ID": "e485aa4f-3bd6-4d71-8fa3-0210fa7f8008",
        "Name": "sample string 2",
        "CompanyId": "df77a4a7-5b3c-4506-a8be-081b72cf53df",
        "CurrentBalance": 4.0,
        "LowBalance": 1.0,
        "Address1": "sample string 5",
        "Address2": "sample string 6",
        "City": "sample string 7",
        "State": "sample string 8",
        "ZipCode": "sample string 9",
        "Phone": "sample string 10",
        "email": "sample string 11",
        "ContactName": "sample string 12",
        "Status": "sample string 13",
        "AcctType": "sample string 14",
        "PriceSheetId": "344ca16a-182b-476d-bf9b-08b8c12d59f5",
        "Coupons": 1,
        "CloseDate": "2026-09-21T10:55:46Z",
        "AccountNumber": "sample string 15",
        "Country": "sample string 16",
        "FrequentlyUsed": true,
        "SortOrder": 1,
        "StartDate": "2026-09-21T10:55:46Z",
        "InActive": true,
        "Password": "sample string 17",
        "Company": {
          "$ref": "1"
        },
        "ChargeCards": [
          {
            "$id": "3",
            "ID": "8ead20a9-7e30-4d6b-aa27-773f5fd49bbd",
            "CompanyId": "aa584ba7-e1fa-4293-a9dc-fcdf129f5419",
            "CardNumber": "sample string 3",
            "ChargeAccountId": "eefffc03-3acc-4459-ad79-ab98ff3c4207",
            "VoidDate": "2026-09-21T10:55:46Z",
            "PassengerID": "b38b933f-343f-4a04-893a-93b5b1fe94ba",
            "PriceSheetID": "f038f343-27b1-4eb2-b9f3-13e885555e50",
            "CardType": "sample string 4",
            "VoidReason": "sample string 5",
            "CardTypeId": "1b873a8a-8f79-4b43-9aa4-e89a7e587ce8",
            "CardType1": {
              "$id": "4",
              "Id": "bf0206b2-913c-4a4d-b0b0-17b13974fa28",
              "Type": "sample string 2",
              "Description": "sample string 3",
              "CardStyle": "sample string 4",
              "PriceSheetId": "9e4bd427-b6c7-4013-b1f1-14016ebd0e18",
              "ItemId": "add5764b-74e7-4c50-875f-468fa8e98245",
              "Discount": true,
              "companyId": "04956494-204c-4254-a3d2-e218f6055a46",
              "NewCardChargeId": "4f76a123-94a0-48fb-b5d2-88764e0b3a5b",
              "rowguid": "844fc201-2e05-4d60-bca7-0be51ae45385",
              "Disclaimer": "sample string 7",
              "FromLocationId": "f35076c5-dfeb-4add-85bc-0a30791fcd40",
              "ToLocationId": "558faf82-985f-4ca4-acab-a7a9a26da78f",
              "ChargeCards": [
                {
                  "$ref": "3"
                },
                {
                  "$ref": "3"
                }
              ]
            },
            "Company": {
              "$ref": "1"
            },
            "Payments": [
              {
                "$id": "5",
                "ID": "0f483673-4af8-434c-b2e4-cd1a73583b8e",
                "TypeId": "0cf3c740-a0d0-46f8-b625-c53c2cdd3738",
                "Type": "sample string 2",
                "AccountID": "c9201f5f-0575-4149-ad12-87061d163fcf",
                "Amount": 3.0,
                "TicketId": "89211f36-2a2c-40d5-873f-70639877fa16",
                "Coupons": 1,
                "ItemId": "f2c7a61b-9cfb-4662-a08b-4309a4cb2318",
                "CreditAuthorization": "sample string 5",
                "CreditAuthorizationAmt": 1.0,
                "CreditRefNumber": "sample string 6",
                "Void": true,
                "VoidDateTime": "2026-09-21T10:55:46Z",
                "VoidAmt": 1.0,
                "VoidRefNumber": "sample string 8",
                "Returned": true,
                "ReturnDateTime": "2026-09-21T10:55:46Z",
                "ReturnAmt": 1.0,
                "ReturnRefNumber": "sample string 10",
                "CardId": "9402f54a-89f8-4143-b42e-84b97137ab9e",
                "CouponId": "94122438-d62c-4ca1-ba20-d208a98c4037",
                "CouponNumber": "sample string 11",
                "Deposit": true,
                "Paylater": 1.1,
                "ChargeCard": {
                  "$ref": "3"
                },
                "PaymentType": {
                  "$id": "6",
                  "Id": "f87c98de-2a10-4cb5-9674-fd9ede49e70e",
                  "Type": "sample string 2",
                  "Description": "sample string 3",
                  "Display": "sample string 4",
                  "SortOrder": 5,
                  "CompanyId": "154bf779-eb81-4718-a56e-2d962949f916",
                  "ReconcileShow": true,
                  "Company": {
                    "$ref": "1"
                  },
                  "Payments": [
                    {
                      "$ref": "5"
                    },
                    {
                      "$ref": "5"
                    }
                  ]
                },
                "Ticket": {
                  "$id": "7",
                  "ID": "513fdde3-9dec-423a-8dd0-0d2427c20adb",
                  "Number": "sample string 2",
                  "SaleDateTime": "2026-09-21T10:55:46Z",
                  "SellerID": "76624fec-a722-473a-87d9-892bd987be89",
                  "BoardingTime": "2026-09-21T10:55:46Z",
                  "BoarderID": "9ee4752e-1018-4bd0-b09a-622995cf37d3",
                  "Total": 1.0,
                  "WalletId": "2c54b17c-3e58-4cdc-9712-3ba17080ac75",
                  "LocationId": "149d3d7d-9de9-413f-96fe-d1a331c83405",
                  "PassengerId": "6c228ddd-6323-46dd-9438-1dff69649d11",
                  "ReturnTime": "2026-09-21T10:55:46Z",
                  "ReturnBoarderId": "315a9b5e-85e2-4941-adcd-8e7e9536d230",
                  "Void": true,
                  "CompanyId": "cb75ee74-d988-408c-a7ff-ca5eaceff05a",
                  "EntryTime": "2026-09-21T10:55:46Z",
                  "BoardingBoatId": "c71dab3e-bf06-4cbc-9a91-9caebe7bcba4",
                  "BoardingLocationId": "5f89095f-75d4-4417-8b48-80e0d60bc7c7",
                  "BoardingTripId": "700232a9-d089-4218-ba66-cdafef0c8aa3",
                  "ReturnBoatId": "beee15f6-443e-4bed-8d27-833d2bd6841c",
                  "ReturnLocationId": "951d7cd1-af73-4035-a64a-f2df7c2076f2",
                  "ReturnTripId": "6488d2d9-0384-44a2-890c-e0554cc2476a",
                  "roundtrip": true,
                  "HandHeldSaleNum": "sample string 6",
                  "ReservationItineraryId": "200e4dac-56c0-4623-831c-f7279fb0a6b4",
                  "ReservationTripId": "63ab4566-b835-413f-b9e9-7a1171a3e705",
                  "Cancelled": true,
                  "Stay": "sample string 8",
                  "InternalComments": "sample string 9",
                  "Memo": "sample string 10",
                  "CancellationUserId": "58977af3-8aaa-409f-8d4b-81350fc2bf9b",
                  "FromLocationId": "97b7d741-9080-45fe-a23a-d029cebc0d69",
                  "ToLocationId": "d0a79215-055b-46d9-981d-a69311300bd0",
                  "CancelTime": "2026-09-21T10:55:46Z",
                  "CancellationUserId1": "0497dfc5-842a-41da-a928-06844a2d4eb0",
                  "CancelTicketid": "db29770f-1407-4846-950a-f679cb36cfdb",
                  "CancelAmount": 1.0,
                  "Edit": 1,
                  "RefundAmount": 1.1,
                  "LineItems": [
                    {
                      "$id": "8",
                      "ID": "b02abc53-1c89-48f2-aab3-a8aac653beac",
                      "TicketID": "bf4127f9-f8e8-4595-aafe-a71713fcddab",
                      "Number": 3,
                      "Description": "sample string 4",
                      "Qty": 5.1,
                      "Total": 6.1,
                      "ItemID": "4a321a26-dda1-43a0-a471-1dc7dfa2d394",
                      "Discount": 1.1,
                      "Coupons": 1,
                      "CardId": "09607390-0539-4fde-abf0-3e3670f6d94a",
                      "NewCardSale": true,
                      "GiftCertificateUsed": true,
                      "Item": {
                        "$id": "9",
                        "ID": "f22c0402-6a70-43a9-8901-858b747f4b12",
                        "ItemNumber": "sample string 2",
                        "ShortName": "sample string 3",
                        "Name": "sample string 4",
                        "Description": "sample string 5",
                        "ItemType": "11cc76d8-7cc6-46e4-bacd-403178e9fdf3",
                        "SortOrder": 7,
                        "CompanyId": "c22ce44a-26e5-4cca-a678-5f4c33ae9742",
                        "OneWayId": "a1342e4b-c9a8-46d8-a98f-bc46b53d42bd",
                        "RoundTrip": true,
                        "InActive": true,
                        "CardPriceSheetId": "4d8bed2b-05a3-48f3-98b1-f7ca1dc42b1b",
                        "TakesSeat": true,
                        "Groups": true,
                        "Expire": 1,
                        "Disclaimer": "sample string 12",
                        "quickbooksId": "ada830ca-bc54-4f7a-8b60-81f12813fa63",
                        "Company": {
                          "$ref": "1"
                        },
                        "RoundTripItems": [
                          {
                            "$ref": "9"
                          },
                          {
                            "$ref": "9"
                          }
                        ],
                        "OneWayItem": {
                          "$ref": "9"
                        },
                        "PriceSheet": {
                          "$id": "10",
                          "ID": "fcc5c6b1-c708-4ede-b257-e4a66016cb5b",
                          "Name": "sample string 2",
                          "Description": "sample string 3",
                          "CompanyId": "ade75370-0073-4b36-bec2-b30457ca85c8",
                          "Basic": "sample string 5",
                          "StartDate": "2026-09-21T10:55:46Z",
                          "EndDate": "2026-09-21T10:55:46Z",
                          "Hierarchy": 6,
                          "Inactive": true,
                          "Company": {
                            "$ref": "1"
                          },
                          "Effectives": [
                            {
                              "$id": "11",
                              "EffectiveID": "a60d13b6-0c0e-43a1-99c1-34f05cf10be4",
                              "PriceSheetID": "52a9ebe4-d5e6-4fcb-a7dc-c11fb1d14502",
                              "EffectiveDay": 1,
                              "EffectiveStartTime": "2026-09-21T10:55:46Z",
                              "EffectiveEndTime": "2026-09-21T10:55:46Z",
                              "Checked": "sample string 3",
                              "PriceSheet": {
                                "$ref": "10"
                              }
                            },
                            {
                              "$ref": "11"
                            }
                          ],
                          "Items": [
                            {
                              "$ref": "9"
                            },
                            {
                              "$ref": "9"
                            }
                          ],
                          "Prices": [
                            {
                              "$id": "12",
                              "ID": "bb553da9-9df8-4348-8911-d1872bd57055",
                              "PriceSheetId": "1e4a2a54-1caf-464f-b943-20dc8b0a795b",
                              "ItemId": "98622246-1cd6-4970-b072-dad17e0cb1a9",
                              "Price1": 4.0,
                              "StartDate": "2026-09-21T10:55:46Z",
                              "EndDate": "2026-09-21T10:55:46Z",
                              "DefaultPrice": true,
                              "Item": {
                                "$ref": "9"
                              },
                              "PriceSheet": {
                                "$ref": "10"
                              }
                            },
                            {
                              "$ref": "12"
                            }
                          ],
                          "ChargeCards": [
                            {
                              "$ref": "3"
                            },
                            {
                              "$ref": "3"
                            }
                          ]
                        },
                        "LineItems": [
                          {
                            "$ref": "8"
                          },
                          {
                            "$ref": "8"
                          }
                        ],
                        "Prices": [
                          {
                            "$ref": "12"
                          },
                          {
                            "$ref": "12"
                          }
                        ]
                      },
                      "Ticket": {
                        "$ref": "7"
                      },
                      "ChargeCard": {
                        "$ref": "3"
                      }
                    },
                    {
                      "$ref": "8"
                    }
                  ],
                  "Payments": [
                    {
                      "$ref": "5"
                    },
                    {
                      "$ref": "5"
                    }
                  ],
                  "User": {
                    "$id": "13",
                    "username": "sample string 4",
                    "pwdKey": "sample string 14",
                    "dName": "s.sample string 7",
                    "id": "f845b505-3295-45bd-ad95-43fcc3c2c322",
                    "UsersId": "f845b505-3295-45bd-ad95-43fcc3c2c322",
                    "UserName": "sample string 4",
                    "DateHired": "2026-09-21T10:55:46Z",
                    "FirstName": "sample string 5",
                    "MiddleName": "sample string 6",
                    "LastName": "sample string 7",
                    "Address": "sample string 8",
                    "City": "sample string 9",
                    "State": "sample string 10",
                    "ZipCode": "sample string 11",
                    "Phone": "sample string 12",
                    "Cell": "sample string 13",
                    "Password": "sample string 14",
                    "sql": "sample string 15",
                    "pwd": "sample string 16",
                    "timechanged": "2026-09-21T10:55:46Z",
                    "inactive": true,
                    "Email": "sample string 19",
                    "AccessFailedCount": 1,
                    "EmailConfirmed": true,
                    "LockoutEnabled": true,
                    "LockoutEndDateUtc": "2026-09-21T10:55:46Z",
                    "PhoneNumberConfirmed": true,
                    "SecurityStamp": "sample string 20",
                    "TwoFactorEnabled": true,
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ],
                    "Users_UserPermissions": [
                      {
                        "$id": "14",
                        "Users_UserPermissionsId": "e8c03923-a5d2-490a-ae21-a30bb479b666",
                        "UsersId": "c748e7b4-988c-4b56-a154-4bcd4f59f7b2",
                        "PermissionsID": "4b8c78a2-e07c-4972-8772-d3af7b2b0e32",
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "14"
                      }
                    ],
                    "AccountTransactions": [
                      {
                        "$id": "15",
                        "ID": "e79108bf-a102-4b31-905f-25dce89590fa",
                        "TransactionDate": "2026-09-21T10:55:46Z",
                        "Amount": 3.0,
                        "Type": "sample string 4",
                        "ChargeAccountID": "f0d44229-b7d0-4299-84a9-9073c327f3c4",
                        "UserID": "58125111-a2ae-4218-b1db-4fb002eb3431",
                        "PaymentType": "sample string 6",
                        "TransactionType": {
                          "$id": "16",
                          "TranType": "sample string 1",
                          "Description": "sample string 2",
                          "AccountTransactions": [
                            {
                              "$ref": "15"
                            },
                            {
                              "$ref": "15"
                            }
                          ]
                        },
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "15"
                      }
                    ],
                    "User_Role": [
                      {
                        "$id": "17",
                        "UsersId": "f691e839-022a-48c3-8f95-d379d1f1ee1a",
                        "RoleId": "a80e102b-3a3c-47d2-998e-407e53c8aaa8",
                        "TerminationDate": "2026-09-21T10:55:46Z",
                        "rowguid": "ff831224-bce5-4f83-b9d1-2158480646f4",
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "17"
                      }
                    ],
                    "CompanyUsers": [
                      {
                        "$id": "18",
                        "CompanyUserId": "28a65103-fc10-4870-98db-2eee6cf334c9",
                        "CompanyId": "2988d76c-3084-4ed1-8dde-12293acdcce0",
                        "UsersId": "a10a4dc1-1ca4-42ae-8bc3-20f35dc4f757",
                        "UserNumber": "sample string 3",
                        "StartDate": "2026-09-21T10:55:46Z",
                        "TerminationDate": "2026-09-21T10:55:46Z",
                        "Company": {
                          "$ref": "1"
                        },
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "18"
                      }
                    ]
                  },
                  "Location": {
                    "$id": "19",
                    "id": "1a4550ef-00ab-4fc9-8ee4-f556a1cd6821",
                    "name": "sample string 2",
                    "abbr": "sample string 3",
                    "companyId": "d8afd711-8386-4d4f-941f-5cee1acc7d44",
                    "inactive": true,
                    "Company": {
                      "$ref": "1"
                    },
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ]
                  },
                  "Wallet": {
                    "$id": "20",
                    "id": "b483432c-ec1d-4144-9d28-78a839c448b7",
                    "Name": "sample string 2",
                    "companyId": "8c5d483e-0477-4270-bc3b-c8ccce6ad2ec",
                    "shortName": "sample string 4",
                    "BoatCrew": true,
                    "SortOrder": 1,
                    "Active": true,
                    "ReconcileShow": true,
                    "BoatId": "4a1e3739-f6f4-4ccc-9b75-e64029426117",
                    "Company": {
                      "$ref": "1"
                    },
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ]
                  }
                },
                "ChargeAccount": {
                  "$ref": "2"
                }
              },
              {
                "$ref": "5"
              }
            ],
            "ChargeAccount": {
              "$ref": "2"
            },
            "PriceSheet": {
              "$ref": "10"
            },
            "LineItems": [
              {
                "$ref": "8"
              },
              {
                "$ref": "8"
              }
            ]
          },
          {
            "$ref": "3"
          }
        ],
        "Payments": [
          {
            "$ref": "5"
          },
          {
            "$ref": "5"
          }
        ]
      },
      {
        "$ref": "2"
      }
    ],
    "ChargeCards": [
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ],
    "CompanyUsers": [
      {
        "$ref": "18"
      },
      {
        "$ref": "18"
      }
    ],
    "deviceCompanies": [
      {
        "$id": "21",
        "id": "c860a11c-77f4-4e76-8677-b24c8bcad8f6",
        "deviceId": "d186ed6f-179e-43b6-8cfd-49cffdcef5b3",
        "companyId": "52d2fa12-13bb-428a-942b-f75af62bd532",
        "voidDate": "2026-09-21T10:55:46Z",
        "Company": {
          "$ref": "1"
        },
        "Device": {
          "$id": "22",
          "id": "414d7498-288e-4754-ad10-962bc46459b0",
          "deviceNumber": "sample string 2",
          "deviceName": "sample string 3",
          "deviceCompanies": [
            {
              "$ref": "21"
            },
            {
              "$ref": "21"
            }
          ]
        }
      },
      {
        "$ref": "21"
      }
    ],
    "Items": [
      {
        "$ref": "9"
      },
      {
        "$ref": "9"
      }
    ],
    "ItemTypes": [
      {
        "$id": "23",
        "ID": "3fab5831-f810-4562-b90b-a0c8cd459f2f",
        "ShortName": "sample string 2",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "CompanyId": "8f227c71-9207-43b1-89dc-9b4d151535b4",
        "Company": {
          "$ref": "1"
        }
      },
      {
        "$ref": "23"
      }
    ],
    "Locations": [
      {
        "$ref": "19"
      },
      {
        "$ref": "19"
      }
    ],
    "PaymentTypes": [
      {
        "$ref": "6"
      },
      {
        "$ref": "6"
      }
    ],
    "PriceSheets": [
      {
        "$ref": "10"
      },
      {
        "$ref": "10"
      }
    ],
    "Roles": [
      {
        "$id": "24",
        "RoleId": "9e5143ed-7fe6-4ce6-8f6c-a7d3a602b3c8",
        "CompanyId": "c54d205e-a7cf-4de7-b37d-d15b3d5e1eab",
        "RoleName": "sample string 2",
        "Active": true,
        "DateRange": 1,
        "PasswordChange": 1,
        "Company": {
          "$ref": "1"
        },
        "Role_Permissions": [
          {
            "$id": "25",
            "RoleId": "b8a6dbab-2ad9-40cd-a1fe-44b528c7e6e6",
            "PermissionsId": "e75a6e13-5284-44db-bccf-a1b09a30b400",
            "Role_PermissionsId": "d309525d-5f0f-43d0-8665-104a9c278fcd",
            "Role": {
              "$ref": "24"
            }
          },
          {
            "$ref": "25"
          }
        ]
      },
      {
        "$ref": "24"
      }
    ],
    "UserPermissions": [
      {
        "$id": "26",
        "UserPermissionId": "da195685-1ab0-497b-958b-c5821a087b04",
        "PermissionsId": "18a91eb9-1f79-47ca-9952-c23970aa5101",
        "CompanyId": "f2b7501f-80cc-4b32-819f-c0f10e1b1f32",
        "ReadWrite": true,
        "Company": {
          "$ref": "1"
        },
        "Permission": {
          "$id": "27",
          "PermissionsId": "fb233cf9-a020-40dc-9d97-4c249e49ea65",
          "TypePermission": "sample string 2",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "parentId": "a21a3d6d-2482-4efc-83d6-a02ff0d63659",
          "MenuSize": 1,
          "ParentItem": 1,
          "MenuOrder": 1,
          "menuTarget": "sample string 5",
          "CostPerUnit": 1.1,
          "Permissions1": [
            {
              "$ref": "27"
            },
            {
              "$ref": "27"
            }
          ],
          "Permission1": {
            "$ref": "27"
          },
          "UserPermissions": [
            {
              "$ref": "26"
            },
            {
              "$ref": "26"
            }
          ]
        }
      },
      {
        "$ref": "26"
      }
    ],
    "Wallets": [
      {
        "$ref": "20"
      },
      {
        "$ref": "20"
      }
    ]
  },
  {
    "$ref": "1"
  }
]