TYPE REFERENCE

`Organisation`

Referenced by 3 generated operations.

Documented fields

Required Optional

addressAddress!Required
Registered address.
Show children
- addressString!Required
  Building and street, app spelling.
- cityString!Required
  City or town.
- countryString!Required
  Country; India by default.
- line1String!Required
  Building, street.
- line2StringOptional
  Area, landmark.
- pinCodeString!Required
  Six digit postal code, app spelling.
- pincodeString!Required
  6-digit PIN code.
- stateString!Required
  State name.
businessTypeString!Required
businessType organisation setting.
cityString!Required
Shop city.
codeString!Required
code organisation setting.
countryString!Required
country organisation setting.
createdAtString!Required
createdAt organisation setting.
defaultTaxRateFloatOptional
Default active GST percent.
emailString!Required
email organisation setting.
fyStartMonthInt!Required
Month the financial year starts, 1–12 (4 = April).
Example: 4
gstRegisteredBoolean!Required
GST registration enabled.
gstStateString!Required
gstState organisation setting.
gstinStringOptional
GSTIN, if registered.
idID!Required
The shop id (the tenant).
Example: "0192f0c1-0000-7000-8000-00000000000a"
industryString!Required
industry organisation setting.
invoiceFooterString!Required
invoiceFooter organisation setting.
invoiceLogoAppFileReferenceOptional
invoiceLogo file reference.
Show children
- idID!Required
  File id; obtain authorised download URL from files API.
- kindStringOptional
  Document category.
- nameString!Required
  Display filename.
- sizeBytesFloat!Required
  Size in bytes, safe integer.
invoicePrefixString!Required
Prefix of invoice numbers.
Example: "DEMO"
invoiceStartNumberInt!Required
Starting sequence within GSTIN and FY.
logoAppFileReferenceOptional
logo file reference.
Show children
- idID!Required
  File id; obtain authorised download URL from files API.
- kindStringOptional
  Document category.
- nameString!Required
  Display filename.
- sizeBytesFloat!Required
  Size in bytes, safe integer.
nameString!Required
Trade name.
Example: "Demo Precision Works"
phoneString!Required
phone organisation setting.
pinCodeString!Required
Shop PIN code.
registrationDetailsString!Required
registrationDetails organisation setting.
shortNameString!Required
shortName organisation setting.
signatureAppFileReferenceOptional
signature file reference.
Show children
- idID!Required
  File id; obtain authorised download URL from files API.
- kindStringOptional
  Document category.
- nameString!Required
  Display filename.
- sizeBytesFloat!Required
  Size in bytes, safe integer.
stateString!Required
Shop address state.
stateCodeString!Required
GST state code (2 digits); decides CGST+SGST or IGST.
taxRates[TaxRate!]!Required
At most 50 rates.
Show children
- activeBoolean!Required
  Available on new invoices.
- idID!Required
  Rate id.
- rateFloat!Required
  Percent, 0–100, at most two decimals.
termsAndConditionsString!Required
termsAndConditions organisation setting.
timezoneString!Required
IANA timezone people read times in.
websiteString!Required
website organisation setting.

`Organisation`

Documented fields

Used by

Search documentation