Data types

Conversation

The 'Conversation' data type contains data on a conversation between a Customer and a Freelancer.

  • Messages (list of messages) - a list of messages sent between a Customer and a Freelancer

  • Participants (list of users) - a list of two users (one Customer and one Freelancer) that are in the conversation

Job

The 'Job' data type contains data on a specific piece of work that a Customer hires a Freelancer to do. It also tracks the status of that job over time.

  • Cost (Cents) (number) - the total cost of the job in cents. The cost is saved in cents because Stripe takes amount values in the lowest denominator of the currency being used (which is cents in the case of USD)

  • Customer (user) - the user who is the Customer for this job

  • Description (text) - a description of the job created by the user when they are initially submitting a proposal on the 'Service' page

  • Freelancer (user) - the user who is the Freelancer for this job

  • Name (text) - title of the job

  • Review (review) - the review left by the Customer for the Freelancer

  • Status (text) - the current status of the job. See the Job Status option set for full details.

  • Submitted work (list of files) - a list of files uploaded by the Freelancer

  • Transaction (transaction) - the transaction associated with the job

Messsage

The 'Message' data type contains data on a specific message that is part of a conversation between a Customer and a Freelancer.

  • Conversation (conversation) - the conversation that the message is part of

  • Creator (user) - the user who created the conversation (will be a Customer)

  • Message Text (text) - the text of the message

Review

Once a job is complete, the Customer can leave a review of the Freelancer. The 'Review' data type contains this information

  • Customer (user) - the Customer leaving the review

  • Description (text) - a comment left by the Customer as part of the review

  • Freelancer (user) - the Freelancer being reviewed

  • Job Name (text) - the name of the job associated with the review

  • Rating (number) - the rating left by the Customer (will be between 0 and 5)

Service

The 'Service' data type contains details on a service that a Freelancer lists for sale on the marketplace.

  • Category (Categories) - the category which the service belongs to. See the Categories option set for full details

  • Description (text) - a description of the service

  • Featured ('yes/no') - if set to yes, the service will appear on the index page in the 'Popular Services' section

  • Freelancer (user) - the Freelancer who is offering the service

  • Image (image) - the image associated with the service

  • Name (text) - the name of the service

  • Price per Hour (number) - a number used to represent the price per hour of the service

Transaction

The 'Transaction' data type stores details on the payment associated with a job. Please note it will only be used by default if you enable the pre-built payment flows that come with the template.

  • Amount (Cents) (number) - the total value of the transaction in cents. Cents are used as Stripe takes amount values in the lowest denominator of that particular currency.

  • Checkout Session ID (text) - the unique Stripe ID of the Checkout Session created for the payment

  • Payment Intent ID (text) the unique Stripe ID of the paymentIntent associated with the payment.

  • Status (text) - status of the transaction.

User

  • Charges enabled? (yes/no) - indicates whether the user (Freelancer) has successfully registered for a Stripe account and can accept payments

  • Customer ID (Stripe) (text) - optional field that can contain the unique Stripe Customer ID associated with a Customer who has made a payment

  • Name (text) - the name of the user

  • Number of reviews (number) - the number of reviews that the user (Freelancer) has received

  • Profile Picture (image) - the user's profile picture

  • Rating (number) - a number representing the average rating the Freelancer has received

  • Role (Role) - a user can be either a Customer or a Freelancer. See the Role option set for more details.

  • Seller Account ID (Stripe) (text) - the unique ID of the Freelancer's Stripe account. This will be used to transfer the appropriate amount to the Freelancer

  • Services (list of services) - a list of services that a Freelancer offers on the marketplace

Last updated