API Reference
SupportAPI Feedback

Create a new Service Entry

post
https://{environment}/api/v4/maintenance/service-entries

Create a new maintenance service entry in the system by providing the required service details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body to create a new service entry in the system.

uuid

Unique Azuga ID of the service entry.

uuid
required

The unique Azuga ID of the entity(vehicle/asset) to be associated with service entry

string

Name of the entity(vehicle/asset) to be associated with the service entry

string

The Vehicle Identification Number (VIN) to link the vehicle to this service entry. This VIN is a unique identifier for the vehicle.

string

Indicates the manufacturer of the entity(vehicle/asset)

string

Indicates the particular model of the entity(vehicle/asset)

integer

Indicates the year the entity(vehicle/asset) was manufactured

string

License number of the entity(vehicle/asset), maximum length should be 30

integer
enum
required

Type Id of the entity(vehicle/asset):

1: Vehicle
2: Asset

Allowed:
string
enum

Type of the entity(vehicle/asset)

Allowed:
integer
enum
required

Indicates category of this service entry using the provided ID codes:

0: Scheduled Maintenance
1: Unscheduled Maintenance
2: Roadside Repair

Allowed:
uuid
required

The unique Azuga ID of the Group.This is automatically generated when the Group object is created and cannot be altered

string
enum
required

Associated Category name.

Allowed:
string

Group name associated with the service entry.

integer

The unique Azuga ID of the customer

date-time
required

Date and time the service was performed. Use YYYY-MM-DD HH:mm:ss format.

integer
required

Duration of the service entry, specified in minutes.

serviceTypeDetails
array of objects
required
length ≥ 1

Service type cost details. Must contain at least one item. Each serviceTypeId must be unique.

serviceTypeDetails*
uuid
required

The unique Azuga ID of the Service Type. This is automatically generated when the Service Type object is created and cannot be altered.

string
required

Name of the Service

number
required

Cost of this specific service. Must be a non-negative float value.

serviceTypeBreakdownDetails
object
required

Per-service-type cost breakdown. Required on create and full update (PUT). Optional on patch, but must be sent together with serviceTypeDetails when updating cost details. Legacy GET responses without breakdown data return an empty object ({}).

boolean
required

Specify,
true: Indicates summarized total cost. Per-service-type serviceCost and breakdown component costs may be 0; totalServiceCost must be a non-negative float value.
false: Indicates itemized costs. Each serviceCost and breakdown totalCost must be a non-negative float value; partsCost, laborCost, and taxAmount may be 0.

number
required

Total service cost. Must be a non-negative float value. When isSummarizedCost is false, must equal the sum of all serviceTypeBreakdownDetails totalCost values.

number

Specify the entity(vehicle/asset)'s current odometer value. This should reflect the most recent distance reading, expressed in KM

integer

The total number of hours the engine has been in operation.

string

provide the Name of the service center.

serviceDocuments
array of objects

Service documents.

serviceDocuments
string

Specify the invoice number associated with this service entry.

string

Specify the initial request or reason for the entity(vehicle/asset) service

string

Use this field to add any general comments or notes related to the service entry.

boolean
required

Flag to reset the service alert timer.

Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

Did this page help you?