Rate tables

A project contract rate table provides markup and pricing information to be used for generating Project Generated Invoices. Every rate table can have lines for each transaction type that identify the criteria to use when applying markup and pricing for that transaction type. The transaction types include timesheets, purchase orders, accounts payable, general ledger, credit cards, and employee expenses.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List rate tables

get/objects/construction/rate-table

Returns up to 100 object references from the collection with a key, ID, and link for each rate table. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "84",
      • "id": "RT-00001",
      • "href": "/objects/construction/rate-table/84"
      },
    • {
      • "key": "85",
      • "id": "RT-00002",
      • "href": "/objects/construction/rate-table/85"
      },
    • {
      • "key": "60",
      • "id": "RT-00003",
      • "href": "/objects/construction/rate-table/60"
      },
    • {
      • "key": "78",
      • "id": "RT-00004",
      • "href": "/objects/construction/rate-table/78"
      },
    • {
      • "key": "79",
      • "id": "RT-00005",
      • "href": "/objects/construction/rate-table/79"
      }
    ],
  • "ia::meta": {
    • "totalCount": 5,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a rate table
post/objects/construction/rate-table
Creates a new rate table.


SecurityOAuth2 
Request 
Request Body schema: application/json
Rate table to be created


id
required
string  <= 20 characters 
Rate table ID


 
 Example:  "2021-LV2"
name
required
string  <= 200 characters 
Rate table name.


 
 Example:  "2021 Level 2"
description
string  <= 1000 characters 
Description of the rate table.


 
 Example:  "2021 Level 2 Rate Table"
object
 
key
string
Location Key


 
 Example:  "1"
id
string
Location


 
 Example:  "US"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Timesheet lines for the rate table.


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Costing Kit"
startDate
string <date> 
Start date


 
 Example:  "2021-08-03"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "8.250"
laborRate
string <decimal-precision-3> 
Labor rate


 
 Example:  "115.500"
object
 
object
 
object
 
object
 
object
 
object
 
object
 
object
 
object
 
Array of objects
Rate table purchase order lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Costing SOPA"
startDate
string <date> 
Start date


 
 Example:  "2021-08-03"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "15.9"
unitPrice
string <decimal-precision-3> 
Unit price


 
 Example:  "112.560"
object
 
object
 
object
 
object
 
Array of objects
Rate table accounts payable lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Service"
startDate
string <date> 
Start date


 
 Example:  "2021-08-01"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "25.5"
object
 
object
 
object
 
object
 
Array of objects
Rate table general ledger lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug John Smith"
startDate
string <date> 
Start date


 
 Example:  "2021-08-01"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "12.500"
object
 
object
 
object
 
object
 
Array of objects
Rate table credit card lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Costing SOPA"
startDate
string <date> 
Start date


 
 Example:  "2021-08-03"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "15.900"
object
 
object
 
object
 
object
 
Array of objects
Rate table employee expense lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Manager"
startDate
string <date> 
Start date


 
 Example:  "2021-08-02"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "14.800"
object
 
object
 
object
 
object
 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "2021-LV2",
  • "name": "2021 Level 2",
  • "description": "2021 Level 2 Rate Table",
  • "location": {
    • "key": "1"
    },
  • "status": "active",
  • "timesheetLines": {
    • "lineNumber": 1,
    • "description": "Aug Costing Kit",
    • "startDate": "2021-08-03",
    • "markupPercent": "8.250",
    • "laborRate": "115.500",
    • "accumulationType": {
      • "key": "2"
      },
    • "standardCostType": {
      • "key": "33"
      },
    • "standardTask": {
      • "key": "3"
      },
    • "employeePosition": {
      • "key": "2"
      },
    • "laborClass": {
      • "key": "2"
      },
    • "laborShift": {
      • "key": "2"
      },
    • "laborUnion": {
      • "key": "2"
      },
    • "timeType": {
      • "key": "1"
      },
    • "dimensions": {
      • "employee": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "item": {
        },
      • "warehouse": {
        },
      • "class": {
        },
      • "task": {
        }
      }
    },
  • "purchasingLines": {
    • "lineNumber": 1,
    • "description": "Aug Costing SOPA",
    • "startDate": "2021-08-03",
    • "markupPercent": "15.900",
    • "unitPrice": "112.560",
    • "accumulationType": {
      • "key": "2"
      },
    • "standardCostType": {
      • "key": "33"
      },
    • "standardTask": {
      • "key": "3"
      },
    • "dimensions": {
      • "employee": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "item": {
        },
      • "warehouse": {
        },
      • "class": {
        },
      • "task": {
        }
      }
    },
  • "accountsPayableLines": {
    • "lineNumber": 1,
    • "description": "Aug Service",
    • "startDate": "2021-08-01",
    • "markupPercent": "25.500",
    • "accumulationType": {
      • "key": "2"
      },
    • "standardCostType": {
      • "key": "33"
      },
    • "standardTask": {
      • "key": "3"
      },
    • "dimensions": {
      • "employee": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "item": {
        },
      • "warehouse": {
        },
      • "class": {
        },
      • "task": {
        }
      }
    },
  • "journalLines": {
    • "lineNumber": 1,
    • "description": "Aug John Smith",
    • "startDate": "2021-08-01",
    • "markupPercent": "12.500",
    • "accumulationType": {
      • "key": "2"
      },
    • "standardCostType": {
      • "key": "33"
      },
    • "standardTask": {
      • "key": "3"
      },
    • "dimensions": {
      • "employee": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "item": {
        },
      • "warehouse": {
        },
      • "class": {
        },
      • "task": {
        }
      }
    },
  • "creditCardLines": {
    • "lineNumber": 1,
    • "description": "Aug Costing SOPA",
    • "startDate": "2021-08-03",
    • "markupPercent": "15.900",
    • "accumulationType": {
      • "key": "2"
      },
    • "standardCostType": {
      • "key": "33"
      },
    • "standardTask": {
      • "key": "3"
      },
    • "dimensions": {
      • "employee": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "item": {
        },
      • "warehouse": {
        },
      • "class": {
        },
      • "task": {
        }
      }
    },
  • "employeeExpenseLines": {
    • "lineNumber": 1,
    • "description": "Aug Manager",
    • "startDate": "2021-08-02",
    • "markupPercent": "14.800",
    • "accumulationType": {
      • "key": "2"
      },
    • "standardCostType": {
      • "key": "33"
      },
    • "standardTask": {
      • "key": "3"
      },
    • "dimensions": {
      • "employee": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "item": {
        },
      • "warehouse": {
        },
      • "class": {
        },
      • "task": {
        }
      }
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "111",
    • "href": "/objects/construction/rate-table/111"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a rate table
get/objects/construction/rate-table/{key}
Returns detailed information for a specified rate table.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the rate table.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "145",
    • "id": "2021-LV2",
    • "name": "2021 Level 2",
    • "description": "2021 Level 2 Rate Table",
    • "location": {
      • "key": "1",
      • "id": "1",
      • "name": "United States"
      },
    • "audit": {
      • "createdDateTime": "2014-01-08T11:28:12Z",
      • "modifiedDateTime": "2014-01-08T11:28:12Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      },
    • "status": "active",
    • "timesheetLines": [
      • {
        }
      ],
    • "purchasingLines": [
      • {
        }
      ],
    • "accountsPayableLines": [
      • {
        }
      ],
    • "journalLines": [
      • {
        }
      ],
    • "creditCardLines": [
      • {
        }
      ],
    • "employeeExpenseLines": [
      • {
        }
      ]
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a rate table
patch/objects/construction/rate-table/{key}
Updates an existing rate table by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the rate table.


 
Request Body schema: application/json
name
string  <= 200 characters 
Rate table name.


 
 Example:  "2021 Level 2"
description
string  <= 1000 characters 
Description of the rate table.


 
 Example:  "2021 Level 2 Rate Table"
object
 
key
string
Location Key


 
 Example:  "1"
id
string
Location


 
 Example:  "US"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Array of objects
Timesheet lines for the rate table.


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Costing Kit"
startDate
string <date> 
Start date


 
 Example:  "2021-08-03"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "8.250"
laborRate
string <decimal-precision-3> 
Labor rate


 
 Example:  "115.500"
object
 
object
 
object
 
object
 
object
 
object
 
object
 
object
 
object
 
Array of objects
Rate table purchase order lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Costing SOPA"
startDate
string <date> 
Start date


 
 Example:  "2021-08-03"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "15.9"
unitPrice
string <decimal-precision-3> 
Unit price


 
 Example:  "112.560"
object
 
object
 
object
 
object
 
Array of objects
Rate table accounts payable lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Service"
startDate
string <date> 
Start date


 
 Example:  "2021-08-01"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "25.5"
object
 
object
 
object
 
object
 
Array of objects
Rate table general ledger lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug John Smith"
startDate
string <date> 
Start date


 
 Example:  "2021-08-01"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "12.500"
object
 
object
 
object
 
object
 
Array of objects
Rate table credit card lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Costing SOPA"
startDate
string <date> 
Start date


 
 Example:  "2021-08-03"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "15.900"
object
 
object
 
object
 
object
 
Array of objects
Rate table employee expense lines


 
 Array 
lineNumber
integer
Line number


 
 Example:  1
description
string  <= 1000 characters 
Description


 
 Example:  "Aug Manager"
startDate
string <date> 
Start date


 
 Example:  "2021-08-02"
markupPercent
string <decimal-precision-3> 
Markup %. Defaults to 0%.


 
 Example:  "14.800"
object
 
object
 
object
 
object
 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "145",
  • "description": "2021 Level 2 Rate Table (Aug)",
  • "timesheetLines": [
    • {
      • "key": "12",
      • "lineNumber": 2,
      • "description": "Aug Costing Kit (Aug)"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "2021-LV2",
    • "href": "/objects/construction/rate-table/12"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a rate table
delete/objects/construction/rate-table/{key}
Deletes a rate table.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the rate table.


 
Responses 
204
No Content


Request samples 
Query rate tables
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "construction/rate-table"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}