Model invoicecomms

Permissions

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

Fields

Name	Type	Link	Maps To	Default	Indexed?	Required?
__v	Number
_deleted	Boolean			false	x
_id	ObjectID			[Function]
_owner_id	ObjectID	User	_owner		x
_updated_by_id	ObjectID	User	_updated_by		x
action	String				x	x
caller	String					x
createdAt	Date
destination	String				x	x
externalId	String				x
id	String				x
invoice_id	ObjectID	Invoice			x
isError	Boolean			false	x
isSuccesfull	Boolean			false
payload	Mixed			[Function]
provider	String				x	x
response	Mixed			[Function]
responseRecieved	Boolean			false
type	String				x	x
updatedAt	Date

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": []
}

action

{
  "path": "action",
  "instance": "String",
  "options": {
    "required": true,
    "index": true,
    "trim": true
  },
  "validators": [
    {
      "message": "Path `{PATH}` is required."
    }
  ],
  "isRequired": true
}

Validators

: Path `{PATH}` is required.

caller

{
  "path": "caller",
  "instance": "String",
  "options": {
    "required": true,
    "trim": true
  },
  "validators": [
    {
      "message": "Path `{PATH}` is required."
    }
  ],
  "isRequired": true
}

Validators

: Path `{PATH}` is required.

createdAt

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

destination

{
  "path": "destination",
  "instance": "String",
  "options": {
    "required": true,
    "enum": [
      "accounting",
      "email",
      "whatsapp",
      "app"
    ],
    "index": true
  },
  "validators": [
    {
      "message": "Path `{PATH}` is required."
    },
    {
      "message": "`{VALUE}` is not a valid enum value for path `{PATH}`."
    }
  ],
  "isRequired": true
}

Validators

: Path `{PATH}` is required.
: `{VALUE}` is not a valid enum value for path `{PATH}`.

externalId

{
  "path": "externalId",
  "instance": "String",
  "options": {
    "index": true,
    "trim": true
  },
  "validators": []
}

id

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

invoice_id

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

isError

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

isSuccesfull

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

payload

{
  "path": "payload",
  "instance": "Mixed",
  "options": {},
  "validators": [],
  "defaultValue": "[Function]"
}

provider

{
  "path": "provider",
  "instance": "String",
  "options": {
    "required": true,
    "index": true,
    "trim": true
  },
  "validators": [
    {
      "message": "Path `{PATH}` is required."
    }
  ],
  "isRequired": true
}

Validators

: Path `{PATH}` is required.

response

{
  "path": "response",
  "instance": "Mixed",
  "options": {},
  "validators": [],
  "defaultValue": "[Function]"
}

responseRecieved

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

type

{
  "path": "type",
  "instance": "String",
  "options": {
    "required": true,
    "enum": [
      "invoice",
      "quote"
    ],
    "index": true
  },
  "validators": [
    {
      "message": "Path `{PATH}` is required."
    },
    {
      "message": "`{VALUE}` is not a valid enum value for path `{PATH}`."
    }
  ],
  "isRequired": true
}

Validators

: Path `{PATH}` is required.
: `{VALUE}` is not a valid enum value for path `{PATH}`.

updatedAt

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