OpenAPI Specification
openapi: 3.1.0
info:
title: MVMNT Bill Payments Vendors API
version: 1.0.0
description: "The MVMNT API enables you to automate freight brokerage workflows by integrating\ndirectly with our Transportation Management System.\n\n## Authentication\n\nOAuth 2.0 client credentials flow. See [Authentication Guide](/getting-started/authentication)\nfor details.\n\n### Token Endpoint\n\n```\nPOST https://api.mvmnt.io/oauth2/token\n```\n\n#### Request\n\n**Headers:**\n```http\nContent-Type: application/x-www-form-urlencoded\n```\n\n**Body Parameters:**\n```\ngrant_type=client_credentials\nclient_id=YOUR_CLIENT_ID\nclient_secret=YOUR_CLIENT_SECRET\n```\n\n#### Example Request\n\n```bash\ncurl -X POST https://api.mvmnt.io/oauth2/token \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=client_credentials\" \\\n -d \"client_id=YOUR_CLIENT_ID\" \\\n -d \"client_secret=YOUR_CLIENT_SECRET\"\n```\n\n#### Success Response\n\n**Status:** `200 OK`\n\n```json\n{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}\n```\n\n**Response Fields:**\n- `access_token`: JWT Bearer token to use for API requests\n- `token_type`: Always `Bearer`\n- `expires_in`: Token lifetime in seconds (3600 = 1 hour)\n"
contact:
name: MVMNT Support
email: support@mvmnt.io
url: https://docs.mvmnt.io
license:
name: Proprietary
url: https://mvmnt.io/legal/terms
x-parsed-md-description:
result:
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: true
attributes:
content: The MVMNT API enables you to automate freight brokerage workflows by integrating
children: []
type: text
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: true
attributes: {}
children: []
type: softbreak
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: true
attributes:
content: directly with our Transportation Management System.
children: []
type: text
annotations: []
slots: {}
type: inline
annotations: []
slots: {}
type: paragraph
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 3
- 4
inline: false
attributes:
level: 2
children:
- $$mdtype: Node
errors: []
lines:
- 3
- 4
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 3
- 4
inline: true
attributes:
content: Authentication
children: []
type: text
annotations: []
slots: {}
type: inline
annotations: []
slots: {}
type: heading
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
content: 'OAuth 2.0 client credentials flow. See '
children: []
type: text
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
href: /getting-started/authentication
children:
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
content: Authentication Guide
children: []
type: text
annotations: []
slots: {}
type: link
annotations: []
slots: {}
redocly:::linkOriginal:href: /getting-started/authentication
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
content: ' for details.'
children: []
type: text
annotations: []
slots: {}
type: inline
annotations: []
slots: {}
type: paragraph
annotations: []
slots: {}
servers:
- url: https://api.mvmnt.io/v1
description: Production
security:
- BearerAuth: []
tags:
- name: Vendors
description: Vendor management operations
paths:
/vendors/filter:
post:
tags:
- Vendors
summary: Filter vendors
description: 'Query vendors using flexible filter criteria with AND/OR logic.
By default, only non-deleted vendors are returned (deletedAt: { isNull: true }).
Override this by explicitly setting deletedAt filter criteria.
'
operationId: filterVendors
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VendorFilterRequest'
responses:
'200':
description: Filtered vendors with pagination
content:
application/json:
schema:
type: object
required:
- data
- pageInfo
properties:
data:
type: array
items:
$ref: '#/components/schemas/Vendor'
pageInfo:
$ref: '#/components/schemas/PaginationInfo'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'500':
$ref: '#/components/responses/InternalServerError'
/vendors:
post:
tags:
- Vendors
summary: Create a new vendor
description: 'Create a new vendor within an organization.
Vendors represent service providers (warehousing, storage, etc.) that are not carriers.
'
operationId: createVendor
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VendorInput'
examples:
warehouse:
summary: Warehouse vendor
value:
name: ABC Warehouse Services
email: billing@abcwarehouse.com
phone: +1-555-123-4567
status: ACTIVE
currency: USD
taxId: 12-3456789
storage:
summary: Storage facility
value:
name: SecureStore Facilities
email: accounts@securestore.com
phone: +1-555-987-6543
status: ACTIVE
currency: USD
responses:
'201':
description: Vendor created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Vendor'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'409':
$ref: '#/components/responses/ConflictError'
'500':
$ref: '#/components/responses/InternalServerError'
/vendors/{id}:
get:
tags:
- Vendors
summary: Get a vendor by ID
description: 'Retrieve a single vendor by its unique identifier.
'
operationId: getVendorById
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
responses:
'200':
description: Vendor found
content:
application/json:
schema:
$ref: '#/components/schemas/Vendor'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'500':
$ref: '#/components/responses/InternalServerError'
patch:
tags:
- Vendors
summary: Update a vendor
description: 'Partially update a vendor. Only provided fields will be updated.
- **Omitted fields**: Not modified (current value preserved)
- **Provided fields**: Updated to the new value
- **Null values**: Clear the field (set to null) where applicable
'
operationId: updateVendor
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VendorPatch'
examples:
updateContact:
summary: Update contact information
value:
email: newemail@abcwarehouse.com
phone: +1-555-999-8888
updateStatus:
summary: Update vendor status
value:
status: INACTIVE
notes: Contract ended
responses:
'200':
description: Vendor updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Vendor'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'409':
$ref: '#/components/responses/ConflictError'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
tags:
- Vendors
summary: Delete a vendor
description: 'Soft delete a vendor (sets deletedAt timestamp).
The vendor will no longer appear in default queries but can be retrieved
by explicitly filtering for deleted records.
'
operationId: deleteVendor
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
responses:
'204':
description: Vendor deleted successfully
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'500':
$ref: '#/components/responses/InternalServerError'
/vendors/search:
post:
summary: Search vendors
description: 'Search vendors using OpenSearch-powered full-text and field-specific search.
This endpoint provides fast, indexed search across vendor data with support for:
- Full-text search across multiple fields
- Field-specific filtering with various operators
- Sorting and pagination
- Saved search preferences
**Note:** Only active (non-deleted) vendors are searchable. Soft-deleted records are automatically excluded from all search results.
**Response Formats:**
- `flat` (default): Returns indexed fields only for faster performance
- `full`: Returns complete vendor objects with all relationships
'
operationId: searchVendors
tags:
- Vendors
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VendorSearchRequest'
responses:
'200':
description: Successful search results
content:
application/json:
schema:
$ref: '#/components/schemas/VendorSearchResponse'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'422':
$ref: '#/components/responses/ValidationError'
'429':
$ref: '#/components/responses/RateLimitExceeded'
/vendors/{id}/outstanding-bills:
get:
summary: Get vendor outstanding bills
description: 'List outstanding (unpaid) bills for a vendor.
Returns bills with status `APPROVED_TO_PAY`.
'
operationId: getVendorOutstandingBills
tags:
- Vendors
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
- $ref: '#/components/parameters/LookupBy'
responses:
'200':
description: Outstanding bills retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/OutstandingBillsResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
/vendors/{id}/bills-for-payment:
get:
summary: Get vendor bills available for payment
description: 'List bills available for payment from a vendor.
Returns bills with status `APPROVED_TO_PAY` and open balance.
'
operationId: getVendorBillsForPayment
tags:
- Vendors
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
- $ref: '#/components/parameters/LookupBy'
responses:
'200':
description: Bills for payment retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/OutstandingBillsForPaymentResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
components:
schemas:
VendorSearchResponse:
type: object
description: 'Response for vendor search requests.
Note: Only active (non-deleted) vendors are included in results.
'
required:
- data
- pagination
- totalResults
properties:
data:
type: array
description: Search results - either flat rows or full vendor objects based on format parameter
items:
oneOf:
- $ref: '#/components/schemas/VendorSearchRow'
- $ref: '#/components/schemas/Vendor'
discriminator:
propertyName: object
mapping:
VENDOR_SEARCH_ROW: '#/components/schemas/VendorSearchRow'
VENDOR: '#/components/schemas/Vendor'
pagination:
$ref: '#/components/schemas/SearchPaginationInfo'
totalResults:
type: integer
description: Total number of matching results (excluding soft-deleted records)
minimum: 0
OutstandingBillsForPaymentResponse:
type: object
required:
- bills
- totalOutstanding
properties:
bills:
type: array
items:
$ref: '#/components/schemas/OutstandingBill'
totalOutstanding:
type: number
description: Total outstanding balance
carrier:
$ref: '#/components/schemas/CarrierReference'
vendor:
$ref: '#/components/schemas/VendorReference'
carrierFactor:
$ref: '#/components/schemas/bill-payments_CarrierFactorReference'
VendorStatus:
type: string
description: Vendor status
enum:
- ACTIVE
- INACTIVE
ValidationError:
type: object
required:
- error
- message
- details
properties:
error:
type: string
description: Error code
example: validation_error
message:
type: string
description: Human-readable error message
details:
type: array
description: Validation error details
items:
type: object
required:
- field
- message
properties:
field:
type: string
description: Field name that failed validation
message:
type: string
description: Validation error message
DatetimeSearchCriteria:
type: object
required:
- operator
description: 'Search criteria for datetime fields.
Supports both absolute datetime values and relative time expressions.
'
properties:
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- BEFORE
- AFTER
- BETWEEN
- NOT_BETWEEN
- EXISTS
- DOES_NOT_EXIST
description: 'Search operator:
- `EQUALS`: Exact match
- `NOT_EQUALS`: Not equal to
- `BEFORE`: Before datetime
- `AFTER`: After datetime
- `BETWEEN`: Between min and max (inclusive)
- `NOT_BETWEEN`: Not between min and max
- `EXISTS`: Field has a value (not null)
- `DOES_NOT_EXIST`: Field is null
'
value:
type: string
format: date-time
description: Absolute datetime for EQUALS, NOT_EQUALS
example: '2025-01-15T10:00:00Z'
min:
type: string
format: date-time
description: Minimum datetime for BETWEEN or NOT_BETWEEN
example: '2025-01-01T00:00:00Z'
max:
type: string
format: date-time
description: Maximum datetime for BETWEEN or NOT_BETWEEN
example: '2025-12-31T23:59:59Z'
valueRelative:
type: integer
description: 'Relative time from now (negative for past, positive for future).
Example: -7 with WEEK unit means 7 weeks ago.
'
valueRelativeUnit:
$ref: '#/components/schemas/RelativeTimeUnit'
minRelative:
type: integer
description: Relative time for min boundary
minRelativeUnit:
$ref: '#/components/schemas/RelativeTimeUnit'
maxRelative:
type: integer
description: Relative time for max boundary
maxRelativeUnit:
$ref: '#/components/schemas/RelativeTimeUnit'
example:
operator: AFTER
value: '2025-01-01T00:00:00Z'
TextSearchCriteria:
type: object
required:
- operator
description: Search criteria for text fields (supports wildcards and partial matching)
properties:
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- STARTS_WITH
- ENDS_WITH
- INCLUDES
- ONE_OF
- NOT_ONE_OF
- EXISTS
- DOES_NOT_EXIST
description: 'Search operator:
- `EQUALS`: Exact match
- `NOT_EQUALS`: Not equal to
- `STARTS_WITH`: Begins with prefix
- `ENDS_WITH`: Ends with suffix
- `INCLUDES`: Contains substring
- `ONE_OF`: Matches any value in array
- `NOT_ONE_OF`: Does not match any value in array
- `EXISTS`: Field has a value (not null)
- `DOES_NOT_EXIST`: Field is null
'
values:
type: array
items:
type: string
description: Array of values for ONE_OF or NOT_ONE_OF operators
example:
- value1
- value2
example:
operator: INCLUDES
values:
- search term
Address:
type: object
description: 'Physical address/location details (nested, without id).
This is an embedded object representing a Location record. The id is managed
internally and not exposed in the API.
'
required:
- line1
- city
- country
- market
- isAirportOrAirbase
- isConstructionOrUtilitySite
- isSmartyValidated
- obeysDst
properties:
line1:
type: string
description: Primary street address line
example: 123 Main St
line2:
type:
- string
- 'null'
description: Secondary address line (suite, floor, etc.)
example: Suite 400
city:
type: string
description: City name
example: Chicago
country:
type: string
description: Country name or code
example: USA
market:
type: string
description: Market or region identifier
example: CHI
latitude:
type:
- string
- 'null'
description: Latitude coordinate
example: '41.8781'
longitude:
type:
- string
- 'null'
description: Longitude coordinate
example: '-87.6298'
isAirportOrAirbase:
type: boolean
description: Whether this location is an airport or airbase
example: false
isConstructionOrUtilitySite:
type: boolean
description: Whether this location is a construction or utility site
example: false
isSmartyValidated:
type: boolean
description: Whether address has been validated by SmartyStreets
example: true
obeysDst:
type: boolean
description: Whether this location observes daylight saving time
example: true
cityId:
type:
- string
- 'null'
format: uuid
description: Reference to standardized city record (internal use)
example: null
Error:
type: object
required:
- error
- message
properties:
error:
type: string
description: Error code
message:
type: string
description: Human-readable error message
ClientKeyFilter:
type: object
description: Filter options for client key fields (limited operations - exact match only)
properties:
equalTo:
type: string
description: Exact match
in:
type: array
description: Matches any value in the array
items:
type: string
isNull:
type: boolean
description: Field is null (true) or not null (false)
KeywordSearchCriteria:
type: object
required:
- operator
description: Search criteria for keyword fields (exact match, no partial matching)
properties:
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- ONE_OF
- NOT_ONE_OF
- EXISTS
- DOES_NOT_EXIST
description: 'Search operator:
- `EQUALS`: Exact match
- `NOT_EQUALS`: Not equal to
- `ONE_OF`: Matches any value in array
- `NOT_ONE_OF`: Does not match any value in array
- `EXISTS`: Field has a value (not null)
- `DOES_NOT_EXIST`: Field is null
'
values:
type: array
items:
type: string
description: Array of values for ONE_OF or NOT_ONE_OF operators
example:
- ACTIVE
- PENDING
example:
operator: ONE_OF
values:
- ACTIVE
- PENDING
BooleanFilter:
type: object
description: Filter options for boolean fields
properties:
equalTo:
type: boolean
description: Exact match
notEqualTo:
type: boolean
description: Not equal to
isNull:
type: boolean
description: Field is null (true) or not null (false)
SearchPaginationInput:
type: object
description: Pagination options for search requests
properties:
pageNumber:
type: integer
minimum: 1
default: 1
description: Page number (1-based)
example: 1
pageSize:
type: integer
minimum: 1
maximum: 250
default: 50
description: Number of results per page (max 250)
example: 50
example:
pageNumber: 1
pageSize: 50
VendorPatch:
type: object
description: 'Partial vendor update. All fields are optional.
- **Omitted fields**: Not modified (current value preserved)
- **Provided fields**: Updated to the new value
- **Null values**: Clear the field (set to null) where applicable
'
properties:
name:
type: string
description: Vendor legal name
example: ABC Warehouse Services
key:
type:
- string
- 'null'
maxLength: 512
description: Client-defined reference identifier
example: ERP-VENDOR-ABC-001
email:
type:
- string
- 'null'
format: email
description: Primary email address
example: billing@abcwarehouse.com
phone:
type:
- string
- 'null'
description: Primary phone number
example: +1-555-123-4567
status:
type:
- string
- 'null'
description: Vendor status
example: ACTIVE
notes:
type:
- string
- 'null'
description: Internal notes about the vendor
example: Preferred vendor for warehouse services
taxId:
type:
- string
- 'null'
description: Tax identification number
example: 12-3456789
currency:
anyOf:
- $ref: '#/components/schemas/vendors_Currency'
- type: 'null'
description: Preferred currency for transactions
corporateAddress:
anyOf:
- $ref: '#/components/schemas/AddressInput'
- type: 'null'
description: Corporate headquarters address
billingAddress:
anyOf:
- $ref: '#/components/schemas/AddressInput'
- type: 'null'
description: Billing address for invoices
paymentTermId:
type:
- string
- 'null'
format: uuid
description: Payment term ID
example: 550e8400-e29b-41d4-a716-446655440001
isMvmnt:
type:
- boolean
- 'null'
description: Whether this vendor is MVMNT itself
example: false
requiredDocuments:
type:
- array
- 'null'
items:
type: string
description: List of required document types
example:
- W9
- INSURANCE_CERTIFICATE
CarrierReference:
type: object
description: 'Enhanced reference to a carrier resource (returned in responses).
Includes full carrier details in addition to id/key.
Note: Does NOT include nested references (contacts, etc.) to prevent recursion.
Maximum nesting depth: 1 level.
'
required:
- id
- name
- createdAt
- updatedAt
properties:
id:
type: string
format: uuid
description: Carrier UUID
example: 550e8400-e29b-41d4-a716-446655440000
key:
type:
- string
- 'null'
maxLength: 512
description: Client-defined reference ID if set
example: ERP-CARRIER-SWIFT
name:
type: string
description: Carrier company name
example: Swift Transportation
phoneNumber:
type:
- string
- 'null'
description: Primary phone number
example: +1-555-987-6543
email:
type:
- string
- 'null'
format: email
description: Primary email address
example: dispatch@swifttrans.com
createdAt:
type: string
format: date-time
description: When the carrier was created
example: '2025-01-15T10:00:00Z'
updatedAt:
type: string
format: date-time
description: When the carrier was last updated
example: '2025-01-15T14:30:00Z'
deletedAt:
type:
- string
- 'null'
format: date-time
description: When the carrier was soft deleted (null if active)
example: null
IntSearchCriteria:
type: object
required:
- operator
description: Search criteria for integer fields
properties:
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- GREATER_THAN
- LESS_THAN
- BETWEEN
- NOT_BETWEEN
- EXISTS
- DOES_NOT_EXIST
description: 'Search operator:
- `EQUALS`: Exact match
- `NOT_EQUALS`: Not equal to
- `GREATER_THAN`: Greater than value
- `LESS_THAN`: Less than value
- `BETWEEN`: Between min and max (inclusive)
- `NOT_BETWEEN`: Not between min and max
- `EXISTS`: Field has a value (not null)
- `DOES_NOT_EXIST`: Field is null
'
value:
type: integer
description: Single value for EQUALS, NOT_EQUALS, GREATER_THAN, LESS_THAN
min:
type: integer
description: Minimum value for BETWEEN or NOT_BETWEEN
max:
type: integer
description: Maximum value for BETWEEN or NOT_BETWEEN
example:
operator: BETWEEN
min: 10
max: 100
VendorSearchRow:
type: object
description: 'Flattened vendor data from search index.
Note: This represents only active vendors. Soft-deleted records are never returned.
'
properties:
object:
type: string
enum:
- VENDOR_SEARCH_ROW
description: Object type identifier for discriminating between flat and full response formats
id:
type: string
format: uuid
friendlyId:
type: string
description: Vendor ID
name:
type: string
status:
type:
- string
- 'null'
enum:
- active
- inactive
- do_not_use
taxId:
type:
- string
- 'null'
description: EIN or other tax ID
service:
type: array
items:
type: string
description: Services provided
location:
type:
- string
- 'null'
description: Computed as "city, state"
city:
type:
- string
- 'null'
state:
type:
- string
- 'null'
zip:
type:
- string
- 'null'
description: Postal code
country:
type:
- string
- 'null'
primaryContactName:
type:
- string
- 'null'
primaryContactEmail:
type:
- string
- 'null'
format: email
primaryContactPhone:
type:
- string
- 'null'
paymentTermName:
type:
- string
- 'null'
quickbooksVendorId:
type:
- string
- 'null'
description: QuickBooks Online vendor ID
numberOfTimesUsed:
type: integer
description: Number of times used
lastUsed:
type:
- string
- 'null'
format: date
description: Last date used
createdAt:
type: string
format: date-time
required:
- object
- id
- friendlyId
- name
- numberOfTimesUsed
- createdAt
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mvmnt/refs/heads/main/openapi/mvmnt-vendors-api-openapi.yml