OBJECT

DirectToConsumerInvoice

link GraphQL Schema definition

1type DirectToConsumerInvoice implements Invoice {
2id: Int!
3
4number: Int!
5
6type: InvoiceType!
7
8status: InvoiceStatus!
9
10# Arguments
11# format: ISO-8601
12createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
13
14# Arguments
15# format: (self-explanatory)
16dueDate(format: String = "Y-m-d"): Date
17
18# Arguments
19# format: (self-explanatory)
20orderDate(format: String = "Y-m-d"): Date
21
22# Arguments
23# format: ISO-8601
24updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
25
26purchaseOrderNumber: String
27
28ourReference: String
29
30additionalInformation: String
31
32pdfUrl: String!
33
34isOverdue: Boolean
35
36# Arguments
37# includingTax: (self-explanatory)
38grandTotal(includingTax: Boolean! = true): MonetaryValue!
39
40companyRegistrationNumber: String
41
42currencyBaseRate: Float!
43
44# Required permission: Account:read
45#
46# Store restrictions apply.
47account: Account
48
49# Required permission: AdminUser:read
50adminUser: AdminUser
51
52# Required permission: Invoice.billingAddress:read
53billingAddress: Address
54
55# Required permission: Commission:read
56#
57# All elements are always returned
58commissions: [Commission!]!
59
60# Required permission: none
61#
62# All elements are always returned
63lines: [InvoiceLine!]!
64
65# Required permission: none
66numberSeries: NumberSeries
67
68# Required permission: Invoice:read
69#
70# All elements are always returned
71payments: [InvoicePayment!]!
72
73# Required permission: PaymentTerms:read
74#
75# Store restrictions apply.
76paymentTerms: PaymentTerms
77
78# Required permission: Invoice.shippingAddress:read
79shippingAddress: Address
80
81# Required permission: ShippingTerms:read
82#
83# Store restrictions apply.
84shippingTerms: ShippingTerms
85
86# Required permission: Store:read
87#
88# Store restrictions apply.
89store: Store!
90
91# Required permission: Invoice:read
92totals: InvoiceTotals!
93
94# Required permission: Customer:read
95#
96# Store restrictions apply.
97customer: Customer!
98
99# Required permission: Order:read
100#
101# All elements are always returned
102#
103# Store restrictions apply.
104orders: [DirectToConsumerOrder!]!
105
106# Required permission: Shipment:read
107#
108# All elements are always returned
109#
110# Store restrictions apply.
111shipments: [DirectToConsumerShipment!]!
112
113}