User
No description
type User implements IBaseUser {
userId: Int!
addresses(
type: AddressType
isDefault: YesNo
): [Address!]!
id: Int! @deprecated
attributes(
filter: AttributeFilterInput
): [Attribute!]! @deprecated
attributeValues(
filter: AttributeFilterInput
): AttributeValueResponse!
orders: OrderResponse!
aclList(
permission: Permission!
): [Int!]!
isAllowed(
userId: Int!
permission: Permission!
): Boolean!
debtorId: String
gender: Gender
firstName: String!
middleName: String
lastName: String!
phone: String
mobile: String
email: String!
iban: String
bankAccount: String
bic: String
notes: String
primaryLanguage: String
expires: DateTime
externalId: String
dateOfBirth: DateTime
mailingList: YesNo
isLoggedIn: Boolean
dateCreated: DateTime
lastModifiedDate: DateTime
taxNumber: String
cocNumber: String
loginRoot: Int
company: String
parentUsergroupId: Int!
managedCompanies: [Company!]
usergroup: Usergroup
usergroupPath: [Usergroup!]!
}
Fields
User.userId
● Int!
non-null scalar
The id of the user.
User.addresses
● [Address!]!
non-null object
User.addresses.type
●AddressType
enum
User.addresses.isDefault
● YesNo
enum
User.id
● Int!
deprecated non-null scalar
DEPRECATEDThis property is no longer relevant or necessary, use userId instead.
The unique identifier of the user.
User.attributes
● [Attribute!]!
deprecated non-null object
DEPRECATEDDeprecated is favour of attributeValues. Added pagination to ther query the default offset will be 12 values. Increasing the offset in a listed view will impact the performance of the api.
Returns an array of legacy Attribute Entities
User.attributes.filter
●AttributeFilterInput
input
User.attributeValues
● AttributeValueResponse!
non-null object
Returns a paginated response of AttributeValues
User.attributeValues.filter
●AttributeFilterInput
input
User.orders
● OrderResponse!
non-null object
User.aclList
● [Int!]!
non-null scalar
User.aclList.permission
●Permission!
non-null enum
User.isAllowed
● Boolean!
non-null scalar
User.isAllowed.userId
●Int!
non-null scalar
User.isAllowed.permission
● Permission!
non-null enum
User.debtorId
● String
scalar
User.gender
● Gender
enum
The gender of the user.
User.firstName
● String!
non-null scalar
The first name of the user.
User.middleName
● String
scalar
The middle name of the user.
User.lastName
● String!
non-null scalar
The last name of the user.
User.phone
● String
scalar
The phone number of the user.
User.mobile
● String
scalar
The mobile number of the user.
User.email
● String!
non-null scalar
The email of the user.
User.iban
● String
scalar
The International Bank Account Number of the user
User.bankAccount
● String
scalar
The Bank Account Number of the user
User.bic
● String
scalar
The Bank Identification Code of the user
User.notes
● String
scalar
User.primaryLanguage
● String
scalar
The primary language of the user
User.expires
● DateTime
scalar
The expiration date of the contact. After this date expires contact will be disabled.
User.externalId
● String
scalar
External ID
User.dateOfBirth
● DateTime
scalar
The date of birth of the contact.
User.mailingList
● YesNo
enum
User.isLoggedIn
● Boolean
scalar
User.dateCreated
● DateTime
scalar
User.lastModifiedDate
● DateTime
scalar
User.taxNumber
● String
scalar
The Tax number of the user.
User.cocNumber
● String
scalar
The CoC number of the user.
User.loginRoot
● Int
scalar
The propeller access root for this user. Users with a login root can log into the backoffice and have a supervisor role on the api's
User.company
● String
scalar
The company of the user.
User.parentUsergroupId
● Int!
non-null scalar
The usergroup id of parent usergroup.
User.managedCompanies
● [Company!]
list object
Companies managed by the user.
User.usergroup
● Usergroup
object
User.usergroupPath
● [Usergroup!]!
non-null object
Interfaces
IBaseUser
interface
Interface for the BaseUser Type, where both Contacts and Customers derive from