Skip to main content

PaymentAllocationState

Derived, read-time classification of a payment's unallocated remainder: awaiting allocation (partner has open invoices) vs overpaid (excess beyond everything owed).

enum PaymentAllocationState {
  AWAITING_ALLOCATION
  FULLY_ALLOCATED
  OVERPAID
}

Values​

PaymentAllocationState.AWAITING_ALLOCATION​

Not yet applied to any invoice.

PaymentAllocationState.FULLY_ALLOCATED​

All of it is applied to invoices.

PaymentAllocationState.OVERPAID​

More was paid than the invoices need.

Member Of​

Payment object