Skip to main content

Vendor

Full vendor detail, including contacts and addresses.

idstring

Unique identifier for the vendor.

Example: 3054
namestring

Display name of the vendor's company.

Example: Pacific Ingredients Co.
statusstring

Current status of the vendor relationship. Only active vendors can be assigned to new purchase orders.

Possible values: [active, inactive, pending, suspended]

Example: active
purchaseOrderCountinteger

Total number of purchase orders ever placed with this vendor.

Example: 23
lastPurchaseOrderDatestring<date>

Date of the most recent purchase order placed with this vendor (ISO 8601). Null if no POs exist.

Example: 2025-09-15
taxIdentificationNumberstring

The vendor's tax identification number (e.g., EIN or VAT number). Used to prevent duplicate vendor records.

paymentTermsstring

Default payment terms for this vendor (e.g., "Net 30", "Due on receipt"). Applied to new POs unless overridden.

Example: Net 30
contacts object[]

All contact persons on file for this vendor. One contact is flagged as primary.

  • Array [
  • namestring

    Full name of the contact.

    Example: Maria Torres
    emailstring<email>

    Email address of the contact.

    Example: maria.torres@pacificingredients.com
    phonestring

    Phone number including country code.

    Example: +1-555-0198
    isPrimaryboolean

    Whether this is the primary contact for the vendor. Exactly one contact per vendor is flagged as primary.

    Example: true
  • ]
  • addresses object[]

    All addresses on file for this vendor (billing, shipping, or both). One address is flagged as primary.

  • Array [
  • addressTypestring

    Whether this address is used for billing, shipping, or both.

    Possible values: [billing, shipping, both]

    Example: both
    streetstring

    Street address line.

    Example: 742 Industrial Parkway
    citystring
    Example: Portland
    statestring

    State or province code.

    Example: OR
    zipCodestring

    Postal or ZIP code.

    Example: 97201
    countrystring

    Two-letter country code (ISO 3166-1 alpha-2).

    Example: US
    isPrimaryboolean

    Whether this is the default address for the vendor. Used as the ship-to address on new purchase orders unless overridden.

    Example: true
  • ]
  • Vendor
    {
    "id": "3054",
    "name": "Pacific Ingredients Co.",
    "status": "active",
    "purchaseOrderCount": 23,
    "lastPurchaseOrderDate": "2025-09-15",
    "taxIdentificationNumber": "string",
    "paymentTerms": "Net 30",
    "contacts": [
    {
    "name": "Maria Torres",
    "email": "maria.torres@pacificingredients.com",
    "phone": "+1-555-0198",
    "isPrimary": true
    }
    ],
    "addresses": [
    {
    "addressType": "both",
    "street": "742 Industrial Parkway",
    "city": "Portland",
    "state": "OR",
    "zipCode": "97201",
    "country": "US",
    "isPrimary": true
    }
    ]
    }