Storefront GraphQL APIReferenceObjects
Invoice
type
InvoiceFields
- fields
_id*ID!tenant?StringinvoiceUID?StringshippingAddress?note?StringrejectionReason?StringpaymentStatus?PAYMENT_STATUSValue in
PROCESSINGPAIDCANCELLEDFAILEDUNATTEMPTEDEXPIREDinvoiceStatus?INVOICE_STATUSValue in
PENDINGPROCESSINGREJECTEDCANCELLEDSHIPMENT_IN_PROGRESSSHIPMENT_IN_TRANSITSHIPMENT_DELIVEREDpaymentMethod?INVOICE_PAYMENT_METHODValue in
CODONLINEpaymentProvider?PAYMENT_PROVIDERValue in
BKASHSSLCOMMERZpaymentTransactionId?StringpaymentSuccessUrl?StringpaymentFailUrl?StringpaymentCancelUrl?StringpaidAt?DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
customer?vendor?lineItems?subTotalAmount?FloatnetTotalAmount?FloattaxRate?FloattaxAmount?FloatdeliveryCharge?FloatcouponCode?StringcouponDiscount?FloatTotal of all discounts on the order. Kept for older clients; equals discountTotal.
discountApplications?discountTotal?FloatshippingDiscount?FloatPart of discountTotal that came off the delivery charge.
deliveryArea?StringdeliverySubArea?Stringcommits?webhookEvent?StringLatest Graphland PGW webhook event as JSON string. Parse with JSON.parse on the client.
createdAt?DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
updatedAt?DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
shipment?customFields?type Invoice { _id: ID! tenant: String invoiceUID: String shippingAddress: LocationReference note: String rejectionReason: String paymentStatus: PAYMENT_STATUS invoiceStatus: INVOICE_STATUS paymentMethod: INVOICE_PAYMENT_METHOD paymentProvider: PAYMENT_PROVIDER paymentTransactionId: String paymentSuccessUrl: String paymentFailUrl: String paymentCancelUrl: String paidAt: DateTime customer: UserReference vendor: VendorReference lineItems: [LineItemReference!] subTotalAmount: Float netTotalAmount: Float taxRate: Float taxAmount: Float deliveryCharge: Float couponCode: String couponDiscount: Float discountApplications: [DiscountApplication!] discountTotal: Float shippingDiscount: Float deliveryArea: String deliverySubArea: String commits: [ResourceCommitHistoryReference!] webhookEvent: String createdAt: DateTime updatedAt: DateTime shipment: Shipment customFields: [CheckoutCustomFieldReference!]}