Records payments againt set of billing items
| From Body | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ContactId | Guid | Contact who owns the Billing items | ||||||||||||||||||
| PaymentDate | DateTime | The date the payment was collected | ||||||||||||||||||
| TenderTypeId | Int32 | Check Legend support for the TenderTypeId | ||||||||||||||||||
| [BillingPaymentsRequestLineItem] | List of billing items and payments. Make sure there is always one BillingId per request | |||||||||||||||||||
|
||||||||||||||||||||
{
"ContactId": "d533730b-3add-4da9-8385-cf1404196a2f",
"PaymentDate": "2025-11-02T17:38:19.788753+00:00",
"BillingPayments": [
{
"BillingId": 1,
"Amount": 2.0,
"ThirdPartyReference": "sample string 3",
"Notes": "sample string 4",
"AuthorizationCode": "sample string 5"
},
{
"BillingId": 1,
"Amount": 2.0,
"ThirdPartyReference": "sample string 3",
"Notes": "sample string 4",
"AuthorizationCode": "sample string 5"
},
{
"BillingId": 1,
"Amount": 2.0,
"ThirdPartyReference": "sample string 3",
"Notes": "sample string 4",
"AuthorizationCode": "sample string 5"
}
],
"TenderTypeId": 2
}
BillingPaymentsResponse
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ContactId | Guid | Contact who the Billing items belongs to | ||||||||||||||||||
| ErrorMessage | String | Error message if there is a global failure | ||||||||||||||||||
| Success | Boolean | |||||||||||||||||||
| [BillingPaymentsResponseLineItem] | For each payment request, you will get one line item | |||||||||||||||||||
|
||||||||||||||||||||
{
"ContactId": "67114a56-40bc-411d-a47c-8d466d6b8a11",
"BillingPayments": [
{
"BillingId": 1,
"Balance": 1.0,
"ProcessDate": "2025-11-02T17:38:19.8043653+00:00",
"PaymentDate": "2025-11-02T17:38:19.8043653+00:00",
"ErrorMessage": "sample string 2"
},
{
"BillingId": 1,
"Balance": 1.0,
"ProcessDate": "2025-11-02T17:38:19.8043653+00:00",
"PaymentDate": "2025-11-02T17:38:19.8043653+00:00",
"ErrorMessage": "sample string 2"
},
{
"BillingId": 1,
"Balance": 1.0,
"ProcessDate": "2025-11-02T17:38:19.8043653+00:00",
"PaymentDate": "2025-11-02T17:38:19.8043653+00:00",
"ErrorMessage": "sample string 2"
}
],
"ErrorMessage": "sample string 2",
"Success": false
}
| Bundle(s) |
|---|
| BillingPayment |