api/fleet - register¶

The register endpoint creates a CRM contact, portal user, and card. The endpoint accepts the following parameters

Request Parameters¶
Parameter	Required	Description
company_id	yes	Unique company ID
contact	yes	contact object containing all required and optional fields
user	yes	user object containing all required and optional fields
card	yes	card object containing all required and optional fields

Contact Object Parameters¶
Parameter	Required	Description
name	yes	Full name of contact
first_name	no	First name of contact
gender	no	Gender of the contact, 0 = company, 1 = male, 2 = female
street	no	Street of contact
zip	no	Post code of contact
city	no	City of contact
country	no	Two-character country code of contact
email	no	Email of contact
phone	no	Phone number of contact
customer_number	no	Customer number of contact
comment	no	Comment of contact

User Object Parameters¶
Parameter	Required	Description
email	yes	Email of the account
password	yes	Password of the account
account_locale	no	Account locale, e.g. de_DE

Card Object Parameters¶
Parameter	Required	Description
card_no	yes	Card number
rate_id	yes	UUID for the rate displayed in be.ENERGISED Rate management
billing_contact_id	yes	Unique billing contact identifier
label	no	Card label
customer_reference	no	Customer reference
comment	no	Comment of card
emp	no	EMP (e.g. AT-HTB) that will be assigned to the card, if set EMA-ID will be generated

Sample Request¶

curl --location --request POST 'https://yourinstancename.beenergised.cloud/api/fleet/v1/register' \
    --header 'x-api-token: your_token' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "company_id": "Company UUID",
        "contact": {
            "name": "Name",
            "gender": "Gemder",
            "city": "City",
            "customer_number": "Customer Number",
            "comment": "Comment"
        },
        "user": {
            "email": "Email",
            "password": "Password",
            "locale": "Locale"
        },
        "card": {
            "card_no": "Card Number",
            "rate_id": "Rate UUID",
            "billing_contact_id": "Billing Contact UUID"
        }
    }'

Sample Response¶

{
    "status": "success",
    "data": {
        "contact_id": "created_contact_id",
        "user_id": "created_user_id",
        "card_id": "created_card_id"
    }
}