Skip to content
API Reference/
/
Create a bill payment

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

Carriers

Carrier management operations

Operations

Carrier Contacts

Carrier contact management operations

Operations

Carrier Factors

Carrier factor (factoring company) management operations

Operations

Carrier Payment Methods

Carrier payment method management operations

Operations

Companies

Company management operations

Operations

Credit Memos

AR credit memo management operations. Credit memos represent customer credits that can be applied to invoices.

Operations

Bills

AP bill management operations. Bills represent carrier and vendor invoices to be paid.

Operations

Bill Payments

AP bill payment management operations. Bill payments record payments made to carriers and vendors.

Operations

Filter bill payments

Request

Search for bill payments using filter criteria.

Common Filters

  • By carrier: { "filter": { "carrierId": { "equalTo": "uuid" } } }
  • By vendor: { "filter": { "vendorId": { "equalTo": "uuid" } } }
  • By factor: { "filter": { "carrierFactorId": { "equalTo": "uuid" } } }
  • By date range: { "filter": { "paymentDate": { "gte": "2025-01-01", "lte": "2025-01-31" } } }
  • By method: { "filter": { "paymentMethodType": { "equalTo": "check" } } }
Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(BillPaymentFilter)
pageSizeinteger[ 1 .. 100 ]
Default 50
cursorstring
curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/bill-payments/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "carrierId": {
        "equalTo": "550e8400-e29b-41d4-a716-446655440000"
      }
    }
  }'

Responses

Bill payments matching filter criteria

Bodyapplication/json
dataArray of objects(BillPayment)required
data[].​idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
data[].​keystring or null

Client-defined key

data[].​recipientTypestring(BillPaymentRecipientType)required

Type of recipient for the payment.

  • CARRIER: Payment to a carrier
  • VENDOR: Payment to a vendor
Enum"CARRIER""VENDOR"
data[].​carrierobject(CarrierReference)

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.

data[].​vendorobject(VendorReference)

Enhanced reference to a vendor profile. Includes full vendor details in addition to id/key.

data[].​carrierFactorobject(bill-payments_CarrierFactorReference)
data[].​paymentDatestring(date)required

Date the payment was made

data[].​paymentMethodTypestring(BillPaymentMethodType)

Payment method used for the bill payment.

  • ACH_WIRE: ACH wire transfer
  • CHECK: Paper check
  • CREDIT_CARD: Credit card payment
  • EFT_DIRECT_DEPOSIT: EFT direct deposit
  • E_TRANSFER: Electronic transfer
  • VENMO: Venmo payment
Enum"ACH_WIRE""CHECK""CREDIT_CARD""EFT_DIRECT_DEPOSIT""E_TRANSFER""VENMO"
data[].​referencestring or null

Check number, transaction ID, etc.

data[].​notesstring or null

Additional notes

data[].​totalAmountnumberrequired

Total payment amount (sum of all applications)

data[].​overpaymentnumber or null

Amount paid in excess of invoice totals

data[].​overpaymentCreditMemoIdstring or null(uuid)

Credit memo created for overpayment

data[].​applicationsArray of objects(BillPaymentApplication)required

Individual bill payments in this group

data[].​applications[].​idstring(uuid)required
data[].​applications[].​billIdstring(uuid)required

Bill (invoice) this payment applies to

data[].​applications[].​billFriendlyIdstring or null

Human-readable bill ID

data[].​applications[].​amountnumberrequired

Amount applied to this bill

data[].​applications[].​loadCarrierIdstring or null(uuid)

Associated load carrier (for carrier bills)

data[].​applications[].​vendedServiceIdstring or null(uuid)

Associated vended service (for vendor bills)

data[].​applications[].​shipmentIdstring or null(uuid)
data[].​applications[].​shipmentFriendlyIdstring or null
data[].​qboIdstring or null

QuickBooks Online bill payment ID

data[].​syncStatusstring or null

QuickBooks sync status

Enum"pending""synced""error"
data[].​syncErrorstring or null

QuickBooks sync error message

