Model organisations

Permissions

User Group	Create?	Read?	Update?	Delete?
admin	x	x	x	x
primary_member	x	x	x
owner	x	x	x
all	x	x

Fields

Name	Type	Link	Maps To	Default	Indexed?	Unique?
__v	Number
_deleted	Boolean			false	x
_id	ObjectID			[Function]
_owner_id	ObjectID	User	_owner		x
_updated_by_id	ObjectID	User	_updated_by		x
about	String
accounts_email	String
address	String
allow_user_printing	Boolean			false
allowed_payments	Array of ObjectID			[Function]
bandwidth_per_month_override	Number
company_registration_number	String
cost_per_month_override	Number
createdAt	Date
currency	String			ZAR
date_created	Date			[Function]
date_onboarded	Date
discount	Number
discount_expires	Date
ebucks_account	Array of Mixed			[Function]
email	String				x
employee_count	Number
escalation_date	Date
escalation_percentage	Number
facebook	String
hidden	Boolean			false	x
img	String
industrysector_id	Array of ObjectID			[Function]
items	Mixed
legal_name	String
linkedin	String
location_id	ObjectID	Location
membership_id	ObjectID	Membership
mobile	String
name	String				x	x
offboard_date	Date
onboard_date	Date
onboarded	Boolean			false
opportunity_id	ObjectID	Opportunity
papercut_username	String
parent_organisation_id	ObjectID	Organisation	parent_organisation
pin	String
postal_address	String
primary_token	ObjectID
printing	Boolean			true
product	String
proposal_id	ObjectID	Proposal
short_name	String				x
signatory_id	ObjectID	User	signatory
space_credits_per_month_override	Number
space_total	Number
start_date	Date			[Function]
status	String			active	x
stuff_credits_per_month_override	Number
stuff_total	Number
subscription_locked	Boolean			false
summarise_invoice	Boolean			false
tel	String
twitter	String
type	Array of String			[Function]
updatedAt	Date
urlid	String				x
user_id	ObjectID	User
vat	String
website	String
xero_id	String
xeroorgaccount_id	ObjectID	XeroOrgAccount
year_founded	Number

Field Details

__v

{
  "path": "__v",
  "instance": "Number",
  "options": {},
  "validators": []
}

_deleted

{
  "path": "_deleted",
  "instance": "Boolean",
  "options": {
    "default": false,
    "index": true
  },
  "validators": [],
  "defaultValue": false
}

_id

{
  "path": "_id",
  "instance": "ObjectID",
  "options": {
    "auto": true,
    "type": "ObjectId"
  },
  "validators": [],
  "defaultValue": "[Function]"
}

_owner_id

{
  "path": "_owner_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_owner",
    "index": true
  },
  "validators": []
}

_updated_by_id

{
  "path": "_updated_by_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_updated_by",
    "index": true
  },
  "validators": []
}

about

{
  "path": "about",
  "instance": "String",
  "options": {},
  "validators": []
}

accounts_email

{
  "path": "accounts_email",
  "instance": "String",
  "options": {
    "validate": [
      null,
      "Please use a valid email address"
    ]
  },
  "validators": [
    {
      "message": "Please use a valid email address"
    }
  ]
}

Validators

: Please use a valid email address

address

{
  "path": "address",
  "instance": "String",
  "options": {},
  "validators": []
}

allow_user_printing

{
  "path": "allow_user_printing",
  "instance": "Boolean",
  "options": {
    "default": false
  },
  "validators": [],
  "defaultValue": false
}

allowed_payments

