Getting StartedAPI Reference
API Reference

Executes the Add action for the Firms data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/pm/2/data/firms/actions/add

Adds a new PM firm record in Vista PM Firm Master.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The code of the subscriber that you are making this request for.

Body Params

Schema for adding a new PM firm record.

integer
required

The group code assigned to the firm/vendor.

integer
required

The unique identifying number for the firm.

string | null

The legal name of the firm/vendor.

string | null

The type or category of firm (e.g., Subcontractor, Supplier).

string
required
length ≤ 15

A shorter name used for sorting and quick identification.

integer
required

The vendor/firm ID number (often the same as FirmNumber).

string | null

The primary contact person's name.

string | null

The primary mailing street address, line 1.

string | null

The mailing city.

string | null

The mailing state or province code.

string | null

The mailing zip or postal code.

string | null

The primary mailing street address, line 2.

string | null

The primary shipping street address, line 1.

string | null

The shipping city.

string | null

The shipping state or province code.

string | null

The shipping zip or postal code.

string | null

The primary shipping street address, line 2.

string | null

The primary phone number.

string | null

The primary fax number.

string | null

The primary email address (legacy).

string | null

The firm's website URL.

string | null

General notes or comments about the firm.

string | null
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

The unique identifier for external attachments.

string
enum
required

Flag for updating Accounts Payable (AP) module.

Allowed:
string | null

The 2-character country code for the mailing address.

string | null

The 2-character country code for the shipping address.

string | null
enum

Flag to exclude the firm from certain processes.

Allowed:
string | null

The primary email address for the firm.

__custom_fields
object

Vista custom fields defined for PMFM in Vista.

Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated 16 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 16 days ago