Vendor Compliance Definitions

NEW!

Vendor compliance is the validation that a subcontractor or vendor has provided documents required for a job. For example, the vendor might need to supply proof of insurance, certified reports, lien waivers, or other misc documents like permits, licenses, and so forth.

A compliance definition sets a compliance category (insurance or miscellaneous), how validation is tracked, and whether payment is allowed if a vendor is not in compliance.

NOTE: To enable the Vendor Compliance subscription, first enable Accounts Payable, Purchasing, and Construction. Vendor compliance is available only for Construction at this time.

Get the Vendor Compliance Object Definition

lookup

List all the fields and relationships for the vendor compliance definition object:

<lookup>
    <object>COMPLIANCEDEFINITION</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use COMPLIANCEDEFINITION

Query and List Vendor Compliance Definitions

query

List the record number, ID, name, and status for each vendor compliance definition where the status is active:

<query>
    <object>COMPLIANCEDEFINITION</object>
    <select>
        <field>RECORDNO</field>
        <field>COMPLIANCEDEFINITIONID</field>
        <field>NAME</field>
        <field>STATUS</field>
    </select>
    <filter>
        <equalto>
            <field>STATUS</field>
            <value>active</value>
        </equalto>
    </filter>
</query>

Parameters

Name Required Type Description
object Required string Use COMPLIANCEDEFINITION
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Query and List Vendor Compliance Definitions (Legacy)

readByQuery

<readByQuery>
    <object>COMPLIANCEDEFINITION</object>
    <fields>RECORDNO, COMPLIANCEDEFINITIONID, NAME</fields>
    <query>CATEGORY = 'Insurance'</query>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use COMPLIANCEDEFINITION
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Vendor Compliance Definitions

read

Get all vendor compliance definition fields for the specified keys:

<read>
    <object>COMPLIANCEDEFINITION</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use COMPLIANCEDEFINITION
keys Required string Comma-separated list of RECORDNO of the vendor compliance definition to get
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Get Vendor Compliance Definitions by ID

readByName

<readByName>
    <object>COMPLIANCEDEFINITION</object>
    <keys>Ins-Exp-Date</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use COMPLIANCEDEFINITION
keys Required string Comma-separated list of COMPLIANCEDEFINITIONID of the compliance definition to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create a Vendor Compliance Definition

create

Create a vendor compliance definition record using the required values:

<create>
    <COMPLIANCEDEFINITION>
        <COMPLIANCEDEFINITIONID>Ins-Exp-Date</COMPLIANCEDEFINITIONID>
        <NAME>Insurance by Expiration Date</NAME>
        <CATEGORY>Insurance</CATEGORY>
        <VALIDATIONRULE>Expiration date</VALIDATIONRULE>
        <PAYMENTNOTIFICATION>Warning</PAYMENTNOTIFICATION>
    </COMPLIANCEDEFINITION>
</create>

Parameters

Name Required Type Description
COMPLIANCEDEFINITION Required object Type of object to create.

COMPLIANCEDEFINITION

Name Required Type Description
COMPLIANCEDEFINITIONID Required string Unique ID for the compliance definition.
NAME Required string The compliance definition name.
CATEGORY Required string Requirement category:
  • Insurance - use for general liability insurance, workers comp insurance, etc.
  • Miscellaneous - use for permits, licenses, bonds, etc.
The category cannot be changed after a compliance definition is created.
VALIDATIONRULE Required string How compliance will be validated:
  • Expiration date
  • Document received
PAYMENTNOTIFICATION Required string Action to take when a vendor is out of compliance with this definition:
  • Ignore - no message is displayed in the UI and payments to the vendor are allowed (default)
  • Warning - display a warning on the Pay Bills page, but payments to the vendor are still allowed
  • Error - display an error message in the UI and block payments to the vendor. Payments attempted through the API will fail and an error message will be returned.
DESCRIPTION Optional string Description of the compliance definition.
STATUS Optional string Status of compliance definition.
  • active - the compliance record can be assigned to compliance types, and compliance records are validated against the definition. (default)
  • inactive - The compliance definition is not used in compliance validation, and cannot be used to create a new compliance type.
TRACKBY Optional string The objects that the compliance definition can be applied to. Vendor is currently the only option. (Default:Vendor)
GENERATERULE Optional boolean Currently non-functional.
COMPDEFENTRIES Optional array Currently non-functional.

Update a Vendor Compliance Definition

update

Update a vendor compliance definition record using COMPLIANCEDEFINITIONID or RECORDNO. If both are used, they must belong to the same record:

<update>
    <COMPLIANCEDEFINITION>
        <RECORDNO>147</RECORDNO>
        <COMPLIANCEDEFINITIONID>Ins-Exp-Date</COMPLIANCEDEFINITIONID>
        <DESCRIPTION>Use for State of California</DESCRIPTION>
    </COMPLIANCEDEFINITION>
</update>

Parameters

Name Required Type Description
COMPLIANCEDEFINITION Required object Type of object to update

COMPLIANCEDEFINITION

Name Required Type Description
RECORDNO Optional integer RECORDNO of the compliance definition to update. Required if not using COMPLIANCEDEFINITIONID.
COMPLIANCEDEFINITIONID Optional string ID of the compliance definition to update. Required if not using RECORDNO.
NAME Optional string The compliance definition name.
VALIDATIONRULE Optional string How compliance will be validated:
  • Expiration date
  • Document received
PAYMENTNOTIFICATION Optional string Action to take when a vendor is out of compliance with this definition:
  • Ignore - no message is displayed in the UI and payments to the vendor are allowed
  • Warning - display a warning on the Pay Bills page, but payments to the vendor are still allowed
  • Error - display an error message in the UI and block payments to the vendor. Payments attempted through the API will fail and an error message will be returned.
DESCRIPTION Optional string Description of the compliance definition.
STATUS Optional string Status of compliance definition.
  • active - the compliance record can be assigned to compliance types, and compliance records are validated against the definition.
  • inactive - The compliance definition is not used in compliance validation, and cannot be used to create a new compliance type.
TRACKBY Optional string The objects that the compliance definition can be applied to. Vendor is currently the only option.
GENERATERULE Optional boolean Currently non-functional.
COMPDEFENTRIES Optional array Currently non-functional.

Delete a Vendor Compliance Definition

delete

Delete a vendor compliance definition. Note that you can only delete definitions not in use by vendor compliance records or types.

<delete>
    <object>COMPLIANCEDEFINITION</object>
    <keys>148</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use COMPLIANCEDEFINITION
keys Required string Comma-separated list of compliance definition RECORDNO to delete

Provide feedback