You are here: API Foundations > Use Cases > Creating and Applying Payments to an Invoice

Creating and Applying Payments to an Invoice

In this use case, you are using several objects to create and apply a payment to an invoice.

To create and apply an electronic payment to an invoice,

Query for Invoice by Account ID:

select ID from Invoice where AccountId = 'someAccountId'

Create a new Payment with the following fields set as follows:

Status = Draft
AccountId = someAccountId
PaymentMethodId = somePaymentMethodId (where somePaymentMethodId refers to a Payment Method on the Account.)

Create a new InvoicePayment with the following fields set as follows:

InvoiceId = ID from Invoice.
PaymentId = ID from Payment. Ensure that the complete amount of the Payment is applied on the Invoice Payment.

Update the Payment with Status = Processed.

Sample Code

Payment payment = new Payment();
payment.setAccountId(accountId);
payment.setPaymentMethodId(paymentMethodId);
payment.setType("Electronic");
payment.setAmount(amount);
payment.setEffectiveDate(Calendar.getInstance());
payment.setStatus("Draft");

ID paymentId = create(payment);
InvoicePayment invoicePayment = new InvoicePayment();
invoicePayment.setPaymentId(payment.getId());>
invoicePayment.setInvoiceId(invoiceId);
invoicePayment.setAmount(50);
create(invoicePayment);
payment = new Payment();
payment.setId(paymentId);
payment.setStatus("Processed");
update(payment);

Open topic with navigation