Skip to main content
POST
/
v1
/
billing-groups
Create a billing group
curl --request POST \
  --url https://api-eu.flexportal.io/v1/billing-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "customerId": "<string>",
  "groupName": "<string>",
  "billingDay": 14,
  "rentalIds": [
    "<string>"
  ],
  "notes": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "billingGroup": {
    "billingGroupId": "<string>",
    "tenantId": "<string>",
    "customerId": "<string>",
    "groupName": "<string>",
    "billingDay": 14,
    "totalMonthlyAmount": 1,
    "currency": "<string>",
    "status": "active",
    "createdBy": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "rentalIds": [],
    "activeRentalCount": 0,
    "notes": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Body

application/json
customerId
string
required
Minimum string length: 1
groupName
string
required
Minimum string length: 1
billingDay
integer
required
Required range: 1 <= x <= 28
rentalIds
string[]
required
Minimum array length: 1
notes
string

Response

Billing group created

success
enum<boolean>
required
Available options:
true,
false
message
string
required
billingGroup
object
required