The following data types are returned by numerous Elance Developer API methods, particularly the Manage, Workroom, and Pay methods.

For JSON responses, unless otherwise specified, all parameters are returned as JSON string types. The value in the Data Type column denotes the type to which the property can safely be cast. 

tableofcontents_number_textJobData

Property Data Type Description
jobid integer The unique integer ID assigned to this job.
userType string The role performed by this user within the associated project.
name string The name of the job.
description string A long description of the job and what it entails.
budget string The budget allocated for this job.
startDate date When bidding for this job began, in the format DD-MON-YY.
endDate date When bidding for this job ends, in the format DD-MON-YY.
category string The category to which this job belongs.
numProposals integer The number of proposals made for this job.
numNewProposals integer The number of new proposals for this job. Returned by workroom/getProposals and workroom/getProposalDetails.
numUnreadMessages integer The number of unread messages associated with this job.
phase string The current phase of the project.
status string The current status of the project. Intended as a display value only; the possible return values may change without notice.
isHourly boolean (JSON true or false) True if the job is paid on an hourly basis; otherwise, false.
jobURL URL The URL to the full description of this job on the Elance Web site. 

tableofcontents_number_textBidData

Property Data Type Description
bidId integer The unique integer ID assigned to this bid.
jobId integer The unique integer ID assigned to this job.
jobName string The name of this job.
userType string The user's role in this project.
clientName string The company name of the client.
clientImageURL URL The URL of the image that shows in search results for the client.
clientCountry string The client's country.
clientCountryCode string The alpha-2 country code for the client's country of residence, as specified by ISO 3166-1.
clientCity string The client's city.
providerName string The provider's company name.
providerImageURL URL The URL of the image that appears in search results for the provider.
providerCountry string The provider's country name.
providerCountryCode string The alpha-2 country code for the provider's country of residence, as specified by ISO 3166-1.
providerCity string The provider's city.
phase string The current phase of the project.
status string The current status of the project. This value is meant for display purposes only; the strings returned may change without notice at any time.
isHourly boolean (JSON true or false) Whetehr the project is paid on an hourly basis, or on a project basis. If true, the project is paid hourly.
isSponsored boolean (JSON true or false) Whether this proposal was sponsored.
isPreBid boolean (JSON true or false) Whether this proposal is a pre-bid, or a submitted bit. If true, it is a pre-bid.
proposalText string The text of the proposal as submitted by the provider. Returned by workroom/getProposalDetails.
bidAmount integer Represents the total bid amount for fixed price projects. When returned by manage/getMyProviders or manage/getMyProvider, may also represent the hourly rate for hourly projects.
hourlyRate integer The number of authorized hours per week. Only set for hourly jobs; will be 0 for fixed-price jobs.
hoursPerWeek integer The number of authorized hours per week. Only set for hourly jobs; will be 0 for fixed-price jobs.
duration integer (JSON number) The number of weeks this project will last. Only set for hourly jobs.
submissionDate timestamp (JSON number) The date this bid was submitted, expressed as seconds elapsed since January 1st, 1970. Returned by workroom/getProposalDetails.
deliveryTimeline DeliveryTimeline enumeration The expected time frame for completion of the project's final deliverable.
numUnreadMessages integer The number of unread private messages associated with this Workroom.
attachments integer The number of files attached to this Workroom.
numUnreadMessages integer (JSON number) The number of unread messages in the Workroom. Returned by workroom/getProposalDetails.
attachments Array of Attachment objects, defined below Any files attached to this bid. 

tableofcontents_number_textScreenData

Property Data Type Description
screenId integer The unique ID assigned to this screen capture.
screenURL URL The URL to the full-sized screen image on the Elance Web site.
thumbURL URL The URL to the thumbnail-sized version of the screen image. The dimensions of the thumbnail are 320px by 240px.
tileURL URL The URL to the tile-sized version of the screen image. The dimensions of this image are 140px by 105px.
timestamp timestamp (JSON number) The date and time this screen capture was taken, expressed as seconds since January 1st, 1970.
date date The day this screen capture was taken (e.g., 22-APR-2010).
userId integer The unique integer ID of the provider whose screen was captured.
userName string The unique name of the provider whose screen was captured..
companyName string The name of the provider's company.
logoURL string A URL to the provider's company logo.
numComments integer (JSON number) The number of comments that are logged with this screen capture.
comments array of Comment objects The comments input by this provider during the course of their work.
bidData A BidData object, as described above The optional data for the associated bid.  

