POST api/v1/BillingEvents/{clientName}
Post a billing event
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientName |
Client Name |
string |
Required |
Body Parameters
Billing Event Object
InvoiceBillingEvent| Name | Description | Type | Additional information |
|---|---|---|---|
| BillingEventGuid |
Unique identifier for the billing event |
globally unique identifier | |
| MemberUniqueKey |
Unique identifier for the member. From the member object |
string | |
| EventDateTime |
Billing event date time |
date | |
| EventTypeId |
Billing event type |
TInvoiceBillingEventType | |
| InvoiceBillingEventStatusId |
Billing event status |
TInvoiceBillingEventStatus | |
| Quantity |
Item code |
decimal number | |
| Price |
Price of the billing event |
decimal number | |
| ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Request Formats
application/json, text/json
{
"billingEventGuid": "6d91f288-c380-4652-bd35-ce286ac4c806",
"memberUniqueKey": "sample string 4",
"eventDateTime": "2025-08-14T01:25:53.8669171+00:00",
"eventTypeId": "Unknown",
"invoiceBillingEventStatusId": "Unknown",
"quantity": 6.0,
"price": 7.0,
"modifiedDateTime": "2025-08-14T01:25:53.8669171+00:00",
"executionTime": 9,
"txID": "sample string 10"
}
application/x-www-form-urlencoded
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.
Response Information
Resource Description
InvoiceBillingEvent| Name | Description | Type | Additional information |
|---|---|---|---|
| BillingEventGuid |
Unique identifier for the billing event |
globally unique identifier | |
| MemberUniqueKey |
Unique identifier for the member. From the member object |
string | |
| EventDateTime |
Billing event date time |
date | |
| EventTypeId |
Billing event type |
TInvoiceBillingEventType | |
| InvoiceBillingEventStatusId |
Billing event status |
TInvoiceBillingEventStatus | |
| Quantity |
Item code |
decimal number | |
| Price |
Price of the billing event |
decimal number | |
| ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Response Formats
application/json, text/json
{
"billingEventGuid": "a6c67225-c705-41e0-94e7-40d242fd8f72",
"memberUniqueKey": "sample string 4",
"eventDateTime": "2025-08-14T01:25:53.9450202+00:00",
"eventTypeId": "Unknown",
"invoiceBillingEventStatusId": "Unknown",
"quantity": 6.0,
"price": 7.0,
"modifiedDateTime": "2025-08-14T01:25:53.9450202+00:00",
"executionTime": 9,
"txID": "sample string 10"
}
application/xml
Sample not available.
text/xml
Sample not available.