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 attributes: [Attribute!]! 
61 
62 billingAddress: Address 
63 
64 #   Required permission: Buyer:read
65 # 
66 #   All elements are always returned
67 # 
68 #   Store restrictions apply.
69 buyers: [Buyer!]! 
70 
71 carrierInformation: CarrierInformation 
72 
73 #   Required permission: Account:read
74 # 
75 #   All elements are always returned
76 deliveryWindowDiscounts: [DeliveryWindowDiscount!]! 
77 
78 #   Required permission: DocumentTemplate:read
79 # 
80 #   Store restrictions apply.
81 documentTemplate: 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)
92 emailHistory(where: EmailHistoryFilter, sort: [EmailHistorySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [WholesaleEmailHistoryEntry!]! 
93 
94 #   Required permission: Invoice:read
95 # 
96 #   Limit must be in range 1 - 200
97 # 
98 #   Store restrictions apply.
99 # 
100 # Arguments
101 #   where: (self-explanatory)
102 #   sort: (self-explanatory)
103 #   limit: (self-explanatory)
104 #   page: (self-explanatory)
105 invoices(where: InvoiceFilter, sort: [InvoiceSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [WholesaleInvoice!]! 
106 
107 #   Required permission: Market:read
108 # 
109 #   Store restrictions apply.
110 market: Market 
111 
112 #   Required permission: Order:read
113 # 
114 #   Limit must be in range 1 - 100
115 # 
116 #   Store restrictions apply.
117 # 
118 # Arguments
119 #   where: (self-explanatory)
120 #   sort: (self-explanatory)
121 #   limit: (self-explanatory)
122 #   page: (self-explanatory)
123 orders(where: OrderFilter, sort: [OrderSort!] = [number_DESC], limit: Int = 20, page: Int = 1): [WholesaleOrder!]! 
124 
125 #   Required permission: PaymentTerms:read
126 # 
127 #   Store restrictions apply.
128 paymentTerms: PaymentTerms 
129 
130 #   Required permission: Pricelist:read
131 # 
132 #   Store restrictions apply.
133 pricelist: Pricelist 
134 
135 #   Required permission: Return:read
136 # 
137 #   Limit must be in range 1 - 200
138 # 
139 #   Store restrictions apply.
140 # 
141 # Arguments
142 #   where: (self-explanatory)
143 #   sort: (self-explanatory)
144 #   limit: (self-explanatory)
145 #   page: (self-explanatory)
146 returns(where: ReturnFilter, sort: [ReturnSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [WholesaleReturn!]! 
147 
148 #   Required permission: SalesRepresentative:read
149 salesRepresentative: SalesRepresentative 
150 
151 shippingAddress: Address 
152 
153 #   Required permission: ShippingTerms:read
154 # 
155 #   Store restrictions apply.
156 shippingTerms: ShippingTerms 
157 
158 #   Required permission: Warehouse:read
159 consignationWarehouse: Warehouse 
160 
161 #   Required permission: TaxClass:read
162 taxClass: TaxClass 
163 
164 #   Required permission: Brand:read
165 # 
166 #   Limit must be in range 1 - 200
167 # 
168 #   Store restrictions apply.
169 # 
170 # Arguments
171 #   where: (self-explanatory)
172 #   sort: (self-explanatory)
173 #   limit: (self-explanatory)
174 #   page: (self-explanatory)
175 brands(where: BrandFilter, sort: [BrandSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Brand!]! 
176 
177 #   Required permission: AdminUser:read
178 # 
179 #   Limit is optional
180 # 
181 # Arguments
182 #   where: (self-explanatory)
183 #   sort: (self-explanatory)
184 #   limit: (self-explanatory)
185 #   page: (self-explanatory)
186 visibleForAgents(where: AdminUserFilter, sort: [AdminUserSort!] = [id_ASC], limit: Int, page: Int = 1): [AdminUser!]! 
187 
188 }

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	attributes: [Attribute!]!
61
62	billingAddress: Address
63
64	# Required permission: Buyer:read
65	#
66	# All elements are always returned
67	#
68	# Store restrictions apply.
69	buyers: [Buyer!]!
70
71	carrierInformation: CarrierInformation
72
73	# Required permission: Account:read
74	#
75	# All elements are always returned
76	deliveryWindowDiscounts: [DeliveryWindowDiscount!]!
77
78	# Required permission: DocumentTemplate:read
79	#
80	# Store restrictions apply.
81	documentTemplate: 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)
92	emailHistory(where: EmailHistoryFilter, sort: [EmailHistorySort!] = [id_DESC], limit: Int = 20, page: Int = 1): [WholesaleEmailHistoryEntry!]!
93
94	# Required permission: Invoice:read
95	#
96	# Limit must be in range 1 - 200
97	#
98	# Store restrictions apply.
99	#
100	# Arguments
101	# where: (self-explanatory)
102	# sort: (self-explanatory)
103	# limit: (self-explanatory)
104	# page: (self-explanatory)
105	invoices(where: InvoiceFilter, sort: [InvoiceSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [WholesaleInvoice!]!
106
107	# Required permission: Market:read
108	#
109	# Store restrictions apply.
110	market: Market
111
112	# Required permission: Order:read
113	#
114	# Limit must be in range 1 - 100
115	#
116	# Store restrictions apply.
117	#
118	# Arguments
119	# where: (self-explanatory)
120	# sort: (self-explanatory)
121	# limit: (self-explanatory)
122	# page: (self-explanatory)
123	orders(where: OrderFilter, sort: [OrderSort!] = [number_DESC], limit: Int = 20, page: Int = 1): [WholesaleOrder!]!
124
125	# Required permission: PaymentTerms:read
126	#
127	# Store restrictions apply.
128	paymentTerms: PaymentTerms
129
130	# Required permission: Pricelist:read
131	#
132	# Store restrictions apply.
133	pricelist: Pricelist
134
135	# Required permission: Return:read
136	#
137	# Limit must be in range 1 - 200
138	#
139	# Store restrictions apply.
140	#
141	# Arguments
142	# where: (self-explanatory)
143	# sort: (self-explanatory)
144	# limit: (self-explanatory)
145	# page: (self-explanatory)
146	returns(where: ReturnFilter, sort: [ReturnSort!] = [id_DESC], limit: Int = 20, page: Int = 1): [WholesaleReturn!]!
147
148	# Required permission: SalesRepresentative:read
149	salesRepresentative: SalesRepresentative
150
151	shippingAddress: Address
152
153	# Required permission: ShippingTerms:read
154	#
155	# Store restrictions apply.
156	shippingTerms: ShippingTerms
157
158	# Required permission: Warehouse:read
159	consignationWarehouse: Warehouse
160
161	# Required permission: TaxClass:read
162	taxClass: TaxClass
163
164	# Required permission: Brand:read
165	#
166	# Limit must be in range 1 - 200
167	#
168	# Store restrictions apply.
169	#
170	# Arguments
171	# where: (self-explanatory)
172	# sort: (self-explanatory)
173	# limit: (self-explanatory)
174	# page: (self-explanatory)
175	brands(where: BrandFilter, sort: [BrandSort!] = [id_ASC], limit: Int = 20, page: Int = 1): [Brand!]!
176
177	# Required permission: AdminUser:read
178	#
179	# Limit is optional
180	#
181	# Arguments
182	# where: (self-explanatory)
183	# sort: (self-explanatory)
184	# limit: (self-explanatory)
185	# page: (self-explanatory)
186	visibleForAgents(where: AdminUserFilter, sort: [AdminUserSort!] = [id_ASC], limit: Int, page: Int = 1): [AdminUser!]!
187
188	}

Account

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by