Customer Service Items
- DocumentAttachments can only be added using this API, they can't be retrieved or removed
- Fields are optional unless specified; optional field nodes can be omitted from the json.
WebMethod
- GJZJ9J – required
Option
- scan – error scan only
- update – add or update item(s)
- remove – delete item(s)
AppendComments
This parameter is only applicable to updating existing records
- true – only append text to existing comments
- false – default; replace any existing comments
CompanyCode
- required
ARSubledgerCode
- required
AR_CustomerServiceItems_tbl
| Field | Description |
|---|---|
CustomerCode | required |
LineNumberUnique | • must be valid for an existing item, not to be assigned by user • a new Service item is added if this field is omitted or has a value of NEXT#;an ID generated by the system will be returned in the result |
TagID | required for adding items |
TagDescription | compatible with Model template code for defaulting description, Manufacturer, ModelNumber, UnitType, CheckListCodes, and Warranty info |
Quantity | defaults to 1 if not specified when adding a new item |
Manufacturer | |
EquipmentModelNumber | |
SerialNumber | required for adding items |
UnitType | Service code |
InstallationDate | YYYY-MM-DD | N/A |
Installer | |
WarrantyPeriod1 | Months |
ExpiryDate1 | YYYY-MM-DD | N/A |
WarrantyPeriod2 | Months |
ExpiryDate2 | YYYY-MM-DD | N/A |
WarrantyPeriod3 | Months |
ExpiryDate3 | YYYY-MM-DD | N/A |
Location | |
Area | |
ChequeListCodes | |
LinkedToSerialNumber | |
Status | A – Active | I – Inactive | P – Poor | F – Fair | G – Good | E – Excellent | C – Condemned |
ServiceItemSpareField1 | |
ServiceItemSpareField2 | |
EquipmentNumber | |
DefaultTechnician | 1 | 2 | 3 | 4 | (default is blank) |
FlatRateTaskCode | |
Comments | This value will be appended to existing text if AppendComments is true (default is false) |
AR_ServiceItemsCustomInfo_tbl
| Field | Description |
|---|---|
FieldNumber | required; 1-99 |
Information |
DocumentAttachments
| Field | Description |
|---|---|
name | required; name of file attachment |
content | required; base64 encoded |
AR_BeltsandFilters_tbl
| Field | Description |
|---|---|
Package | required; must be valid for an existing item, or new item value assigned by user |
LineNumber | • must be valid for an existing item, not to be assigned by user • a new item is added if this field is omitted or has a value of NXT; an IDgenerated by the system will be returned in the result |
remove | • Delete this item • boolean; default=false |
TypeOfRecord | • I – Inventory (default)• M – Memo |
PartNumber | required where TypeOfRecord = I |
BeltsFiltersNotes | Notes for the belt/filter item (not defined in the source reference — confirm with development) |
Quantity | Quantity (not defined in the source reference — confirm with development) |
CheckListCodes | Check-list codes (not defined in the source reference — confirm with development) |
examples
template: { "WebMethod":"GJZJ9J", "Option":"template", "AppendComments":true, "CompanyCode":"", "ARSubledgerCode":"", "AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"",
"LineNumberUnique":"",
"TagID":"",
"TagDescription":"",
"Quantity":0,
"Manufacturer":"",
"EquipmentModelNumber":"",
"SerialNumber":"",
"UnitType":"",
"InstallationDate":"",
"Installer":"",
"WarrantyPeriod1":0,
"ExpiryDate1":"",
"WarrantyPeriod2":0,
"ExpiryDate2":"",
"WarrantyPeriod3":0,
"ExpiryDate3":"",
"Location":"",
"Area":"",
"ChequeListCodes":"",
"LinkedToSerialNumber":"",
"Status":"A",
"ServiceItemSpareField1":"",
"ServiceItemSpareField2":"",
"EquipmentNumber":"",
"DefaultTechnician":"1",
"FlatRateTaskCode":"",
"Comments":"",
"AR_BeltsandFilters_tbl":[
{
"Package":"",
"LineNumber":"",
"remove":false,
"TypeOfRecord":"I",
"PartNumber":"",
"BeltsFiltersNotes":"",
"Quantity":0,
"CheckListCodes":""
}
],
"AR_ServiceItemCustomInfo_tbl":[{"FieldNumber":"","Information":""}],
"DocumentAttachments":[{"name":"filename","content":""}]
}]
Create a Service Item
{
"WebMethod":"GJZJ9J",
"Option":"update",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"TagID":"0001",
"TagDescription":"0001",
"Quantity":4,
"SerialNumber":"B_SERIAL_2_A",
"InstallationDate":"2017-05-01T00:00:00Z",
"Installer":"john",
"Location":"loc1",
"Area":"area1",
"Status":"E",
"EquipmentNumber":"eqp123",
"Comments":"my comment",
"DocumentAttachments":[
{
"name":"doc.pdf",
"content":"JVBERi0x..."
}
],
"AR_BeltsandFilters_tbl":[
{
"Package":"A",
"LineNumber":"001",
"TypeOfRecord":"M",
"PartNumber":"Package",
"Quantity":1
}
],
"AR_ServiceItemCustomInfo_tbl":[
{
"FieldNumber":"01",
"Information":"TEST"
}
]
}
]
}Add more comments to a Service item
{
"WebMethod":"GJZJ9J",
"Option":"update",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AppendComments":true,
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00027",
"Comments":"Add comment to the bottom"
}
]
}Change comments of Service item(s)
{
"WebMethod":"GJZJ9J",
"Option":"update",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00027",
"Comments":"New comment"
},
{
"CustomerCode":"101-000",
"LineNumberUnique":"00028",
"Comments":"New comment"
}
]
}Delete Service item(s)
{
"WebMethod":"GJZJ9J",
"Option":"remove",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00027"
},
{
"CustomerCode":"101-000",
"LineNumberUnique":"00028"
}
]
}Delete Belts & Filters from Service item(s)
{
"WebMethod":"GJZJ9J",
"Option":"update",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00027",
"AR_BeltsandFilters_tbl":[
{
"Package":"A",
"LineNumber":"001",
"remove":true
}
]
}
]
}- Items cannot be deleted if they are tied to a W/O, or Service Contract.
Attach Document(s) to Service item(s)
{
"WebMethod":"GJZJ9J",
"Option":"update",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00026",
"DocumentAttachments":[
{
"name":"doc01.pdf",
"content":"JVBERi0xLjUN..."
},
{
"name":"doc02.pdf",
"content":"JVBERi0xLjUN..."
}
]
},
{
"CustomerCode":"101-000",
"LineNumberUnique":"00027",
"DocumentAttachments":[
{
"name":"doc03.pdf",
"content":"JVBERi0xLjUN..."
},
{
"name":"doc04.pdf",
"content":"JVBERi0xLjUN..."
}
]
}
]
}Read Service item(s)
- returns available fields (empty fields are omitted)
- does not retrieve attachments
{
"WebMethod":"GJZJ9J",
"Option":"download",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00027"
},
{
"CustomerCode":"202-000",
"LineNumberUnique":"00028"
}
]
}Error examples
{
"WebMethod":"GJZJ9J",
"Option":"update",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00026"
}
],
"errorsFound":1,
"errors":{
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"'101-000'",
"LineNumberUnique":"'00026'",
"DocumentAttachments":[
{
"name":"filename required"
}
]
}
]
}
}{
"WebMethod":"GJZJ9J",
"Option":"remove",
"CompanyCode":"JC",
"ARSubledgerCode":"AR",
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"00026"
}
],
"errorsFound":1,
"errors":[
{
"AR_CustomerServiceItems_tbl":[
{
"CustomerCode":"101-000",
"LineNumberUnique":"'00026' This Service Item is tied to W/O(s) SCANS1"
}
]
}
]
}