CareTend APIs

Creates a new proof of delivery document.

post
https://integrationhub.wellsky.io/commands/v4/documents/proofofdelivery
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The requested API version

Body Params
date-time

Optional date when the document was re-sent.

date-time

Optional date when the document was returned.

date-time

Optional date and time when the document was sent.

string
enum
file

The image file of the document to be uploaded.

int64

The ID of the entity to assign this document to.
Must be used together with AssignmentType.

boolean

Indicates whether the inventory item should be printed with the delivery ticket.
Only applicable when AssignmentType is InventoryItem.

boolean

Indicates whether the inventory item should be printed with the delivery ticket only for the first fill.
Only applicable when AssignmentType is InventoryItem.

string
enum
Allowed:
WorkflowGroups
array of objects

Optional workflow group(s) to associate with the document.
Send this field multiple times to place the document in more than one workflow group
(for example both IV and SPRx), matching the multi-group behavior available in CareTend.
Values supplied here are combined (de-duplicated) with WCTS.Service.IntegrationApi.Controllers.Documents.Contracts.CreateDocumentRequestV4Base.WorkflowGroup when both are provided.
Note: System.ComponentModel.DataAnnotations.EnumDataTypeAttribute does not validate collection elements, so each value is
validated in the mapper (ResolveWorkflowGroups), which rejects any undefined value.

WorkflowGroups
Allowed:
CompanyId
array of int64s
required
length ≥ 1

Company ID(s) to associate with the document.
The field can be sent multiple times for multiple IDs.
At least one company ID is required.

CompanyId*
string
required

Description of the document. This will be used as the document name
and is also stored in the DocumentTracking.Description field.

string
length between 1 and 255

Optional document category name. If provided, the system will look up the category ID by this name.

string

Optional Incoming Document Path name (for example "Intake Referrals"). When provided, the
document is placed on that path (setting the "Path Name" shown in the Incoming Documents
grid) and the path's default team, companies and workflow groups are applied, matching how
the desktop network-share import routes documents. Use WCTS.Service.IntegrationApi.Controllers.Documents.Contracts.CreateDocumentRequestV4Base.IncomingDocumentPathId
to select the path by id instead; the id takes precedence when both are supplied.

int64

Optional Incoming Document Path id. Takes precedence over
WCTS.Service.IntegrationApi.Controllers.Documents.Contracts.CreateDocumentRequestV4Base.IncomingDocumentPath when both are provided.

string
length ≤ 50

Optional keywords to associate with the document.
Used for searching and categorizing documents.

string

Optional notes to be stored with the document.

date-time

Optional date when the document was received.

date-time

Optional queue date that drives the "Queue Date" shown in the Incoming Documents grid
(applies to New Fax and New Scan documents, which are the kinds that appear in that grid).
When supplied, the document is queued as of this date instead of the time the API call is
processed, so the original document timing is preserved.

Responses

Updated 4 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?