Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Vendors

Create a new vendor

Create a new vendor within an organization.

Vendors represent service providers (warehousing, storage, etc.) that are not carriers.

post/vendors

Request body

namestring required

Vendor legal name

keystring

Client-defined reference identifier

emailstring email

Primary email address

phonestring

Primary phone number

statusstring

Vendor status

notesstring

Internal notes about the vendor

taxIdstring

Tax identification number

currency'USD' | 'CAD' | 'MXN' | 'EUR' | 'GBP'

Currency code

paymentTermIdstring uuid

Payment term ID

isMvmntboolean

Whether this vendor is MVMNT itself

requiredDocumentsstring[]

List of required document types

Example request

{
  "name": "ABC Warehouse Services",
  "key": "ERP-VENDOR-ABC-001",
  "email": "billing@abcwarehouse.com",
  "phone": "+1-555-123-4567",
  "status": "ACTIVE",
  "notes": "Preferred vendor for warehouse services",
  "taxId": "12-3456789",
  "corporateAddress": {
    "line1": "123 Main St",
    "line2": "Suite 400",
    "city": "Chicago",
    "country": "USA",
    "market": "CHI",
    "latitude": "41.8781",
    "longitude": "-87.6298",
    "isSmartyValidated": true,
    "obeysDst": true
  },
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 400",
    "city": "Chicago",
    "country": "USA",
    "market": "CHI",
    "latitude": "41.8781",
    "longitude": "-87.6298",
    "isSmartyValidated": true,
    "obeysDst": true
  },
  "paymentTermId": "550e8400-e29b-41d4-a716-446655440001",
  "requiredDocuments": [
    "W9",
    "INSURANCE_CERTIFICATE"
  ]
}

Response

Vendor created successfully

object'VENDOR'

Object type identifier

idstring uuid required

Unique vendor identifier

friendlyIdstring required

Human-readable vendor identifier

namestring required

Vendor legal name

keystring nullable

Client-defined reference identifier

emailstring email nullable

Primary email address

phonestring nullable

Primary phone number

statusstring nullable

Vendor status

notesstring nullable

Internal notes about the vendor

taxIdstring nullable

Tax identification number

currency'USD' | 'CAD' | 'MXN' | 'EUR' | 'GBP'

Currency code

isMvmntboolean nullable

Whether this vendor is MVMNT itself

requiredDocumentsstring[] nullable

List of required document types

createdAtstring date-time required

When the vendor was created

updatedAtstring date-time required

When the vendor was last updated

deletedAtstring date-time nullable

When the vendor was soft deleted (null if active)

Example response

{
  "object": "VENDOR",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "friendlyId": "V123456",
  "name": "ABC Warehouse Services",
  "key": "ERP-VENDOR-ABC-001",
  "email": "billing@abcwarehouse.com",
  "phone": "+1-555-123-4567",
  "status": "ACTIVE",
  "notes": "Preferred vendor for warehouse services",
  "taxId": "12-3456789",
  "corporateAddress": {
    "line1": "123 Main St",
    "line2": "Suite 400",
    "city": "Chicago",
    "country": "USA",
    "market": "CHI",
    "latitude": "41.8781",
    "longitude": "-87.6298",
    "isSmartyValidated": true,
    "obeysDst": true
  },
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 400",
    "city": "Chicago",
    "country": "USA",
    "market": "CHI",
    "latitude": "41.8781",
    "longitude": "-87.6298",
    "isSmartyValidated": true,
    "obeysDst": true
  },
  "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,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "requiredDocuments": [
    "W9",
    "INSURANCE_CERTIFICATE"
  ],
  "paymentMethods": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "VENDOR-PM-001",
      "paymentMethodType": "ACH",
      "status": "ACTIVE",
      "isPreferred": true,
      "email": "payments@vendor.com",
      "phone": "+1-555-123-4567",
      "companyName": "Vendor Payments LLC",
      "username": "vendor_payments",
      "bankName": "Chase Bank",
      "bankAddress": "123 Bank Street, Dallas, TX 75201",
      "accountName": "Vendor 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,
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z",
      "deletedBy": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "phoneExt": "123",
        "status": "ACTIVE",
        "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      }
    }
  ],
  "contacts": [
    {
      "object": "VENDOR_CONTACT",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "ERP-VENDOR-CONTACT-001",
      "email": "john.smith@abcwarehouse.com",
      "phone": "+1-555-123-4567",
      "role": "Billing Manager",
      "roles": [
        "BILLING",
        "AGENT"
      ],
      "deletedBy": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "phoneExt": "123",
        "status": "ACTIVE",
        "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "createdAt": "2025-01-15T10:00:00Z"
    }
  ],
  "deletedBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "ACTIVE",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z"
}