tableofcontents_number_textComment Data

Property Data Type Description
text string The text of the comment input by the provider.
name string The name of the provider who logged this comment.
timestamp timestamp The day and time this comment was logged, expressed as second elapsed since January 1st, 1970. 

tableofcontents_number_textAttachments

Property Data Type Description
name string The name of the attached file.
extension string The three-letter file extension.
iconURL URL The URL to the file's icon. The dimensions of an icon are 25px by 25px.
fileURL URL The full URL to the file hosted on the Elance Web site.
thumbURL URL Set for image files. The URL to the thumbnail of the image. The dimensions of the thumbnail are 320px by 240px.
tileURL URL Set for image files. The URL to the tile-sized version of the image. The dimensions of the thumbnail are 140px by 105px.
size string The size of the file, expressed in bytes. 

tableofcontents_number_textTimesheetData

Value Data Type Description
id integer The unique ID assigned by Elance to this Timesheet record.
week Date The week to which this Timesheet applies, expressed as the date of the week-ending Sunday. Format is DD-MMM-YYYY; e.g., 24-APR-2010.
bidId integer The unique ID of this Timesheet's Workroom.
provider string The unique Elance username, chosen by the user, corresponding to the provider who is working this job.
client string The unique Elance username, chosen by the user, corresponding to the client who was hired for this job.
providerUserId integer The unique ID, assigned by Elance, corresponding to the provider who was hired for this job.
clientUserId integer The unique ID, assigned by Elance, corresponding to the client who was hired for this job.
status string One of the values of TimesheetStatuses indicating whether the current Timesheet has been filed and/or paid.
projectStatus string One of the values of the TimesheetProjectStatuses enumeration indicating whether the current project is on track, has been completed, or has encountered a problem.
projectStatusDescription string An optional longer summary of the current status of the project, provided by the provider.
projectStatusChangedBy string One of the values of the User Type enumeration indicating whether the project status was most recently changed by the client or by the provider (provider).
projectStatusReason string The reason the client or customer has filed the current status report. May be blank.
projectStatusComment string Extended explanation of project status provided by client or provider. May be blank.
planComment string The status description supplied by the provider at the time the Timesheet was filed.
startDate timestamp The starting day and time for the Timesheet.
endDate timestamp The ending day and time for the Timesheet.
nextEndDate timestamp The ending day and time for next week's Timesheet.
submitDate timestamp The day and time that this Timesheet was submitted for processing. If this value is absent from an API response, it indicates that the Timesheet has not yet been submitted.
sentDate timestamp The day and time that this Timesheet was sent to the client; after this point, the Timesheet is locked, and only the total hours may be edited. If this value is absent from an API response, it indicates that the Timesheet has not yet been sent.
approveByDate timestamp The day and time by which the Timesheet must be approved by the client before it is automatically approved.
autoPayDate timestamp The day and time after which AutoPay may be executed on a Timesheet. Typically, AutoPay occurs within 24 hours of this value. 

tableofcontents_number_textStatusReportData

