Documents

Get document attachment

Changed on

Read one attachment and its optional signing state. The file and original parent must both be accessible.

get/documents/{id}/attachments/{attachmentId}

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/documents/{id}/attachments/{attachmentId}
  • Auth: HTTP bearer

Path parameters

idstring required

Resource ID (UUID) or client key

attachmentIdstring uuid required

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Response

Successful response

attachmentIdstring uuid required

Existing relationship UUID, used for individual edits and removal.

documentIdstring uuid required

Stored file UUID used by /documents/{id}.

resourceType'ORDER' | 'LOAD' | 'SERVICE' | 'CARRIER' | 'CUSTOMER' | 'VENDOR' | 'LOCATION' | 'PAYMENT' | 'BILL_PAYMENT' required

Immutable business owner of one attachment. SHIPMENT is a read aggregate; QUOTE management is deferred.

resourceIdstring uuid required

Immutable owner UUID.

loadCarrierIdstring uuid

Carrier assignment, present only for LOAD.

typestring required

Relationship category. Existing unrecognized categories are returned unchanged; new writes require the owner's supported enum.

fileNamestring required

Relationship display name, falling back to the file name when absent.

attachToInvoiceboolean nullable

Stored relationship preference. True selects an eligible file by default; false excludes it. Null inherits current invoice/customer defaults. Create omission stores null; PATCH omission leaves it unchanged. Supported only by ORDER, LOAD and SERVICE. True is rejected for ineligible categories or .xlsx/.xls/.doc/.docx/.csv display names. Does not generate, send or modify an existing invoice PDF.

Changes