Skip to main content

Navigating the API Records Screen

Navigation of the API records screen

S
Written by Shauna Greaves
Updated over 2 weeks ago

The purpose of this screen is to manage, create and update individual records that pull through from Bullhorn from multiple modules:

Contractor

Client

Assignment

You can access the API records screen in two ways:

  1. From data was synced from Bullhorn successfully click 'View Records' to view the synced records directly on the API screen.



  2. From the Dashboard, navigate to the Search menu and select API Integration.


    This will bring you to the API Integration screen. Then select API Records.


    This screen shows all Records that have been pulled automatically due to the creation or update of a contractor, client or assignment in Bullhorn.

On the API records screen, you can filter the available records

Module

Select the module you want to update.
Currently available: Contractor, Client, Assignment.

Filters for Contractor

Batch No.

Search using a specific Batch Number to quickly locate a batch.

First Name

Search by the individual’s first name.

Surname

Search by the individual’s surname.

NI Number

Search using the NI number.

Pulled at

Filter records that were pulled between two selected dates.

Last Updated at

Filter records that were last updated between two selected dates.

Grid Columns for Contractor

When using the filters, ensure you increase the number of items displayed per page, as you will only be able to filter the records currently visible on the screen.

Field Descriptions

API Reference ID
The unique reference ID for this specific data pull from Bullhorn.

Batch No
Search using a specific Batch Number to quickly locate a batch.

First Name
Search by the individual’s first name.

Surname
Search by the individual’s surname.

Email Address
Search using the individual’s email address.

Mobile No.
Search using the individual’s mobile number.

NI Number
Search using the National Insurance number.

Record Status

  • New Record – A completely new contractor created in Bullhorn.

  • Existing Record – A contractor who already exists in Quartz but has had details updated in Bullhorn. These updates will pull through to this screen.

Actions

  • Pen Icon
    Allows you to view and edit the contractor’s details.

  • Failed Reason

    Allows you to see the reason why the record has gone to the invalid tab.

  • Alert Icon
    Indicates that a newer record with updated values exists in another batch. Any available actions must be completed within that batch. Once you generate the newer batch, this record will no longer show here.

Filters for Clients

Batch No.

Search using a specific Batch Number to quickly locate a batch.

Client Name

Search by the Client's name

Group By

Search by how the invoices are grouped Timesheet, Contractor, Client and Client and Location

Payment Terms

Search by the payment terms of the client

Email Address

Search by the email address of the client

Pulled at

Filter records that were pulled between two selected dates.

Last Updated at

Filter records that were last updated between two selected dates.

Grid Columns for Clients

When using the filters, ensure you increase the number of items displayed per page, as you will only be able to filter the records currently visible on the screen.

API Reference ID
The unique reference ID for this specific data pull from Bullhorn.

Batch No
Search using a specific Batch Number to quickly locate a batch.

Client Name

Search by the Client's name

Sales Tax

Search by the Sales Tax

Email Address

Search by the email address of the client

City

Search by the city of the client

Group By

Search by how the invoices are grouped Timesheet, Contractor, Client and Client and Location

Payment Terms

Search by the payment terms of the client.

Pulled at

Filter records that were pulled between two selected dates.

Last Updated at

Filter records that were last updated between two selected dates.

Actions

  • Pen Icon
    Allows you to view and edit the client's details.

  • Failed Reason

    Allows you to see the reason why the record has gone to the invalid tab.

  • Alert Icon
    Indicates that a newer record with updated values exists in another batch. Any available actions must be completed within that batch. Once you generate the newer batch, this record will no longer show here.

Filters for Assignment

Batch No.

Search using a specific Batch Number to quickly locate a batch.

Contractor

Search by the contractor's name

Client

Search by the Client's name

Assignment Start Date - End Date

Date when the assignment starts - Date when the assignment ends

Timesheet Frequency

Weekly, Monthly

Payment Frequency

Weekly, Monthly

Pulled at

Filter records that were pulled between two selected dates.

Last Updated at

Filter records that were last updated between two selected dates.

Grid Columns for Assignment

When using the filters, ensure you increase the number of items displayed per page, as you will only be able to filter the records currently visible on the screen.

API Reference ID
The unique reference ID for this specific data pull from Bullhorn.

Batch No
Search using a specific Batch Number to quickly locate a batch.

Contractor

Search by the contractor's name

Client