data[].​createdAtstring(date-time)required
data[].​updatedAtstring or null(date-time)
paginationobject(PaginationInfo)required
pagination.​pageSizeintegerrequired

Number of items per page

Example: 50
pagination.​hasNextPagebooleanrequired

Whether there are more pages

Example: true
pagination.​hasPreviousPageboolean

Whether there are previous pages

Example: false
pagination.​endCursorstring or null

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

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

Create a bill payment

Request

Record a payment for one or more carrier/vendor bills.

What happens

  • PaymentGroup record is created
  • Payment applications are created for each bill
  • Bill open balances are reduced
  • Load/service status updates to PAID when fully paid

Carrier factor payments

To pay a carrier's factor instead of the carrier directly, specify carrierFactorId in the request.

Overpayments

If allowOverpayment is true and payment exceeds bill totals, a credit memo is automatically created for the difference.

Security
BearerAuth
Bodyapplication/jsonrequired
paymentDatestring(date)required

Date of payment

paymentMethodTypestring(BillPaymentMethodType)

Payment method used for the bill payment.

  • ACH_WIRE: ACH wire transfer
  • CHECK: Paper check
  • CREDIT_CARD: Credit card payment
  • EFT_DIRECT_DEPOSIT: EFT direct deposit
  • E_TRANSFER: Electronic transfer
  • VENMO: Venmo payment
Enum"ACH_WIRE""CHECK""CREDIT_CARD""EFT_DIRECT_DEPOSIT""E_TRANSFER""VENMO"
carrierFactorIdstring(uuid)

Carrier factor to pay (for factored payments)

referencestring<= 500 characters

Check number, transaction ID, etc.

notesstring<= 2000 characters

Additional notes

applicationsArray of objects(BillPaymentApplicationInput)non-emptyrequired

Bills to pay

applications[].​billIdstring(uuid)required

Bill (invoice) to apply payment to

applications[].​amountnumber>= 0.01required

Amount to apply to this bill

allowOverpaymentboolean

Allow payment amount to exceed bill totals

Default false
curl -i -X POST \
  https://docs.mvmnt.io/_mock/apis/openapi/bill-payments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentDate": "2025-01-15",
    "paymentMethodType": "CHECK",
    "reference": "CHK-12345",
    "applications": [
      {
        "billId": "550e8400-e29b-41d4-a716-446655440000",
        "amount": 2500
      }
    ]
  }'

Responses

Bill payment created successfully

Bodyapplication/json
idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
keystring or null

Client-defined key

recipientTypestring(BillPaymentRecipientType)required

Type of recipient for the payment.

  • CARRIER: Payment to a carrier
  • VENDOR: Payment to a vendor
Enum"CARRIER""VENDOR"
carrierobject(CarrierReference)

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.

vendorobject(VendorReference)

Enhanced reference to a vendor profile. Includes full vendor details in addition to id/key.

carrierFactorobject(bill-payments_CarrierFactorReference)
paymentDatestring(date)required

Date the payment was made

paymentMethodTypestring(BillPaymentMethodType)

Payment method used for the bill payment.

  • ACH_WIRE: ACH wire transfer
  • CHECK: Paper check
  • CREDIT_CARD: Credit card payment
  • EFT_DIRECT_DEPOSIT: EFT direct deposit
  • E_TRANSFER: Electronic transfer
  • VENMO: Venmo payment
Enum"ACH_WIRE""CHECK""CREDIT_CARD""EFT_DIRECT_DEPOSIT""E_TRANSFER""VENMO"
referencestring or null

Check number, transaction ID, etc.

notesstring or null

Additional notes

totalAmountnumberrequired

Total payment amount (sum of all applications)

overpaymentnumber or null

Amount paid in excess of invoice totals

overpaymentCreditMemoIdstring or null(uuid)

Credit memo created for overpayment

applicationsArray of objects(BillPaymentApplication)required

Individual bill payments in this group

applications[].​idstring(uuid)required
applications[].​billIdstring(uuid)required

Bill (invoice) this payment applies to

