Skip to content
/Carrier Factors

MVMNT API (1.0.0)

The MVMNT API enables you to automate freight brokerage workflows by integrating directly with our Transportation Management System.

Authentication

OAuth 2.0 client credentials flow. See Authentication Guide for details.

Token Endpoint

POST https://api.mvmnt.io/oauth2/token

Request

Headers:

Content-Type: application/x-www-form-urlencoded

Body Parameters:

grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET

Example Request

curl -X POST https://api.mvmnt.io/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Success Response

Status: 200 OK

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Response Fields:

  • access_token: JWT Bearer token to use for API requests
  • token_type: Always Bearer
  • expires_in: Token lifetime in seconds (3600 = 1 hour)
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://docs.mvmnt.io
MVMNT Support
support@mvmnt.io
License
Proprietary
Languages
Servers
Mock server
https://docs.mvmnt.io/_mock/apis/openapi/
Production
https://api.mvmnt.io/v1/

Companies

Operations

Carrier Contacts

Operations

Carriers

Operations

Carrier Factors

Operations

Filter carrier factors

Request

Query carrier factors (factoring companies) using flexible filter criteria with AND/OR logic.

By default, only non-deleted carrier factors are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.

Carrier factors represent factoring companies that provide payment services for carriers.

Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(CarrierFactorFilter)
Example: {"and":[{"companyName":{"includes":"Capital"}},{"currency":{"equalTo":"USD"}}]}
pageSizeinteger[ 1 .. 250 ]

Number of results per page

Default 50
Example: 50
cursorstring

Pagination cursor for next page

curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-factors/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "and": [
        {
          "companyName": {
            "includes": "Capital"
          }
        },
        {
          "currency": {
            "equalTo": "USD"
          }
        }
      ]
    },
    "pageSize": 50
  }'

Responses

Filtered carrier factors with pagination

Bodyapplication/json
dataArray of objects(CarrierFactor)required
data[].​idstring(uuid)read-onlyrequired

Unique carrier factor identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
data[].​companyNamestringrequired

Factoring company legal name

Example: "Capital Factoring Services Inc"
data[].​keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-FACTOR-001"
data[].​emailstring or null(email)

Primary email address

Example: "accounting@capitalfactoring.com"
data[].​phoneNumberstring or null

Primary phone number

Example: "+1-555-234-5678"
data[].​addressLine1string or null

Primary street address

Example: "789 Finance Ave"
data[].​addressLine2string or null

Secondary address line (suite, floor, etc.)

Example: "Suite 500"
data[].​citystring or null

City name

Example: "Dallas"
data[].​statestring or null

State or province

Example: "TX"
data[].​countrystring or null

Country code or name

Example: "USA"
data[].​zipCodestring or null

Postal/ZIP code

Example: "75201"
data[].​bankNamestring or null

Bank name

Example: "Chase Bank"
data[].​bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
data[].​accountNamestring or null

Bank account holder name

Example: "Capital Factoring Services Inc"
data[].​accountNumberstring or null

Bank account number

Example: "****1234"
data[].​abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
data[].​wirestring or null

Wire transfer routing number

Example: "026009593"
data[].​swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
data[].​eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
data[].​eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
data[].​clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
data[].​currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
data[].​paymentTermPaymentTermReference (object) or null
Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

object PaymentTermReference Recursive
data[].​createdAtstring(date-time)read-onlyrequired

When the carrier factor was created

Example: "2025-01-15T10:00:00Z"
data[].​updatedAtstring(date-time)read-onlyrequired

When the carrier factor was last updated

Example: "2025-01-15T14:30:00Z"
data[].​deletedAtstring or null(date-time)read-only

When the carrier factor was soft deleted (null if active)

Example: null
pageInfoobject(PaginationInfo)required
pageInfo.​pageSizeintegerrequired

Number of items per page

Example: 50
pageInfo.​hasNextPagebooleanrequired

Whether there are more pages

Example: true
pageInfo.​hasPreviousPageboolean

Whether there are previous pages

Example: false
pageInfo.​endCursorstring or null

Cursor for the next page (null if no next page)

