Skip to main content

SalesOrderPaymentSummary

What the seller has taken in against one sales order before or without an invoice, in the order's own currency. Drives the order screen's Paid and Balance.

type SalesOrderPaymentSummary {
  awaitingAcceptanceAmount: Float!
  balanceAmount: Float!
  canRecordPayment: Boolean!
  currency: String
  draftAmount: Float!
  overpaidAmount: Float!
  payments: [SalesOrderPaymentLine!]!
  receivedAmount: Float!
  recordPaymentBlockedCode: String
  totalAmount: Float!
  unclaimedAmount: Float!
  verifiedAmount: Float!
}

Fields​

SalesOrderPaymentSummary.awaitingAcceptanceAmount ● Float! non-null scalar​

Portal bank transfers the customer registered that the seller has not accepted yet. Not counted as received.

SalesOrderPaymentSummary.balanceAmount ● Float! non-null scalar​

Total minus received, never below zero. Recording a payment is offered while this is above zero.

SalesOrderPaymentSummary.canRecordPayment ● Boolean! non-null scalar​

Whether this order may take a payment now. The same rule the payment mutations enforce for the admin, the customer apps and the MCP tools: payable status (a Draft only with Prepaid terms) and something still unpaid and unclaimed.

SalesOrderPaymentSummary.currency ● String scalar​

The order's currency code; every amount below is in it.

SalesOrderPaymentSummary.draftAmount ● Float! non-null scalar​

Admin entries still in Draft, linked to the order. A claim on the balance, not money; not counted as received.

SalesOrderPaymentSummary.overpaidAmount ● Float! non-null scalar​

How far received money is above the order total (the customer over-paid, or the order was edited down after payment). Zero otherwise. The extra stays unallocated on the payment.

SalesOrderPaymentSummary.payments ● [SalesOrderPaymentLine!]! non-null object​

Each payment tied to the order, in the order the payments were read.

SalesOrderPaymentSummary.receivedAmount ● Float! non-null scalar​

Money received against the order: every committed payment linked to it, verified or not. A portal transfer the seller has not accepted yet is not included. Can exceed the total when the customer over-paid.

SalesOrderPaymentSummary.recordPaymentBlockedCode ● String scalar​

Why it cannot take a payment: ORDER_NOT_PAYABLE (status), ORDER_FULLY_PAID, or ORDER_PAYMENT_WAITING (a transfer or Draft is waiting to be accepted or confirmed). Null when it can.

SalesOrderPaymentSummary.totalAmount ● Float! non-null scalar​

The order total.

SalesOrderPaymentSummary.unclaimedAmount ● Float! non-null scalar​

Still unpaid and unclaimed: total minus received, minus transfers waiting for acceptance, minus Draft entries, never below zero. A payment is offered only while this is above zero.

SalesOrderPaymentSummary.verifiedAmount ● Float! non-null scalar​

The part of received money that a second person or the payment gateway vouched for. This is what the Payment Before Release rule counts.

Member Of​

SalesOrder object