applications[].​billFriendlyIdstring or null

Human-readable bill ID

applications[].​amountnumberrequired

Amount applied to this bill

applications[].​loadCarrierIdstring or null(uuid)

Associated load carrier (for carrier bills)

applications[].​vendedServiceIdstring or null(uuid)

Associated vended service (for vendor bills)

applications[].​shipmentIdstring or null(uuid)
applications[].​shipmentFriendlyIdstring or null
qboIdstring or null

QuickBooks Online bill payment ID

syncStatusstring or null

QuickBooks sync status

Enum"pending""synced""error"
syncErrorstring or null

QuickBooks sync error message

createdAtstring(date-time)required
updatedAtstring or null(date-time)
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "string",
  "recipientType": "CARRIER",
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "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"
  },
  "carrierFactor": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "companyName": "string",
    "bankName": "string"
  },
  "paymentDate": "2019-08-24",
  "paymentMethodType": "ACH_WIRE",
  "reference": "string",
  "notes": "string",
  "totalAmount": 0,
  "overpayment": 0,
  "overpaymentCreditMemoId": "2f027b50-303e-4b13-9bf5-d1a4ed9ead57",
  "applications": [
    { … }
  ],
  "qboId": "string",
  "syncStatus": "pending",
  "syncError": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get a bill payment

Request

Retrieve a bill payment by ID.

The response includes all payment applications and their associated bills.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

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.

Enum"id""key"
Example: by=key
curl -i -X GET \
  'https://docs.mvmnt.io/_mock/apis/openapi/bill-payments/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bill payment retrieved successfully

Bodyapplication/json
idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
keystring or null

Client-defined key

recipientTypestring(BillPaymentRecipientType)required

Type of recipient for the payment.

  • CARRIER: Payment to a carrier
  • VENDOR: Payment to a vendor
Enum"CARRIER""VENDOR"
carrierobject(CarrierReference)

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.

vendorobject(VendorReference)

Enhanced reference to a vendor profile. Includes full vendor details in addition to id/key.

carrierFactorobject(bill-payments_CarrierFactorReference)
paymentDatestring(date)required

Date the payment was made

paymentMethodTypestring(BillPaymentMethodType)

Payment method used for the bill payment.

  • ACH_WIRE: ACH wire transfer
  • CHECK: Paper check
  • CREDIT_CARD: Credit card payment
  • EFT_DIRECT_DEPOSIT: EFT direct deposit
  • E_TRANSFER: Electronic transfer
  • VENMO: Venmo payment
Enum"ACH_WIRE""CHECK""CREDIT_CARD""EFT_DIRECT_DEPOSIT""E_TRANSFER""VENMO"
referencestring or null

Check number, transaction ID, etc.

notesstring or null

Additional notes

totalAmountnumberrequired

Total payment amount (sum of all applications)

overpaymentnumber or null

Amount paid in excess of invoice totals

overpaymentCreditMemoIdstring or null(uuid)

Credit memo created for overpayment

applicationsArray of objects(BillPaymentApplication)required

Individual bill payments in this group

applications[].​idstring(uuid)required
applications[].​billIdstring(uuid)required

Bill (invoice) this payment applies to

applications[].​billFriendlyIdstring or null

Human-readable bill ID

applications[].​amountnumberrequired

Amount applied to this bill

applications[].​loadCarrierIdstring or null(uuid)

Associated load carrier (for carrier bills)

applications[].​vendedServiceIdstring or null(uuid)

Associated vended service (for vendor bills)

applications[].​shipmentIdstring or null(uuid)
applications[].​shipmentFriendlyIdstring or null
qboIdstring or null

QuickBooks Online bill payment ID

syncStatusstring or null

QuickBooks sync status

Enum"pending""synced""error"
syncErrorstring or null

QuickBooks sync error message