Example: "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
Response
application/json
{
  "data": [
    { … }
  ],
  "pageInfo": {
    "pageSize": 50,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}

Create carrier factor

Request

Create a new carrier factor (factoring company).

Factoring companies provide payment services for carriers, allowing them to receive immediate payment for invoices.

Security
BearerAuth
Bodyapplication/jsonrequired
companyNamestringrequired

Factoring company legal name

Example: "Capital Factoring Services Inc"
keystring<= 512 characters

Client-defined reference identifier

Example: "ERP-FACTOR-001"
emailstring(email)

Primary email address

Example: "accounting@capitalfactoring.com"
phoneNumberstring

Primary phone number

Example: "+1-555-234-5678"
addressLine1string

Primary street address

Example: "789 Finance Ave"
addressLine2string

Secondary address line (suite, floor, etc.)

Example: "Suite 500"
citystring

City name

Example: "Dallas"
statestring

State or province

Example: "TX"
countrystring

Country code or name

Example: "USA"
zipCodestring

Postal/ZIP code

Example: "75201"
bankNamestring

Bank name

Example: "Chase Bank"
bankAddressstring

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring

Bank account holder name

Example: "Capital Factoring Services Inc"
accountNumberstring

Bank account number

Example: "1234567890"
abaAchstring

ABA/ACH routing number for electronic transfers

Example: "021000021"
wirestring

Wire transfer routing number

Example: "026009593"
swiftCodestring

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring

EFT transit number (Canadian banking)

Example: "00010"
clabestring

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
currencystring

Preferred currency code (ISO 4217)

Example: "USD"
paymentTermIdstring(uuid)

Payment term ID

Example: "550e8400-e29b-41d4-a716-446655440002"
curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-factors \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyName": "Capital Factoring Services Inc",
    "email": "accounting@capitalfactoring.com",
    "phoneNumber": "+1-555-234-5678",
    "addressLine1": "789 Finance Ave",
    "city": "Dallas",
    "state": "TX",
    "country": "USA",
    "zipCode": "75201"
  }'

Responses

Carrier factor created successfully

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique carrier factor identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
companyNamestringrequired

Factoring company legal name

Example: "Capital Factoring Services Inc"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-FACTOR-001"
emailstring or null(email)

Primary email address

Example: "accounting@capitalfactoring.com"
phoneNumberstring or null

Primary phone number

Example: "+1-555-234-5678"
addressLine1string or null

Primary street address

Example: "789 Finance Ave"
addressLine2string or null

Secondary address line (suite, floor, etc.)

Example: "Suite 500"
citystring or null

City name

Example: "Dallas"
statestring or null

State or province

Example: "TX"
countrystring or null

Country code or name

Example: "USA"
zipCodestring or null

Postal/ZIP code

Example: "75201"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Capital Factoring Services Inc"
accountNumberstring or null

Bank account number

Example: "****1234"
abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
paymentTermPaymentTermReference (object) or null
Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

object PaymentTermReference Recursive
createdAtstring(date-time)read-onlyrequired

When the carrier factor was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the carrier factor was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the carrier factor was soft deleted (null if active)

Example: null
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "companyName": "Capital Factoring Services Inc",
  "key": "ERP-FACTOR-001",
  "email": "accounting@capitalfactoring.com",
  "phoneNumber": "+1-555-234-5678",
  "addressLine1": "789 Finance Ave",
  "addressLine2": "Suite 500",
  "city": "Dallas",
  "state": "TX",
  "country": "USA",
  "zipCode": "75201",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Capital Factoring Services Inc",
  "accountNumber": "****1234",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Get carrier factor

Request

Retrieve a single carrier factor by its unique identifier.

Carrier factors represent factoring companies that provide payment services.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X GET \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-factors/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Carrier factor found

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique carrier factor identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
companyNamestringrequired

Factoring company legal name

Example: "Capital Factoring Services Inc"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-FACTOR-001"
emailstring or null(email)

Primary email address

Example: "accounting@capitalfactoring.com"
phoneNumberstring or null

Primary phone number

Example: "+1-555-234-5678"
addressLine1string or null

Primary street address

Example: "789 Finance Ave"
addressLine2string or null

Secondary address line (suite, floor, etc.)

Example: "Suite 500"
citystring or null

City name

Example: "Dallas"
statestring or null

State or province

Example: "TX"
countrystring or null

Country code or name

Example: "USA"
zipCodestring or null

Postal/ZIP code

Example: "75201"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Capital Factoring Services Inc"
accountNumberstring or null

Bank account number

Example: "****1234"
abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
paymentTermPaymentTermReference (object) or null
Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

object PaymentTermReference Recursive
createdAtstring(date-time)read-onlyrequired

When the carrier factor was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the carrier factor was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the carrier factor was soft deleted (null if active)

