Data Dictionary

int

auto

primary key

string

true

unique alphamumeric identifier

string

true

contact email address

string

true

user’s given name

string

true

user’s surname

datetime

auto

date and time at which the user was joined Tunga

int

type of user

developer, project_owner, project_manager, admin

string

relative local path of user’s avatar

string

current status of user’s Payoneer application

one of initial, pending, approved or declined

default: initial

string

user’s full name

string

absolute url of user’s avatar

string

display friendly representation of the user type

one of Developer, Project Owner or Project Manager

boolean

indicates is user is a developer

boolean

indicates is user is a project manager

boolean

indicates is user is a project owner/ client

boolean

indicates is user is an admin

user’s profile object

int

auto

primary key

auto

owner of the profile

string

user’s country of residence

must be an ISO 3166-1 alpha-2 country code

e.g UG for Uganda, NL - The Netherlands

string

user’s city of residence

string

user’s street of residence

string

user’s plot number of residence

string

user’s postal code of residence

string

user’s postal address of residence

string

user’s phone number

list<Skill>

a list of the user’s skills

saved and parsed as a string of comma separated values e.g

React.js, Django, "Amazon Web Services"

string

user’s vat number

string

absolute url of user’s only applies to clients

string

user’s skype id

string

full country name e.g Uganda for UG

string

string reprensentation of city object

string

City, Country location e.g Kampala, Uganda

list<Skill>

list of Skill objects

hash<list<Skill»

hash of Skill object lists where each hash key is a skill category

language, framework, platform, library, storage, api and other

int

auto

primary key

auto

user who created the company

string

registered name of the company

string

country in which company is located

must be an ISO 3166-1 alpha-2 country code

e.g UG for Uganda, NL - The Netherlands

string

city in which company is located

string

company street address

string

company plot number

string

company postal code

string

company postal address

string

company telephone number

string

company vat number

string

company registration number

string

company website

string

a brief decription of the company

list<Skill>

a list of the skills needed by the company

saved and parsed as a string of comma separated values e.g

React.js, Django, "Amazon Web Services"

string

full country name e.g Uganda for UG

string

string reprensentation of city object

string

City, Country location e.g Kampala, Uganda

list<Skill>

list of Skill objects

hash<list<Skill»

hash of Skill object lists where each hash key is a skill category

language, framework, platform, library, storage, api and other

int

auto

primary key

string

true

name of the skill or product

e.g MongoDB, JavaScript e.t.c

int

auto

primary key

auto

owner of the education info

string

true

name of the institution/ school

string

true

name of the award after e.g Bachelor of Science in Mathematics

number

true

integer for start month for duration of education award

values 1 to 12 for January to December

number

true

start year for duration of education award

number

integer for end month for duration of education award

values 1 to 12 for January to December

number

end year for duration of education award

string

true

detailed description of the education award

datetime

auto

timestamp of when the object was created

int

auto

primary key

auto

owner of the education info

string

true

name of the company

string

true

position/title of the company after e.g Senior Software Engineer

number

true

integer for start month for duration of education award

values 1 to 12 for January to December

number

true

start year for duration of education award

number

integer for end month for duration of education award

values 1 to 12 for January to December

number

end year for duration of education award

string

true

detailed description of the education award

datetime

auto

timestamp of when the object was created

int

auto

primary key

auto

user that created the project (owner by default)

string

true

brief title of the project

string

true

more detailed decription of the project

the owner of the project (overrides user when set)

project manager for the project

list<Skill>

true

a list of skills needed to complete the project

saved and parsed as a string of comma separated values e.g

React.js, Django, "Amazon Web Services"

string

budget for the project

string

auto

ISO 4217 currency code for the currency in which the payment will be made

default: EUR

string

true

type of project

one of web, mobile, other

default: other

string

type of project

one of 2w - 2 weeks, 6m - 6 months, permanent

default: none

string

stage of the project

one of opportunity, active

default: active

date

start date for the project

date

desired deadline for the project

boolean

auto

determines if surveys are enabled for this clients

default: true

boolean

auto

determines if updates are enabled for this pm

default: true

datetime

auto

timestamp of when the object was created

boolean

indicates whether the object is archived

datetime

auto

timestamp of when the object was archived

int

auto

primary key

true

Project object the document is related to

string

absolute url for the document, used for shared documents links e.g Google Drive and Dropbox

object

Uploaded file object

used for directly uploaded documents

string

true

type of document

one of

estimate, proposal, planning, requirements, wireframes, timeline, other

string

title of the document

string

description of the document

auto

user that created the document

datetime

auto

timestamp of when the object was created

string

absolute url for the document

int

auto

primary key

true

Project the user is participating to

true

participating user

string

status of the user’s participation

one of initial, accepted, rejected

default: initial

boolean

auto

determines if updates are enabled for this participant

default: true

auto

user that created the participation object

datetime

auto

timestamp of when the object was created

int

auto

primary key

true

Project the user is being polled about

true

polled user

string

status of the user’s poll

one of initial, interested, uninterested

default: initial

auto

user that created the participation object

datetime

auto

timestamp of when the object was created

int

auto

primary key

true

Project for the invoice

true

user invoicing (for tunga invoices) or being invoiced (for client and developer)

string

true

type of invoice

one of client, tunga, developer

name denotes entity being invoiced.

developer is only for historical purposes

string

title of the invoice

default: title of the project

number

true

amount that will be paid

string

auto

ISO 4217 currency code for the currency in which the payment will be made

