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": "22e60e4b-c2eb-44e1-87b7-281312c188b1",
    "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": "8f81fca3-2c1e-4639-83c7-7a28a2c8e71d",
    "QuickBooksFile": "sample string 10",
    "email": "sample string 11",
    "ChargeAccounts": [
      {
        "$id": "2",
        "ID": "c2db931e-f1ee-4d86-a3bd-9a12e9f957df",
        "Name": "sample string 2",
        "CompanyId": "e7741092-a7b0-4907-8f80-606ac88d1c27",
        "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": "9d13988b-99b8-45b0-9a69-927a57b8a7ea",
        "Coupons": 1,
        "CloseDate": "2026-06-01T15:32:43Z",
        "AccountNumber": "sample string 15",
        "Country": "sample string 16",
        "FrequentlyUsed": true,
        "SortOrder": 1,
        "StartDate": "2026-06-01T15:32:43Z",
        "InActive": true,
        "Password": "sample string 17",
        "Company": {
          "$ref": "1"
        },
        "ChargeCards": [
          {
            "$id": "3",
            "ID": "3844ca10-cddd-4609-ba19-aeae24f9956e",
            "CompanyId": "5fc8c6fa-2f4b-4a63-a4c1-4adc1761ce8e",
            "CardNumber": "sample string 3",
            "ChargeAccountId": "e3d640f3-eee0-4e88-aaed-a82e52d376bd",
            "VoidDate": "2026-06-01T15:32:43Z",
            "PassengerID": "df3e8226-6ba4-438e-a473-fe2b23a22cd8",
            "PriceSheetID": "a2fdddd7-c64f-4f3f-9077-37d5dde15da6",
            "CardType": "sample string 4",
            "VoidReason": "sample string 5",
            "CardTypeId": "464fab02-1149-4469-82a5-1708280dd927",
            "CardType1": {
              "$id": "4",
              "Id": "f05e89a0-e207-4cde-806d-e252ea1a0728",
              "Type": "sample string 2",
              "Description": "sample string 3",
              "CardStyle": "sample string 4",
              "PriceSheetId": "1ade4597-8525-4e2f-b8f1-a259c07ab66f",
              "ItemId": "93016413-1c3e-49c7-8fa8-c00844bc209e",
              "Discount": true,
              "companyId": "468fe38d-34b3-45e5-a09d-18e28735c559",
              "NewCardChargeId": "d8f1ab16-b46b-45f7-94bc-2ea9c771261e",
              "rowguid": "aac7fc68-072a-479e-9e17-af889e55aa76",
              "Disclaimer": "sample string 7",
              "FromLocationId": "eb214dbf-cffb-402e-862e-0f61d0c04444",
              "ToLocationId": "863fc47c-a5b5-4fcf-b276-2f22aff2f516",
              "ChargeCards": [
                {
                  "$ref": "3"
                },
                {
                  "$ref": "3"
                }
              ]
            },
            "Company": {
              "$ref": "1"
            },
            "Payments": [
              {
                "$id": "5",
                "ID": "03b59f7e-99c8-4f6c-92e5-28db08eb5789",
                "TypeId": "8bfcb70c-aca0-4bd3-9cca-39aaf238f831",
                "Type": "sample string 2",
                "AccountID": "5dfdea44-3ea2-48b6-b110-4f144c4d1557",
                "Amount": 3.0,
                "TicketId": "128a1ec3-28b4-439d-bf2b-9677845b664f",
                "Coupons": 1,
                "ItemId": "204cf5cf-c18c-44fa-b297-c755c8420a83",
                "CreditAuthorization": "sample string 5",
                "CreditAuthorizationAmt": 1.0,
                "CreditRefNumber": "sample string 6",
                "Void": true,
                "VoidDateTime": "2026-06-01T15:32:43Z",
                "VoidAmt": 1.0,
                "VoidRefNumber": "sample string 8",
                "Returned": true,
                "ReturnDateTime": "2026-06-01T15:32:43Z",
                "ReturnAmt": 1.0,
                "ReturnRefNumber": "sample string 10",
                "CardId": "3061a163-3d6d-412d-9644-b30e29bfd377",
                "CouponId": "b57f2faf-2022-4b16-b43b-ab72b9b4e224",
                "CouponNumber": "sample string 11",
                "Deposit": true,
                "Paylater": 1.1,
                "ChargeCard": {
                  "$ref": "3"
                },
                "PaymentType": {
                  "$id": "6",
                  "Id": "ab8f6abd-2b91-42f1-9ce9-a321deeb1f3e",
                  "Type": "sample string 2",
                  "Description": "sample string 3",
                  "Display": "sample string 4",
                  "SortOrder": 5,
                  "CompanyId": "3ff55405-1428-4bed-bfc5-4b929b92cda9",
                  "ReconcileShow": true,
                  "Company": {
                    "$ref": "1"
                  },
                  "Payments": [
                    {
                      "$ref": "5"
                    },
                    {
                      "$ref": "5"
                    }
                  ]
                },
                "Ticket": {
                  "$id": "7",
                  "ID": "e52b7a3d-8cc2-43e7-a1a3-1e6afffa6f74",
                  "Number": "sample string 2",
                  "SaleDateTime": "2026-06-01T15:32:43Z",
                  "SellerID": "ac8921d8-bb72-4d92-a6c4-2d5ff6614175",
                  "BoardingTime": "2026-06-01T15:32:43Z",
                  "BoarderID": "ad0d9fb3-7a0e-45ae-8b3e-95b7f3679825",
                  "Total": 1.0,
                  "WalletId": "0a7f01c7-da85-44fc-8232-8ca5b84b72b6",
                  "LocationId": "82b96be0-b89f-4abf-9ff4-d3319825957a",
                  "PassengerId": "aa0e2e17-ed4e-4b0d-b7a2-e57d4bf6da3f",
                  "ReturnTime": "2026-06-01T15:32:43Z",
                  "ReturnBoarderId": "5ca9fc26-2e6c-48a9-abae-430e53e1de08",
                  "Void": true,
                  "CompanyId": "cede2e17-6129-44ea-8382-5a1c4c00628e",
                  "EntryTime": "2026-06-01T15:32:43Z",
                  "BoardingBoatId": "78075dd4-439e-4308-9af8-3df55ef6c6cc",
                  "BoardingLocationId": "6310bd9a-16db-4483-af3d-d3df238a6c99",
                  "BoardingTripId": "56afdb24-2ec7-4991-a758-e41a51bf3a1c",
                  "ReturnBoatId": "4685d483-42d7-4126-af77-2f12d890275b",
                  "ReturnLocationId": "6b902b1d-4e90-4072-9824-c63e252d44e6",
                  "ReturnTripId": "87a67c0d-8d6a-4c5d-b6b9-87668ef6bd65",
                  "roundtrip": true,
                  "HandHeldSaleNum": "sample string 6",
                  "ReservationItineraryId": "835af426-9252-4365-9b1d-c00a6645b8fe",
                  "ReservationTripId": "07f37d28-a605-465c-8fd1-bce5d74abb0f",
                  "Cancelled": true,
                  "Stay": "sample string 8",
                  "InternalComments": "sample string 9",
                  "Memo": "sample string 10",
                  "CancellationUserId": "f4f547fe-e801-48e5-b4f7-3149bbeb2d4b",
                  "FromLocationId": "60a566ed-26a3-4de4-8bd9-e84fa03e18f4",
                  "ToLocationId": "40c1c1e8-5cb1-45ca-a2e9-47f35371f0ce",
                  "CancelTime": "2026-06-01T15:32:43Z",
                  "CancellationUserId1": "f49c99e7-ce56-4170-94d5-6f724b0df667",
                  "CancelTicketid": "aba58677-7cd7-42f6-a74e-29d491ca8914",
                  "CancelAmount": 1.0,
                  "Edit": 1,
                  "RefundAmount": 1.1,
                  "LineItems": [
                    {
                      "$id": "8",
                      "ID": "6e0d6aeb-a276-4953-b74a-5fcb30776b32",
                      "TicketID": "82a890ae-385b-45d0-9c95-b1b4bd522aee",
                      "Number": 3,
                      "Description": "sample string 4",
                      "Qty": 5.1,
                      "Total": 6.1,
                      "ItemID": "f06611d7-a1e2-48cd-ad0c-c1bcc795bcdd",
                      "Discount": 1.1,
                      "Coupons": 1,
                      "CardId": "2f050b90-4047-4e9c-9b5f-747fcd6a86ea",
                      "NewCardSale": true,
                      "GiftCertificateUsed": true,
                      "Item": {
                        "$id": "9",
                        "ID": "63f0ac46-b11a-495d-a1e4-dbee0503130b",
                        "ItemNumber": "sample string 2",
                        "ShortName": "sample string 3",
                        "Name": "sample string 4",
                        "Description": "sample string 5",
                        "ItemType": "c182d014-10da-4929-84d5-8cf6bdd30a11",
                        "SortOrder": 7,
                        "CompanyId": "7328de77-7224-46cb-94a4-53de8a6aa8f0",
                        "OneWayId": "13d0bd5b-056c-4ec6-8529-9e765d9166ce",
                        "RoundTrip": true,
                        "InActive": true,
                        "CardPriceSheetId": "79790de7-3686-4fce-aa0f-0e18f7156aa0",
                        "TakesSeat": true,
                        "Groups": true,
                        "Expire": 1,
                        "Disclaimer": "sample string 12",
                        "quickbooksId": "5393ee1e-eeed-4a95-9cd3-693d640c9be3",
                        "Company": {
                          "$ref": "1"
                        },
                        "RoundTripItems": [
                          {
                            "$ref": "9"
                          },
                          {
                            "$ref": "9"
                          }
                        ],
                        "OneWayItem": {
                          "$ref": "9"
                        },
                        "PriceSheet": {
                          "$id": "10",
                          "ID": "89e6f9ff-29ad-47e1-bf16-1058ad492bc8",
                          "Name": "sample string 2",
                          "Description": "sample string 3",
                          "CompanyId": "f52da7b0-3d4d-4511-a7b1-5ee763b9768a",
                          "Basic": "sample string 5",
                          "StartDate": "2026-06-01T15:32:43Z",
                          "EndDate": "2026-06-01T15:32:43Z",
                          "Hierarchy": 6,
                          "Inactive": true,
                          "Company": {
                            "$ref": "1"
                          },
                          "Effectives": [
                            {
                              "$id": "11",
                              "EffectiveID": "53890cd1-3054-4a77-a12c-9d5a642fe755",
                              "PriceSheetID": "b343d7eb-286f-4905-b405-307c8d5daf14",
                              "EffectiveDay": 1,
                              "EffectiveStartTime": "2026-06-01T15:32:43Z",
                              "EffectiveEndTime": "2026-06-01T15:32:43Z",
                              "Checked": "sample string 3",
                              "PriceSheet": {
                                "$ref": "10"
                              }
                            },
                            {
                              "$ref": "11"
                            }
                          ],
                          "Items": [
                            {
                              "$ref": "9"
                            },
                            {
                              "$ref": "9"
                            }
                          ],
                          "Prices": [
                            {
                              "$id": "12",
                              "ID": "2557f736-9894-49ef-864e-e80b6449e53a",
                              "PriceSheetId": "7340ff8f-ca5b-47d4-b5b0-fb2a4b853c6d",
                              "ItemId": "ba87bd00-9b1d-426c-a675-085094ba8353",
                              "Price1": 4.0,
                              "StartDate": "2026-06-01T15:32:43Z",
                              "EndDate": "2026-06-01T15:32:43Z",
                              "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": "d0228d98-8a29-4b26-a665-918da7b7de3d",
                    "UsersId": "d0228d98-8a29-4b26-a665-918da7b7de3d",
                    "UserName": "sample string 4",
                    "DateHired": "2026-06-01T15:32:43Z",
                    "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-06-01T15:32:43Z",
                    "inactive": true,
                    "Email": "sample string 19",
                    "AccessFailedCount": 1,
                    "EmailConfirmed": true,
                    "LockoutEnabled": true,
                    "LockoutEndDateUtc": "2026-06-01T15:32:43Z",
                    "PhoneNumberConfirmed": true,
                    "SecurityStamp": "sample string 20",
                    "TwoFactorEnabled": true,
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ],
                    "Users_UserPermissions": [
                      {
                        "$id": "14",
                        "Users_UserPermissionsId": "24846979-7b79-4d92-9b2a-5b59d6e153fa",
                        "UsersId": "7fe36c30-901d-4f08-86a0-ab24fe563089",
                        "PermissionsID": "57797b7d-6e03-4fba-a886-67f12cc18d3d",
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "14"
                      }
                    ],
                    "AccountTransactions": [
                      {
                        "$id": "15",
                        "ID": "580e57d5-ce46-4e87-beba-361b3ab3de94",
                        "TransactionDate": "2026-06-01T15:32:43Z",
                        "Amount": 3.0,
                        "Type": "sample string 4",
                        "ChargeAccountID": "f0d03e9c-209a-427c-bbe7-80024fc2103b",
                        "UserID": "9f399274-2693-4c21-bb2f-b76788b76aa8",
                        "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": "161a3fd1-8e7c-47ce-8124-db9c11e4fb30",
                        "RoleId": "398b79b1-2928-4cff-9a49-eb2fdd7aa927",
                        "TerminationDate": "2026-06-01T15:32:43Z",
                        "rowguid": "abd36856-77b6-46b6-82c1-cb0529102b31",
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "17"
                      }
                    ],
                    "CompanyUsers": [
                      {
                        "$id": "18",
                        "CompanyUserId": "758d9cf2-2ffb-4475-a6b2-eb79b38f4c11",
                        "CompanyId": "d8fe3874-4df2-4fe9-b6cf-cdb080908248",
                        "UsersId": "362260fb-a16c-4bbd-b6ea-a9dd63d448b2",
                        "UserNumber": "sample string 3",
                        "StartDate": "2026-06-01T15:32:43Z",
                        "TerminationDate": "2026-06-01T15:32:43Z",
                        "Company": {
                          "$ref": "1"
                        },
                        "User": {
                          "$ref": "13"
                        }
                      },
                      {
                        "$ref": "18"
                      }
                    ]
                  },
                  "Location": {
                    "$id": "19",
                    "id": "049b973f-8eab-40d9-bfe3-df6ddbdb8258",
                    "name": "sample string 2",
                    "abbr": "sample string 3",
                    "companyId": "01b3fffb-513f-405c-a718-0b0aa73e9dd6",
                    "inactive": true,
                    "Company": {
                      "$ref": "1"
                    },
                    "Tickets": [
                      {
                        "$ref": "7"
                      },
                      {
                        "$ref": "7"
                      }
                    ]
                  },
                  "Wallet": {
                    "$id": "20",
                    "id": "0413bae2-7130-46fc-aac6-4327182c16e3",
                    "Name": "sample string 2",
                    "companyId": "8e2291c5-baeb-4351-af70-d6ade3c641d9",
                    "shortName": "sample string 4",
                    "BoatCrew": true,
                    "SortOrder": 1,
                    "Active": true,
                    "ReconcileShow": true,
                    "BoatId": "f201ff48-e52b-4959-8e8d-d635c706fb77",
                    "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": "3533697c-8d59-477f-8115-244065e207f5",
        "deviceId": "5d189cd6-002b-4165-8280-548f7f173e3a",
        "companyId": "f92a2832-7592-4db1-9963-1c503370a8cc",
        "voidDate": "2026-06-01T15:32:43Z",
        "Company": {
          "$ref": "1"
        },
        "Device": {
          "$id": "22",
          "id": "c78b0095-91bf-4aca-8118-c609113d7c59",
          "deviceNumber": "sample string 2",
          "deviceName": "sample string 3",
          "deviceCompanies": [
            {
              "$ref": "21"
            },
            {
              "$ref": "21"
            }
          ]
        }
      },
      {
        "$ref": "21"
      }
    ],
    "Items": [
      {
        "$ref": "9"
      },
      {
        "$ref": "9"
      }
    ],
    "ItemTypes": [
      {
        "$id": "23",
        "ID": "64c14629-a09e-496d-b39f-ac6770e897cc",
        "ShortName": "sample string 2",
        "Name": "sample string 3",
        "Description": "sample string 4",
        "CompanyId": "b9adb835-1262-4616-b6ab-bf787d7324cc",
        "Company": {
          "$ref": "1"
        }
      },
      {
        "$ref": "23"
      }
    ],
    "Locations": [
      {
        "$ref": "19"
      },
      {
        "$ref": "19"
      }
    ],
    "PaymentTypes": [
      {
        "$ref": "6"
      },
      {
        "$ref": "6"
      }
    ],
    "PriceSheets": [
      {
        "$ref": "10"
      },
      {
        "$ref": "10"
      }
    ],
    "Roles": [
      {
        "$id": "24",
        "RoleId": "522c0bd9-4235-4192-8802-a8c5d4326e93",
        "CompanyId": "7fad6a0e-c173-4661-a13f-2ad8bd34bb9d",
        "RoleName": "sample string 2",
        "Active": true,
        "DateRange": 1,
        "PasswordChange": 1,
        "Company": {
          "$ref": "1"
        },
        "Role_Permissions": [
          {
            "$id": "25",
            "RoleId": "ae657c53-6d58-4590-a57d-026a6841989a",
            "PermissionsId": "ba484ace-d13b-469a-8f14-ff9d15d76f09",
            "Role_PermissionsId": "c6c5e94f-2f52-46d7-b733-58192683b3ba",
            "Role": {
              "$ref": "24"
            }
          },
          {
            "$ref": "25"
          }
        ]
      },
      {
        "$ref": "24"
      }
    ],
    "UserPermissions": [
      {
        "$id": "26",
        "UserPermissionId": "f02eaff7-d75d-4286-86b1-bfe7a980bdfe",
        "PermissionsId": "2b8380cb-9b91-4535-90c3-fb8316b844a7",
        "CompanyId": "a709cbdc-70bf-4211-b77a-723ad4840f0f",
        "ReadWrite": true,
        "Company": {
          "$ref": "1"
        },
        "Permission": {
          "$id": "27",
          "PermissionsId": "57093ca8-97d0-45fe-8a24-8834b9b21779",
          "TypePermission": "sample string 2",
          "Name": "sample string 3",
          "Description": "sample string 4",
          "parentId": "679a7009-84f1-44cb-aabf-d4cfcbf392ff",
          "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"
  }
]