Example: null
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "companyName": "Capital Factoring Services Inc",
  "key": "ERP-FACTOR-001",
  "email": "accounting@capitalfactoring.com",
  "phoneNumber": "+1-555-234-5678",
  "addressLine1": "789 Finance Ave",
  "addressLine2": "Suite 500",
  "city": "Dallas",
  "state": "TX",
  "country": "USA",
  "zipCode": "75201",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Capital Factoring Services Inc",
  "accountNumber": "****1234",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Update carrier factor

Request

Partially update a carrier factor. 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
Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired
companyNamestring

Factoring company legal name

Example: "Capital Factoring Services Inc"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-FACTOR-001"
emailstring or null(email)

Primary email address

Example: "accounting@capitalfactoring.com"
phoneNumberstring or null

Primary phone number

Example: "+1-555-234-5678"
addressLine1string or null

Primary street address

Example: "789 Finance Ave"
addressLine2string or null

Secondary address line

Example: "Suite 500"
citystring or null

City name

Example: "Dallas"
statestring or null

State or province

Example: "TX"
countrystring or null

Country code or name

Example: "USA"
zipCodestring or null

Postal/ZIP code

Example: "75201"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Capital Factoring Services Inc"
accountNumberstring or null

Bank account number

Example: "1234567890"
abaAchstring or null

ABA/ACH routing number

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
clabestring or null

CLABE number (Mexican banking)

Example: "012180001234567897"
currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
paymentTermIdstring or null(uuid)

Payment term ID

Example: "550e8400-e29b-41d4-a716-446655440002"
curl -i -X PATCH \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-factors/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "newemail@capitalfactoring.com",
    "phoneNumber": "+1-555-999-8888"
  }'

Responses

Carrier factor updated successfully

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique carrier factor identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
companyNamestringrequired

Factoring company legal name

Example: "Capital Factoring Services Inc"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-FACTOR-001"
emailstring or null(email)

Primary email address

Example: "accounting@capitalfactoring.com"
phoneNumberstring or null

Primary phone number

Example: "+1-555-234-5678"
addressLine1string or null

Primary street address

Example: "789 Finance Ave"
addressLine2string or null

Secondary address line (suite, floor, etc.)

Example: "Suite 500"
citystring or null

City name

Example: "Dallas"
statestring or null

State or province

Example: "TX"
countrystring or null

Country code or name

Example: "USA"
zipCodestring or null

Postal/ZIP code

Example: "75201"
bankNamestring or null

Bank name

Example: "Chase Bank"
bankAddressstring or null

Bank address

Example: "123 Bank Street, Dallas, TX 75201"
accountNamestring or null

Bank account holder name

Example: "Capital Factoring Services Inc"
accountNumberstring or null

Bank account number

Example: "****1234"
abaAchstring or null

ABA/ACH routing number for electronic transfers

Example: "021000021"
wirestring or null

Wire transfer routing number

Example: "026009593"
swiftCodestring or null

SWIFT/BIC code for international transfers

Example: "CHASUS33"
eftInstitutionstring or null

EFT institution number (Canadian banking)

Example: "001"
eftTransitstring or null

EFT transit number (Canadian banking)

Example: "00010"
clabestring or null

CLABE number (Mexican banking identifier)

Example: "012180001234567897"
currencystring or null

Preferred currency code (ISO 4217)

Example: "USD"
paymentTermPaymentTermReference (object) or null
Any of:

Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.

object PaymentTermReference Recursive
createdAtstring(date-time)read-onlyrequired

When the carrier factor was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

When the carrier factor was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

When the carrier factor was soft deleted (null if active)

Example: null
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "companyName": "Capital Factoring Services Inc",
  "key": "ERP-FACTOR-001",
  "email": "accounting@capitalfactoring.com",
  "phoneNumber": "+1-555-234-5678",
  "addressLine1": "789 Finance Ave",
  "addressLine2": "Suite 500",
  "city": "Dallas",
  "state": "TX",
  "country": "USA",
  "zipCode": "75201",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Capital Factoring Services Inc",
  "accountNumber": "****1234",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "apOnly": false,
    "doNotUse": false,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Delete carrier factor

Request

Soft delete a carrier factor (sets deletedAt timestamp).

The carrier factor will no longer appear in default queries but can be retrieved by explicitly filtering for deleted records.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X DELETE \
  https://docs.mvmnt.io/_mock/apis/openapi/carrier-factors/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Carrier factor deleted successfully

Response
No content

Carrier Payment Methods

Operations

Customer Contacts

Operations

Customers

Operations

Locations

Operations

Location Contacts

Operations

Payment Terms

Operations

Teams

Operations

Users

Operations

Vendors

Operations

Vendor Contacts

Operations

Vendor Payment Methods

Operations

Saved Searches

Operations

Event Notifications

Webhooks