Executes the Add action for the Agreements data object.

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

Adds a new SM Agreement

Path Params

subscriber_code

string

required

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

Body Params

SMCo

integer

required

1 to 255

Required.

Agreement

string

required

length ≤ 15

Required.

Description

string | null

Optional. If omitted, null will be defaulted.

AlternateAgreement

string | null

Optional. If omitted, null will be defaulted.

AgreementType

string | null

Optional. If omitted, null will be defaulted.

Customer

integer

required

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

CustomerPO

string | null

Optional. If Omitted, null will be defaulted.

EffectiveDate

date | null

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

StartDate

date | null

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

ExpirationDate

date | null

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

RenewThrough

date | null

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.

RenewMarkUp

string | null

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

RateTemplate

string | null

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

AgreementPrice

string | null

Optional. If omitted null will be defaulted.

BillingReduction

string | null

Optional. If omitted null will be defaulted.

TaxTypeOverride

string | null

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

RevenueRecognition

string

length ≤ 1

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

CostRevenueMargin

string | null

Optional. If omitted, null will be defaulted.

ReportID

integer | null

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

AutoScheduleTrips

string

Optional. If omitted, N will be defaulted.

Notes

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

X-Application-Key

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.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/sm/2/data/agreements/actions/add \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.

x-$.result for SuccessfulObject returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Successful"

x-$.result for FailedObject returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Failed"