TOOLS Navbar
Json

Introduction

This document describes RedTeam’s API standards, data model, and endpoints. Endpoints may be tested using the examples in the left side of each section. Any other tool may require you to enter your API key, Client ID, Access Key and Secret Key.

Standards

Pagination

Endpoints that return multiple records use offset based pagination which uses uri parameters limit and skip query parameters. ?limit indicates the maximum number of records to return, and ?skip indicates the number of items to skip in the set of unpaginated records. If an endpoint returned 6 issues, setting ?skip to 2 and ?limit to 3 would retrieve the third, fourth, and fifth issue:

The default and maximum number for ?limit is 500, but you can request less. The default ?skip value starts from the beginning of unpaginated records and is 0.

The curl command below skips two records and returns a maximum of ten records:

cURL

The response to a request that returns multiple records is paginated and is always of the form:

[
  {
    "data": [{}, {}, {}, {}, {}, {}, {}, {}, {}, {}],
    "total_count": 14,
    "next_page_url": "...?skip=12&limit=10",
  }
]

data is the array of records matched with ?skip and ?limit, total_count is the number of unpaginated records, and next_page_url is a url to the next page of records -- it will be null if you’ve reached the last page.

If ?limit or ?skip are not positive integers or 0, the RedTeam API will return a 400 with an appropriate message.

Authentication

All request must be done using: AWS Signature for authentication using the AccessKey and SecretKey provided by RedTeam also the x-api-key is required as Header parameters.

1. Request user authorization

For authentication and establishing a new API connection, the request must be done using: AWS Signature for authentication using the AccessKey and SecretKey provided by RedTeam and the following Header and Body parameters.

  POST: "https://api.redteam.com/authenticate"  
  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
  Body Parameter: 
      '{
        "username": "your_username",
        "password": "your_password",
        "company": "your_company",
        "client_id": "your_client_id"
      }'  


HTTP REQUEST
POST https://api.redteam.com/authenticate


Header Parameters

Name Type Description
x-api-key
[Required]
string API key provides by RedTeam.


Json Body

Name Type Description
username,
password,
company,
client_id

Json
Login data and client_id provided by RedTeam.

Below is an example of a response from a successful login:

[
  {
    "type": "SUCCESS",
    "code": "a600c8ab85bb55885c72c2ba0562e797ffec6cd9450861f099338ab98f1915a5",
    "details": null
  }
]

2. Request access token

The authorization code from the previous step can be used to retrieve the access token. The request must be done using: AWS Signature for authentication using the AccessKey and SecretKey provided by RedTeam and the following Header parameters.

  POST: "https://api.redteam.com//oauth/token"  
  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      x_grant_type: 'authorization_code'
      x_code: '{{code}}'


HTTP REQUEST
POST https://api.redteam.com/oauth/token

Name Type Description
x-api-key
[Required]
string Is required.
x_grant_type
[Required]
string authorization_code
x_code
[Required]
string Result code from the previous step.

Below is an example of a response from a successful request:

[
  {
    "access_token": "bb4e2271-e99c-4f66-bc1e-698ffd744f33",
    "expires_in":  86400,
    "entered_date": "2018-11-12T12:20:01.384-05:00"
  }
]

3. Using access token

Now that you have an access token, your application can perform API requests on behalf of the user. Your header must include Authorization: Bearer access_token with the access_token from the previous steps.

cURL

4. Refreshing accessing tokens

Access tokens will periodically expire. You can use the refresh_token to request a new access token when that happens. This avoids forcing your user to re-authorize your application.

The request must be done using: AWS Signature for authentication using the AccessKey and SecretKey provided by RedTeam and the following Header parameters. If request is successful, you will receive a new access_token.

  POST: "https://api.redteam.com//oauth/token"  
  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      x_grant_type: 'refresh_token'
      x_refresh_token: '{{access_token}}'


HTTP REQUEST
POST https://api.redteam.com/oauth/token

Name Type Description
x-api-key
[Required]
string Is required.
x_grant_type
[Required]
string refresh_token
x_refresh_token
[Required]
string Expired token

Below is an example of a response from a successful request:

[
  {
    "access_token": "bb4e2271-e99c-4f66-bc1e-698ffd744f33",
    "expires_in":  86400,
    "entered_date": "2018-11-12T12:20:01.384-05:00"
  }
]

Secundary Objects

References

The above command returns JSON structured like this:

[
  {
    "Reference_ID": "14",
    "Reference_Name": null,
    "Reference_Type": "Vendor_Invoices"
  }
]

Attribute Type Description
Reference_ID string(15) Unique identifier of the annotation. Never blank
Reference_Name string(50)
Reference_Type string(20)

Lines

The above command returns JSON structured like this:

[
  {
    "Line_ID": 2,
    "Line_Description": "Invoice # 1210001-Css Contruction",
    "Line_Amount": 130.55,
    "Line_Reference": {
      "reference_ID": "32",
      "reference_Name": null,
      "reference_Type": "Vendor_Invoices"
    }
  }
]

