OBJECT

Invoice

link GraphQL Schema definition

1type 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"): String!
13
14# Arguments
15# format: (self-explanatory)
16dueDate(format: String = "Y-m-d"): String
17
18# Arguments
19# format: (self-explanatory)
20orderDate(format: String = "Y-m-d"): String
21
22# Arguments
23# format: ISO-8601
24updatedAt(format: String = "Y-m-d\\TH:i:sP"): String!
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
42# Required permission: Account:read
43#
44# Store restrictions apply.
45account: Account
46
47# Required permission: AdminUser:read
48adminUser: AdminUser
49
50# Required permission: Invoice.billingAddress:read
51billingAddress: Address
52
53# Required permission: Commission:read
54#
55# All elements are always returned
56commissions: [Commission!]!
57
58# Required permission: none
59#
60# All elements are always returned
61lines: [InvoiceLine!]!
62
63# Required permission: none
64numberSeries: NumberSeries
65
66# Required permission: Purchaser:read
67purchaser: Purchaser!
68
69# Required permission: Invoice.shippingAddress:read
70shippingAddress: Address
71
72# Required permission: Store:read
73#
74# Store restrictions apply.
75store: Store!
76
77# Required permission: Invoice:read
78totals: InvoiceTotals!
79
80# Required permission: ShippingTerms:read
81#
82# Store restrictions apply.
83shippingTerms: ShippingTerms
84
85# Required permission: PaymentTerms:read
86#
87# Store restrictions apply.
88paymentTerms: PaymentTerms
89
90}