Model locations
Permissions
| User Group | Create? | Read? | Update? | Delete? |
|---|
| setup | x | x | x | x |
| super_user | x | x | x | x |
| admin | | x | | |
| user | | x | | |
| all | | x | | |
Fields
| Name | Type | Link | Maps To | Default | Indexed? | Unique? | Required? |
|---|
| __v | Number | | | | | | |
| _deleted | Boolean | | | false | x | | |
| _id | ObjectID | | | [Function] | | | |
| _owner_id | ObjectID | User | _owner | | x | | |
| _updated_by_id | ObjectID | User | _updated_by | | x | | |
| access_instructions | String | | | | | | |
| active | Boolean | | | true | x | | |
| address | String | | | | | | |
| background_colour | String | | | | | | |
| bank_account | String | | | | | | |
| bank_code | String | | | | | | |
| city | String | | | | | | |
| clay_id | String | | | | | | |
| community_manager_email | String | | | | | | |
| community_manager_name | String | | | | | | |
| community_manager_tel | String | | | | | | |
| contract_addendum | String | | | | | | |
| contract_prepend | String | | | | | | |
| contract_template | String | | | | | | |
| createdAt | Date | | | | | | |
| deposit_product_id | ObjectID | Product | deposit_product | | | | |
| description | String | | | | | | |
| email | String | | | | | | |
| flexi_agreement_addendum | String | | | | | | |
| flexi_agreement_prepend | String | | | | | | |
| flexi_agreement_template | String | | | | | | |
| flexi_membership_product_id | ObjectID | Product | flexi_membership_product | | | | |
| headquarters | Boolean | | | false | x | | |
| hidden | Boolean | | | false | x | | |
| img | String | | | | | | |
| logo | String | | | | | | |
| mail_template | String | | | | | | |
| map_img | String | | | | | | |
| map_link | String | | | | | | |
| matrix_room | String | | | | | | |
| name | String | | | | | | |
| nas_ip | String | | | | | | |
| operator | String | | | | | | |
| proposal_addendum | String | | | | | | |
| proposal_prepend | String | | | | | | |
| proposal_template | String | | | | | | |
| short_name | String | | | | | | |
| suburb | String | | | | | | |
| timezone | String | | | | | | |
| timezone_offset | String | | | | | | |
| updatedAt | Date | | | | | | |
| urlid | String | | | | | | |
| website | String | | | | | | |
| what3words | Array of String | | | [Function] | | | |
| xero_branding_theme | String | | | | | | |
| xero_creditcard_id | String | | | | | | |
| xero_eft_id | String | | | | | | |
| xero_fnb_ebucks_id | String | | | | | | |
| xero_paypal_id | String | | | | | | |
| xero_tax_type | String | | | | | | |
| xero_tenant_id | String | | | | | | |
| xero_tracking_name | String | | | | | | |
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": []
}access_instructions
{
"path": "access_instructions",
"instance": "String",
"options": {},
"validators": []
}active
{
"path": "active",
"instance": "Boolean",
"options": {
"default": true,
"index": true
},
"validators": [],
"defaultValue": true
}address
{
"path": "address",
"instance": "String",
"options": {},
"validators": []
}background_colour
{
"path": "background_colour",
"instance": "String",
"options": {},
"validators": []
}bank_account
{
"path": "bank_account",
"instance": "String",
"options": {},
"validators": []
}bank_code
{
"path": "bank_code",
"instance": "String",
"options": {},
"validators": []
}city
{
"path": "city",
"instance": "String",
"options": {},
"validators": []
}clay_id
{
"path": "clay_id",
"instance": "String",
"options": {},
"validators": []
}community_manager_email
{
"path": "community_manager_email",
"instance": "String",
"options": {},
"validators": []
}community_manager_name
{
"path": "community_manager_name",
"instance": "String",
"options": {},
"validators": []
}community_manager_tel
{
"path": "community_manager_tel",
"instance": "String",
"options": {},
"validators": []
}contract_addendum
{
"path": "contract_addendum",
"instance": "String",
"options": {},
"validators": []
}contract_prepend
{
"path": "contract_prepend",
"instance": "String",
"options": {},
"validators": []
}contract_template
{
"path": "contract_template",
"instance": "String",
"options": {},
"validators": []
}createdAt
{
"path": "createdAt",
"instance": "Date",
"options": {
"immutable": true
},
"validators": []
}deposit_product_id
{
"path": "deposit_product_id",
"instance": "ObjectID",
"options": {
"link": "Product",
"map_to": "deposit_product"
},
"validators": []
}description
{
"path": "description",
"instance": "String",
"options": {},
"validators": []
}email
{
"path": "email",
"instance": "String",
"options": {},
"validators": []
}flexi_agreement_addendum
{
"path": "flexi_agreement_addendum",
"instance": "String",
"options": {},
"validators": []
}flexi_agreement_prepend
{
"path": "flexi_agreement_prepend",
"instance": "String",
"options": {},
"validators": []
}flexi_agreement_template
{
"path": "flexi_agreement_template",
"instance": "String",
"options": {},
"validators": []
}flexi_membership_product_id
{
"path": "flexi_membership_product_id",
"instance": "ObjectID",
"options": {
"link": "Product",
"map_to": "flexi_membership_product"
},
"validators": []
}headquarters
{
"path": "headquarters",
"instance": "Boolean",
"options": {
"default": false,
"index": true
},
"validators": [],
"defaultValue": false
}hidden
{
"path": "hidden",
"instance": "Boolean",
"options": {
"default": false,
"index": true
},
"validators": [],
"defaultValue": false
}img
{
"path": "img",
"instance": "String",
"options": {},
"validators": []
}logo
{
"path": "logo",
"instance": "String",
"options": {},
"validators": []
}mail_template
{
"path": "mail_template",
"instance": "String",
"options": {},
"validators": []
}map_img
{
"path": "map_img",
"instance": "String",
"options": {},
"validators": []
}map_link
{
"path": "map_link",
"instance": "String",
"options": {},
"validators": []
}matrix_room
{
"path": "matrix_room",
"instance": "String",
"options": {},
"validators": []
}name
{
"path": "name",
"instance": "String",
"options": {},
"validators": []
}nas_ip
{
"path": "nas_ip",
"instance": "String",
"options": {},
"validators": []
}operator
{
"path": "operator",
"instance": "String",
"options": {},
"validators": []
}proposal_addendum
{
"path": "proposal_addendum",
"instance": "String",
"options": {},
"validators": []
}proposal_prepend
{
"path": "proposal_prepend",
"instance": "String",
"options": {},
"validators": []
}proposal_template
{
"path": "proposal_template",
"instance": "String",
"options": {},
"validators": []
}short_name
{
"path": "short_name",
"instance": "String",
"options": {},
"validators": []
}suburb
{
"path": "suburb",
"instance": "String",
"options": {},
"validators": []
}timezone
{
"path": "timezone",
"instance": "String",
"options": {},
"validators": []
}timezone_offset
{
"path": "timezone_offset",
"instance": "String",
"options": {},
"validators": []
}updatedAt
{
"path": "updatedAt",
"instance": "Date",
"options": {},
"validators": []
}urlid
{
"path": "urlid",
"instance": "String",
"options": {},
"validators": []
}website
{
"path": "website",
"instance": "String",
"options": {},
"validators": []
}what3words
{
"path": "what3words",
"instance": "Array",
"options": {
"type": [
null
]
},
"validators": [],
"defaultValue": "[Function]",
"arrayType": "String"
}xero_branding_theme
{
"path": "xero_branding_theme",
"instance": "String",
"options": {},
"validators": []
}xero_creditcard_id
{
"path": "xero_creditcard_id",
"instance": "String",
"options": {},
"validators": []
}xero_eft_id
{
"path": "xero_eft_id",
"instance": "String",
"options": {},
"validators": []
}xero_fnb_ebucks_id
{
"path": "xero_fnb_ebucks_id",
"instance": "String",
"options": {},
"validators": []
}xero_paypal_id
{
"path": "xero_paypal_id",
"instance": "String",
"options": {},
"validators": []
}xero_tax_type
{
"path": "xero_tax_type",
"instance": "String",
"options": {},
"validators": []
}xero_tenant_id
{
"path": "xero_tenant_id",
"instance": "String",
"options": {},
"validators": []
}xero_tracking_name
{
"path": "xero_tracking_name",
"instance": "String",
"options": {},
"validators": []
}