Model xeropayments

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
_updated_by_id	ObjectID	User	_updated_by		x
account	Mixed
amount	Number
bank_amount	Number
createdAt	Date
currency_rate	Number
date	Date				x
has_account	Boolean
invoice	Mixed
invoice_id	ObjectID	Invoice	local_invoice		x
is_reconciled	Boolean
location_id	ObjectID	Location			x
organisation_id	ObjectID	Organisation			x
payment_id	String
payment_type	String
reference	String
status	String
updatedAt	Date
updated_date_utc	Date				x
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": {},
  "validators": []
}

_updated_by_id

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

account

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

amount

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

bank_amount

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

createdAt

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

currency_rate

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

date

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

has_account

{
  "path": "has_account",
  "instance": "Boolean",
  "options": {},
  "validators": []
}

invoice

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

invoice_id

{
  "path": "invoice_id",
  "instance": "ObjectID",
  "options": {
    "link": "Invoice",
    "index": true,
    "map_to": "local_invoice"
  },
  "validators": []
}

is_reconciled

{
  "path": "is_reconciled",
  "instance": "Boolean",
  "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": []
}

payment_id

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

payment_type

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

reference

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

status

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

updatedAt

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

updated_date_utc

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

xero_tenant_id

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