Value Data Type Description
id integer The unique integer, assigned by Elance, to this Status Report.
approveByDate timestamp The day and time by which the Timesheet must be approved by the client before it is automatically approved.
week Date The week to which this Status Report applies, expressed as the date of the week-ending Sunday. Format is DD-MMM-YYYY; e.g., 24-APR-2010.
bidId integer The unique ID of this Status Report's Workroom.
provider string The unique Elance username, chosen by the user, corresponding to the provider who is working this job.
client string The unique Elance username, chosen by the user, corresponding to the client who was hired for this job.
providerUserId integer The unique ID, assigned by Elance, corresponding to the provider who was hired for this job.
clientUserId integer The unique ID, assigned by Elance, corresponding to the client who was hired for this job.
status string One of the values of StatusReportStatuses indicating whether the current Status Report has been filed.
projectStatus string One of the values of the StatusReportProjectStatuses enumeration indicating whether the current project is on track, has been completed, or has encountered a problem.
projectStatusDescription string An optional longer summary of the current status of the project, provided by the provider.
projectStatusChangedBy string One of the values of the User Type enumeration indicating whether the project status was most recently changed by the client or by the provider (provider).
projectStatusReason string The reason the client or customer has filed the current Status Report. May be blank.
projectStatusComment string Extended explanation of project status provided by client or provider. May be blank.
planComment string The status description supplied by the provider at the time the Status Report was filed.
startDate timestamp The starting day and time for the Status Report.
endDate timestamp The ending day and time for the Status Report.
nextEndDate timestamp The ending day and time for next week's Status Report.
submitDate timestamp The day and time that this Status Report was submitted for processing. If this value is absent from an API response, it indicates that the Status Report has not yet been submitted.
sentDate timestamp The day and time that this Status Report was sent to the client; after this point, the Status Report is locked, and only the total hours may be edited. If this value is absent from an API response, it indicates that the Status Report has not yet been sent.
approveByDate timestamp The day and time by which the Status Report must be approved by the client before it is automatically approved.
totalHours decimal The number of hours entered or automatically tracked for the provider for the week. This field is only available to providers.
overdue boolean true if the Status Report was filed past the deadline for the specified period; otherwise, false.
seenByClient boolean true if the client has requested to view the Status Report; otherwise, false.
invoiceIDs array (integer) The IDs for the BillingData or InvoiceData objects associated with this Status Report. 

tableofcontents_number_textStatusReportCommentData

Value Data Type Description
parentID integer The unique ID of the TimesheetData or StatusReportData object associated with this Status Report comment.
userID integer The unique ID, assigned by Elance, of the user who posted this Status Report comment.
date Date The day on which the comment was logged.
comment string The text of the comment entered by the user.
projectStatus string One of the values of the StatusReportProjectStatuses enumeration indicating whether the current project is on track, has been completed, or has encountered a problem.
projectStatusDescription string An optional longer summary of the current status of the project, provided by the provider.
projectStatusReason string The reason the client or customer has filed the current Status Report. May be blank. 

tableofcontents_number_textWorkItemData

Value Data Type Description
parentId integer The ID of the StatusReportData or TimesheetData object to which this work item entry belongs.
workUnitId The ID of the type of unit of work for this work item. A value of 1 indicates an Hourly Milestone work item, a value of 2 indicate an Hourly Other work item, and any values greater than 2 indicates a custom work item type.
userId integer The user to whom this work item belongs. Will always be the user ID of a provider belonging to the team that was awarded the associated job.
userName string The unique text handle of the user who owns this work item.
day Date The day, month and year on which this work item was logged, rendered in the format DD-MON-YYYY.
type string The kind of work item, expressed as one of the text values of the WorkItemTypes enumeration.
status string A text value from the WorkItemStatuses enumeration describing whether the associated Status Report or Timesheet has been submitted.
description string An explanation of the work item's meaning, as entered by the provider.
quantity integer Either the amount of time worked for this work increment, or the number of work products produced.
milestoneId integer The corresponding unique integer ID of the MilestoneData object with which this work item is associated. This property will only be set if the type property is "Hourly Milestone". 

tableofcontents_number_textProgressItemData

