action.skip

Entry and Payment Lifecycle

As payment and settlement progress, the amount values and statuses of entries, entry items and payments change. This article illustrates a number of common use cases.

Create and Settle Entry

This example shows the behavior in the following simple use case:

  • Create an entry that represents a receivable,
  • Trigger a payment operation,
  • Collect the money, and
  • Settle the receivable.
Step Entry Entry Item Payment
Create entry Status = Open
Open amount = 100
Expected amount = 0
Assigned amount = 0
Outstanding amount = 100
Trigger payment
Creates payment and entry item
Status = Open
Open amount = 100
Expected amount = -100
Assigned amount = 0
Outstanding amount = 100


Expected amount = -100
Assigned Amount = 0
Status = Issued/Pending
Open amount = -100
Collected amount = 0
Assigned amount = 0
Available Amount = 0
Collect payment
Not "tangible", intermediate state during processing only
Status = Open
Open amount = 100
Expected amount = -100
Assigned amount = 0
Outstanding amount = 100


Expected amount = -100
Assigned Amount = 0
Status = Collected
Open amount = -100
Collected amount = -100
Assigned amount = 0
Available Amount = -100
Settle entry and payment Status = Balanced
Open amount = 100
Expected amount = 0
Assigned amount = -100
Outstanding amount = 0


Expected amount = 0
Assigned Amount = -100
Status = Collected
Open amount = -100
Collected amount = -100
Assigned amount = -100
Available Amount = 0

Cancel Entry

This example shows the behavior when canceling an entry:

  • Create an entry that represents a receivable,
  • Trigger a payment operation,
  • Collect the money,
  • Settle the receivable, and
  • Cancel the entry.
Step Entry Entry Item Payment
Create entry Status = Open
Open amount = 100
Expected amount = 0
Assigned amount = 0
Outstanding amount = 100
Trigger payment
Creates payment and entry item
Status = Open
Open amount = 100
Expected amount = -100
Assigned amount = 0
Outstanding amount = 100


Expected amount = -100
Assigned Amount = 0
Status = Issued/Pending
Open amount = -100
Collected amount = 0
Assigned amount = 0
Available Amount = 0
Collect payment
Not "tangible", intermediate state during processing only
Status = Open
Open amount = 100
Expected amount = -100
Assigned amount = 0
Outstanding amount = 100


Expected amount = -100
Assigned Amount = 0
Status = Collected
Open amount = -100
Collected amount = -100
Assigned amount = 0
Available Amount = -100
Settle entry and payment Status = Balanced
Open amount = 100
Expected amount = 0
Assigned amount = -100
Outstanding amount = 0


Expected amount = 0
Assigned Amount = -100
Status = Collected
Open amount = -100
Collected amount = -100
Assigned amount = -100
Available Amount = 0
Cancel entry Status = Canceled
Open amount = 0
Expected amount = 0
Assigned amount = 0
Outstanding amount = 0


Expected amount = 0
Assigned Amount = 0
Status = Collected
Open amount = -100
Collected amount = -100
Assigned amount = 0
Available Amount = -100

After the cancellation, the defined credit balance strategy is applied to the related payments.

Credit Balance Strategy Payment Refund
Future Settlement (default) Status = Collected
Open amount = -100
Collected amount = -100
Assigned amount = 0
Available Amount = -100
Blocked Amount = 0
Prepared Refund Status = Collected
Open amount = 0
Collected amount = 0
Assigned amount = 0
Available Amount = 0
Blocked Amount = 100
Status = Prepared
Open amount = 100
Refunded amount = 0
Refund method = Prepared Refund
Direct Refund Status = Collected
Open amount = 0
Collected amount = 0
Assigned amount = 0
Available Amount = 0
Blocked Amount = 100
Status = Approved
Open amount = 100
Refunded amount = 0
Refund method = Direct Refund