Skip to main content

CustomerOrderPaymentOverlay

"Payment under review" overlay for an order: AWAITING_PAYMENT + a pending COLLECTION payment (derived, never a backend status).

type CustomerOrderPaymentOverlay {
  amountToPay: Float!
  approved: Boolean!
  canPay: Boolean!
  orderId: ID!
  pendingAmount: Float
  receivedAmount: Float!
  registeredAt: DateTime
  underReview: Boolean!
}

Fields​

CustomerOrderPaymentOverlay.amountToPay ● Float! non-null scalar​

What the customer may still pay (total minus received, waiting transfers and draft entries); 0 when canPay is false.

CustomerOrderPaymentOverlay.approved ● Boolean! non-null scalar​

True when the seller has taken in the whole order total (accepted or recorded). Apps show 'Payment approved'.

CustomerOrderPaymentOverlay.canPay ● Boolean! non-null scalar​

True when the customer may pay this order now: payable status and something still unpaid and unclaimed.

CustomerOrderPaymentOverlay.orderId ● ID! non-null scalar​

The ID of the order.

CustomerOrderPaymentOverlay.pendingAmount ● Float scalar​

The amount of a bank transfer registered and not yet confirmed.

CustomerOrderPaymentOverlay.receivedAmount ● Float! non-null scalar​

What the seller has already taken in against the order.

CustomerOrderPaymentOverlay.registeredAt ● DateTime scalar​

When the transfer was registered.

CustomerOrderPaymentOverlay.underReview ● Boolean! non-null scalar​

True when the seller is checking the transfer.

Returned By​

customerOrderPaymentOverlays query