Paylocity

Use the @bijection/connectors/paylocity entrypoint to declare Paylocity resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Employees	`roster`	Employee status roster

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Employees

roster: Employee status roster

The following example matches configuration standard.

import { paylocity } from "@bijection/connectors/paylocity";
export const source = paylocity.employees.roster();

Inferred record types

Resource without an operational record table

Configuration: standard

Case: paylocity/employees/roster/standard. Connection and resource configuration are declared by this exact case. Credential kind: paylocity. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`companyId`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "paylocity",
    "output": {
      "kind": "single",
      "collection": "employees"
    },
    "credential_kind": "paylocity",
    "connection_fields": [
      "companyId"
    ],
    "address": {
      "kind": "fixed",
      "url": "https://api.paylocity.com/"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "companyId": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: employees

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "page": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange page",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "employees": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "page": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange page",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“employees”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
backoff-stated-wait	{“kind”:“connection”}	Native test: integrations/acquisition/backoff_a_stated_wait_defers_the_next_dispatch_and_then_resumes (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/paylocity/fixtures/identity.json	passed (2026-10-24T21:36:12.283Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. employees.roster walks GET /api/v2/companies/{companyId}/employees?pagesize=100&pagenumber=n whole each pass and publishes each employee’s employeeId, statusCode and statusTypeCode (the list’s whole answer). OAuth client credentials (scope=WebLinkAPI) issue a Bearer token. WebLink webhooks carry no delivery identity and no signature, so no listener is declared. Built from the provider’s published API documentation; nothing here has run against Paylocity or been qualified.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Availability

Resources and modes

Employees

roster: Employee status roster

Configuration: standard

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Employees

​roster: Employee status roster

​Configuration: standard

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Employees

roster: Employee status roster

Configuration: standard

Provider guidance

Provider references

Source and evidence