mobileInvoice

Requires a customer (portal or buyer app) session.

Returns one of the buyer's SALES invoices in full — lines, bill breakdown, payments received and addresses — for the invoice-detail screen reached from Billing. Company-scoped: another partner's (or tenant's) invoice reads as not-found, and an unissued DRAFT / CANCELLED / VOIDED invoice is never returned.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query MobileInvoice($invoiceId: ID!) {
  mobileInvoice(invoiceId: $invoiceId) {
    id
    invoiceNumber
    salesOrderNumber
    status
    balanceDue
    currency
    bill {
      vatName
      belowMov
      cartId
      customerTier
      deliveryFee
      deliveryOptionId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MobileInvoice($invoiceId: ID!) {\n  mobileInvoice(invoiceId: $invoiceId) {\n    id\n    invoiceNumber\n    salesOrderNumber\n    status\n    balanceDue\n    currency\n    bill {\n      vatName\n      belowMov\n      cartId\n      customerTier\n      deliveryFee\n      deliveryOptionId\n    }\n  }\n}",
  "variables": {
    "invoiceId": "id"
  }
}
EOF

Variables:

{
  "invoiceId": "id"
}

Response:

{
  "data": {
    "mobileInvoice": {
      "id": "id",
      "invoiceNumber": "string",
      "salesOrderNumber": "string",
      "status": "string",
      "balanceDue": 0,
      "currency": "string",
      "bill": {
        "vatName": "string",
        "belowMov": true,
        "cartId": "id",
        "customerTier": "string",
        "deliveryFee": 0,
        "deliveryOptionId": "id"
      }
    }
  }
}

mobileInvoice(
  invoiceId: ID!
): MobileInvoice!

Arguments

mobileInvoice.invoiceId ● ID! non-null scalar

The ID of the invoice.

Type

MobileInvoice object

A buyer's sales invoice in full for the buyer app: lines, bill breakdown, payments received and addresses.