---
title: "Returns the company configuration settings."
method: GET
path: "/v1/companySetupConfig"
tags: ["CompanySetupConfig"]
---

# Returns the company configuration settings.

`GET /v1/companySetupConfig`

## Response `200`

OK

- CompanySetupConfigViewModel
  - `generalDetails` CompanyGeneralDetaisViewModel
    - `companyName` string
    - `companyAddresses` string[]
    - `regionId` integer
    - `regionDescription` string
    - `currencyId` integer
    - `currencyCode` string
    - `currencyDescription` string
    - `currentcySymbol` string
    - `phones` string[]
    - `emails` string[]
    - `faxes` string[]
    - `vatReg` string
  - `financialYear` CompanyFinancialYearViewModel
    - `startMonth` integer
    - `startYear` integer
    - `firstMonth` integer
  - `referenceSettings` CompanyReferenceSettingViewModel
    - `sales` boolean
    - `purchases` boolean
    - `debtorsJournal` boolean
    - `creditorsJournal` boolean
  - `options` CompanyOptionViewModel
    - `creditNoteJournalAgeingValue` integer
    - `creditNoteJournalAgeingName` string
    - `useAllocations` boolean
    - `useNominal` boolean
    - `useNominalCode` boolean
    - `discrepancyAllowed` number, double
    - `allowEntryOfGrossPriceInInvoicing` boolean
    - `marginVatScheme` boolean
    - `creditInputForReverseChargeVAT` boolean
    - `printOSItemsOnly` boolean
    - `enableVOCRReporting` boolean
    - `vocrSettingValue` boolean
    - `salesVatAnalysisType` integer
    - `purchasesVatAnalysisType` integer

---

[API](https://skmtc.dev/bigredcloud/apis/big-red-cloud-api.md) · [All operations](https://skmtc.dev/bigredcloud/apis/big-red-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bigredcloud/big-red-cloud-api/revisions/e1d97979e906/schema)