Service Type API

Create service type

Create a service type, for example to mirror a new NetSuite or QuickBooks item. Prices are not part of a service type; they live in rate tables, which this API does not change.

Usage notes:

serviceTypeName must be unique for the carrier and contextType. New carriers start with a set of default service types (for example Demurrage and Storage), so list first: a duplicate returns 400.
A service type deleted in ARMS still holds its name and can’t be restored through the API. List with getDeleted: true to find it, and restore it in the ARMS service type settings.
A serviceTypeGroupId that does not exist returns 400.
A missing permission returns 401.

POST

rms

service_types

create

curl --request POST \
  --url https://api-lg.arms.cedarai.com/rms/service_types/create \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "item": {
    "serviceTypeName": "Track Lease",
    "serviceTypeCode": "LEASE",
    "contextType": "CYCLE"
  }
}
'

{
  "item": {
    "serviceTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carrierId": 123,
    "serviceTypeName": "<string>",
    "serviceTypeCode": "<string>",
    "contextType": "INCIDENTAL",
    "serviceTypeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceTypeGroupName": "<string>",
    "defaultTaxIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "contract": {
    "effect": "append",
    "resourceType": "ServiceType"
  }
}

{
  "message": "<string>"
}

Authorizations

x-arms-api-key

string

header

required

Your ARMS API key

x-arms-assume-user

string

header

required

Email of a user assigned to the appropriate user group

Query Parameters

carrierId

integer

required

Carrier identifier; required for all endpoints

Body

application/json

item

object

required

Show child attributes

carrierId

integer

Carrier identifier. Defaults to the carrierId query parameter; if you send it, use the same value.

Response

item

object

A service type: what a charge is for. Fields without a value are left out.

Show child attributes

contract

object

Show child attributes

⌘I

curl --request POST \
  --url https://api-lg.arms.cedarai.com/rms/service_types/create \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "item": {
    "serviceTypeName": "Track Lease",
    "serviceTypeCode": "LEASE",
    "contextType": "CYCLE"
  }
}
'

{
  "item": {
    "serviceTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carrierId": 123,
    "serviceTypeName": "<string>",
    "serviceTypeCode": "<string>",
    "contextType": "INCIDENTAL",
    "serviceTypeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceTypeGroupName": "<string>",
    "defaultTaxIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "contract": {
    "effect": "append",
    "resourceType": "ServiceType"
  }
}

{
  "message": "<string>"
}