createdAtstring(date-time)required
updatedAtstring or null(date-time)
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "string",
  "recipientType": "CARRIER",
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "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"
  },
  "carrierFactor": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "companyName": "string",
    "bankName": "string"
  },
  "paymentDate": "2019-08-24",
  "paymentMethodType": "ACH_WIRE",
  "reference": "string",
  "notes": "string",
  "totalAmount": 0,
  "overpayment": 0,
  "overpaymentCreditMemoId": "2f027b50-303e-4b13-9bf5-d1a4ed9ead57",
  "applications": [
    { … }
  ],
  "qboId": "string",
  "syncStatus": "pending",
  "syncError": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Update a bill payment

Request

Update bill payment fields.

Constraints

  • Cannot change carrier factor after creation
  • Can add/remove/update payment applications

Updating applications

In the applications array:

  • Include id to update an existing application
  • Omit id and include billId to add a new application
  • Set delete: true with id to remove an application
Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

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.

Enum"id""key"
Example: by=key
Bodyapplication/jsonrequired
paymentDatestring(date)
paymentMethodTypestring(BillPaymentMethodType)

Payment method used for the bill payment.

  • ACH_WIRE: ACH wire transfer
  • CHECK: Paper check
  • CREDIT_CARD: Credit card payment
  • EFT_DIRECT_DEPOSIT: EFT direct deposit
  • E_TRANSFER: Electronic transfer
  • VENMO: Venmo payment
Enum"ACH_WIRE""CHECK""CREDIT_CARD""EFT_DIRECT_DEPOSIT""E_TRANSFER""VENMO"
referencestring or null
notesstring or null
applicationsArray of objects(BillPaymentApplicationPatch)

Update payment applications

curl -i -X PATCH \
  'https://docs.mvmnt.io/_mock/apis/openapi/bill-payments/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reference": "CHK-12345-UPDATED"
  }'

Responses

Bill payment updated successfully

Bodyapplication/json
idstring(uuid)required
Example: "550e8400-e29b-41d4-a716-446655440000"
keystring or null

Client-defined key

recipientTypestring(BillPaymentRecipientType)required

Type of recipient for the payment.

  • CARRIER: Payment to a carrier
  • VENDOR: Payment to a vendor
Enum"CARRIER""VENDOR"
carrierobject(CarrierReference)

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.

vendorobject(VendorReference)

Enhanced reference to a vendor profile. Includes full vendor details in addition to id/key.

carrierFactorobject(bill-payments_CarrierFactorReference)
paymentDatestring(date)required

Date the payment was made

paymentMethodTypestring(BillPaymentMethodType)

Payment method used for the bill payment.

  • ACH_WIRE: ACH wire transfer
  • CHECK: Paper check
  • CREDIT_CARD: Credit card payment
  • EFT_DIRECT_DEPOSIT: EFT direct deposit
  • E_TRANSFER: Electronic transfer
  • VENMO: Venmo payment
Enum"ACH_WIRE""CHECK""CREDIT_CARD""EFT_DIRECT_DEPOSIT""E_TRANSFER""VENMO"
referencestring or null

Check number, transaction ID, etc.

notesstring or null

Additional notes

totalAmountnumberrequired

Total payment amount (sum of all applications)

overpaymentnumber or null

Amount paid in excess of invoice totals

overpaymentCreditMemoIdstring or null(uuid)

Credit memo created for overpayment

applicationsArray of objects(BillPaymentApplication)required

Individual bill payments in this group

applications[].​idstring(uuid)required
applications[].​billIdstring(uuid)required

Bill (invoice) this payment applies to

applications[].​billFriendlyIdstring or null

Human-readable bill ID

applications[].​amountnumberrequired

Amount applied to this bill

applications[].​loadCarrierIdstring or null(uuid)

Associated load carrier (for carrier bills)

applications[].​vendedServiceIdstring or null(uuid)

Associated vended service (for vendor bills)

applications[].​shipmentIdstring or null(uuid)
applications[].​shipmentFriendlyIdstring or null
qboIdstring or null

QuickBooks Online bill payment ID

syncStatusstring or null

QuickBooks sync status

Enum"pending""synced""error"
syncErrorstring or null

QuickBooks sync error message

