GET Company/Get?includeStatus={includeStatus}
Request Information
This method supports OData queries.
URI Parameters
Name | Type | Additional information | Description |
---|---|---|---|
includeStatus | bool |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
This collection is wrapped in a paging response object.
Paging response of CompanyName | Type | Additional information | Description |
---|---|---|---|
TotalResults | integer |
None. |
|
ReturnedResults | integer |
None. |
|
Results | Collection of Company |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalResults": 1, "ReturnedResults": 2, "Results": [ { "ID": 1, "Name": "sample string 2", "CurrencySymbol": "sample string 3", "CurrencyDecimalDigits": 4, "NumberDecimalDigits": 5, "DecimalSeparator": "sample string 6", "HoursDecimalDigits": 7, "ItemCostPriceDecimalDigits": 8, "ItemSellingPriceDecimalDigits": 9, "PostalAddress1": "sample string 10", "PostalAddress2": "sample string 11", "PostalAddress3": "sample string 12", "PostalAddress4": "sample string 13", "PostalAddress5": "sample string 14", "GroupSeparator": "sample string 15", "RoundingValue": 16, "TaxSystem": 0, "RoundingType": 0, "AgeMonthly": true, "DisplayInactiveItems": true, "WarnWhenItemCostIsZero": true, "DoNotAllowProcessingIntoNegativeQuantities": true, "WarnWhenItemQuantityIsZero": true, "WarnWhenItemSellingBelowCost": true, "CountryId": 22, "CompanyEntityTypeId": 1, "TakeOnBalanceDate": "2024-11-15", "EnableCustomerZone": true, "EnableAutomaticBankFeedRefresh": true, "ContactName": "sample string 25", "Telephone": "sample string 26", "Fax": "sample string 27", "Mobile": "sample string 28", "Email": "sample string 29", "IsPrimarySendingEmail": true, "PostalAddress01": "sample string 31", "PostalAddress02": "sample string 32", "PostalAddress03": "sample string 33", "PostalAddress04": "sample string 34", "PostalAddress05": "sample string 35", "CompanyInfo01": "sample string 36", "CompanyInfo02": "sample string 37", "CompanyInfo03": "sample string 38", "CompanyInfo04": "sample string 39", "CompanyInfo05": "sample string 40", "IsOwner": true, "UseCCEmail": true, "CCEmail": "sample string 42", "DateFormatId": 44, "CheckForDuplicateCustomerReferences": true, "CheckForDuplicateSupplierReferences": true, "DisplayName": "sample string 47", "DisplayInactiveCustomers": true, "DisplayInactiveSuppliers": true, "DisplayInactiveTimeProjects": true, "UseInclusiveProcessingByDefault": true, "LockProcessing": true, "LockProcessingDate": "2024-11-15", "LockTimesheetProcessing": true, "LockTimesheetProcessingDate": "2024-11-15", "LockedForConversion": true, "LockedForTransfer": true, "TaxPeriodFrequency": 1, "PreviousTaxPeriodEndDate": "2024-11-15", "PreviousTaxReturnDate": "2024-11-15", "UseNoreplyEmail": true, "AgeingBasedOnDueDate": true, "UseLogoOnEmails": true, "UseLogoOnCustomerZone": true, "City": "sample string 58", "State": "sample string 59", "Country": "sample string 60", "HomeCurrencyId": 1, "CurrencyId": 1, "Created": "2024-11-15", "Modified": "2024-11-15", "Active": true, "TaxNumber": "sample string 63", "RegisteredName": "sample string 64", "RegistrationNumber": "sample string 65", "IsPracticeAccount": true, "LogoPositionID": 67, "Attachment": { "ID": 1, "Image": "QEA=", "Timestamp": "QEA=" }, "CompanyTaxNumber": "sample string 68", "TaxOffice": "sample string 69", "CustomerZoneGuid": "036e14cd-a02f-4365-9138-edd7b86d95b5", "ClientTypeId": 71, "DisplayTotalTypeId": 72, "DisplayInCompanyConsole": true, "LastLoginDate": "2024-11-15", "Status": 0, "TaxReportingTypeId": 74, "SalesOrdersReserveItemQuantities": true, "PrescribedGoodsTrader": true, "DisplayInactiveItemBundles": true, "CompanyTransferStatus": 0, "InventoryTypeId": 64 }, { "ID": 1, "Name": "sample string 2", "CurrencySymbol": "sample string 3", "CurrencyDecimalDigits": 4, "NumberDecimalDigits": 5, "DecimalSeparator": "sample string 6", "HoursDecimalDigits": 7, "ItemCostPriceDecimalDigits": 8, "ItemSellingPriceDecimalDigits": 9, "PostalAddress1": "sample string 10", "PostalAddress2": "sample string 11", "PostalAddress3": "sample string 12", "PostalAddress4": "sample string 13", "PostalAddress5": "sample string 14", "GroupSeparator": "sample string 15", "RoundingValue": 16, "TaxSystem": 0, "RoundingType": 0, "AgeMonthly": true, "DisplayInactiveItems": true, "WarnWhenItemCostIsZero": true, "DoNotAllowProcessingIntoNegativeQuantities": true, "WarnWhenItemQuantityIsZero": true, "WarnWhenItemSellingBelowCost": true, "CountryId": 22, "CompanyEntityTypeId": 1, "TakeOnBalanceDate": "2024-11-15", "EnableCustomerZone": true, "EnableAutomaticBankFeedRefresh": true, "ContactName": "sample string 25", "Telephone": "sample string 26", "Fax": "sample string 27", "Mobile": "sample string 28", "Email": "sample string 29", "IsPrimarySendingEmail": true, "PostalAddress01": "sample string 31", "PostalAddress02": "sample string 32", "PostalAddress03": "sample string 33", "PostalAddress04": "sample string 34", "PostalAddress05": "sample string 35", "CompanyInfo01": "sample string 36", "CompanyInfo02": "sample string 37", "CompanyInfo03": "sample string 38", "CompanyInfo04": "sample string 39", "CompanyInfo05": "sample string 40", "IsOwner": true, "UseCCEmail": true, "CCEmail": "sample string 42", "DateFormatId": 44, "CheckForDuplicateCustomerReferences": true, "CheckForDuplicateSupplierReferences": true, "DisplayName": "sample string 47", "DisplayInactiveCustomers": true, "DisplayInactiveSuppliers": true, "DisplayInactiveTimeProjects": true, "UseInclusiveProcessingByDefault": true, "LockProcessing": true, "LockProcessingDate": "2024-11-15", "LockTimesheetProcessing": true, "LockTimesheetProcessingDate": "2024-11-15", "LockedForConversion": true, "LockedForTransfer": true, "TaxPeriodFrequency": 1, "PreviousTaxPeriodEndDate": "2024-11-15", "PreviousTaxReturnDate": "2024-11-15", "UseNoreplyEmail": true, "AgeingBasedOnDueDate": true, "UseLogoOnEmails": true, "UseLogoOnCustomerZone": true, "City": "sample string 58", "State": "sample string 59", "Country": "sample string 60", "HomeCurrencyId": 1, "CurrencyId": 1, "Created": "2024-11-15", "Modified": "2024-11-15", "Active": true, "TaxNumber": "sample string 63", "RegisteredName": "sample string 64", "RegistrationNumber": "sample string 65", "IsPracticeAccount": true, "LogoPositionID": 67, "Attachment": { "ID": 1, "Image": "QEA=", "Timestamp": "QEA=" }, "CompanyTaxNumber": "sample string 68", "TaxOffice": "sample string 69", "CustomerZoneGuid": "036e14cd-a02f-4365-9138-edd7b86d95b5", "ClientTypeId": 71, "DisplayTotalTypeId": 72, "DisplayInCompanyConsole": true, "LastLoginDate": "2024-11-15", "Status": 0, "TaxReportingTypeId": 74, "SalesOrdersReserveItemQuantities": true, "PrescribedGoodsTrader": true, "DisplayInactiveItemBundles": true, "CompanyTransferStatus": 0, "InventoryTypeId": 64 } ] }