Getting StartedAPI Reference
API Reference

Executes the Add action for the Compliances data object.

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

Adds a new Compliance record to a subcontract

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

Key to sl/2/compliances(SLCo, SL, CompCode, Seq).

string
required
length ≤ 30

Key to sl/2/compliances(SLCo, SL, CompCode, Seq)

string
required
length ≤ 10

Key to sl/2/compliances(SLCo, SL, CompCode, Seq). Key to hq/2/compliance_codes(CompCode)

string
enum

Identifies if this code should be used to verify compliance. Optional. If omitted, this value will default based on the CompCode.

Allowed:
string | null

Optional. If omitted, the CompCode description 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. Only valid for D-Date CompType Compliance Codes. If provided for non D-Date CompType Compliance Code input will be ignored and null saved. If omitted, null will be saved.

string | null
enum

Only valid for F-Flag CompType Compliance Codes. If provided for non F-Flag CompType Compliance Code Input will be ignored and null saved. If omitted, null will be saved for D-Date CompTypes, N will be saved for F-Flag CompTypes.

Allowed:
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.

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

Optional. If omitted, null will be defaulted.

integer | null

Supplier. Key to ap/2/vendors(VendorGroup, Vendor). VendorGroup defaulted based on SLCo. Value should be provided only if this Compliance code relates to a supplier and not the subcontractor.

string | null

Used to put a non-compliance code on a specific AP Invoice. Optional. If omitted, null will be defaulted.

__custom_fields
object

Add a property for each user defined values that should be set.

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 about 1 month ago

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

Updated about 1 month ago