Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceObjects

Invoice

typeInvoice

Fields

  1. fields
_id*ID!
commits?
couponCode?String
couponDiscount?Float

Total of all discounts on the order. Kept for older clients; equals discountTotal.

createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

customFields?
customer?
deliveryArea?String
deliveryCharge?Float
deliverySubArea?String
discountApplications?
discountTotal?Float
invoiceStatus?INVOICE_STATUS
Value inCANCELLEDPENDINGPROCESSINGREJECTEDSHIPMENT_DELIVEREDSHIPMENT_IN_PROGRESSSHIPMENT_IN_TRANSIT
invoiceUID?String
lineItems?
netTotalAmount?Float
note?String
paidAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

paymentCancelUrl?String
paymentFailUrl?String
paymentMethod?INVOICE_PAYMENT_METHOD
Value inCODONLINE
paymentProvider?PAYMENT_PROVIDER
Value inBKASHSSLCOMMERZ
paymentStatus?PAYMENT_STATUS
Value inCANCELLEDEXPIREDFAILEDPAIDPROCESSINGUNATTEMPTED
paymentSuccessUrl?String
paymentTransactionId?String
rejectionReason?String
shipment?
shippingAddress?
shippingDiscount?Float

Part of discountTotal that came off the delivery charge.

subTotalAmount?Float
taxAmount?Float
taxRate?Float
tenant?String
updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

vendor?
webhookEvent?String

Latest Graphland PGW webhook event as JSON string. Parse with JSON.parse on the client.

Usages

Returned by
QUERYsale__invoice
Field of
InvoiceWithPagination.nodes
SDL
type Invoice {  _id: ID!  commits: [ResourceCommitHistoryReference!]  couponCode: String  couponDiscount: Float  createdAt: DateTime  customFields: [CheckoutCustomFieldReference!]  customer: UserReference  deliveryArea: String  deliveryCharge: Float  deliverySubArea: String  discountApplications: [DiscountApplication!]  discountTotal: Float  invoiceStatus: INVOICE_STATUS  invoiceUID: String  lineItems: [LineItemReference!]  netTotalAmount: Float  note: String  paidAt: DateTime  paymentCancelUrl: String  paymentFailUrl: String  paymentMethod: INVOICE_PAYMENT_METHOD  paymentProvider: PAYMENT_PROVIDER  paymentStatus: PAYMENT_STATUS  paymentSuccessUrl: String  paymentTransactionId: String  rejectionReason: String  shipment: Shipment  shippingAddress: LocationReference  shippingDiscount: Float  subTotalAmount: Float  taxAmount: Float  taxRate: Float  tenant: String  updatedAt: DateTime  vendor: VendorReference  webhookEvent: String}