Search by the Client's name

Assignment Start Date - End Date

Date when the assignment starts - Date when the assignment ends

Timesheet Frequency

Weekly, Monthly

Payment Frequency

Weekly, Monthly

Record Status

New record vs existing record

Last Updated at

Filter records that were last updated between two selected dates.

Actions

  • Pen Icon
    Allows you to view and edit the client's details.

  • Failed Reason

    Allows you to see the reason why the record has gone to the invalid tab.

  • Alert Icon
    Indicates that a newer record with updated values exists in another batch. Any available actions must be completed within that batch. Once you generate the newer batch, this record will no longer show here.


All records that have been pulled will be displayed in the grid and organised into four columns.

*Depending on which module you are currently looking at, the process is mirrored.

Valid Records

The Valid Record Screen displays a list of valid records that have been successfully pulled from Bullhorn, with all relevant fields populated.

From this screen, you can:

  1. Select Records

    • select individual records of your choice to bulk action.

  2. Generate Records

    • Choose Generate to create or update the selected record in Quartz.

  3. Archive Records

    • Choose Archive if you do not want the selected records to be updated in the relevant module screen in Quartz.

    To view or edit a record in more detail, click the pen icon next to the record. This will allow you to update the record information.

Once you have reviewed the information, you have two options:

Save – Saves the record without creating it in Quartz, allowing you to return and make further edits later.

Create – Confirms the information and populates the record directly into Quartz.

Invalid Records

The invalid Records screen displays a list of records that have missing or invalid details meaning they cannot be created / updated in Quartz.

From this screen, you can:

Select Records and Achieve

  • Mark records as achieved if they are not needed.

View the Failed Reason

  • See a detailed explanation of why a record has failed.

Edit the record

  • Incorrect information is highlighted in red.

  • You can correct the errors and then:

    Save – Sends the record to Valid Records for further review.

    Create – Populates the corrected or updates the record directly into Quartz.


Archived Records


The Achieved Records screen displays a list of records that you have selected to mark as achieved.

From this screen, you can:

  • Filter

  • Mark records as Un-achieved if needed, moving them out of the achieved list.

Completed Records

The Completed Records screen displays a list of records that have been successfully created or updated in Quartz.

From this screen, you can:

  • Filter the list to find specific records.

  • View the record directly in Quartz.

Tip - When you pull new contractors from Bullhorn into Quartz, they will appear in the Contractor screen once created. Instead of clicking into each individual contractor profile, simply click the green person icon to grant login access.


All records that have been pulled will be displayed in the grid and organised into four columns.

*Depending on which module you are currently looking at, the process is mirrored.

Valid Records

The Valid Record Screen displays a list of valid records that have been successfully pulled from Bullhorn, with all relevant fields populated.

From this screen, you can:

  1. Select Records

    • select individual records of your choice to bulk action.

  2. Generate Records

    • Choose Generate to create or update the selected record in Quartz.

  3. Archive Records

    • Choose Archive if you do not want the selected records to be updated in the relevant module screen in Quartz.

    To view or edit a record in more detail, click the pen icon next to the record. This will allow you to update the record information.

Once you have reviewed the information, you have two options:

Save – Saves the record without creating it in Quartz, allowing you to return and make further edits later.

Create – Confirms the information and populates the record directly into Quartz.

Invalid Records

The invalid Records screen displays a list of records that have missing or invalid details meaning they cannot be created / updated in Quartz.

From this screen, you can:

Select Records and Achieve

  • Mark records as achieved if they are not needed.

View the Failed Reason

  • See a detailed explanation of why a record has failed.

Edit the record

  • Incorrect information is highlighted in red.

  • You can correct the errors and then:

    Save – Sends the record to Valid Records for further review.

    Create – Populates the corrected or updates the record directly into Quartz.


Archived Records


The Achieved Records screen displays a list of records that you have selected to mark as achieved.

From this screen, you can:

  • Filter

  • Mark records as Un-achieved if needed, moving them out of the achieved list.

Completed Records

The Completed Records screen displays a list of records that have been successfully created or updated in Quartz.

From this screen, you can:

  • Filter the list to find specific records.

  • View the record directly in Quartz.

Tip - When you pull new contractors from Bullhorn into Quartz, they will appear in the Contractor screen once created. Instead of clicking into each individual contractor profile, simply click the green person icon to grant login access.

Did this answer your question?