# Update paycheck settings or deactivate a job Update this job to set where pay should be deposited for paychecks related to this job, or deactivate on-demand pay for this job. Returns the job object if the update succeeded. Returns an error if update parameters are invalid. Endpoint: PATCH /rest/jobs/{job_id} Version: 3.0.0-beta01 Security: oauth_user_token ## Header parameters: - `DailyPay-API-Version` (integer) The version of the DailyPay API to use for this request. If not provided, the latest version of the API will be used. - `Accept` (string) The media type of the requested payload. This should be set to to signify your client can receive responses in the JSON:API format. For more details, see https://jsonapi.org. Enum: "application/vnd.api+json", "*/*" ## Path parameters: - `job_id` (string, required) Unique ID of the job Example: "e9d84b0d-92ba-43c9-93bf-7c993313fa6f" ## Request fields (application/vnd.api+json): - `data` (object, required) A job describes the financial relationship between a person and an organization. - `data.type` (string, required) - `data.id` (string, required) Example: "e9d84b0d-92ba-43c9-93bf-7c993313fa6f" - `data.attributes` (object) - `data.attributes.activation_status` (string) Activation is the process of verifying that data is available for a Job, and that a person has verified their identity as the Person associated with the Job. Only paychecks from Jobs with status will contribute to an earnings balance account. To deactivate a job, update activation_status to . Enum: "DEACTIVATED", "DEACTIVATION_PENDING", "ACTIVATION_REQUIRED", "ACTIVATION_UNDER_REVIEW", "ACTIVATED" - `data.relationships` (object) The relationships between the job and other resources, including the accounts to which paychecks from this job are deposited. - `data.relationships.direct_deposit_default_depository` (object) The account to which paychecks from this job will attempt to be deposited. - `data.relationships.direct_deposit_default_depository.data` (object, required) - `data.relationships.direct_deposit_default_card` (object) The account to which paychecks from this job will attempt to be deposited, if the account fails. ## Response 200 fields (application/vnd.api+json): - `data` (object, required) A job describes the financial relationship between a person and an organization. - `data.type` (string, required) - `data.id` (string, required) Example: "e9d84b0d-92ba-43c9-93bf-7c993313fa6f" - `data.attributes` (object, required) - `data.attributes.external_identifiers` (object) Holds unique identifiers for the employee or job defined by external organizations. - `data.attributes.first_name` (string) The first name of the person as it is listed in their employee profile. Example: "Edith" - `data.attributes.last_name` (string) The last name of the person as it is listed in their employee profile. Example: "Clarke" - `data.attributes.activation_status` (string) Activation is the process of verifying that data is available for a Job, and that a person has verified their identity as the Person associated with the Job. Only paychecks from Jobs with status will contribute to an earnings balance account. To deactivate a job, update activation_status to . Enum: "DEACTIVATED", "DEACTIVATION_PENDING", "ACTIVATION_REQUIRED", "ACTIVATION_UNDER_REVIEW", "ACTIVATED" - `data.attributes.wage_rate` (object, required) - `data.attributes.wage_rate.amount` (integer, required) A monetary quantity expressed in units of the lowest denomination in the associated currency. For example, resolves to $72.50. - `data.attributes.wage_rate.currency` (string, required) A three-letter ISO 4217 currency code. For example, for US Dollars, for Euros, or for Japanese Yen. - `data.attributes.wage_rate.frequency` (string, required) Enum: "HOURLY", "WEEKLY", "BIWEEKLY", "TWICE_MONTHLY", "MONTHLY", "ANNUALLY" - `data.attributes.title` (string,null) Example: "Computer" - `data.attributes.department` (string,null) Example: "Finance" - `data.attributes.location` (string) Example: "New York, New York" - `data.attributes.direct_deposit_status` (string, required) - Direct deposit is not set up for this Job. Update this resource's relationships to set up direct deposit. - A system action is still pending. - Direct deposit is set up for this Job. Enum: "SETUP_REQUIRED", "SETUP_PENDING", "SETUP_COMPLETE" - `data.links` (object, required) - `data.links.self` (string, required) - `data.relationships` (object, required) The relationships between the job and other resources, including the accounts to which paychecks from this job are deposited. - `data.relationships.person` (object, required) - `data.relationships.person.data` (object, required) - `data.relationships.organization` (object, required) - `data.relationships.direct_deposit_default_depository` (object) The account to which paychecks from this job will attempt to be deposited. - `data.relationships.direct_deposit_default_card` (object) The account to which paychecks from this job will attempt to be deposited, if the account fails. ## Response 400 fields (application/vnd.api+json): - `errors` (array, required) A list of errors that occurred. - `errors.code` (string, required) A code that indicates what went wrong. Please consider this an open enum, where new codes may be added over time. Example: "INVALID_PARAMETERS" - `errors.status` (string, required) The HTTP status code for the error. Example: "400" - `errors.detail` (string, required) A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change Example: "The request failed because it was not in the correct format or did not contain valid data." - `errors.links` (object, required) A list of links to resources that may be helpful in resolving the error. - `errors.links.about` (string) Example: "https://developer.dailypay.com/tag/Errors" - `errors.source` (object) Location in the request that may have caused the error. - `errors.source.parameter` (string) The name of the parameter that caused the error. Example: "filter[first_name]" - `errors.source.pointer` (string) A JSON Pointer to the location in the request that caused the error. Example: "/data/attributes/first_name" - `errors.source.header` (string) The name of the header that caused the error. Example: "Accept" - `errors.meta` (object, required) Additional information about the error. - `errors.meta.request_id` (string) A UUID for the originating request. Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe" - `errors.meta.trace_id` (string) An ID used for tracing purposes. Example: "4016616108459136584" ## Response 401 fields (application/vnd.api+json): - `errors` (array, required) A list of errors that occurred. - `errors.status` (string, required) The HTTP status code for the error. Example: "400" - `errors.detail` (string, required) A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change Example: "The request failed because it was not in the correct format or did not contain valid data." - `errors.links` (object, required) A list of links to resources that may be helpful in resolving the error. - `errors.links.about` (string) Example: "https://developer.dailypay.com/tag/Errors" - `errors.source` (object) Location in the request that may have caused the error. - `errors.source.parameter` (string) The name of the parameter that caused the error. Example: "filter[first_name]" - `errors.source.pointer` (string) A JSON Pointer to the location in the request that caused the error. Example: "/data/attributes/first_name" - `errors.source.header` (string) The name of the header that caused the error. Example: "Accept" - `errors.meta` (object, required) Additional information about the error. - `errors.meta.request_id` (string) A UUID for the originating request. Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe" - `errors.meta.trace_id` (string) An ID used for tracing purposes. Example: "4016616108459136584" - `errors.code` (string, required) A code that indicates what went wrong. Enum: "INVALID_TOKEN", "UNAUTHORIZED" ## Response 403 fields (application/vnd.api+json): - `errors` (array, required) A list of errors that occurred. - `errors.status` (string, required) The HTTP status code for the error. Example: "400" - `errors.detail` (string, required) A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change Example: "The request failed because it was not in the correct format or did not contain valid data." - `errors.links` (object, required) A list of links to resources that may be helpful in resolving the error. - `errors.links.about` (string) Example: "https://developer.dailypay.com/tag/Errors" - `errors.source` (object) Location in the request that may have caused the error. - `errors.source.parameter` (string) The name of the parameter that caused the error. Example: "filter[first_name]" - `errors.source.pointer` (string) A JSON Pointer to the location in the request that caused the error. Example: "/data/attributes/first_name" - `errors.source.header` (string) The name of the header that caused the error. Example: "Accept" - `errors.meta` (object, required) Additional information about the error. - `errors.meta.request_id` (string) A UUID for the originating request. Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe" - `errors.meta.trace_id` (string) An ID used for tracing purposes. Example: "4016616108459136584" - `errors.code` (string, required) A code that indicates what went wrong. Enum: "FORBIDDEN" ## Response 404 fields (application/vnd.api+json): - `errors` (array, required) A list of errors that occurred. - `errors.status` (string, required) The HTTP status code for the error. Example: "400" - `errors.detail` (string, required) A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change Example: "The request failed because it was not in the correct format or did not contain valid data." - `errors.links` (object, required) A list of links to resources that may be helpful in resolving the error. - `errors.links.about` (string) Example: "https://developer.dailypay.com/tag/Errors" - `errors.source` (object) Location in the request that may have caused the error. - `errors.source.parameter` (string) The name of the parameter that caused the error. Example: "filter[first_name]" - `errors.source.pointer` (string) A JSON Pointer to the location in the request that caused the error. Example: "/data/attributes/first_name" - `errors.source.header` (string) The name of the header that caused the error. Example: "Accept" - `errors.meta` (object, required) Additional information about the error. - `errors.meta.request_id` (string) A UUID for the originating request. Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe" - `errors.meta.trace_id` (string) An ID used for tracing purposes. Example: "4016616108459136584" - `errors.code` (string, required) A code that indicates what went wrong. Enum: "RECORD_NOT_FOUND", "NOT_FOUND" ## Response 500 fields (application/vnd.api+json): - `errors` (array, required) A list of errors that occurred. - `errors.status` (string, required) The HTTP status code for the error. Example: "400" - `errors.detail` (string, required) A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change Example: "The request failed because it was not in the correct format or did not contain valid data." - `errors.links` (object, required) A list of links to resources that may be helpful in resolving the error. - `errors.links.about` (string) Example: "https://developer.dailypay.com/tag/Errors" - `errors.source` (object) Location in the request that may have caused the error. - `errors.source.parameter` (string) The name of the parameter that caused the error. Example: "filter[first_name]" - `errors.source.pointer` (string) A JSON Pointer to the location in the request that caused the error. Example: "/data/attributes/first_name" - `errors.source.header` (string) The name of the header that caused the error. Example: "Accept" - `errors.meta` (object, required) Additional information about the error. - `errors.meta.request_id` (string) A UUID for the originating request. Example: "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe" - `errors.meta.trace_id` (string) An ID used for tracing purposes. Example: "4016616108459136584" - `errors.code` (string, required) A code that indicates what went wrong. Enum: "UNEXPECTED_ERROR"