Model xerocreditnotes

Permissions

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

Fields

Name	Type	Link	Maps To	Default	Indexed?
__v	Number
_deleted	Boolean			false	x
_id	ObjectID			[Function]
_owner_id	ObjectID	User	_owner		x
_updated_by_id	ObjectID	User	_updated_by		x
allocations	Array of Mixed			[Function]
contact	Mixed
createdAt	Date
credit_note_id	String
credit_note_number	String
currency_code	String
currency_rate	Number
date	Date				x
fully_paid_on_date	Date
line_amount_types	String
location_id	ObjectID	Location			x
organisation_id	ObjectID	Organisation			x
remaining_credit	Number
status	String
sub_total	Number
total	Number
total_tax	Number
type	String
updatedAt	Date
updated_date_utc	Date
xero_tenant_id	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": []
}

allocations

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

contact

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

createdAt

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

credit_note_id

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

credit_note_number

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

currency_code

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

currency_rate

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

date

{
  "path": "date",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

fully_paid_on_date

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

line_amount_types

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

location_id

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

organisation_id

{
  "path": "organisation_id",
  "instance": "ObjectID",
  "options": {
    "link": "Organisation",
    "index": true
  },
  "validators": []
}

remaining_credit

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

status

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

sub_total

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

total

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

total_tax

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

type

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

updatedAt

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

updated_date_utc

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

xero_tenant_id

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