Bill Payments8

Bills11

Carrier Contacts5

Carrier Factors6

Carrier Payment Methods5

Carriers8

Companies5

Credit Memos8

Customer Contacts5

Customers8

Documents20

Invoices11

Loads13

Location Contacts5

Locations6

Payment Terms5

Payments6

Quotes6

Reference Data3

Saved Searches5

Search1

Services5

Shipments16

Stops5

Teams5

Users6

Vendor Contacts5

Vendor Payment Methods5

Vendors8

Webhooks

Event Notifications1

Services

Update a service

Changed on Oct 16, 2026

Update service fields.

Note: Status changes happen automatically based on billing workflow.

patch/services/{id}

Request

Base URL: https://api.mvmnt.io/v1
URL: https://api.mvmnt.io/v1/services/{id}
Auth: HTTP bearer

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

descriptionstring nullable

scheduledDatestring date nullable

completedDatestring date nullable

referenceNumberstring nullable

Response

Service updated successfully

idstring uuid required

keystring nullable

Human-readable service ID

shipmentIdstring uuid

Parent shipment

shipmentKeystring nullable

Parent shipment friendly ID

Current status of the service.

Active states:

ACTIVE: Service is active/in progress

Billing states (AP):

AWAITING_INVOICE: Waiting for vendor invoice
INVOICE_IN_REVIEW: Invoice received, under review
APPROVED_TO_PAY: Approved for payment
PAID: Paid to vendor

Final states:

CANCELED: Service canceled

descriptionstring nullable

Service description

totalCostnumber nullable

Sum of all charges

scheduledDatestring date nullable

completedDatestring date nullable

referenceNumberstring nullable

Vendor reference number

createdAtstring date-time required

updatedAtstring date-time nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "SVC-12345",
  "vendor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-VENDOR-ABC-001",
    "friendlyId": "V123456",
    "name": "ABC Warehouse Services",
    "email": "billing@abcwarehouse.com",
    "phone": "+1-555-123-4567",
    "status": "ACTIVE",
    "currency": "USD",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "charges": [
    {
      "chargeCode": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345"
      }
    }
  ]
}

Changes

Oct 16, 2026a67a66657930 Revision changes
- info
  added the optional property // to the response with the status
Oct 7, 20262cd6ecfbeb82 Revision changes
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- info
  added subschema #2 to the response body allOf list for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (3 revisions)