Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Sale__invoice

{ collectionName: 'sale__Invoice', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the `sale__Invoice` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYsale__invoice(where: CommonFindDocumentDto!): Invoice!

{ collectionName: 'sale__Invoice', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the sale__Invoice read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

where*

Returns

  1. sale__invoice
_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.

Example Request
query Sale__invoice($where: CommonFindDocumentDto!) {  sale__invoice(where: $where) {    _id    commits {      action      commitedBy {        email        name        phoneNumber        referenceId      }      committedAt      note    }    couponCode    couponDiscount    createdAt    customFields {      key      value    }    deliveryArea    deliveryCharge    deliverySubArea    discountTotal  }}
Variables
{  "where": {    "and": [      {        "and": [          {            "and": [              {                "and": [                  {}                ],                "key": "string"              }            ],            "key": "string"          }        ],        "key": "string"      }    ],    "key": "string"  }}
Example Response
{  "data": {    "sale__invoice": {      "_id": "1",      "commits": [        {          "action": "string",          "commitedBy": {            "email": "string",            "name": "string",            "phoneNumber": "string",            "referenceId": "1"          },          "committedAt": "<DateTime>",          "note": "string"        }      ],      "couponCode": "string",      "couponDiscount": 10.5,      "createdAt": "<DateTime>",      "customFields": [        {          "key": "string",          "value": "string"        }      ],      "deliveryArea": "string",      "deliveryCharge": 10.5,      "deliverySubArea": "string",      "discountTotal": 10.5    }  }}

Sale__discounts QUERY

{ collectionName: 'sale__Discount', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the `sale__Discount` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Sale__invoice Offers QUERY

Automatic Buy X Get Y offers an editable order qualifies for but doesn't have yet. { collectionName: 'sale__Invoice', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the `sale__Invoice` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).