@dsptch-work/api-client 0.51.0 → 0.51.1

package/CHANGELOG.md

@@ -7,6 +7,15 @@ minor bump until `1.0.0`. See [RELEASING.md](./RELEASING.md) for the release and
 
 ## [Unreleased]
 
+## [0.51.1] - 2026-11-06
+
+### Changed
+
+- `Jobs.createCaEcprXmlExport()` returns `422` with problem type `certified_payroll_export_blocked` when a compliance check blocks the export. Resolve the failing checks before retrying. `ProblemTypeCatalog` and `zProblemTypeCatalog` add that value; update exhaustive handlers as needed.
+- `CprImports.createDsptchCprImport()` rejects a prevailing-wage row with hours at a multiplier whose rate is zero or negative. It returns `422` naming `non_positive_rate_for_prevailing_wage_hours` and writes nothing. Request types are unchanged.
+
+See the [API changelog](https://dsptch.app/support/docs/developers/api-changelog#2026-11-06) for the complete REST contract changes.
+
 ## [0.51.0] - 2026-11-05
 
 ### Added

package/dist/gen/sdk.gen.d.ts

@@ -2700,6 +2700,8 @@ export declare class Jobs {
      * `start_date`..`end_date`. Returns the pending export (201); poll the member
      * GET for generation status and the file URL. Requires a user-scoped key. A
      * job that does not offer CA eCPR is 422 `certified_payroll_format_unavailable`.
+     * Failing compliance checks that block the export are 422
+     * `certified_payroll_export_blocked`.
      * A window with no reportable pay periods is 422 `nothing_exportable`.
      * Does not start DocuSeal signing.
      *

package/dist/gen/sdk.gen.js

@@ -4549,6 +4549,8 @@ export class Jobs {
      * `start_date`..`end_date`. Returns the pending export (201); poll the member
      * GET for generation status and the file URL. Requires a user-scoped key. A
      * job that does not offer CA eCPR is 422 `certified_payroll_format_unavailable`.
+     * Failing compliance checks that block the export are 422
+     * `certified_payroll_export_blocked`.
      * A window with no reportable pay periods is 422 `nothing_exportable`.
      * Does not start DocuSeal signing.
      *

package/dist/gen/types.gen.d.ts

@@ -265,6 +265,12 @@ export type Problem = {
  *
  * The upload behind an image attachment's signed id is not an image content type. Upload an image file.
  *
+ * ### certified_payroll_export_blocked
+ *
+ * **Certified Payroll Export Blocked**
+ *
+ * Failing compliance checks block this certified payroll export: a job-level check on the named job, or a time-card check on a worker the export would include. These are the same checks that disable Export in the web app. Resolve the failing checks, then retry.
+ *
  * ### certified_payroll_format_unavailable
  *
  * **Certified Payroll Format Unavailable**
@@ -418,7 +424,7 @@ export type Problem = {
  * Another write to the same resource held it for longer than this request was willing to wait, or collided with it, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
  *
  */
-export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'malformed_body' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'forbidden_key' | 'insufficient_api_key_scope' | 'user_scoped_key_required' | 'not_found' | 'already_subscribed' | 'already_terminated' | 'authorization_revoked' | 'import_in_progress' | 'pay_schedule_already_exists' | 'pay_schedule_deletion_in_progress' | 'pay_schedule_deletion_refused' | 'product_archived' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'certified_payroll_format_unavailable' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'not_incomplete_permanent_copy' | 'nothing_exportable' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'database_timeout' | 'write_contended';
+export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'malformed_body' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'forbidden_key' | 'insufficient_api_key_scope' | 'user_scoped_key_required' | 'not_found' | 'already_subscribed' | 'already_terminated' | 'authorization_revoked' | 'import_in_progress' | 'pay_schedule_already_exists' | 'pay_schedule_deletion_in_progress' | 'pay_schedule_deletion_refused' | 'product_archived' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'certified_payroll_export_blocked' | 'certified_payroll_format_unavailable' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'not_incomplete_permanent_copy' | 'nothing_exportable' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'database_timeout' | 'write_contended';
 export type ApiKeyScopeResponseObject = {
     resource: string;
     action: 'read' | 'create' | 'update' | 'delete';
@@ -7528,7 +7534,7 @@ export type DsptchCprImportResponseObject = {
     updated_at: string;
 };
 /**
- * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
+ * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. On a job that tracks prevailing wage, each rate must also be more than 0 when the row has hours at its multiplier: a row that prices such hours at 0 or below answers 422 naming `non_positive_rate_for_prevailing_wage_hours`, and nothing is written. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
  *
  * Submitting the same work twice is refused rather than doubled: an import will not write onto a time card that already holds data, so a retry after a submission that already succeeded answers 422 naming `time_card_has_data`, and nothing is written. The guard is per time card, not per file, so a corrected file for the same worker and period is refused the same way — clear that period's data first.
  *
@@ -11311,7 +11317,7 @@ export type JobCaEcprXmlExportsResponseObject = {
     data: Array<JobCaEcprXmlExportResponseObject>;
 };
 /**
- * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. A window with no reportable pay periods answers 422 nothing_exportable.
+ * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. Failing compliance checks that block the export answer 422 certified_payroll_export_blocked. A window with no reportable pay periods answers 422 nothing_exportable.
  */
 export type JobCaEcprXmlExportCreateParameters = {
     /**

package/dist/gen/zod.gen.d.ts

@@ -239,6 +239,12 @@ export declare const zProblem: z.ZodObject<{
  *
  * The upload behind an image attachment's signed id is not an image content type. Upload an image file.
  *
+ * ### certified_payroll_export_blocked
+ *
+ * **Certified Payroll Export Blocked**
+ *
+ * Failing compliance checks block this certified payroll export: a job-level check on the named job, or a time-card check on a worker the export would include. These are the same checks that disable Export in the web app. Resolve the failing checks, then retry.
+ *
  * ### certified_payroll_format_unavailable
  *
  * **Certified Payroll Format Unavailable**
@@ -427,6 +433,7 @@ export declare const zProblemTypeCatalog: z.ZodEnum<{
     version_overlap: "version_overlap";
     precondition_failed: "precondition_failed";
     attachment_not_image: "attachment_not_image";
+    certified_payroll_export_blocked: "certified_payroll_export_blocked";
     certified_payroll_format_unavailable: "certified_payroll_format_unavailable";
     company_not_employer: "company_not_employer";
     confirm_apprenticeship_conflict: "confirm_apprenticeship_conflict";
@@ -3819,7 +3826,7 @@ export declare const zDsptchCprImportResponseObject: z.ZodObject<{
     updated_at: z.ZodISODateTime;
 }, z.core.$strip>;
 /**
- * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
+ * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. On a job that tracks prevailing wage, each rate must also be more than 0 when the row has hours at its multiplier: a row that prices such hours at 0 or below answers 422 naming `non_positive_rate_for_prevailing_wage_hours`, and nothing is written. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
  *
  * Submitting the same work twice is refused rather than doubled: an import will not write onto a time card that already holds data, so a retry after a submission that already succeeded answers 422 naming `time_card_has_data`, and nothing is written. The guard is per time card, not per file, so a corrected file for the same worker and period is refused the same way — clear that period's data first.
  *
@@ -5863,7 +5870,7 @@ export declare const zJobCaEcprXmlExportResponseObject: z.ZodObject<{
     created_at: z.ZodISODateTime;
 }, z.core.$strip>;
 /**
- * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. A window with no reportable pay periods answers 422 nothing_exportable.
+ * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. Failing compliance checks that block the export answer 422 certified_payroll_export_blocked. A window with no reportable pay periods answers 422 nothing_exportable.
  */
 export declare const zJobCaEcprXmlExportCreateParameters: z.ZodObject<{
     start_date: z.ZodISODate;

package/dist/gen/zod.gen.js

@@ -240,6 +240,12 @@ export const zProblem = z.object({
  *
  * The upload behind an image attachment's signed id is not an image content type. Upload an image file.
  *
+ * ### certified_payroll_export_blocked
+ *
+ * **Certified Payroll Export Blocked**
+ *
+ * Failing compliance checks block this certified payroll export: a job-level check on the named job, or a time-card check on a worker the export would include. These are the same checks that disable Export in the web app. Resolve the failing checks, then retry.
+ *
  * ### certified_payroll_format_unavailable
  *
  * **Certified Payroll Format Unavailable**
@@ -428,6 +434,7 @@ export const zProblemTypeCatalog = z.enum([
     'version_overlap',
     'precondition_failed',
     'attachment_not_image',
+    'certified_payroll_export_blocked',
     'certified_payroll_format_unavailable',
     'company_not_employer',
     'confirm_apprenticeship_conflict',
@@ -3540,7 +3547,7 @@ export const zDsptchCprImportResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
+ * Submit a certified payroll report for a pay period. The pay period's pay schedule must be in aggregate time mode; a schedule that keeps time as entries is refused. The file carries every column of the DSPTCH CPR template: the payroll, job and employee identifiers, the employer and employee pay, contribution and deduction amounts, the three wage pay rates, and one hours column per multiplier per day of the period — seven days each for a weekly schedule, fourteen for a biweekly one. All of them must be present as column headers, or the file is refused naming the ones missing. Of those, job_id, week_ending_date, employee_payroll_id, one_x_wage_pay_rate and one_five_x_wage_pay_rate must also carry a value on every row, and two_x_wage_pay_rate must whenever any 2x hours column does. On a job that tracks prevailing wage, each rate must also be more than 0 when the row has hours at its multiplier: a row that prices such hours at 0 or below answers 422 naming `non_positive_rate_for_prevailing_wage_hours`, and nothing is written. federal_labor_classification and regional_labor_classification are read when present, and are needed only where a position has more than one wage determination in a jurisdiction. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
  *
  * Submitting the same work twice is refused rather than doubled: an import will not write onto a time card that already holds data, so a retry after a submission that already succeeded answers 422 naming `time_card_has_data`, and nothing is written. The guard is per time card, not per file, so a corrected file for the same worker and period is refused the same way — clear that period's data first.
  *
@@ -5392,7 +5399,7 @@ export const zJobCaEcprXmlExportResponseObject = z.object({
     created_at: z.iso.datetime()
 });
 /**
- * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. A window with no reportable pay periods answers 422 nothing_exportable.
+ * Start a job-scoped CA DIR eCPR XML certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Filename is server-owned. A job that does not offer CA eCPR answers 422 certified_payroll_format_unavailable. Failing compliance checks that block the export answer 422 certified_payroll_export_blocked. A window with no reportable pay periods answers 422 nothing_exportable.
  */
 export const zJobCaEcprXmlExportCreateParameters = z.object({
     start_date: z.iso.date(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.51.0",
+  "version": "0.51.1",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",