Breaking changes

Changes for CCH iFirm Taxprep 2025.40 (2025-12-05)

Description of Changes

Boolean filters now accept a single boolean value instead of an array in the getList endpoints.

The copyToDocuments property can now be provided per print format, when printing or publishing returns.

 

Endpoint impacted

Description of the breaking change

Documents – Get List (POST)

The structure of the below endpoints was modified:

Starting with version v40, the getList endpoints were updated to introduce simplified boolean handling.

Previously, all filters required array syntax, even for single values.

Impacted filters:

  • rolled_forward

  • has_tracking_card

This change ensures consistent typing across the API.

 

Request Body Example Before v40:

{

"filters": {

"rolled_forward": [false],

"has_tracking_card": [true]

}

}

Request Body Example After v40:

{

"filters": {

"rolled_forward": false,

"has_tracking_card": true

}

}

Notes

  • Boolean filters will not be accepted as arrays anymore.

  • Other filters continue to use arrays of typed values (e.g., string, integer, GUID), according to their data type.

  • Applies to T1, T2, T3, and TF Documents getList endpoints.

Print – Print Documents to PDF (POST)

The structure of the below endpoint was modified:

  • In the request body, each printFormats object may now include the copyToDocuments Boolean property. This optional parameter allows to send a copy of the printed return to the Documents module, for the selected print format.

    • If omitted, the system uses the value defined in the print format.

    • If set to true, the printed return will also be sent to the Documents module.

    • If set to false, it will not be sent regardless of the value defined in the print format.

 

Request Body Example Before v40:

{

"documents": [

{

"documentId": "4cffbb10-589c-457a-8a52-adda08b8e480",

"returns": [

{

"id": 0,

"language": "English",

"jurisdictions": ["FED","QC"]

}

]

}

],

"options": {

"printFormats": [

{

"id": "5d03b830-aefd-4558-80a0-a3796956f046"

}

],

"overridePrintedDate": "2023-02-21",

"mergePdf": true,

"maskSinHeaderFooter": false,

"maskSinForms": false,

"copyToDocuments": true

}

}

Request Body Example After v40:

{

"documents": [

{

"documentId": "4cffbb10-589c-457a-8a52-adda08b8e480",

"returns": [

{

"id": 0,

"language": "English",

"jurisdictions": ["FED","QC"]

}

]

}

],

"options": {

"printFormats": [

{

"id": "5d03b830-aefd-4558-80a0-a3796956f046"

"copyToDocuments": true #optional

}

],

"overridePrintedDate": "2023-02-21",

"mergePdf": true,

"maskSinHeaderFooter": false,

"maskSinForms": false

}

}

Publish – Publish Returns to Portal (POST)

The structure of the below endpoint was modified:

  • In the request body, the copyToDocuments property was moved inside each printFormats object. This allows specifying, per Print Format, whether the return should also be sent to the Documents module.

    • If omitted, the value defined in the print format is used.

    • If true, the published return is also sent to the Documents module.

    • If false, the published return is not sent, regardless of the value defined in the print format.

Request Body Example Before v40:

{

"documents":

[

{

"documentId": "f9d1f139-fbf1-4d24-978e-ff5e34f6a9d6",

"returns":

[

{

"id": 0,

"language": "English",

"jurisdictions": ["FED","QC"]

}

]

}

],

"options":

{

"printFormats":

[

{

"id": "g9d1l138-fds1-4d23-945e-ff9s34j8a9a8"

},

{

"id": "a8a1l130-qcu1-9v23-218d-cc9a34k9q3q5"

}

],

"overridePrintedDate": "2015-02-21",

"maskSinHeaderFooter": true,

"maskSinForms": false,

"copyToDocuments": true

}

}

Request Body Example After v40:

{

"documents": [

{

"documentId": "e873bbb4-43cd-4474-859d-8c71c3c57c47",

"returns": [

{

"id": 0,

"language": "English",

"jurisdictions": ["FED", "AB"]

}

]

}

],

"options": {

"printFormats": [

{

"id": "5d03b830-aefd-4558-80a0-a3796956f046",

"copyToDocuments": true

}

],

"overridePrintedDate": "2015-02-21",

"maskSinHeaderFooter": true,

"maskSinForms": true

}

}

Print – List of Print Formats (GET)

The structure of the below endpoint was modified:

  • The copyToDocuments Boolean value is now returned for each Print Format in the response body.

    • This value indicates if, by default, the printed or published return will be sent to the Documents module.

    • The value can be overridden in POST requests to the affected print/publish endpoints.

Response Body Example Before v40:

{

"result": [

{

"id": "4382550f-f4fb-1c5f-d840-fff01957f57b",

"name": "Government copy",

"description": "Groups forms required to meet the filing requirements of the tax authorities. It must be used to file paper returns.",

"isDefault": ["d6d50e87-7189-4ac9-b136-cc849412f4c3"],

"lastModificationTimestamp": "2020-08-11T17:55:05Z"

}

],

"errors": []

}

 

Response Body Example After v40:

{

"result": [

{

"id": "4382550f-f4fb-1c5f-d840-fff01957f57b",

"name": "Government copy",

"copyToDocuments": true,

"description": "Groups forms required to meet the filing requirements of the tax authorities. It must be used to file paper returns.",

"isDefault": ["d6d50e87-7189-4ac9-b136-cc849412f4c3"],

"lastModificationTimestamp": "2020-08-11T17:55:05Z"

}

],

"errors": []

}