• alias
    string

    Friendly name for the Port Order.

  • number_cost
    integer

    The cost to port each individual number associated with the Port Order.

  • total_cost
    integer

    The cost to port every number associated with the Port Order.

  • created_at
    datetime

    DateTime of when an object was first created.

  • last_update_timestamp
    datetime

    DateTime of when the most recent change was applied to the Port Order.

  • notifications_email
    string array

    Contains email addresses that will be emailed whenever a change is made to the Port Order.

  • notifications_url
    string array

    Contains URLs that will be POSTed to whenever a change is made to the Port Order.

  • desired_completion_datetime
    datetime

    DateTime of when you would ideally like for the Port Order to complete.

  • lsp_requested_completion_date
    datetime

    Date that Flowroute is requesting the Losing Service Provider to allow the Port Order to complete on. If Flowroute's port request is successful, then this will become the firm_order_completion_date.

  • firm_order_completion_date
    datetime

    Date that Flowroute and the Losing Service Provider have agreed to complete the Port Order on. This is the date on which your number(s) will migrate to Flowroute.

  • end_user_information
    hash

    Contains fields related to the Current Service Provider and your account with them.

  • current_provider
    string

    The company from which you currently purchase telecom services.

  • current_provider_account_number
    string

    The ID for your account with the Losing Service Provider.

  • authorized_contact
    string

    First and last name of the person authorized to make changes on your account with the Losing Service Provider.

  • billing_number
    string

    Main phone number that represents your account with the Losing Service Provider.

  • company_name
    string

    Name of the company that has the account with the Losing Service Provider.

  • service_address
    hash

    Contains fields related to the address that the Losing Service Provider has on file for the porting numbers.

  • address
    string

    Street address where the Losing Service Provider services the porting numbers. This is often referred to as the "Service Address" and can be different from the "Billing Address".

  • address2
    string

    Second line of the Address; often contains Unit, Floor, or Suite information.

  • city
    string

    City where the Losing Service Provider services the porting numbers.

  • state
    string

    State where the Losing Service Provider services the porting numbers.

  • zip
    string

    Zip code where the Losing Service Provider services the porting numbers.

  • country
    string

    Country where the Losing Service Provider services the porting numbers.

  • wireless_fields
    hash

    Contains fields for additional information often required when porting numbers away from Wireless carriers.

  • last_four_ssn
    integer

    The last four digits of the authorized_contact's social security number.

  • pin
    string

    Pin that the Losing Service Provider requires in order to make changes to your account.

  • loa
    hash

    Contains fields related to the Letter of Agency that users must esign in order to authorize Flowroute to port their numbers.

  • url
    string

    URL where you can download a copy of a document associated with the Port Order.

  • esigned
    boolean

    Defines whether or not the user has esigned the LOA for the Port Order.

  • esigned_at
    datetime

    DateTime of when the user esigned the LOA for the Port Order.

  • uploaded_files
    array containing hashes

    Contains fields relates to files that have been uploaded to the Port Order. These will often be Bills from the Losing Service Provider.

  • file_id
    string

    Unique identifier for a file that was uploaded to the Port Order.

  • file_name
    string

    Name of the file that was uploaded to the Port Order.

  • uploaded_at
    datetime

    DateTime of when the file was uploaded to the Port Order.

  • detected_mimetype
    datetime

    The type of file that was uploaded to the Port Order.

  • file_size
    integer

    Size of the uploaded file in kilobytes.

  • recommendations
    array containing hashes

    Contains fields for tasks that Flowroute is recommending the user to complete in order to help ensure the Port Order completes in a timely fashion.

  • author
    string

    The Flowroute agent that created the recommendation.

  • task
    string

    High level explanation of what Flowroute is requesting.

  • explanation
    string

    More granular explanation of what Flowroute is requesting.

  • outcome
    string

    What benefit fulfilling this recommendation will have for the user.

  • resolved
    boolean

    Whether or not the recommendation has been acknowledged by the user.

  • resolved_by
    string

    The user that resolved the recommendation.

  • progress
    hash

    Contains fields related to the status of a Port Order and what tasks remain to be completed.

  • blocked
    boolean

    Whether or not the Port Order requires user involvement to move forward.

  • blockers
    array containing hashes

    Contains fields related to issues that are preventing the Port Order from moving forward. These require user intervention in order to resolve.

  • started_at
    datetime

    DateTime on which something first began.

  • reason
    string

    High level explanation of what the blocker is.

  • explanation
    string

    More granular explanation of what the blocker is.

  • blocked_fields
    array containing strings

    Which fields or sections of the Port Order need to be updated in order to resolve the blocker.

  • current_state
    string

    Which state the Port Order is currently in.

  • states
    array of hashes

    Contains fields related to the different states that the Port Order needs to go through in order to reach completion.

  • state_sequence
    integer

    Defines the order in which each state must be completed.

  • complete
    boolean

    Whether or not all tasks in the state have been completed.

  • tasks
    array containing hashes

    Contains fields related to tasks that must be completed in order to move onto the next state.

  • task_sequence
    integer

    Defines the order in which each task must be completed.