v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Accounting Code3

Attachment7

Attachment Certification1

Auth1

CAPAs2

Chart Of Accounts2

Company Info2

Custom Field2

Customer6

Customer Address5

Customer Contact5

Customer Tier2

Department4

Equipment4

Gauge Code2

Grade Code2

InProcessTrackingFieldType2

Inventory6

Inventory Event2

Inventory Event Details3

Inventory Lot3

Inventory Transactions1

Invoice5

Invoice Deposit Adjustment Line Item2

Invoice Deposit Line Item2

Invoice Discount Line Item1

Invoice Fee Line Item4

Invoice Line Item2

Invoice Note1

Invoice Part Line Item4

Invoice Refund Line Item4

Invoice Shipping Charge Line Item1

Invoice Tax Line Item2

Item10

Item Category2

Item Class2

Item Custom Fields2

Item Customer4

Item Material Vendor3

Item PriceBreaks4

Item Routing26

Item Tag5

Item Vendor3

Job8

Job Custom Fields2

Job Full Routing18

Job Item To Make3

Job Item To Make Operation8

Job Operation1

Job Part Line Item Full Routing1

Job Tracking Timers3

Location3

Material4

Material Code2

Material Vendor6

NCRs2

Note3

Operation4

Payment Term3

Purchase Order7

Purchase Order Custom Fields2

Purchase Order Discount Line Item1

Purchase Order Fee Line Item7

Purchase Order Line Item3

Purchase Order Outside Processing Line Item7

Purchase Order Part Line Item7

Purchase Order Tax Line Item2

Purchase Order Vendor Credit Line Item4

Quote10

Quote Custom Fields2

Quote Discount Line Item3

Quote Fee Line Item5

Quote Part Line Item7

Quote Part Line Item Custom Fields2

Quote Part Line Item Full Routing19

Quote Tax Line Item5

Receiving Receipt5

Receiving Receipt Line Item5

Refund Reason Code2

Reporting9

Sales Order7

Sales Order Blanket Line Item4

Sales Order Custom Fields2

Sales Order Discount Line Item3

Sales Order Fee Line Item6

Sales Order Line Item2

Sales Order Part Line Item8

Sales Order Part Line Item Custom Fields2

Sales Order Part Line Item Full Routing19

Sales Order Refund Line Item4

Sales Order Shipping Charge Line Item1

Sales Order Tax Line Item5

ScrapReport1

Shape Code2

Shipment Custom Fields1

Shipment Line Items (V3)1

Shipments4

Shipping Method2

Tag5

Tax Rate4

Time Clock Timers3

Timer4

Tool8

Tool Calibration5

User2

User Status2

Vendor5

Vendor Address5

Vendor Contact5

Work Order2

WorkCenter4

Attachment

Find attachments based on search parameters.

post/api/attachments/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

attachmentIdsstring[] nullable

Filter to attachments whose ids are in the list.

formatsCommonEnumAttachmentMediaFormatEnum[] nullable

Allows for filtering based on specific attachment format types.

Response

List of attachments matching the filters

idstring required

Unique Id associated to this entity

namestring nullable

The file name.

descriptionstring nullable

Description

type'standard' | 'externalAccessDocument' | 'certification'

Attachment types

format'undefined' | 'cad' | 'document' | 'image' | 'video'

Attachment format

sizeinteger nullable

File size in bytes

fileIdstring required

Internal file identifier

createdUtcstring date-time

UTC timestamp when this attachment record was created on its current owner. Note: when an attachment is copied between owners (for example, from a quote to a job), a new attachment record is created and this value reflects the copy time, not the original upload time.