Creates a Billing Item against an Agreement or Member Service.
| 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 (i.e. the lgdGLProcessType such as Prorate Fee, Freeze Fee, Admin Fee etc.). Used to determine what GL Code to use when creating the billing on Legend. |
| 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 or the Xplor Group. This should typically be false when the monies are going to the client. |
| 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 | Contact ID for the Member for whom the billing is for. |
| TotalAmount | Decimal | The total amount that the billing is for. Includes tax - tax will be inferred. |
{
"PayerId": "60068b1c-c7b0-4668-b110-29733323a83c",
"BillingTypeId": 2,
"AgreementId": 3,
"MemberServiceId": 4,
"TotalAmount": 5.0,
"EffectiveDate": "2025-04-25T14:14:35.8653537+01: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": "2244aeca-09d7-48c7-a26a-4154b60fee74",
"BillingId": 2,
"GlCode": "sample string 3",
"TotalAmount": 4.0
}
| Bundle(s) |
|---|
| BillingPayment |