default: EUR

number

true

tax rate as a percentage e.g 20 for 20%

number

true

processing fee that will be charged for the transaction

default: 0

auto

user that created the invoice

datetime

auto

timestamp of when the object was created

string

auto

unique invoice number for this invoice

string (uuid4)

unique reference for invoices created by a batch request e.g one payout to multiple devs

boolean

indicates whether invoice has been paid

datetime

timestamp of when payment receipt was confirmed

string

auto

one of pending, approved or canceled

default: approved for client and developer invoice types and pending for tunga invoices

setting this field to approved for tunga invoice types will trigger a payout

number

auto

tax amount calculated from the amount and tax_rate

amount * (tax_rate/100)

int

auto

primary key

true

Invoice for which the payment will be made

string

true

amount that will be paid

string

auto

ISO 4217 currency code for the currency in which the payment will be made

default: EUR

string

true

one of stripe, bank, bitcoin, bitonic

all new payments are made with either stripe or bank, However, bitcoin and bitonic are supported for historical data

datetime

timestamp of when payment receipt was confirmed

auto

user that created the payment

datetime

auto

timestamp of when the object was created

string

type of payment

one of sale, purchase

sale for client and developer invoices and purchase for tunga invoices

int

auto

primary key

true

Project object associated with the event

string

true

event type

developer = Developer Update,
pm = PM Report,
client = Client survey,
milestone = Milestone (for all),
internal = Internal Milestone (only PMs and Devs)

string

true

title of the event

string

true

description of the vent

date

true

date when a report for the event is due

datetime

auto

timestamp of when the last reminder about the event was sent to participants

datetime

auto

timestamp of when the missed notification was sent to Tunga

auto

user that created the progress event

datetime

auto

timestamp of when the object was created

boolean

auto

true if current user is a participant in event

auto

list of all event participants

int

auto

primary key

true

ProgressEvent for which the report is required

auto

user that created the progress report

datetime

auto

timestamp of when the object was created

string

yes - for developer and pm events

no - for all other cases

current status of the project or milestone

one of

onschedule, behind_progressing, behind_stuck, behind, stuck

behind and stuck are only for historical purposes

string

yes - only if status is either behind_stuck or stuck for developer and pm events

no - for all other cases

reason for being stuck if status is either behind_stuck or stuck for developer and pm events

one of

resolving_error, poor_doc, hardware_problem, unclear_spec, personal_issue, other

string

yes - only if stuck_reason is other for developer and pm events

no - for all other cases

detailed reason for being stuck if stuck_reason is other for developer and pm events

number

yes - for developer and pm events

no - for all other cases

an integer 1 to 100 representing the percentage of the project or milestone completed

string

yes - for developer and pm events

no - for all other cases

description of what has been accomplished since the last update

string

yes - for developer and pm events

no - for all other cases

description of what is now being done

date

yes - for developer and pm events

no - for all other cases

date for next deadline

boolean

yes - for developer and pm events

no - for all other cases

indicates whether the next deadline will be met

string

yes - only for developer and pm events for which next_deadline_meet is false

no - for all other cases

reason why the next deadline will not be met

number

yes - for developer and client events

no - for all other cases

an integer 1 to 5 representing the rating for what has been delivered

boolean

yes - for developer and pm events

no - for all other cases

indicates whether the last deadline was be met

boolean

yes - only for pm and client events for which last_deadline_met is false

no - for all other cases

expresses whether the last deadline miss was communicated beforehand

date

yes - for developer events

no - for all other cases

date when the project or milestone was started

string

yes - only for pm events for which last_deadline_met is false

no - for all other cases

reason why the last deadline was not be met

string

yes - only for pm events

no - for all other cases

detailed description of the team’s performance

boolean

yes - only for client events

no - for all other cases

detailed description of the team’s performance

number

yes - for client events

no - for all other cases

an integer 1 to 5 representing the rating for communication with PM and developers

string

yes - only for client events for which deliverable_satisfaction is false or rate_deliverables is lower than 3

no - for all other cases

reason why deliverable_satisfaction is false or rate_deliverables is lower than 3

string

yes - only for client events for which rate_communication is less than 3

no - for all other cases

reason why rate_communication is lower than 3

int

auto

primary key

auto

user that created the comment

string

the comment

int

id of the object the comment was added to

ContentType of the object the comment was added to

datetime

auto

timestamp of when the object was created

int

auto

primary key

Channel the message was sent in

user that sent the message

string

the message

datetime

auto

timestamp of when the object was created

json

user object for external messages e.g Slack responses

string

message source

either null or slack

json

extra details about external messages e.g from Slack

object

consolidated object representing the message sender user either user or alt_user or channel inquirer as the data source

must include id, name, display_name and short_name with optional email, avatar_url and inquirer fields

int

auto

primary key

int

auto

channel type

direct, topic, support, developer

default: topic

string

topic of the channel

int

tracks last read activity id for guests

int

id of the object the channel was created for

ContentType of the object the channel was created for

user that created the channel

datetime

auto

timestamp of when the object was created

int

auto

primary key

true

Channel the participant is part of

true

user that is participating in the channel

int

tracks last read activity id for participant

datetime

auto

timestamp of when the last email about the missed messages was sent

datetime

auto

timestamp of when the object was created

int

auto

primary key

object

Uploaded file object

user that uploaded the file

int

id of the object the file was uploaded to

ContentType of the object the file was uploaded to

datetime

auto

timestamp of when the file was uploaded