Service Record Full (Get)

Read a service record together with its charges in a single call, create new service records, and push changes to existing ones. These three endpoints extend the read-only Service-Records and Service-Record Expenses articles.

Authentication

All three endpoints authenticate the same way as the rest of the cieTrade.net API. Every request needs both of the following:

  • An authorized UserID, passed as a query string parameter on the request URL — this is the user's cieTrade.net login email.
  • A Bearer Token in the Authorization header of your tool or code call. The token is found under Settings → Integration → Api Token.

The user must have Can Access cieTrade API checked under Settings → Users & Roles, and must have an email address on their user record — the create and update endpoints record that user against every change they make.

Note On the two write endpoints, UserID stays on the query string. Everything else is sent in the JSON request body.

Service Records (Full)

Returns service records with their charges and expenses nested underneath, so a record and its lines can be retrieved in one call rather than matching up the results of Service-Records and Service-Record Expenses yourself.

Request Example

GET
https://api.cietrade.net/GetServiceRecordFull?UserID=Example@gmail.com&ServiceID=813

Query Parameters (Filters)

Parameter Description Required
UserID cieTrade.net User Name. REQUIRED
ServiceID Specific Service ID to request. Blank value defaults to ALL. OPTIONAL
CustomerNm Customer Name or counterparty ID to request service records for. Blank value defaults to ALL. OPTIONAL
LocationNm Service location to request service records for. Blank value defaults to ALL. OPTIONAL
VendorNm Hauler/Service Provider Name or counterparty ID. Blank value defaults to ALL. OPTIONAL
Status Accepts Active or Inactive. Blank value defaults to ALL. OPTIONAL
AsOf Returns all records that were last updated on and after this date. If other filter options are provided, they will be ignored if an AsOf date is provided. OPTIONAL

Response Example

[
  {
    "serviceNo": 813,
    "customer": "DAKTEST234",
    "location": "Main Plant",
    "department": "Corporate",
    "equipment_type": "30 Yard Open Top",
    "equipment_no": "OT-4417",
    "equipment_count": 1,
    "site_reference": "30yd OT MSW",
    "commodity_name": "#1 PREPARED (P)",
    "vendor": "BEST BUY",
    "schedule": "Weekly",
    "weekly_interval": "1",
    "days": "M,R",
    "daily_interval": "",
    "times_per_day": "",
    "monthly_interval": 1,
    "job_type": "Empty & Return",
    "start_date": "07-01-25",
    "expiration_date": "07-31-26",
    "pickups_per_month": 8,
    "weight_per_yard": 0.00,
    "target_weight": 0.00,
    "target_weight_uom": "ST",
    "create_service_jobs": true,
    "receiver": "",
    "receiver_location": "",
    "default_request_party": "Open Market",
    "request_sent_to": "dispatch@bestbuy.com",
    "instructions": "Gate code 4417",
    "questions_to_ask": "",
    "billingsheet_notes": "",
    "description": "Occurs every week Monday, Thursday.",
    "UDF_1": "Permanent",
    "UDF_2": "Vendor",
    "UDF_3": "",
    "UDF_4": "",
    "UDF_5": "",
    "reason_code": "NEWP",
    "reason_description": "New placement",
    "Status": "Active",
    "Bin_SensorID": "",
    "Bin_ID": "",
    "LastUpdated": "Oct 16 2025 12:51PM",
    "expenses": [
      {
        "expense_id": 502,
        "charge_description": "Recycling Rebate",
        "vendor": "BEST BUY",
        "expense_account": "TESTACC123",
        "expense_price": "123.00",
        "expense_uom": "LBS",
        "chargeback_account": "Recycling Rebate",
        "chargeback_price": "32.00",
        "chargeback_uom": "LBS",
        "apply_to_service": "(ANY)",
        "material": "#1 PREPARED (P)",
        "taxable": false,
        "recurring": true,
        "advance_bill": false,
        "apply_fuel_surcharge": false,
        "is_target_overweight_charge": false,
        "benchmark_weight": 0.00,
        "benchmark_uom": "FLAT",
        "LastUpdated": "Oct 16 2025 12:51PM"
      }
    ]
  }
]
Note expense_id is the identifier of an individual charge line. It is required by Service Record (Update) to change or remove a specific charge, and is not returned by Service-Record Expenses.

Results are limited to the first 75,000 rows and are returned in the order they were last updated, with the most recently updated items at the top.

AsOf matches a record when either the service record itself or any of its charge lines changed on or after that date, so a change to a price alone is not missed.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.