Owners Query
Get Owner list from EverReal
Introduction
Our owner query will get you the list of owners from the respective company. We provides ability to filter the owner by externalId and fullSearch over firstName, lastName and email. Please make sure the paging option is used to fetch more items.
To understand what is necessary and how to use GraphQL, on master data page we explain what is necessary to do
Query
type Query {
owners(input: OwnersFilterListPaging): [Owner]
}
Schema
type Owner {
id: String
externalId: String
email: String
firstName: String
lastName: String
companyName: String
address: Address
bankInformation: OwnerBankIformation
bankDepositInformation: OwnerBankDepositInformation
}
type Address {
streetName: String
streetNumber: String
zipCode: String
city: String
country: String
}
type OwnerBankDepositInformation {
iban: String
bic: String
bankName: String
accountHolderName: String
}
type OwnerBankIformation {
bankName: String
bankAddress: String
bic: String
iban: String
}
input OwnersFilterListPaging {
filter: OwnersFilter
paging: GraphPaging
sort: GraphSorting
}
input OwnersFilter {
id: String
externalId: String
companyId: String
fullSearch: String
updatedAt: IDateRange
}
input GraphPaging {
skip: Int
take: Int
}
input GraphSorting {
fieldName: String
direction: String
}
Examples of Owner Query
{
owners(
input: {
filter: { externalId: "iE-32" }
paging: { skip: 0, take: 50 }
}
) {
id
email
firstName
lastName
address {
city
}
bankInformation {
iban
}
}
}
Last updated
Was this helpful?