createdAtstring(date-time)required
updatedAtstring or null(date-time)
Response
application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "string",
  "recipientType": "CARRIER",
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z",
    "deletedAt": null
  },
  "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"
  },
  "carrierFactor": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "companyName": "string",
    "bankName": "string"
  },
  "paymentDate": "2019-08-24",
  "paymentMethodType": "ACH_WIRE",
  "reference": "string",
  "notes": "string",
  "totalAmount": 0,
  "overpayment": 0,
  "overpaymentCreditMemoId": "2f027b50-303e-4b13-9bf5-d1a4ed9ead57",
  "applications": [
    { … }
  ],
  "qboId": "string",
  "syncStatus": "pending",
  "syncError": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a bill payment

Request

Delete a bill payment and all its applications.

What happens

  • PaymentGroup record is deleted
  • All Payment applications are deleted
  • Bill open balances are restored
  • Load/service status may revert if payment made them PAID
Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

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.

Enum"id""key"
Example: by=key
curl -i -X DELETE \
  'https://docs.mvmnt.io/_mock/apis/openapi/bill-payments/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bill payment deleted successfully

Response
No content

Get bill payment applications

Request

List all bills paid by this payment group.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

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.

Enum"id""key"
Example: by=key
curl -i -X GET \
  'https://docs.mvmnt.io/_mock/apis/openapi/bill-payments/550e8400-e29b-41d4-a716-446655440000/applications?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Applications retrieved successfully

Bodyapplication/json
dataArray of objects(BillPaymentApplication)
totalAmountnumber
Response
application/json
{
  "data": [
    { … }
  ],
  "totalAmount": 0
}

Generate remittance advice

Request

Generate a remittance advice document for a bill payment.

Formats

  • PDF (default): Set Accept header to application/pdf
  • JSON: Set Accept header to application/json
Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

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.

Enum"id""key"
Example: by=key
curl -i -X GET \
  'https://docs.mvmnt.io/_mock/apis/openapi/bill-payments/550e8400-e29b-41d4-a716-446655440000/remittance-advice?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Remittance advice generated

Body
string(binary)
Response
No response example

Send remittance advice email

Request

Email the remittance advice to the carrier or vendor.

Uses the recipient's default email from their profile.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

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.

Enum"id""key"
Example: by=key
Bodyapplication/json
toEmailstring(email)

Override recipient email

ccEmailsArray of strings(email)

CC recipients

messagestring<= 2000 characters

Additional message in email body

curl -i -X POST \
  'https://docs.mvmnt.io/_mock/apis/openapi/bill-payments/550e8400-e29b-41d4-a716-446655440000/send-remittance?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Remittance advice sent successfully

Bodyapplication/json
successboolean
sentTostring(email)
Response
application/json
{
  "success": true,
  "sentTo": "user@example.com"
}

Customers

Customer management operations

Operations

Customer Contacts

Customer contact management operations

Operations

Documents

Document management operations. Documents are files (PDFs, images) that can be attached to orders, loads, or services.

Operations

Invoices

AR invoice management operations. Invoices represent customer billing for shipment services.

Operations

Loads

Load management operations. Loads represent carrier execution - which carrier is moving the freight.

Operations

Locations

Location management operations

Operations

Location Contacts

Location contact management operations

Operations

Payment Terms

Payment term management operations

Operations

Payments

AR payment management operations. Payments represent received customer payments applied to invoices.

Operations

Quotes

Quote management operations. Quotes are pricing requests/responses that can be converted to shipments.

Operations

Saved Searches

Saved search management operations

Operations

Services

Service (vended service) management operations. Services represent non-carrier vendor work (drayage, customs, warehousing).

Operations

Shipments

Shipment tracking and management operations. Shipments contain orders, loads, and services.

Operations

Teams

Team management operations

Operations

Users

User management operations

Operations

Vendors

Vendor management operations

Operations

Vendor Contacts

Vendor contact management operations

Operations

Vendor Payment Methods

Vendor payment method management operations

Operations

Event Notifications

Webhooks