Record a writedown for a member.
The writedown needs to be allocated to one or more "billing items".
| From Body | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ContactId | Guid | The External ID of the contact. | ||||||||||||
| Notes | String | A user-readable note indicating the reason for the writedown. | ||||||||||||
| TenderTypeId | Int32 |
Tender types are customer specific and are configurable by the users. However, there are many pre-configured values that are common to most customers. Here are the pre-configured values: 1 - Cash 2 - Cheque 3 - Card 4 - E Card 5 - Credit 6 - Credit Note 7 - Voucher 8 - EFT 28 - External Payment. This is the most useful item for integrators, as it makes it clear the payment is external. |
||||||||||||
| WriteDownDate | DateTime | The date/time at which the writedown occurred. | ||||||||||||
| [BillingWriteDownsRequestLineItem] | List of billing items and payments. Make sure there is always one BillingId per request | |||||||||||||
|
||||||||||||||
{
"ContactId": "f9025eb8-7bcb-4f72-aa35-ca5d82e6cb01",
"WriteDownDate": "2026-02-05T00:13:12.497898+00:00",
"BillingWriteDowns": [
{
"BillingId": 1,
"Amount": 2.0,
"GLAccountId": 3
},
{
"BillingId": 1,
"Amount": 2.0,
"GLAccountId": 3
},
{
"BillingId": 1,
"Amount": 2.0,
"GLAccountId": 3
}
],
"TenderTypeId": 2,
"Notes": "sample string 3"
}
BillingWriteDownsResponse
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ContactId | Guid | Contact who the Billing items belongs to | ||||||||||||||||||
| ErrorMessage | String | Error message if there is a global failure | ||||||||||||||||||
| Success | Boolean | |||||||||||||||||||
| [BillingWriteDownsResponseLineItem] | For each write down request, you will get one line item | |||||||||||||||||||
|
||||||||||||||||||||
{
"ContactId": "ded1508b-0f17-491e-96cf-e58eedce9c92",
"BillingWriteDowns": [
{
"BillingId": 1,
"Balance": 1.0,
"ProcessDate": "2026-02-05T00:13:12.497898+00:00",
"WriteDownDate": "2026-02-05T00:13:12.497898+00:00",
"ErrorMessage": "sample string 2"
},
{
"BillingId": 1,
"Balance": 1.0,
"ProcessDate": "2026-02-05T00:13:12.497898+00:00",
"WriteDownDate": "2026-02-05T00:13:12.497898+00:00",
"ErrorMessage": "sample string 2"
},
{
"BillingId": 1,
"Balance": 1.0,
"ProcessDate": "2026-02-05T00:13:12.497898+00:00",
"WriteDownDate": "2026-02-05T00:13:12.497898+00:00",
"ErrorMessage": "sample string 2"
}
],
"ErrorMessage": "sample string 2",
"Success": false
}
| Bundle(s) |
|---|
| BillingWriteDown |