GET Company/Current

Retrieves the current Company.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Company
NameTypeAdditional informationDescription
ID integer

None.

Name string

Required

String length: inclusive between 0 and 100

CurrencySymbol string

String length: inclusive between 0 and 3

CurrencyDecimalDigits integer

Range: inclusive between 0 and 4

NumberDecimalDigits integer

Range: inclusive between 0 and 4

DecimalSeparator string

String length: inclusive between 0 and 3

HoursDecimalDigits integer

Range: inclusive between 0 and 4

ItemCostPriceDecimalDigits integer

Range: inclusive between 0 and 4

ItemSellingPriceDecimalDigits integer

Range: inclusive between 0 and 4

PostalAddress1 string

None.

PostalAddress2 string

None.

PostalAddress3 string

None.

PostalAddress4 string

None.

PostalAddress5 string

None.

GroupSeparator string

String length: inclusive between 0 and 3

RoundingValue integer

None.

TaxSystem Tax System

None.

RoundingType Rounding Type

Required

AgeMonthly bool

None.

DisplayInactiveItems bool

None.

WarnWhenItemCostIsZero bool

None.

DoNotAllowProcessingIntoNegativeQuantities nullable bool

None.

WarnWhenItemQuantityIsZero bool

None.

WarnWhenItemSellingBelowCost bool

None.

CountryId integer

None.

CompanyEntityTypeId nullable integer

None.

TakeOnBalanceDate nullable date

None.

EnableCustomerZone bool

None.

EnableAutomaticBankFeedRefresh bool

None.

ContactName string

String length: inclusive between 0 and 50

Telephone string

String length: inclusive between 0 and 30

Fax string

String length: inclusive between 0 and 30

Mobile string

String length: inclusive between 0 and 30

Email string

Matching regular expression pattern: ^[A-Za-z0-9!#\$%&'\*\+/=\?\^_`\{\|}~-]+(\.[A-Za-z0-9!#\$%&'\*\+/=\?\^_`\{\|}~-]+)*@[A-Za-z0-9-]+(\.[A-Za-z0-9-]+)*\.([A-Za-z]{2,})$

String length: inclusive between 0 and 100

IsPrimarySendingEmail bool

None.

PostalAddress01 string

String length: inclusive between 0 and 100

PostalAddress02 string

String length: inclusive between 0 and 100

PostalAddress03 string

String length: inclusive between 0 and 100

PostalAddress04 string

String length: inclusive between 0 and 100

PostalAddress05 string

String length: inclusive between 0 and 100

CompanyInfo01 string

String length: inclusive between 0 and 100

CompanyInfo02 string

String length: inclusive between 0 and 100

CompanyInfo03 string

String length: inclusive between 0 and 100

CompanyInfo04 string

String length: inclusive between 0 and 100

CompanyInfo05 string

String length: inclusive between 0 and 100

IsOwner bool

None.

UseCCEmail nullable bool

None.

CCEmail string

Matching regular expression pattern: (([a-zA-Z0-9!#\$%&'_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5}){1,25})+([;.](([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5}){1,25})+)*

String length: inclusive between 0 and 100

DateFormatId integer

Read Only / System Generated

CheckForDuplicateCustomerReferences bool

None.

CheckForDuplicateSupplierReferences bool

None.

DisplayName string

String length: inclusive between 0 and 100

DisplayInactiveCustomers bool

None.

DisplayInactiveSuppliers bool

None.

DisplayInactiveTimeProjects bool

None.

UseInclusiveProcessingByDefault bool

None.

LockProcessing bool

None.

LockProcessingDate nullable date

None.

LockTimesheetProcessing bool

None.

LockTimesheetProcessingDate nullable date

None.

LockedForConversion nullable bool

None.

LockedForTransfer nullable bool

None.

TaxPeriodFrequency nullable integer

Range: inclusive between 0 and 100

Gets or sets the tax period frequency in months.

PreviousTaxPeriodEndDate nullable date

None.

PreviousTaxReturnDate nullable date

None.

UseNoreplyEmail bool

None.

AgeingBasedOnDueDate bool

None.

UseLogoOnEmails bool

None.

Gets or sets a value indicating whether or not to use the Company Logo on the Document Emails ex. Tax Invoice, Credit Note etc.

UseLogoOnCustomerZone bool

None.

Gets or sets a value indicating whether or not to use the Company Logo on the Customer Zone.

City string

None.

State string

None.

Country string

None.

HomeCurrencyId nullable integer

None.

CurrencyId nullable integer

None.

Created date

Read Only / System Generated

Modified nullable date

Read Only / System Generated

Active bool

None.

TaxNumber string

String length: inclusive between 0 and 30

RegisteredName string

String length: inclusive between 0 and 100

RegistrationNumber string

String length: inclusive between 0 and 50

IsPracticeAccount bool

None.

LogoPositionID integer

None.

Attachment Company Logo

Read Only / System Generated

CompanyTaxNumber string

String length: inclusive between 0 and 30

TaxOffice string

String length: inclusive between 0 and 50

CustomerZoneGuid globally unique identifier

Read Only / System Generated

ClientTypeId integer

Read Only / System Generated

DisplayTotalTypeId integer

Read Only / System Generated

DisplayInCompanyConsole bool

Read Only / System Generated

LastLoginDate nullable date

Read Only / System Generated

Status Company Status

None.

TaxReportingTypeId integer

None.

SalesOrdersReserveItemQuantities bool

None.

Quantity of items appearing on Sales Orders need to be created and updated upon invoicing/Sales This value can only be altered as long as there are no SalesOrders record captured for this company

PrescribedGoodsTrader bool

None.

DisplayInactiveItemBundles nullable bool

None.

CompanyTransferStatus Company Transfer Status

None.

InventoryTypeId byte

None.

Gets the Inventory Type Id. Periodic Inventory = 0, Perpetual Inventory = 1, Simple Inventory = 2

Response Formats

application/json, text/json

Sample:
{
  "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": "2021-10-20",
  "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": "2021-10-20",
  "LockTimesheetProcessing": true,
  "LockTimesheetProcessingDate": "2021-10-20",
  "LockedForConversion": true,
  "LockedForTransfer": true,
  "TaxPeriodFrequency": 1,
  "PreviousTaxPeriodEndDate": "2021-10-20",
  "PreviousTaxReturnDate": "2021-10-20",
  "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": "2021-10-20",
  "Modified": "2021-10-20",
  "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": "9b71a6c9-4267-4073-b119-0469b4bf88f1",
  "ClientTypeId": 71,
  "DisplayTotalTypeId": 72,
  "DisplayInCompanyConsole": true,
  "LastLoginDate": "2021-10-20",
  "Status": 0,
  "TaxReportingTypeId": 74,
  "SalesOrdersReserveItemQuantities": true,
  "PrescribedGoodsTrader": true,
  "DisplayInactiveItemBundles": true,
  "CompanyTransferStatus": 0,
  "InventoryTypeId": 64
}