Details Endpoint

/api/partner/1.0/{product}/documents/details

Endpoint authentication

When adopting OAuth 2.0 as an authentication method, the below security requirements are needed in order to trigger this endpoint:

• If the user does not have access to the API Administration security role, an error 401: Unauthorized is displayed.

• The user must fulfill the below security roles requirements; if he fails to obtain access to all the necessary security roles, an error 403: Insufficient privileges to execute this request is displayed:

  • The user must acquire access to at least one of the below specified product access security roles; he needs to have access to the security role corresponding to the product included in the URL:

    • Tax - Access T1 Product

    • Tax - Access T2 Product

    • Tax - Access T3 Product

    • Tax - Access Forms Product

• This endpoint validates against the user's contact security and return visibility. If the user does not have access to the contact or return in question, an error 306: Resource not found in the system is displayed.

Endpoint description

This endpoint allows to add or update the Details of one or a batch of documents for the product specified in the URL. Please note that the Details endpoint can handle up to 100 documents at a time or the endpoint’s rate limit, whichever comes first.

Model	{ "details": "string", "documentIds": [ "string" ] }
Properties	details: Short description of a maximum of 255 characters. When set to an empty string, the details’ value of the document is cleared.
	documentIds: The GUID(s) array of documents which can be retrieved by creating a get request using the Documents endpoint.

Examples

Request URL	https://mysite.cchifirm.ca/taxcan/api/partner/1.0/t1/documents/details
Request body	{ "details": "Scenario 2025", "documentIds": [ "471a9712-5bb0-445e-986b-f2689f4813ed" ] }
Response body	{ "errors": [] }