Issue:
We need to be able to create payments against invoices using the SedonaWeb 2.0 API.
Resolution:
Using the SedonaAPI, you can create payment records in the SedonaOffice database.
Creating a request to create a new payment record.
This document assumes you have the information needed to create a collection or call from Postman to your SedonaAPI.
When using the POST /api/ARPayment, you only need minimal information for the request to be successful. The example below shows the fields needed to create a basic payment against an existing invoice.
{
"TransactionDate": "2025-02-28",
"PaymentMethodCode": "Visa",
"TypeCVEO": "C",
"CustomerId": 42586,
"CheckNumber": "ACH Processing",
"Amount": 10.00,
"Memo": "Payment test",
"BranchId": 4,
"BranchCode": "OH",
"DepositCheckDetails": [
{
"TypeUAIM": "I",
"InvoiceId": 497794,
"Amount": 10.00,
"BranchId": 4,
"BranchCode": "OH"
}
]
}
In this example, BranchId and BranchCode are included, but only one is needed for the transaction to be successful.
PaymentMethodCode needs to be a valid Payment Method in the company. You can also send the PaymentMethodId instead of the code.
TypeCVEO should be C for Customer.
CheckNumber can be the actual check number if known, or, as in this example, the payment is a type of Visa, so the text value of "ACH Processing" was used.
There are other fields in the model that can be sent along with this basic data. Items like DepositBatchDescription, CheckDate, or other resources in the model can be sent.
In the DepositCheckDetail section, the TypeUAIM should be I for invoice.
Then just the Invoice ID, the amount, and the BranchID or the BranchCode are needed.
The payments will display against the customer in Payments. 
GL entries are created.
Payment is applied to the specified invoice.
The deposit batch is created and can be posted.
There are also additional fields that can be sent, but this is the minimum needed, and a payment that can be applied to multiple invoices at one time. The amounts in the details must sum to the amount in the header.
"DepositCheckDetails":
[
{
"TypeUAIM": "I",
"InvoiceId": 497794,
"Amount": 10.00,
"BranchId": 4,
"BranchCode": "OH"
},
{
"TypeUAIM": "I",
"InvoiceId": 497796,
"Amount": 10.00,
"BranchId": 4,
"BranchCode": "OH"
}
Additional API information can be found at the link below.