Attribute Type Description
Line_ID int
Line_Description string
Line_Amount decimal
Line_Reference References

Roles

The above command returns JSON structured like this:

[
  {
    "id": "PM",
    "name": "Project Manager",
    "type": "ServiceProvider"
  }
]

Attribute Type Description
id string(15) Unique identifier of the annotation. Never blank
name string(50) This attribute returns the Role name.
type string(20) This attribute returns the Role type.

GET List All Roles

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/roles"

Get a list of roles. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Roles

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/roles/`{{id}}`"

Get a specific role by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of role to retrieve.

Cost_Divisions

The above command returns JSON structured like this:

[
  {
    "id": "07",
    "name": "Thermal and Moisture Protection",
    "status": "Active"
  }
]

Attribute Type Description
id string(4) Unique identifier of the annotation. Never blank
name string(50) This attribute returns the Cost Division name
status string(10) This attribute returns only these values 'Active' or 'Inactive'

GET List All Cost_Divisions

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/cost_divisions"

Get a list of cost divisions. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Cost_Divisions

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/cost_divisions/`{{id}}`"

Get a specific cost division by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of cost division to retrieve.

Company_Divisions

The above command returns JSON structured like this:

[
  {
    "id": "280",
    "name": "Wegmans Food Markets",
    "legal_name": "Wegmans Food Markets",
    "status": "Active"
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
name string(50) This attribute returns the Company Division name
legal_name string(100) This attribute returns the Company Division legal name
status string(10) This attribute returns only these values 'Active' or 'Inactive'

GET List All Company_Divisions

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/company_divisions"

Get a list of company divisions. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Company_Divisions

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/company_divisions/`{{id}}`"

Get a specific company division by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of company division to retrieve.

Cost_Codes

Cost Code is a series of alphabetical or numerical symbols each of which represents a particular labour, material or overhead cost item. Cost codes facilitate the classification and recording of costs for cost control purposes.

The above command returns JSON structured like this:

[
  {
    "id": "25",
    "number": "01721",
    "name": "Field Engineering & Layout",
    "status": "Active",
    "costDivisionRef": {
      "reference_ID":"01",
      "reference_Name":"General Requirements",
      "reference_Type":"Cost_Divisions",
    }
  }
]

Attribute Type Description
id string(15) Unique identifier of the annotation. Never blank
number string(15) Cost Code Id
name string(100) Cost Code Name
status string(3) This attribute returns only these values 'Active' or 'Inactive'
costDivisionRef References[object] Indentifier of Division for this cost code

GET List All Cost_Codes

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/cost_codes"

Get a list of cost codes. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Cost_Codes

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/cost_codes/`{{id}}`"

Get a specific cost codes by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of cost code to retrieve.

Project_Cost_Codes

Project Cost Code is a series of alphabetical or numerical symbols each of which represents a particular labour, material or overhead cost item. Cost codes facilitate the classification and recording of costs for cost control purposes.

The above command returns JSON structured like this:

[
  {
    "id": 24,
    "number": "001501-00000-L",
    "name": "Courier Service",
    "status": "Active",
    "projectRef": {
        "projectNum": "1890001",
        "scopeNum": "0"
    },
    "costCodeRef": {
        "reference_ID": "5",
        "reference_Name": "001501-00000-L - Courier Service",
        "reference_Type": "Cost_Codes"
    },
    "phaseRef": {
        "reference_ID": "61",
        "reference_Name": "1 - Phase 1",
        "reference_Type": "Project_Phase"
    }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
number string(15) Project Cost Code Number
name string(1000) Project Cost Code Name
status string(3) This attribute returns only these values 'Active' or 'Inactive'
projectRef References[object] Indentifier of Project for this project cost code
costCodeRef References[object] Indentifier of Cost Code for this project cost code
phaseRef References[object] Indentifier of Phase for this project cost code

GET List All Project_Cost_Codes

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/project_cost_codes"

Get a list of Project Cost code. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.

GET Retrieve a Project_Cost_Codes

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/project_cost_codes/`{{id}}`"

Get a specific project cost code by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of project cost code to retrieve.

Cost_Categories

Cost Categories is a series of alphabetical or numerical symbols each of which represents a particular labour, material or overhead cost item. Cost codes facilitate the classification and recording of costs for cost control purposes.

The above command returns JSON structured like this:

[
  {
      "id": 6,
      "code": "M",
      "name": "Material",
      "description": "Material",
      "status": "Active",
      "costTypeRef": {
        "reference_ID": "3",
        "reference_Name": "Material",
        "reference_Type": "CostType"
      }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
code string(15) This attribute returns the cost category code.
name string(50) This attribute returns the cost category name
description string(150) This attribute returns the cost category description
status string(3) This attribute returns only these values 'Active' or 'Inactive'
costTypeRef References[object] Indentifier of Cost Type for this Cost Category

GET List All Cost_Categories

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/cost_categories"

Get a list of cost categories. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Cost_Category

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/cost_categories/`{{id}}`"

Get a specific cost category by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of cost category to retrieve.

Project_Cost_Categories

Project Cost Categories is a series of alphabetical or numerical symbols each of which represents a particular labour, material or overhead cost item. Cost codes facilitate the classification and recording of costs for cost control purposes.

The above command returns JSON structured like this:

[
  {
      "id": 1669,
      "name": "Material",
      "status": "Active",
      "projectRef": {
        "projectNum": "2170001",
        "scopeNum": "00"
      },
      "costCategoryRef": {
        "reference_ID": "6",
        "reference_Name": "Material",
        "reference_Type": "Cost_Category"
      }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
name string(1000) This attribute returns the project cost category name.
status string(3) This attribute returns only these values 'Active' or 'Inactive'.
projectRef References[object] Indentifier of Project for this project cost code.
costCodeRef References[object] Indentifier of Cost Code for this project cost code.

GET List All Project_Cost_Categories

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/project_cost_categories/"

Get a list of project cost categories. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.

GET Retrieve a Project_Cost_Category

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/project_cost_categories/`{{id}}`"

Get a specific project cost category by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of project cost category to retrieve.

Project_Phases

Project Phases is a series of alphabetical or numerical symbols each of which represents a particular labour, material or overhead cost item. Cost codes facilitate the classification and recording of costs for cost control purposes.

The above command returns JSON structured like this:

[
  {
      "id": 2,
      "code": "01",
      "name": "DA01 edited",
      "status": "Active",
      "projectRef": {
        "projectNum": "1080007",
        "scopeNum": "00"
      }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
code string(15) This attribute returns the project phase code.
name string(1000) This attribute returns the project phase name.
status string(3) This attribute returns only these values 'Active' or 'Inactive'.
projectRef References[object] Indentifier of Project for this project phase.

GET List All Project_Phases

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/project_phases"

Get a list of project phases. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.

GET Retrieve a Project_Phase

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/project_phases/`{{id}}`"

Get a specific project phase by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of project phase to retrieve.

Customers

The above command returns JSON structured like this:

[
  {
    "id": "11",
    "name": "Above All Stoe Fronts, Inc.",
      "status": "Active",
    "phone": "407-555-1234",
    "address": "50 Gilpin Ave",
    "city": "Hauppauge",
    "state": "NY",
    "postal_code": "10455",
    "country": "USA"
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
name string(10) This attribute returns the customer name.
status string(3) This attribute returns only these values 'Active' or 'Inactive'
phone string(50) This attribute returns the customer phone.
address string(255) This attribute returns the customer address.
city string(50) This attribute returns the customer city.
state string(50) This attribute returns the customer state.
postal_code string(50) This attribute returns the customer postal code.
country string(50) This attribute returns the customer country.

GET List All Customers

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/customers"

Get a list of Customers. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Customers

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/customers/`{{id}}`"

Get a specific customer by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of customer to retrieve.

Projects

The above command returns JSON structured like this:

[
  {
    "id": "3",
    "projectnum": "1020001",
      "scopenum": "00",
    "name": "Winnie Palmer Addition",
    "manager": "Chelsea Sykes",
    "status": "InProgress",
    "substatus": "Expecting Contract",
    "market": "Commercial",
      "division": "Construction Company",
    "work_location": "101 Orange Ave.",
    "pco_requests": "35",
      "customerRef": {
      "Reference_ID":"447",
      "Reference_Name":"American Facilities",
      "Reference_Type":"Customers"
    }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
projectnum string(7) This attribute returns the identifier number entered by customer.
scopenum string(2) This attribute returns the project scope number.
name string(100) This attribute returns the project name.
manager string(150) This attribute returns the project manager.
status string(50) This attribute returns only these values 'Active' or 'Inactive'.
substatus int This attribute returns the project substatus.
market string(50) This attribute returns the project market.
division string(50) This attribute returns the project division.
work_location string(255) This attribute returns the project work location.
pco_requests int This attribute returns the project change order requests.
customerRef References[object] Indentifier of Customer for this project.

GET List All Projects

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/projects"

Get a list of projects. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.

GET Retrieve a Projects

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/projects/`{{id}}`"

Get a specific project by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of project to retrieve.

Terms

The above command returns JSON structured like this:

[
  {
    "id": "2",
    "name": "NET15",
    "description": "NET 15",
    "due": "15",
    "status": "Active"  
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
name string(20) This attribute returns the term name.
description string(100) This attribute returns the term description.
due int This attribute returns the term due.
status string(3) This attribute returns only these values 'Active' or 'Inactive'.

GET List All Terms

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/terms"

Get a list of terms. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Terms

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/terms/`{{id}}`"

Get a specific term by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of term to retrieve.

Vendors

The above command returns JSON structured like this:

[
  {
    "id": "59",
    "name": "Automatic Irigation Design",
      "status": "Active",
    "type": "Subcontractor",
    "phone": "407-555-1234",
    "address": "333 Baldwin Road",
    "city": "Hempstead",
    "state": "NY",
    "postal_code": "11550",
      "country": "USA"
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
name string(200) This attribute returns the vendor name.
status string(3) This attribute returns only these values 'Active' or 'Inactive'.
type string(50) This attribute returns the vendor type.
phone string(50) This attribute returns the vendor phone.
address string(255) This attribute returns the vendor address.
city string(50) This attribute returns the vendor city.
state string(50) This attribute returns the vendor state.
postal_Code string(50) This attribute returns the vendor postal code.
country string(50) This attribute returns the vendor country.

GET List All Vendors

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/vendors"

Get a list of vendors. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Vendors

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/vendors/`{{id}}`"

Get a specific vendor by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of vendor to retrieve.

Labor_Categories

The above command returns JSON structured like this:

[
  {
    "id": "2",
    "name": "Operations Manager",
    "rate": "67.07",
    "status": "Active",
    "companyDivisionsRef": {
      "Reference_ID":"1",
      "Reference_Name":"Construction Company",
      "Reference_Type":"Company_Divisions"
    }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
name string(100) This attribute returns the labor category name.
rate string(20) This attribute returns the labor category rate.
status string(3) This attribute returns only these values 'Active' or 'Inactive'.
companyDivisionsRef References[object] Indentifier of Company Division for this labor category.

GET List All Labor_Categories

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/labor_categories"

Get a list of labor categories. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Labor_Categories

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/labor_categories/`{{id}}`"

Get a specific labor category by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of labor category to retrieve.

Employees

The above command returns JSON structured like this:

[
  {
    "id": "5",
    "first_name": "Jeff",
    "last_name": "Roche",
    "system_admin": "yes",
    "title": "Superintendent",
    "email": "",
    "phone": "82382-3232323",
    "mobile": "407-883-2720",
    "employment_type": "Exempt",
    "hourly_rate": "40.0",
    "status": "Active",
      "laborCategoryRef": {
            "Reference_ID": "9",
        "Reference_Name": "Project Administrator",
        "Reference_Type": "Labor_Categories"
    },
      "roleRef": {
        "Reference_ID":"Admin",
        "Reference_Name":"Service Provider Administrator",
        "Reference_Type":"Roles"
    },
    "companyDivisionRef": {
        "Reference_ID":"1",
        "Reference_Name":"Construction Company",
        "Reference_Type":"Company_Divisions"
    },
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
first_name string(50) This attribute returns the employee first name.
last_name string(30) This attribute returns the employee last name.
system_admin string(15) This attribute returns only these values 'yes' or 'no'.
title string(100) This attribute returns the employee title.
email string(100) This attribute returns the employee email.
phone string(50) This attribute returns the employee phone.
mobile string(30) This attribute returns the employee mobil.
employment_type string(20) This attribute returns only these values 'Exempt' or 'Non-Exempt'
hourly_rate int This attribute returns the employee hourly rate.
status string(3) This attribute returns only these values 'Active' or 'Inactive'.
laborCategoryRef References[object] Indentifier of Labor Category for this employee.
roleRef References[object] Indentifier of Role for this employee.
companyDivisionRef References[object] Indentifier of Company Division for this employee.

GET List All Employees

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/employees"

Get a list of employees. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Employees

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/employees/`{{id}}`"

Get a specific employee by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of employee to retrieve.

Pay_Codes

The above command returns JSON structured like this:

[
  {
    "id": "2",
    "name": "Operations",
    "type": "Indirect",
    "status": "Active"
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
name string(50) This attribute returns the pay code name.
type string(25) This attribute returns the pay code type.
status string(3) This attribute returns only these values 'Active' or 'Inactive'

GET List All Pay_Codes

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/pay_codes"

Get a list of pay code. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Pay_Codes

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/lists/pay_codes/`{{id}}`"

Get a specific pay code by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of pay code to retrieve.

Customer_Contracts

The above command returns JSON structured like this:

{
  "projectRef": {
    "projectNum": "1010002",
    "scopeNum": "00"
  },
  "customerRef": {
    "reference_ID": "2",
    "reference_Name": "Wilson Fisks Development customer",
    "reference_Type": "Customers"
  },
  "contractLines": [
    {
      "date": "2017-01-05T00:00:00",
      "scope": "00",
      "description": "Original",
      "type": "TM",
      "days": "23",
      "amount": 0.00000000,
      "status": "Request"
    },
    {
      "date": "2018-06-07T00:00:00",
      "scope": "01",
      "description": "change",
      "type": "TM",
      "days": "0",
      "amount": 0.00000000,
      "status": "Request"
    },
    {
      "date": "2018-07-23T00:00:00",
      "scope": "02",
      "description": "CO6",
      "type": "TM",
      "days": "0",
      "amount": 0.00000000,
      "status": "Proposal"
    },
    {
      "date": "2019-09-11T00:00:00",
      "scope": "03",
      "description": "as",
      "type": "TM",
      "days": "0",
      "amount": 0.00000000,
      "status": "Cancelled"
    }
  ]
}

Attribute Type Description
id int Unique identifier of the annotation. Never blank.
projectRef References[object] Indentifier of Project for this customer contract.
customerRef References[object] Indentifier of customer for this customer contract.
contractLines ContractLines[] This attribute returns the lines of the customer contract.



ContractLines

Attribute Type Description
date string(10)
scope string(2)
description string(100)
type string(20)
days int
amount decimal
status string(50)

GET List all Customer_Contracts

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/customer_contracts"

Get a list of customer contracts. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Customer_Contracts

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/customer_contracts/`{{id}}`"

Get a specific Customer_Contracts by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of Customer_Contracts to retrieve.

Customer_Billings

The above command returns JSON structured like this:

[
  {
      "id": 1029,
      "reference": "001",
      "description": "",
      "invoice_date": "2020-02-17T00:00:00",
      "due_date": "2020-02-12T00:00:00",
      "expected_date": "2020-02-12T00:00:00",
      "billed": 250.0,
      "retainage": 25.0,
      "sales_tax": 0,
      "receivable": 275.00,
      "status": "Committed",
      "projectRef": {
        "projectNum": "3100005",
        "scopeNum": "00"
      }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
reference string(22)
description string(5000) This attribute returns the description.
invoice_date string(10) This attribute returns the invoice date.
due_date string(10) This attribute returns the due date.
expected_date string(10) This attribute returns the expected date.
billed float This attribute returns the billed amount.
retainage float This attribute returns the retainage.
sales_tax int This attribute returns the sales tax.
receivable float This attribute returns the receivable.
status string(10) This attribute returns only these values 'Active' or 'Inactive'.
projectRef References[object] Indentifier of Project for this customer bullings.

GET List All Customer_Billings

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/customer_billings"

Get a list of customer billing. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Customer_Billings

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/customer_billings/`{{id}}`"

Get a specific customer billing by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of customer billing to retrieve.

Customer_Receipts

The above command returns JSON structured like this:

[
  {
      "id": 130,
      "reference": "123",
      "amount": 100.0,
      "status": "Committed",
      "date": "2020-02-15T00:00:00",
      "customerRef": {
        "reference_ID": "2",
        "reference_Name": "Wilson Fisks Development customer",
        "reference_Type": "Customers"
      },
      "lines": [
        {
          "line_ID": 1,
          "line_Description": "Invoice # 1010001-002",
          "line_Amount": 100.00,
          "line_Reference": {
            "reference_ID": "4",
            "reference_Name": null,
            "reference_Type": "Customer_Billings"
          }
        }
      ]
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
reference string(50)
amount decimal This attribute returns the customer receipt amount.
status string(50) This attribute returns only these values 'Active' or 'Inactive'.
date string(20) This attribute returns the customer receipt date.
customerRef References[object] Indentifier of Customer for this customer receipt.
lines Lines[object] This attribute returns the lines of the customer receipt.



Lines

Attribute Type Description
line_ID int count increment
line_Description string
line_Amount decimal
line_Reference References[object] Customer_Billings

GET List All Customer_Receipts

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/customer_receipts"

Get a list of customer receipts. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Customer_Receipts

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/customer_receipts/`{{id}}`"

Get a specific customer receipt by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of customer receipt to retrieve.

Vendor_Commitments

The above command returns JSON structured like this:

[
  {
      "id": "061520200950582",
      "prime_scope": "00",
      "type": "PO",
      "sub_scope": "00",
      "description": "Phase T03",
      "total_amount": "23423",
      "order_number": "300007-019",
      "order_date": "2020-06-15T00:00:00",
      "start_date": "0001-01-01T00:00:00",
      "finish_date": "0001-01-01T00:00:00",
      "delivery_date": "0001-01-01T00:00:00",
      "status": "Executed",
      "projectRef": {
        "projectNum": "300007",
        "scopeNum": "00"
      },
      "vendorRef": {
        "reference_ID": "4618",
        "reference_Name": "A. Lis & Co.",
        "reference_Type": "Vendors"
      },
      "projectCostCategoriesRef": {
        "reference_ID": "6862",
        "reference_Name": "Material",
        "reference_Type": "Project_Cost_Categories"
      },
      "lines": [
        {
          "line_ID": 1,
          "line_Description": "Paiting 3.0",
          "line_Amount": 23423.0,
          "line_Reference": {
            "reference_ID": "6938",
            "reference_Name": "8500.000 - Windows",
            "reference_Type": "Project_Cost_Codes"
          }
        }
      ]
  }
]

Attribute Type Description
id string(50) Unique identifier of the annotation. Never blank
prime_scope string(2) This attribute returns the prime scope.
type int This attribute returns the commitment type.
number string(20) This attribute returns the commitment number.
sub_scope string(3) This attribute returns the commitment sub scope.
description string(100) This attribute returns the commitment description.
total_amount float This attribute returns the commitment total amount.
order_number string(50) This attribute returns the commitment order number.
order_date string(10) This attribute returns the commitment order date-
start_date string(10) This attribute returns the commitment order state.
finish_date string(10) This attribute returns the commitment finish date.
delivery_date string(10) This attribute returns the commitment delivery date.
status string(10) This attribute returns only these values 'Active' or 'Inactive'.
projectRef References[object] Indentifier of Project for this vendor commitment.
vendorRef References[object] Indentifier of Vendor for this vendor commitment.
projectCostCategoriesRef References[object] Indentifier of Project Cost Category for this vendor commitment.
Lines Lines[object]



Lines

Attribute Type Description
line_ID int count increment
line_Description string
line_Amount decimal
line_Reference References[object] Project_Cost_Codes

GET List All Vendor_Commitments

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/vendor_commitments"

Get a list of vendor commitment. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.
vendorID
integer (optional) Vendor ID.

GET Retrieve a Vendor_Commitments

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/vendor_commitments/`{{id}}`"

Get a specific vendor commitment by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of vendor commitment to retrieve.

Employee_Commitments

The above command returns JSON structured like this:

[
  {
      "id": "002623202085637",
      "prime_scope": "00",
      "type": "LA",
      "sub_scope": "00",
      "description": "General Liability Insurance",
      "total_amount": "10000",
      "order_number": "300007-002",
      "order_date": "2020-06-23T00:00:00",
      "start_date": "2020-06-01T00:00:00",
      "finish_date": "2020-06-27T00:00:00",
      "delivery_date": "0001-01-01T00:00:00",
      "status": "Committed",
      "projectCostCategoryRef": {
        "reference_ID": "6985",
        "reference_Name": "Labor",
        "reference_Type": "Project_Cost_Category"
      },
      "projectRef": {
        "projectNum": "300007",
        "scopeNum": "00"
      },
      "employeeRef": {
        "reference_ID": "1647",
        "reference_Name": "Carlos Avalos",
        "reference_Type": "Employee"
      },
      "lines": [
        {
          "line_ID": 1,
          "line_Description": "Avalos, Carlos (Project Manager Principal)",
          "line_Amount": 10000.0,
          "line_Reference": {
            "reference_ID": "6869",
            "reference_Name": "8000.000 - DOORS & WINDOWS",
            "reference_Type": "Project_Cost_Codes"
          }
        }
      ]
  }
]

Attribute Type Description
id string(50) Unique identifier of the annotation. Never blank
prime_scope string(2) This attribute returns the commitment prime scope.
type int This attribute returns the commitment type.
sub_scope string(3) This attribute returns the commitment sub scope.
description string(100) This attribute returns the commitment description.
total_amount float This attribute returns the commitment total amount.
order_number string(50) This attribute returns the commitment order number.
order_date string(10) This attribute returns the commitment order date.
start_date string(10) This attribute returns the commitment start date.
finish_date string(10) This attribute returns the commitment finish date.
delivery_date string(10) This attribute returns the commitment delivery date.
status string(10) This attribute returns only these values 'Active' or 'Inactive'.
projectCostCategoryRef References[object] Indentifier of Project Cost Category for this vendor commitment.
projectRef References[object] Indentifier of Project for this vendor commitment.
employeeRef References[object] Indentifier of Employee for this vendor commitment.
lines Lines[object]



Lines

Attribute Type Description
line_ID int count increment
line_Description string
line_Amount decimal
line_Reference References[object] Project_Cost_Codes

GET List All Employee_Commitments

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/employee_commitments"

Get a list of employee commitment. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.
employeeID
integer (optional) Employee ID.

GET Retrieve a Employee_Commitments

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/employee_commitments/`{{id}}`"

Get a specific employee commitment by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of employee commitment to retrieve.

Vendor_Invoices

The above command returns JSON structured like this:

[
  {
      "id": 2911,
      "reference": "Invoice attachment",
      "status": "Committed",
      "date": "2020-06-12T00:00:00",
      "period_ending": "2020-06-12T00:00:00",
      "invoiced": 2153.0,
      "approved": 200.0,
      "retained": 0.0,
      "sales_tax": 0.00000000,
      "authorized": 200.0,
      "projectRef": {
        "projectNum": "300007",
        "scopeNum": "00"
      },
      "vendorRef": {
        "reference_ID": "4618",
        "reference_Name": "Aristocrat Pant Contracting",
        "reference_Type": "Vendors"
      },
      "commitmentRef": {
        "reference_ID": "061220201530200",
        "reference_Name": null,
        "reference_Type": "Vendor_Commitments"
      },
      "projectCostCodeRef": {
        "reference_ID": "6936",
        "reference_Name": "8000.000 - DOORS & WINDOWS",
        "reference_Type": "Project_Cost_Codes"
      },
      "projectCostCategoryRef": {
        "reference_ID": "6862",
        "reference_Name": "Material",
        "reference_Type": "Project_Cost_Categories"
      },
      "lines": [
        {
          "vI_ChangeInProgress": 100.00,
          "vI_ChangeInTax": 0.00
        },
        {
          "vI_ChangeInProgress": 100.00,
          "vI_ChangeInTax": 0.00
        }
      ]
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
reference string(20) This attribute returns the invoice reference.
status string(10) This attribute returns only these values 'Active' or 'Inactive'.
date date This attribute returns the invoice date.
period_ending date This attribute returns the invoice perdiod ending.
invoiced float This attribute returns the invoice invoiced amount.
approved float This attribute returns the invoice approved amount.
retained float This attribute returns the invoice retained amount.
sales_tax float This attribute returns the invoice sales tax.
authorized float This attribute returns the invoice authorized amount.
projectRef References[object] Indentifier of Project for this vendor invoice.
vendorRef References[object] Indentifier of Vendor for this vendor invoice.
commitmentRef References[object] Indentifier of Commitment for this vendor invoice.
projectCostCodeRef References[object] Indentifier of Project Cost Code for this vendor invoice.
projectCostCategoryRef References[object] Indentifier of Project Cost Category for this vendor invoice.
Lines VendorInvoiceLines



VendorInvoiceLines

Attribute Type Description
vI_ChangeInProgress decimal count increment
vI_ChangeInTax decimal

GET List All Vendor_Invoices

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/vendor_invoices"

Get a list of vendor invoices. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.
vendorID
integer (optional) Vendor ID.

GET Retrieve a Vendor_Invoices

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/vendor_invoices/`{{id}}`"

Get a specific vendor invoice by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of vendor invoice to retrieve.

Vendor_Payments

The above command returns JSON structured like this:

[
  {
      "id": 1292,
      "reference": "Check 002",
      "status": "Draft",
      "amount": 3143.79,
      "date": "2020-02-15T00:00:00",
      "vendorRef": {
        "reference_ID": "5",
        "reference_Name": "Michael Obama",
        "reference_Type": "Vendors"
      },
      "lines": [
        {
          "line_ID": 1,
          "line_Description": "Invoice # 1130005-004/0924-01",
          "line_Amount": 1301.35,
          "line_Reference": {
            "reference_ID": "1313",
            "reference_Name": null,
            "reference_Type": "Vendor_Invoices"
          }
        },
        {
          "line_ID": 1,
          "line_Description": "Invoice # 78814/25-360",
          "line_Amount": 18442.44,
          "line_Reference": {
            "reference_ID": "1313",
            "reference_Name": null,
            "reference_Type": "Vendor_Invoices"
          }
        }
      ]
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
reference string(15) This attribute returns the payment reference.
status string(20) This attribute returns only these values 'Active' or 'Inactive'.
amount decimal This attribute returns the vendor payment amount.
date string(25) This attribute returns the vendor payment date.
vendorRef References[object] Indentifier of Vendor for this vendor payment.
lines Lines[]



Lines

Attribute Type Description
line_ID int count increment
line_Description string
line_Amount decimal
line_Reference References[object] Vendor_Invoices

GET List All Vendor_Payments

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/vendor_payments"

Get a list of vendor payments. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.
vendorID
integer (optional) Vendor ID.

GET Retrieve a Vendor_Payments

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/vendor_payments/`{{id}}`"

Get a specific vendor payment by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of vendor payment to retrieve.

Employee_Times

The above command returns JSON structured like this:

[
  {
      "id": 2939,
      "co_code": "333",
      "start_date": "2020-06-24T00:00:00",
      "finish_date": "2020-06-24T00:00:00",
      "hours": "1.0000",
      "salary": "50.00",
      "wc": "5403",
      "status": "Active",
      "laborCategoryRef": {
        "reference_ID": "4",
        "reference_Name": "Project Coordinator",
        "reference_Type": "Labor_Categories"
      },
      "employeeRef": {
        "reference_ID": "1647",
        "reference_Name": "Betsabe Capcha",
        "reference_Type": "Employees"
      },
      "projectRef": {
        "projectNum": "1020007",
        "scopeNum": "00"
      },
      "payCodeRef": null,
      "projectCostCodeRef": {
        "reference_ID": "496",
        "reference_Name": "030000 - Concrete",
        "reference_Type": "Project_Cost_Codes"
      }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
co_code string(50)
start_date datetime This attribute returns the employee time start date.
finish_date datetime This attribute returns the employee time finish date.
hours int This attribute returns the employee time hours.
salary int This attribute returns the employee time salary.
wc int This attribute returns the employee time wc.
status string(10) This attribute returns only these values 'Active' or 'Inactive'
laborCategoryRef References[object] Indentifier of Labor Category Code for this employee time.
employeeRef References[object] Indentifier of Employee for this employee time.
projectRef References[object] Indentifier of Porject for this employee time.
payCodeRef References[object] Indentifier of Pay Code for this employee time.
projectCostCodeRef References[object] Indentifier of Project Cost Code for this employee time.

GET List All Employee_Times

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/employee_times"

Get a list of employee times. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.
employeeID
integer (optional) Employee ID.

GET Retrieve a Employee_Times

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/employee_times/`{{id}}`"

Get a specific employee time by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of employee time to retrieve.

Employee_Expenses

The above command returns JSON structured like this:

[
  {
      "id": 390,
      "co_code": "",
      "description": "Lunch for Travel",
      "date": "2020-06-23T00:00:00",
      "amount": "850",
      "paid_by": "2",
      "status": "Draft",
      "employeeRef": {
        "reference_ID": "1647",
        "reference_Name": "David Doe",
        "reference_Type": "Employee"
      },
      "employeeCommitmentRef": {
        "reference_ID": "062320200857512",
        "reference_Name": null,
        "reference_Type": "Employee_Commitments"
      },
      "payCodeRef": {
        "reference_ID": "18",
        "reference_Name": "Marketing Materials",
        "reference_Type": "Pay_Code"
      },
      "projectCostCodeRef": {
        "reference_ID": "6936",
        "reference_Name": "8000.000 - DOORS & WINDOWS",
        "reference_Type": "Project_Cost_Codes"
      }
  }
]

Attribute Type Description
id int Unique identifier of the annotation. Never blank
co_code string(10) This attribute returns the employee expense co code.
description string(1000) This attribute returns the employee expense description.
date datetime This attribute returns the employee expense date.
amount decimal This attribute returns the employee expense amount.
paid_by int This attribute returns the employee expense paid by type.
status string(10) This attribute returns only these values 'Active' or 'Inactive'.
employeeRef References[object] Indentifier of Employee for this employee expense.
employeeCommitmentRef References[object] Indentifier of Employee Commitment for this employee expense.
payCodeRef References[object] Indentifier of Pay Code for this employee expense.
projectCostCodeRef References[object] Indentifier of Project Cost Code for this employee expense.

GET List All Employee_Expenses

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/employee_expenses"

Get a list of employee expense. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.
projectNum
string(30) (optional) Project number.
employeeID
integer (optional) Employee ID.

GET Retrieve a Employee_Expenses

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/employee_expenses/`{{id}}`"

Get a specific employee expenses by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of employee expense to retrieve.

Non_Commitment_Costs

The above command returns JSON structured like this:

[
  {
      "id": 9864,
      "scope": "00",
      "category": "DM",
      "date": "2020-05-06T00:00:00",
      "amount": "280.00",
      "payee": "AltGr Inc",
      "description": "Distribution 1",
      "projectRef": {
        "projectNum": "2510003",
        "scopeNum": "00"
      },
      "projectCostCodeRef": {
        "reference_ID": "6895",
        "reference_Name": "000233  - CONCRETE",
        "reference_Type": "Project_Cost_Codes"
      }
  }
]

Attribute Type Description
id string(15) Unique identifier of the annotation. Never blank
scope string(2) This attribute returns the non commitment cost scope.
category string(50) This attribute returns the non commitment cost category.
date string(50) This attribute returns the non commitment cost date.
amount string(50) This attribute returns the non commitment cost amount.
payee string(50) This attribute returns the non commitment cost payee.
description string(50) This attribute returns the non commitment cost description.
projectRef References[object] Indentifier of Project for this non commitment cost.
projectCostCodeRef References[object] Indentifier of Project Cost Code for this non commitment cost.

GET List All Non_Commitment_Costs

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/non_commitment_costs"

Get a list of non commitment cost. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.

GET Retrieve a Non_Commitment_Costs

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/non_commitment_costs/`{{id}}`"

Get a specific non commitment cost by unique identifier.

Path Params Description
id
[required]
string
Unique identifier of non commitment cost to retrieve.

Estimate_At_Complete

The above command returns JSON structured like this:

[
  {
      "project": "1020002",
      "description": "Wayfair Waterfront Condos",
      "actual_start": "",
      "anticipated_finish": "TBD",
      "contract": "1135031.750000000",
      "direct_labor": "112000.000000000",
      "direct_material": "62343.000000000",
      "direct_subcontract": "878998.000000000",
      "direct_equipment": "0.000000000",
      "total_direct_cost": "1053341.000000000",
      "estimated_gross_profit": "81690.750000000",
      "total_indirect_cost": "105334.100000000",
      "estimated_profit": "-23643.350000000",
      "manager": "RMorton"
  }
]

Attribute Type Description
project string(50)
description string(50)
actual_start string(50)
anticipated_finish string(50)
contract string(50)
direct_labor string(50)
direct_material string(50)
direct_subcontract string(50)
direct_equipment string(50)
total_direct_cost string(50)
estimated_gross_profit string(50)
total_indirect_cost string(50)
estimated_profit string(50)
manager string(50)

GET List All Estimate_At_Complete

  Authorization: 'AWS Signature'
  Header Parameter: 
      x-api-key: '{{api_key}}'
      access-token: '{{access-token}}'

  GET: "https://api.redteam.com/transactions/estimate_at_complete"

Get a list of estimate at complete. Results are paginated, see Pagination for details on how pagination works. We get maximun 500 records by query.

Query Params Type Description
limit
integer 500 (optional) Number of records to retrieve. Maximum value of 500.
skip
integer 0 (optional) Number of records to skip in the set of results.