{
  "path": "allowed_payments",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "PaymentMethod"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

bandwidth_per_month_override

{
  "path": "bandwidth_per_month_override",
  "instance": "Number",
  "options": {},
  "validators": []
}

company_registration_number

{
  "path": "company_registration_number",
  "instance": "String",
  "options": {},
  "validators": []
}

cost_per_month_override

{
  "path": "cost_per_month_override",
  "instance": "Number",
  "options": {},
  "validators": []
}

createdAt

{
  "path": "createdAt",
  "instance": "Date",
  "options": {
    "immutable": true
  },
  "validators": []
}

currency

{
  "path": "currency",
  "instance": "String",
  "options": {
    "default": "ZAR"
  },
  "validators": [],
  "defaultValue": "ZAR"
}

date_created

{
  "path": "date_created",
  "instance": "Date",
  "options": {},
  "validators": [],
  "defaultValue": "[Function]"
}

date_onboarded

{
  "path": "date_onboarded",
  "instance": "Date",
  "options": {},
  "validators": []
}

discount

{
  "path": "discount",
  "instance": "Number",
  "options": {},
  "validators": []
}

discount_expires

{
  "path": "discount_expires",
  "instance": "Date",
  "options": {},
  "validators": []
}

ebucks_account

{
  "path": "ebucks_account",
  "instance": "Array",
  "options": {
    "type": [
      null
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "Mixed"
}

email

{
  "path": "email",
  "instance": "String",
  "options": {
    "index": true,
    "validate": [
      null,
      "Please use a valid email address"
    ]
  },
  "validators": [
    {
      "message": "Please use a valid email address"
    }
  ]
}

Validators

: Please use a valid email address

employee_count

{
  "path": "employee_count",
  "instance": "Number",
  "options": {},
  "validators": []
}

escalation_date

{
  "path": "escalation_date",
  "instance": "Date",
  "options": {},
  "validators": []
}

escalation_percentage

{
  "path": "escalation_percentage",
  "instance": "Number",
  "options": {},
  "validators": []
}

facebook

{
  "path": "facebook",
  "instance": "String",
  "options": {},
  "validators": []
}

hidden

{
  "path": "hidden",
  "instance": "Boolean",
  "options": {
    "default": false,
    "index": true
  },
  "validators": [],
  "defaultValue": false
}

img

{
  "path": "img",
  "instance": "String",
  "options": {},
  "validators": []
}

industrysector_id

{
  "path": "industrysector_id",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "IndustrySector"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

items

{
  "path": "items",
  "instance": "Mixed",
  "options": {},
  "validators": []
}

legal_name

{
  "path": "legal_name",
  "instance": "String",
  "options": {},
  "validators": []
}

{
  "path": "linkedin",
  "instance": "String",
  "options": {},
  "validators": []
}

location_id

{
  "path": "location_id",
  "instance": "ObjectID",
  "options": {
    "link": "Location"
  },
  "validators": []
}

membership_id

{
  "path": "membership_id",
  "instance": "ObjectID",
  "options": {
    "link": "Membership"
  },
  "validators": []
}

mobile

{
  "path": "mobile",
  "instance": "String",
  "options": {},
  "validators": []
}

name

{
  "path": "name",
  "instance": "String",
  "options": {
    "unique": true,
    "index": true
  },
  "validators": [
    {
      "message": "Name cannot be empty"
    }
  ]
}

Validators

: Name cannot be empty

offboard_date

{
  "path": "offboard_date",
  "instance": "Date",
  "options": {},
  "validators": []
}

onboard_date

{
  "path": "onboard_date",
  "instance": "Date",
  "options": {},
  "validators": []
}

onboarded

{
  "path": "onboarded",
  "instance": "Boolean",
  "options": {
    "default": false
  },
  "validators": [],
  "defaultValue": false
}

opportunity_id

{
  "path": "opportunity_id",
  "instance": "ObjectID",
  "options": {
    "link": "Opportunity"
  },
  "validators": []
}

papercut_username

{
  "path": "papercut_username",
  "instance": "String",
  "options": {},
  "validators": []
}

parent_organisation_id

{
  "path": "parent_organisation_id",
  "instance": "ObjectID",
  "options": {
    "link": "Organisation",
    "map_to": "parent_organisation"
  },
  "validators": []
}

{
  "path": "pin",
  "instance": "String",
  "options": {},
  "validators": []
}

postal_address

{
  "path": "postal_address",
  "instance": "String",
  "options": {},
  "validators": []
}

primary_token

{
  "path": "primary_token",
  "instance": "ObjectID",
  "options": {},
  "validators": []
}

printing

{
  "path": "printing",
  "instance": "Boolean",
  "options": {
    "default": true
  },
  "validators": [],
  "defaultValue": true
}

product

{
  "path": "product",
  "instance": "String",
  "options": {},
  "validators": []
}

proposal_id

{
  "path": "proposal_id",
  "instance": "ObjectID",
  "options": {
    "link": "Proposal"
  },
  "validators": []
}

short_name

{
  "path": "short_name",
  "instance": "String",
  "options": {
    "index": {
      "unique": true,
      "partialFilterExpression": {
        "short_name": {
          "$type": "string"
        },
        "_deleted": false
      }
    }
  },
  "validators": []
}

signatory_id

{
  "path": "signatory_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "signatory"
  },
  "validators": []
}

space_credits_per_month_override

{
  "path": "space_credits_per_month_override",
  "instance": "Number",
  "options": {},
  "validators": []
}

space_total

{
  "path": "space_total",
  "instance": "Number",
  "options": {},
  "validators": []
}

start_date

{
  "path": "start_date",
  "instance": "Date",
  "options": {},
  "validators": [],
  "defaultValue": "[Function]"
}

status

{
  "path": "status",
  "instance": "String",
  "options": {
    "validate": {},
    "index": true,
    "default": "active"
  },
  "validators": [
    {
      "message": "Validator failed for path `{PATH}` with value `{VALUE}`"
    }
  ],
  "defaultValue": "active"
}

Validators

: Validator failed for path `{PATH}` with value `{VALUE}`

stuff_credits_per_month_override

{
  "path": "stuff_credits_per_month_override",
  "instance": "Number",
  "options": {},
  "validators": []
}

stuff_total

{
  "path": "stuff_total",
  "instance": "Number",
  "options": {},
  "validators": []
}

subscription_locked

{
  "path": "subscription_locked",
  "instance": "Boolean",
  "options": {
    "default": false
  },
  "validators": [],
  "defaultValue": false
}

summarise_invoice

{
  "path": "summarise_invoice",
  "instance": "Boolean",
  "options": {
    "default": false
  },
  "validators": [],
  "defaultValue": false
}

tel

{
  "path": "tel",
  "instance": "String",
  "options": {},
  "validators": []
}

twitter

{
  "path": "twitter",
  "instance": "String",
  "options": {},
  "validators": []
}

type

{
  "path": "type",
  "instance": "Array",
  "options": {
    "type": [
      {
        "validate": {},
        "index": true,
        "default": "member"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "String"
}

updatedAt

{
  "path": "updatedAt",
  "instance": "Date",
  "options": {},
  "validators": []
}

urlid

{
  "path": "urlid",
  "instance": "String",
  "options": {
    "index": {
      "unique": true
    }
  },
  "validators": []
}

user_id

{
  "path": "user_id",
  "instance": "ObjectID",
  "options": {
    "link": "User"
  },
  "validators": []
}

vat

{
  "path": "vat",
  "instance": "String",
  "options": {},
  "validators": []
}

website

{
  "path": "website",
  "instance": "String",
  "options": {},
  "validators": []
}

xero_id

{
  "path": "xero_id",
  "instance": "String",
  "options": {},
  "validators": []
}

xeroorgaccount_id

{
  "path": "xeroorgaccount_id",
  "instance": "ObjectID",
  "options": {
    "link": "XeroOrgAccount"
  },
  "validators": []
}

year_founded

{
  "path": "year_founded",
  "instance": "Number",
  "options": {},
  "validators": []
}