Value Data Type Description
parentId integer The ID of the StatusReportData or TimesheetData object to which this progress item entry belongs.
description string An explanation of the progress item's meaning, as entered by the provider.
milestoneId integer The corresponding unique integer ID of the MilestoneData object with which this progress is associated.
targetCompletionDate timestamp The date on which the provider expects to complete this progress item. May be changed at will by the provider. May differ from the value of the deliveryDate property.
deliveryDate timestamp The date, agreed upon by both client and provider, on which the provider is expected to finish this progress item. May differ from the value of the targetCompletionDate property. May only be changed if the client and provider agree to a new set of terms and milestones for the project.
revised boolean If true, signifies that the value of the targetDeliveryDate property has been set to a different value than the deliveryDate property. If this property is not included in a response, its value is assumed to be false.
progressPercent integer The percentage of the progress item complete, as set by the provider. Legal values are integers in the range from 0 to 100.
amount decimal Dollar value of the progress item and associated milestone, expressed in United States Dollars (USD).
invoiceDate timestamp The date on which the associated invoice was created; in other words, the date on which the provider billed the client for this milestone.
paidDate timestamp The date either on which the funds associated with this progress item were released from Escrow, or on which a non-Escrow payment was made.
invoiceId integer The unique ID assigned to the associated BillingData or InvoiceData object for this progress item. Only set if the progress item is associated with a non-hourly project, and an associated invoice has been created. 

tableofcontents_number_textBillingData

Value Data Type Description
invoice InvoiceData The invoice associated with this billing action.
invoiceDetails array of InvoiceLineItemData objects A list of hours billed to the project, along with the associated rate.
invoiceActivity array of InvoiceActivityData objects The list of actions performed against the invoice.
payments array of PaymentData objects The list of payments made against the invoice. 

tableofcontents_number_textInvoiceData

Value Data Type Description
id integer The unique ID assigned to this invoice by Elance.
date timestamp The date on which the invoice was created.
bidId integer The unique ID of the associated BidData object for this invoice.
jobId integer The unique ID of the associated JobData object for this invoice.
provider integer The Elance username of the associated conttractor for this invoice.
client integer The Elance username of the associated conttractor for this invoice.
providerUserId integer The unique ID of the associated conttractor for this invoice.
clientUserId integer The unique ID of the associated conttractor for this invoice.
type string One of the string values of the InvoiceTypes enumerated type that specifies the kind of invoice.
status string One of the string values of the InvoiceStatuses enumerated type specifying the current disposition of this invoice.
txnCode string One of the string values of the TXNCodes enumerated type specifying the transaction code for this invoice.
amountBilled decimal The total amount billed for this invoice, expressed in the denomination specified by the currency property.
amountPaid decimal The total amount already paid against this invoice, expressed in the denomination specified by the currency property.
amountOutstanding The amount that has not yet been paid on this invoice, expressed in the denomination specified by the currency property.
currency currency The ISO 4217 currency code for all monetary amounts included in this transaction.
comments string A description associated with this invoice by either the client or provider.
lineItemCount integer The number of line items in the invoice. This will correspond to the number of InvoiceLineItemData objects returned.
paymentIds array of integers The list of payment IDs for payments made against this invoice. Each payment ID can be used to retrieve a corresponding PaymentData object. 

tableofcontents_number_textInvoiceLineItemData

Value Data Type Description
parentId integer The ID to which this InvoiceLineItemData object belongs. Can be used to retrieve a BillingData or an InvoiceData object.
description string The user- or system-generated comment pertaining to this line item. This property may or may not be set in the response.
type string One of the string values of the InvoiceLineItemTypes enumeration specifying the kind of invoice.
milestoneId integer The unique ID assigned to the milestone associated with this line item, if the value of the type property is set to Milestone; otherwise, this property is absent from the response. Can be used to retrieve an instance of a MilestoneData object.
milestoneDescription string The text describing the milestone (e.g., "First Four Articles"). Will only be set if the value of the type property is set to Milestone; otherwise, this property is absent from the response.
rate amount The billing rate for this invoice line item, specified in United States Dollars (USD). Only set if the associated job is an Hourly job; otherwise, this property is absent from the response.
hours integer The number of billable hours associated with this line item. Only set if the associated job is Hourly; otherwise, this property is absent from the response.
amount amount The total amount (rate x hours) billed for this line item. 

tableofcontents_number_textInvoiceActivityData

Value Data Type Description
parentId integer The unique ID assigned to the invoice to which this activity data item belongs. Can be used to sretrieve either a BillingData or InvoiceData object.
activity string One of the values of the InvoiceActivityTypes enumeration specifying the action represented by this activity entry, such as the creation of an invoice or the release of funds.
user string The unique Elance username, chosen by the user, of the client or provider who initiated this action.
date timestamp The day and time at which this activity occurred.
comments string Any user input associated with the activity. This property may or may not be set; if not set, this property is not included in the response.
paymentId integer The unique integer assigned to the payment action associated with this activity. Used to retrieve an instance of the PaymentData object. 

