Getting StartedAPI Reference
API Reference

Executes the Add action for the Vendor Compliances data object.

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

Adds a Compliance record to a Vendor

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

The AP Company you are working with.

integer
required
1 to 999999

Vendor Id. Key to ap/vendors(VendorGroup, Vendor). VendorGroup defaulted based on APCo.

string
required
length ≤ 10

Compliance Code. Key to hq/compliance_codes(CompCode)

string
enum

Provide Y if you want this Compliance verified. Optional. If omitted, Y will be defaulted.

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

Expiration Date for Date type CompCode values. Optional. If omitted, null will be defaulted. Format YYYY-MM-DD.

string | null
enum

Vendor has Complied. Optional. If omitted, null will be defaulted.

Allowed:
string | null

Optional. If omitted, null will be defaulted.

string | null
enum

Optional. If set to Y will invoke the Vendor Compliance replication.

Allowed:
string | null
enum

Optional. If set to Y will invoke the Vendor Compliance replication.

Allowed:
__custom_fields
object

Add a property for each user defined values that should be set on the header form as part of this action.

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

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

Updated 2 months ago