OBJECT

Account

GraphQL Schema definition

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

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

Account

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by