OBJECT

Account

link GraphQL Schema definition

1type Account implements ObjectWithAttributes {
2id: Int!
3
4name: String!
5
6status: Status!
7
8# Arguments
9# format: ISO-8601
10createdAt(format: String = "Y-m-d\\TH:i:sP"): String!
11
12# Arguments
13# format: ISO-8601
14updatedAt(format: String = "Y-m-d\\TH:i:sP"): String!
15
16discountPercent: Float!
17
18isDiscountVisible: Boolean!
19
20# Required permission: Account.internalComment:read
21internalComment: String
22
23otherComment: String
24
25accountEmail: String
26
27billingEmail: String
28
29shippingEmail: String
30
31websiteUrl: String
32
33vatNumber: String
34
35creditLimit: MonetaryValue
36
37allowConsignation: Boolean!
38
39applyCreditLimit: Boolean!
40
41blockIfUnpaidInvoices: Boolean!
42
43hasBrandsRestriction: Boolean!
44
45isInternal: Boolean!
46
47accountAddress: Address
48
49# Required permission: Account:read
50#
51# All elements are always returned
52addressBook: [AddressBookEntry!]!
53
54# Required permission: AllocationRule:read
55allocationRule: AllocationRule
56
57# Required permission: Account.attributes:read
58#
59# All elements are always returned
60attributes: [Attribute!]!
61
62billingAddress: Address
63
64# Required permission: Purchaser:read
65#
66# All elements are always returned
67#
68# Store restrictions apply.
69buyers: [Buyer!]!
70
71carrierInformation: CarrierInformation
72
73# Required permission: Account:read
74#
75# All elements are always returned
76deliveryWindowDiscounts: [DeliveryWindowDiscount!]!
77
78# Required permission: DocumentTemplate:read
79#
80# Store restrictions apply.
81documentTemplate: DocumentTemplate
82
83# Required permission: EmailHistory:read
84#
85# Limit must be in range 1 - 200
86#
87# Arguments
88# where: (self-explanatory)
89# sort: (self-explanatory)
90# limit: (self-explanatory)
91# page: (self-explanatory)
92emailHistory(
93where: EmailHistoryFilter,
94sort: [EmailHistorySort!] = [id_DESC],
95limit: Int = 20,
96page: Int = 1
97): [EmailHistoryEntry!]!
98
99# Required permission: Invoice:read
100#
101# Limit must be in range 1 - 200
102#
103# Store restrictions apply.
104#
105# Arguments
106# where: (self-explanatory)
107# sort: (self-explanatory)
108# limit: (self-explanatory)
109# page: (self-explanatory)
110invoices(where: InvoiceFilter, sort: [InvoiceSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [Invoice!]!
111
112# Required permission: Market:read
113#
114# Store restrictions apply.
115market: Market
116
117# Required permission: Order:read
118#
119# Limit must be in range 1 - 100
120#
121# Store restrictions apply.
122#
123# Arguments
124# where: (self-explanatory)
125# sort: (self-explanatory)
126# limit: (self-explanatory)
127# page: (self-explanatory)
128orders(where: OrderFilter, sort: [OrderSort!] = [number_DESC], limit: Int = 20, page: Int = 1): [WholesaleOrder!]!
129
130# Required permission: PaymentTerms:read
131#
132# Store restrictions apply.
133paymentTerms: PaymentTerms
134
135# Required permission: Pricelist:read
136#
137# Store restrictions apply.
138pricelist: Pricelist
139
140# Required permission: Return:read
141#
142# Limit must be in range 1 - 200
143#
144# Store restrictions apply.
145#
146# Arguments
147# where: (self-explanatory)
148# sort: (self-explanatory)
149# limit: (self-explanatory)
150# page: (self-explanatory)
151returns(where: ReturnFilter, sort: [ReturnSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [Return!]!
152
153# Required permission: SalesRepresentative:read
154salesRepresentative: SalesRepresentative
155
156shippingAddress: Address
157
158# Required permission: ShippingTerms:read
159#
160# Store restrictions apply.
161shippingTerms: ShippingTerms
162
163# Required permission: Warehouse:read
164consignationWarehouse: Warehouse
165
166# Required permission: TaxClass:read
167taxClass: TaxClass
168
169# Required permission: Brand:read
170#
171# Limit must be in range 1 - 200
172#
173# Store restrictions apply.
174#
175# Arguments
176# where: (self-explanatory)
177# sort: (self-explanatory)
178# limit: (self-explanatory)
179# page: (self-explanatory)
180brands(where: BrandFilter, sort: [BrandSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Brand!]!
181
182# Required permission: AdminUser:read
183#
184# Limit is optional
185#
186# Arguments
187# where: (self-explanatory)
188# sort: (self-explanatory)
189# limit: (self-explanatory)
190# page: (self-explanatory)
191visibleForAgents(
192where: AdminUserFilter,
193sort: [AdminUserSort!] = [id_ASC],
194limit: Int,
195page: Int = 1
196): [AdminUser!]!
197
198}