tableofcontents_number_textPaymentData

Value Data Type Description
id integer Unique integer assigned to this payment object.
date timestamp The day and time this payment was made.
bidId integer The unique ID of the Workroom associated with the payment. This property may or may not be set; if it is not set, it is not included in the response.
jobId integer The unique ID of the job associated with this payment. This property may or may not be set; if it is not set, it is not included in the response.
provider string The username of the provider who placed the winning bid for this job.
client string The username of the client who created the job.
providerUserId integer The unique integer, assigned by Elance, of the provider who placed the winning bid for this job.
clientUserId integer The unique integer, assigned by Elance, of the client who placed the winning bid for this job.
fromAccountId integer The unique integer, assigned by Elance, of the account that initiated this payment transaction.
toAccountId integer The unique integer, assigned by Elance, of the account designated as the destination for this payment transaction.
internalPaymentDisplay string The human-readable text description of the internal (Elance) originating account for this transaction.
externalPaymentDisplay string The human-readable text description of the external originating account for this transaction (e.g., a Visa card).
externalPaymentId integer The ID of the external originating account. May or may not be set. If not set, this property will not appear in the response. If set, can be used to retrieve an AccountData object.
fromAmount amount The amount of the payment issued from the originating account.
fromCurrency currency The currency used for the fromAmount property.
toAmount amount The amount that is being deposited in the destination account.
toCurrency currency The currency used for the toAmount field.
amount amount The total amount of this transaction, specified in USD.
fromDescription string The description of the operation that is displayed to the owner of the originating account. Older payment entries may contain HTML code.
toDescription string The description of the operation that is displayed to the owner of the destination account. Older payment entries may contain HTML code. 

tableofcontents_number_textEnumerated Data Types

tableofcontents_number_textPhase Enumeration

Value Description
1 auction - The job is open for bidding.
2 selection - The job is closed for bidding, but not yet being worked.
4 canceled - The job was canceled by either the client or the provider.
5 working - Work in progress.
89 complete - The job is marked as complete by the client.  

 

tableofcontents_number_textUser Type Enumeration

Value Description
CLIENT The logged in user is the client for this job.
PROVIDER The logged in user is the provider for this job. 

tableofcontents_number_textEvent Type Enumeration

Value Description
MESSAGE The PMB message was received.
ALERT Any other type of event on the Elance system.

tableofcontents_number_textScope Enumeration

Value Description
GENERAL The message is a general message, unrelated to any specific job or bid.
JOB This message pertains to a specific job.
WORKROOM This message was posted to a workroom. 

 

tableofcontents_number_textTimesheetStatuses

Value Description
Draft Not submitted by the provider. Only viewable by the provider; cannot be viewed by the client.
Scheduled for Delivery Deprecated. Timesheet will be delivered at a future date. The appearance of this status indicates a system issue.
Sent Submitted to client. Can be viewed by both parties. Only overall hours can be edited. Indicates that an invoice has been created, and associated with this timesheet.
Partially Paid The Elance AutoPay system already processed a payment, but a number of hours remain unpaid. This occurs if a provider works more than the number of authorized weekly hours for the project. The provider can adjust the overall number of hours, but the new number must be equal to or greater than the number of hours already paid.
Paid The timesheet has been paid in full. It cannot be edited. 

tableofcontents_number_textTimesheetProjectStatuses Enumeration

Value Description
OK The project is on schedule, and has encountered no blocking issues.
Problem The project has encountered a blocking issue, and requires immediate attention.
Complete - Pending Confirmation The provider has marked the project as Complete; the project will be marked Complete upon confirmation of the client.
Complete The client has confirmed that the project is complete. 

tableofcontents_number_textStatusReportStatuses

