Model paymentrequests


Permissions

User GroupCreate?Read?Update?Delete?
financex
setupxxxx
adminxxx
userx
memberx
all

Fields

NameTypeLinkMaps ToDefaultIndexed?Unique?
__vNumber
_deletedBooleanfalsex
_idObjectIDfunction defaultId() { return new oid(); }
_owner_idObjectIDUser_ownerx
_updated_by_idObjectIDUser_updated_byx
callback_urlString
cancelled_atDate
createdAtDate
currencyStringZAR
descriptionString
failed_atDate
initiated_atDatefunction now() { [native code] }
invoice_idObjectIDInvoice
invoice_nrString
notesString
paid_atDate
payment_linkString
platformString
platform_request_idString
platform_responseMixed
platform_urlString
redirect_urlString
statusStringinitiated
totalNumber
updatedAtDate
user_idObjectIDUser

Raw definition

{
	"path": "__v",
	"instance": "Number",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"__v"
	],
	"options": {},
	"_index": null
}
{
	"path": "_deleted",
	"instance": "Boolean",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"_deleted"
	],
	"options": {
		"default": false,
		"index": true
	},
	"_index": true,
	"defaultValue": false
}
{
	"path": "_id",
	"instance": "ObjectID",
	"validators": [],
	"getters": [],
	"setters": [
		null
	],
	"_presplitPath": [
		"_id"
	],
	"options": {
		"auto": true,
		"type": "ObjectId"
	},
	"_index": null
}
{
	"path": "_owner_id",
	"instance": "ObjectID",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"_owner_id"
	],
	"options": {
		"link": "User",
		"map_to": "_owner",
		"index": true
	},
	"_index": true
}
{
	"path": "_updated_by_id",
	"instance": "ObjectID",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"_updated_by_id"
	],
	"options": {
		"link": "User",
		"map_to": "_updated_by",
		"index": true
	},
	"_index": true
}
{
	"enumValues": [],
	"regExp": null,
	"path": "callback_url",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"callback_url"
	],
	"options": {},
	"_index": null
}
{
	"path": "cancelled_at",
	"instance": "Date",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"cancelled_at"
	],
	"options": {},
	"_index": null
}
{
	"path": "createdAt",
	"instance": "Date",
	"validators": [],
	"getters": [],
	"setters": [
		null,
		null
	],
	"_presplitPath": [
		"createdAt"
	],
	"options": {
		"immutable": true
	},
	"_index": null,
	"$immutable": true
}
{
	"enumValues": [],
	"regExp": null,
	"path": "currency",
	"instance": "String",
	"validators": [
		{
			"message": "Path `{PATH}` is required.",
			"type": "required"
		}
	],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"currency"
	],
	"options": {
		"required": true,
		"default": "ZAR"
	},
	"_index": null,
	"isRequired": true,
	"originalRequiredValue": true,
	"defaultValue": "ZAR"
}
{
	"enumValues": [],
	"regExp": null,
	"path": "description",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"description"
	],
	"options": {},
	"_index": null
}
{
	"path": "failed_at",
	"instance": "Date",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"failed_at"
	],
	"options": {},
	"_index": null
}
{
	"path": "initiated_at",
	"instance": "Date",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"initiated_at"
	],
	"options": {},
	"_index": null
}
{
	"path": "invoice_id",
	"instance": "ObjectID",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"invoice_id"
	],
	"options": {
		"link": "Invoice"
	},
	"_index": null
}
{
	"enumValues": [],
	"regExp": null,
	"path": "invoice_nr",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"invoice_nr"
	],
	"options": {},
	"_index": null
}
{
	"enumValues": [],
	"regExp": null,
	"path": "notes",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"notes"
	],
	"options": {},
	"_index": null
}
{
	"path": "paid_at",
	"instance": "Date",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"paid_at"
	],
	"options": {},
	"_index": null
}
{
	"enumValues": [],
	"regExp": null,
	"path": "payment_link",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"payment_link"
	],
	"options": {},
	"_index": null
}
{
	"enumValues": [],
	"regExp": null,
	"path": "platform",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"platform"
	],
	"options": {},
	"_index": null
}
{
	"enumValues": [],
	"regExp": null,
	"path": "platform_request_id",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"platform_request_id"
	],
	"options": {},
	"_index": null
}
{
	"path": "platform_response",
	"instance": "Mixed",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"platform_response"
	],
	"options": {},
	"_index": null
}
{
	"enumValues": [],
	"regExp": null,
	"path": "platform_url",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"platform_url"
	],
	"options": {},
	"_index": null
}
{
	"enumValues": [],
	"regExp": null,
	"path": "redirect_url",
	"instance": "String",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"redirect_url"
	],
	"options": {},
	"_index": null
}
{
	"enumValues": [
		"initiated",
		"pending",
		"processing",
		"paid",
		"failed",
		"cancelled"
	],
	"regExp": null,
	"path": "status",
	"instance": "String",
	"validators": [
		{
			"message": "`{VALUE}` is not a valid enum value for path `{PATH}`.",
			"type": "enum",
			"enumValues": [
				"initiated",
				"pending",
				"processing",
				"paid",
				"failed",
				"cancelled"
			]
		}
	],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"status"
	],
	"options": {
		"enum": [
			"initiated",
			"pending",
			"processing",
			"paid",
			"failed",
			"cancelled"
		],
		"default": "initiated"
	},
	"_index": null,
	"defaultValue": "initiated"
}
{
	"path": "total",
	"instance": "Number",
	"validators": [
		{
			"message": "Path `{PATH}` is required.",
			"type": "required"
		},
		{
			"message": "Validator failed for path `{PATH}` with value `{VALUE}`",
			"type": "user defined"
		}
	],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"total"
	],
	"options": {
		"required": true
	},
	"_index": null,
	"isRequired": true,
	"originalRequiredValue": true
}
{
	"path": "updatedAt",
	"instance": "Date",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"updatedAt"
	],
	"options": {},
	"_index": null
}
{
	"path": "user_id",
	"instance": "ObjectID",
	"validators": [],
	"getters": [],
	"setters": [],
	"_presplitPath": [
		"user_id"
	],
	"options": {
		"link": "User"
	},
	"_index": null
}