Users

Deprecated: use PUT /v1/Users/contractors/{contractorId} (BF-7493).

Changed on

Same as PUT /v1/Users/contractors/{contractorId}, with contractorId taken from the body (400 when missing or not greater than 0). The body is the new PUT body: the old key paycheckType is no longer read (the field is paycheckDeliveryId), and this route no longer reactivates the contractor, resets registration or clears ATSSyncId.

put/v{version}/Users/contractors

Request

  • Base URL
    https://api.bilflo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.bilflo.com/v{version}/Users/contractors
  • Auth
    API key in header Authorization

Path parameters

versionstring required

Headers

company-idstring required

Request body

companyIdstring uuid
contractorIdinteger
firstNamestring nullable
middleNamestring nullable
lastNamestring nullable
titlestring nullable
emailAddressstring nullable
phonestring nullable
phoneExtstring nullable
isElectronicDeliveryboolean nullable
address1string nullable
address2string nullable
citystring nullable
zipCodestring nullable
stateCodestring nullable
stateWorkingstring nullable
stateSubjectToTaxstring nullable
socialSecurityNumberstring nullable
dateOfBirthstring date-time nullable
genderstring nullable
routingNumberstring nullable
accountNumberstring nullable
federalFilingStatusIdinteger nullable
stateFilingStatusIdinteger nullable
stateFilingCodestring nullable
federalAllowancenumber double nullable
stateAllowancenumber double nullable
additionalFederalWithholdingsnumber double nullable
additionalStateWithholdingsnumber double nullable
otherIncomeAmountnumber double nullable
otherDeductionAmountnumber double nullable
totalDependentClaimAmountnumber double nullable
isFederalTaxExemptboolean nullable
isStateTaxExemptboolean nullable
isHasTwoJobsboolean nullable
isI9OnFileboolean nullable
paycheckDeliveryIdinteger nullable
paycheckDeliveryAccountTypeIdinteger nullable
is1099boolean nullable
contractorCompanystring nullable
isSickTimeEnabledboolean nullable
isVacationTimeEnabledboolean nullable
isHealthInsuranceEnabledboolean nullable

Response

Success

isValidboolean
errorsstring[] nullable
warningsstring[] nullable
infostring[] nullable
messagestring nullable

Changes

    • breaking

      removed the enum value 1.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 1.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 1.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 1.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 1.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 1.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 2.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 2.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 2.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 2.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 2.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 2.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 3.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 3.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 3.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 3.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 3.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 3.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 4.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 4.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 4.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 4.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 4.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 4.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 5.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 5.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 5.00 of the request property (media type: application/*+json)

    • breaking

      removed the enum value 5.00 of the request property (media type: application/json)

    • breaking

      removed the enum value 5.00 of the request property (media type: text/json)

    • breaking

      removed the enum value 5.00 of the request property (media type: application/*+json)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: text/json)

    • warning

      removed the request property (media type: application/*+json)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: text/json)

    • warning

      removed the request property (media type: application/*+json)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: text/json)

    • warning

      removed the request property (media type: application/*+json)

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: text/json)

    • warning

      removed the request property (media type: application/*+json)

    • info

      endpoint deprecated

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: text/json)

    • info

      the request property became nullable (media type: application/*+json)