Value Description
Draft Not submitted by the provider. Only viewable by the provider; cannot be viewed by the client.
Scheduled for Delivery Deprecated. Status Report will be delivered at a future date. The appearance of this status indicates a system issue.
Sent Submitted to client. Can be viewed by both parties. Only overall hours can be edited. Indicates that an invoice has been created, and associated with this Status Report. 

tableofcontents_number_textStatusReportProjectStatuses Enumeration

Value Description
OK The project is on schedule, and has encountered no blocking issues.
Problem The project has encountered a blocking issue, and requires immediate attention.
Complete - Pending Confirmation The provider has marked the project as Complete; the project will be marked Complete upon confirmation of the client.
Complete The client has confirmed that the project is complete. 

tableofcontents_number_textWorkItemTypes Enumeration

Value Description
Hourly Milestone This work item reflects hours logged against a project milestone.
Hourly Other This work item reflects hours logged for some other reason.
Custom This work item reflects work done according to a non-hourly unit of measure agreed upon by the client and the provider. 

tableofcontents_number_textWorkItemStatuses Enumeration

Value Description
Draft The associated Status Report or Timesheet has not yet been submitted; this work item may still be edited.
Sent The associated Status Report or Timesheet has been submitted to the client; this work item is locked, and may not be edited.
Invoiced DEPRECATED. The associated Status Report or Timesheet has been submitted to the client; this work item is locked, and may not be edited. May appear on older work items. 

tableofcontents_number_textTXNCodes Enumeration

Value Description

tableofcontents_number_textInvoiceTypes Enumeration

Value Description
Fund Request The invoice represents the provider's request for Escrow funding.
Release Request The invoice represents the provider's request for the release of funds held in Escrow.
Invoice The invoice represents a miscellaneous, non-Escrow invoicing request.
Receipt The invoice represents a payment made by the client that is not associated with an invoice request sent by the provider (e.g., a bonus payment).
Pro Forma This invoice represents an estimated future billing for an Hourly job.
Credit Memo This invoice represents the voiding and reverse crediting of another invoice.

tableofcontents_number_textInvoiceStatuses Enumeration

Value Description
Not Funded Escrow has not yet been funded. Associated only with invoices with a type property of Fund Request.
Funded Escrow has been funded. Associated only with invoices with a type property of Fund Request.
Not Released Escrow funds have not been released. Associated only with invoices with a type property of Release Request.
Released Escrow funds have been released. Associated only with invoices with a type property of Release Request.
Unpaid No payments have yet been made on the invoice.
Partially Paid Payments have been made on the invoice, but there is a balance still outstanding.
Paid The invoice has been paid in full.
Sent A document related to invoicing, such as a Credit Memo, has been sent.
Voided The invoice has been either voided due to a change in terms for the job, or manually voided by a provider, or voided due to the issuance of a full refund.

tableofcontents_number_textInvoiceActivityTypes Enumeration

Value Description
Sent The invoice has been created and sent.
Fund Request Sent The provider's request for Escrow funding has been sent.
Release Request Sent The providers request for Escrow release has been sent.
Pro forma invoice sent The Pro Forma invoice has been sent.
Pro forma invoice revised The Pro Forma invoice has been updated due to a change in billing.
Payment A payment has been made.
Funded Escrow has been funded.
Released Escrow funds have been release.d
Auto-Release Escrow funds have been released automatically by the Elance payment system.
Invoice created and paid A Pro Forma invoice has been converted into a full invoice, and a payment made.
Partially paid with Auto-Pay The invoice was partially paid through the Auto-Pay process.
Invoice created and Auto-Paid A Pro Forma invoice has been converted to a full invoice, and the invoice was paid in full by the Auto-Pay process.
Comment The client or provider has added descriptive text to the invoice.
Voided The invoice has been voided.
Credit Memo A Credit Memo has been created, and linked to the voided invoice. 

tableofcontents_number_textDeliveryTimeline Enumeration

Value Description
13001 Within 1 day
13002 Within 3 days
13003 Within 1 week
13010 Within 2 weeks
13011 Within 3 weeks
13004 Within 1 month
13012 Within 2 months
13005 Within 3 months
13006 Within 6 months
13007 More than 6 months