Getting StartedAPI Reference
API Reference

Executes the Add action for the Agreements data object.

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

Adds a new SM Agreement

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
integer
required
1 to 255

Required.

string
required
length ≤ 15

Required.

string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, null will be defaulted.

integer
required

key to sm/customers(SMCo, CustGroup, Customer) CustGroup is based on SMCo.

string | null

Optional. If Omitted, null will be defaulted.

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

Format: YYYY-MM-DD. Optional. If omitted null will be defaulted.

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

Format: YYYY-MM-DD. Optional. If omitted null will be defaulted.

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

Format: YYYY-MM-DD. Optional. If omitted null will be defaulted.

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|2[0-9]|1[0-9]|0[1-9])$

Format: YYYY-MM-DD. Optional. If omitted null will be defaulted. Can only be provided, if the provided $.AgreementType has AutoRenew = Y. If the Agreement Type is not provided or AutoRenew is N, this value will be ignored.

string | null
^[-+]?[0-9]{1,2}(?:.[0-9]{0,4})?$

Required if $RenewThrough is provided. If $.RenewThrough is not provided this property is ignored.

string | null

Key to SM Rate Template. Optional. If omitted null will be defaulted.

string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Optional. If omitted null will be defaulted.

string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Optional. If omitted null will be defaulted.

string | null
enum

Material Tax Type Override. Options:N-No Tax, S-SalesTax Only, U-UseTaxOnly. Optional. If omitted, null will be defaulted.

Allowed:
string
enum
length ≤ 1

Options: B-As Billed, S-Amortize, C-As Costs Incurred. Optional. If omitted, B will be defaulted.

Allowed:
string | null
^[-+]?[0-9]{1,2}(?:.[0-9]{0,4})?$

Optional. If omitted, null will be defaulted.

integer | null

Custom Invoice Report. Optional. If omitted, null will be defaulted.

string
enum

Optional. If omitted, N will be defaulted.

Allowed:
string | null

Optional. If omitted, null will be defaulted.

__custom_fields
object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

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 4 months ago

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

Updated 4 months ago