EQUIPMENT

Creates a new equipment record.

POST/api/v2/external/equipment

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentialsAPI key

Request body

application/jsonrequired

The request containing equipment data to create.

externalIdstring
parentIdinteger · int32nullable
statusstringnullable
parentTypestringnullable
descriptionstringnullable
makestringnullable
modelstringnullable
serialNumberstringnullable
stockNumberstringnullable
equipmentNumberstringnullable
equipmentYearstringnullable
inventorybooleannullable
fleetstringnullable
fleetTypestringnullable
newUsedstringnullable
groupCodestringnullable
currentBranchIdinteger · int32nullable
currentBranchstringnullable
accountNumberstringnullable
parentNumberinteger · int32nullable
machinebooleannullable
availableForQuotebooleannullable
pmActivebooleannullable
classstringnullable
inOutstringnullable
categorystringnullable
acquisitionDatestring · date-timenullable
deletedbooleannullable
addRecordIfMatchNotFoundbooleannullable
externalProviderstringnullable
modifySourcestringnullable

Responses

Equipment created successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

equipmentIdinteger · int32
parentIdinteger · int32
parentTypestring
parentNamestring
companyIdinteger · int32
companyAccountNostring
companyNamestring
machinebooleannullable
categorystring
categoryIdinteger · int32nullable
makestringnullable
modelstringnullable
descriptionstringnullable
serialNostringnullable
stockNostringnullable
equipmentNostringnullable
equipYearstringnullable
startDatestring · datenullable
startHoursnumber · doublenullable
lastSmrdatestring · datenullable
lastSmrnumber · doublenullable
activebooleannullable
latitudenumber · doublenullable
longitudenumber · doublenullable
hoursPerDaynumber · doublenullable
hoursPerDayRangeinteger · int32nullable
ucwearProfileIdinteger · int32nullable
ucstartDatestring · datenullable
ucstartHoursnumber · doublenullable
pmprofileIdinteger · int32nullable
pmstartDatestring · datenullable
pmstartHoursnumber · doublenullable
pmactivebooleannullable
pmfluidSampleOnlybooleannullable
pminitialIntervalinteger · int32nullable
pmintervalStepinteger · int32nullable
pmroundIntervalbooleannullable
pmstartIntervalinteger · int32nullable
pmcalculateNextIntervalbooleannullable
pmmaxHoursinteger · int32nullable
pmcommentsstringnullable
componentProfileIdinteger · int32nullable
getprofileIdinteger · int32nullable
inventorybooleannullable
currentBranchIdinteger · int32nullable
fleetstringnullable
fleetTypestringnullable
statusstringnullable
newUsedstringnullable
groupCodestringnullable
acquisitionCostnumber · doublenullable
bookValuenumber · doublenullable
currentCostnumber · doublenullable
listPricenumber · doublenullable
sellPricenumber · doublenullable
acquisitionDatestring · datenullable
availableForQuotebooleannullable
inventoryNotesstringnullable
inventorySpecsstringnullable
deletedbooleannullable
classstringnullable
inOutstringnullable
lockSellPricebooleannullable
sellPriceUseMarkupbooleannullable
sellPriceMarkupnumber · doublenullable
sellPriceMarkupCostFieldstringnullable
baseNostringnullable
consignmentUnitbooleannullable
rentalDaysinteger · int32nullable
hoursPerDayOverridebooleannullable
uctargetWearPercentnumber · doublenullable
excludeUctrackingbooleannullable
completebooleannullable
satelliteIdentifierstringnullable
satelliteProviderstringnullable
enteredstring · date-timenullable
lastModifiedstring · date-timenullable
linkedbooleannullable
hasUcboolean
ucdatestring · datenullable
ucactionstringnullable
ucintervalinteger · int32nullable
ucintervalTypestringnullable
saleDatestring · datenullable
tierstringnullable
webListingbooleannullable
webListingDescriptionstringnullable

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/external/equipment' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": "string",
    "parentId": 1024,
    "status": "string",
    "parentType": "string",
    "description": "string",
    "make": "Caterpillar",
    "model": "320",
    "serialNumber": "CAT0320XABC12345",
    "stockNumber": "STK-1001",
    "equipmentNumber": "string",
    "equipmentYear": "string",
    "inventory": true,
    "fleet": "string",
    "fleetType": "string",
    "newUsed": "string",
    "groupCode": "string",
    "currentBranchId": 1024,
    "currentBranch": "string",
    "accountNumber": "string",
    "parentNumber": 1,
    "machine": true,
    "availableForQuote": true,
    "pmActive": true,
    "class": "string",
    "inOut": "string",
    "category": "string",
    "acquisitionDate": "2026-01-15T14:30:00Z",
    "machineSpecs": [
      {
        "description": "string",
        "salesCode": "string",
        "sequence": 1,
        "cost": 125000.5,
        "list": 1.5
      }
    ],
    "udfs": [
      {
        "fieldName": "string",
        "fieldValue": "string",
        "recordType": "string"
      }
    ],
    "warranties": [
      {
        "warrantyType": "string",
        "startDate": "2026-01-15T14:30:00Z",
        "endTime": "2026-01-15T14:30:00Z"
      }
    ],
    "replaceSmr": {
      "replaceSmr": 3250,
      "comments": "string"
    },
    "deleted": false,
    "addRecordIfMatchNotFound": true,
    "externalProvider": "string",
    "modifySource": "string"
  }'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "equipmentId": 1024,
    "parentId": 1024,
    "parentType": "string",
    "parentName": "string",
    "companyId": 1024,
    "companyAccountNo": "string",
    "companyName": "Acme Equipment Co.",
    "machine": true,
    "category": "string",
    "categoryId": 1024,
    "make": "Caterpillar",
    "model": "320",
    "description": "string",
    "serialNo": "CAT0320XABC12345",
    "stockNo": "STK-1001",
    "equipmentNo": "string",
    "equipYear": "string",
    "startDate": "2026-01-15",
    "startHours": 3250,
    "lastSmrdate": "2026-01-15",
    "lastSmr": 3250,
    "active": true,
    "latitude": 41.8781,
    "longitude": -87.6298,
    "hoursPerDay": 3250,
    "hoursPerDayRange": 3250,
    "ucwearProfileId": 1024,
    "ucstartDate": "2026-01-15",
    "ucstartHours": 3250,
    "pmprofileId": 1024,
    "pmstartDate": "2026-01-15",
    "pmstartHours": 3250,
    "pmactive": true,
    "pmfluidSampleOnly": true,
    "pminitialInterval": 1,
    "pmintervalStep": 1,
    "pmroundInterval": true,
    "pmstartInterval": 1,
    "pmcalculateNextInterval": true,
    "pmmaxHours": 3250,
    "pmcomments": "string",
    "componentProfileId": 1024,
    "getprofileId": 1024,
    "inventory": true,
    "currentBranchId": 1024,
    "fleet": "string",
    "fleetType": "string",
    "status": "string",
    "newUsed": "string",
    "groupCode": "string",
    "acquisitionCost": 125000.5,
    "bookValue": 125000.5,
    "currentCost": 125000.5,
    "listPrice": 125000.5,
    "sellPrice": 125000.5,
    "acquisitionDate": "2026-01-15",
    "availableForQuote": true,
    "inventoryNotes": "string",
    "inventorySpecs": "string",
    "deleted": false,
    "class": "string",
    "inOut": "string",
    "lockSellPrice": true,
    "sellPriceUseMarkup": true,
    "sellPriceMarkup": 125000.5,
    "sellPriceMarkupCostField": "string",
    "baseNo": "string",
    "consignmentUnit": true,
    "rentalDays": 1,
    "hoursPerDayOverride": true,
    "uctargetWearPercent": 1.5,
    "excludeUctracking": true,
    "complete": true,
    "satelliteIdentifier": "string",
    "satelliteProvider": "string",
    "entered": "2026-01-15T14:30:00Z",
    "lastModified": "2026-01-15T14:30:00Z",
    "linked": true,
    "hasUc": true,
    "ucdate": "2026-01-15",
    "ucaction": "string",
    "ucinterval": 1,
    "ucintervalType": "string",
    "saleDate": "2026-01-15",
    "tier": "string",
    "webListing": true,
    "webListingDescription": "string",
    "udfs": [
      {
        "udf": {
          "udfid": 1024,
          "recordType": "string",
          "categoryId": 1024,
          "subCategoryId": 1024,
          "category": "string",
          "categorySortOrder": 1,
          "subCategory": "string",
          "subCategorySortOrder": 1,
          "fieldName": "string",
          "displayText": "string",
          "dataType": "string",
          "editable": true,
          "visible": true,
          "required": true,
          "complete": true,
          "editCriteria": "string",
          "editRules": "string",
          "sortOrder": 1,
          "location": "string",
          "lastModified": "2026-01-15T14:30:00Z",
          "deleted": false
        },
        "lookups": [
          {
            "udflookupId": 1024,
            "udfid": 1024,
            "value": "string",
            "groupName": "string",
            "sortOrder": 1,
            "lastModified": "2026-01-15T14:30:00Z",
            "deleted": false
          }
        ],
        "assignedId": 1024,
        "udfid": 1024,
        "recordType": "string",
        "recordId": 1024,
        "lookupId": 1024,
        "stringValue": "string",
        "dateValue": "2026-01-15",
        "numericValue": 125000.5,
        "booleanValue": true,
        "entered": "2026-01-15T14:30:00Z",
        "lastModified": "2026-01-15T14:30:00Z"
      }
    ],
    "recordAccessRights": {
      "exists": true,
      "view": true,
      "edit": true,
      "delete": true,
      "addNote": true
    }
  },
  "errors": []
}