Choose attach document API

Choose an appropriate API to attach a document to an order or line

You can attach documents using two methods:

1. Embedded in the order, using the /order API

2. Attach to an existing order, using the /order/documents API

1. Embedded in the order message using the /order API

You can attach documents using the documents field on either order or lines level in the body of the Send order endpoint:

Issue a new order

This will NOT create an OrderDocumentsAttachedByBuyeractivity and NO acknowledge task for the supplier.

The total number of documents is limited to 100 documents per order header and per order line.

Documents body

• code : optional document code or number. The document code should be unique within your company and immutable.

If a document with the same code is already attached to the order or line, the document will be replaced, else it will be appended.

• revision: optional document revision (or version) code or number

• name : optional document short (file) name

• description : optional document description or long name

• type: optional document business type

• objectId: optional Tradecloud object identifier which was returned by the Tradecloud object-storage upload

• url: optional document location if it is not stored in the Tradecloud object-storage.

2. Attach to an existing order using the /order/documents API

You can attach documents to existing orders using the documents field on either order or lines level in the body of the Attach order documents endpoint.

This will create OrderDocumentsAttachedByBuyer and, if enabled, an acknowledge task for the supplier.

The total number of documents is limited to 100 documents per order header and per order line.

Before attaching a document to an order, the order must have been sent to Tradecloud first.

When attaching documents the provided purchase order number will be verified.

Order documents body

Order

• companyId: the optional Tradecloud company identifier. You only have to provide a companyId when your integration user account has multiple company permissions.

• supplierAccountNumber: the supplier account number as known in your ERP system

• purchaseOrderNumber: the purchase order number as known in your ERP system

• documents: the documents to be attached to this order

Lines

• lines: the purchase order lines having a new document attached

• position: the line position within the purchase order

• documents: the documents to be attached to this line

Documents

• code : optional document code or number. The document code should be unique within your company and immutable.

If a document with the same code is already attached to the order or line, the document will be replaced, else it will be appended.

• revision: optional document revision (or version) code or number

• name : optional document short (file) name

• description : optional document description or long name

• type: optional document business type

• objectId: optional Tradecloud object identifier which was returned by the Tradecloud object-storage upload

• url: optional document location if it is not stored in the Tradecloud object-storage.