Creates a Billing Item against a member in the system, which will need to be paid.
The Billing Item will need to be created against an Agreement or Member Service - either AgreementId or MemberServiceId will need to be supplied.
| From Body | Type | Description |
|---|---|---|
| AgreementId | Int32 | Optional.
The ID of an Agreement to which the billing relates. If not provided, must provide MemberServiceID in the request. |
| BillingTypeId | Int32 |
Why the billing is to be created (aka lgdGlProcessType). Used to determine what General Ledger Code to use when creating the billing on Legend, for accounting purposes. Some common values are: 1 - Enrollment Fee 2 - First Month Fee 3 - Prorate Fee 4 - Membership Fee 15 - Booking Charge 16 - Booking Cancellation 27 - Credit Note 57 - Manual Charge 63 - Course 96 - Payment |
| EffectiveDate | DateTime | Optional.
The date that the billing is effective from. If not supplied the default is now. |
| IsExternalBilling | Boolean |
This should typically be true when the monies are going to a 3rd party, such as fees charged for a transaction. This should typically be false when the monies are going to the customer. |
| MemberServiceId | Int32 | Optional.
The ID of a Member Service to which the billing relates. If not provided, must provide AgreeementID in the request. |
| PayerId | Guid |
The ExternalID for the contact for whom the billing is for. Note that the contact needs to be some kind of membership. |
| TotalAmount | Decimal |
The total amount that the billing is for. Includes tax - tax will be inferred. |
{
"PayerId": "7de1b3c8-35e2-405c-9933-1eb4c197fd73",
"BillingTypeId": 2,
"AgreementId": 3,
"MemberServiceId": 4,
"TotalAmount": 5.0,
"EffectiveDate": "2026-02-05T00:12:42.1999858+00:00",
"IsExternalBilling": true
}
CreateBillingResponse
| Name | Type | Description |
|---|---|---|
| BillingId | Int32 | The unique identifier for this billing. |
| ContactId | Guid | The contact for which this billing was created. |
| GlCode | String | General ledger code against which the billing was created. |
| TotalAmount | Decimal | Total amount billed, including tax. |
{
"ContactId": "b2907161-554f-4869-94f3-4e80bca891e9",
"BillingId": 2,
"GlCode": "sample string 3",
"TotalAmount": 4.0
}
| Bundle(s) |
|---|
| BillingPayment |