Create Purchase Order
POST
purchase-orders
Creates a new Purchase Order.
Resource Information
| Method and URI | POST https://api.aps.autodesk.com/fusion-operations/v2/purchase-orders |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
| Content-Type* string | Must be application/json |
* Required
Request
Body Structure
The Purchase Order object to be created, conforming to the specified schema.
Expand all
| code* string | Purchase Order code
Max length: 255 |
| supplier | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| billingAddress | Billing address for the Purchase Order. Must be one of the company addresses. If not provided, the default company address will be used. |
| anyOf | Billing address for the Purchase Order. Must be one of the company addresses. If not provided, the default company address will be used. |
| 0 object | |
| code* string | Address code
Max length: 255 |
| name string | Address name
Max length: 255 |
| city string | Address city
Max length: 255 |
| street* string | Address street |
| postalCode string | Address postal code |
| state string | Address state
Max length: 255 |
| country* string | Address country (ISO 3166-1 alpha-2 code) |
| default boolean | Is default address |
| 1 all of | |
| 0 | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| createdAt* datetime: ISO 8601 | Creation date of the Purchase Order (e.g. 2025-06-21T14:07:17Z) |
| approvalStatus enum:string | Possible values: DRAFT, IN_REVIEW, APPROVED, CONFIRMED, REJECTED |
| documentStatus enum:string | Possible values: NONE, INQUIRE, ORDER, RECEIPT, INVOICE |
| observations string | Max length: 4000 |
| parameters array: object | |
| name* string | |
| value* string | |
| notes string | Max length: 5000 |
| externalNotes string | Max length: 5000 |
| status enum:string | Possible values: OPEN, CLOSED, ARCHIVED |
| active boolean | Indicates if the Purchase Order is visible in the tablet |
| receivings* array: object | |
| code* string | Receiving number
Max length: 255 |
| dueDate datetime: ISO 8601 | Receiving due date (e.g. 2025-06-21T14:07:17Z) |
| requestedDate datetime: ISO 8601 | Receiving requested date (e.g. 2025-06-21T14:07:17Z) |
| deliveryAddress | |
| anyOf | |
| 0 object | |
| code* string | Address code
Max length: 255 |
| name string | Address name
Max length: 255 |
| city string | Address city
Max length: 255 |
| street* string | Address street |
| postalCode string | Address postal code |
| state string | Address state
Max length: 255 |
| country* string | Address country (ISO 3166-1 alpha-2 code) |
| default boolean | Is default address |
| shippingCost number | |
| tax number | |
| products* array: object | |
| product | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| variableParameters array: object | |
| name string | |
| value string | |
| quantityOrdered number | |
| unitOfMeasurement | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| cost number | |
| observations string | Max length: 2000 |
| tax number |
* Required
Response
HTTP Status Code Summary
| 201 Created | PurchaseOrder successfully created. |
| 400 Bad Request | Bad request due to invalid data. |
| 401 Unauthorized | The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request. |
| 403 Forbidden | The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request. |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying. |
| 500 Internal Server Error | An unknown server-side error occurred. Please try again later. If the problem persists, please contact support. |
Response
Header (429)
| Retry-After integer | The number of seconds to wait before retrying the request. |
Response
Body Structure (201)
Expand all
| id int | Unique identifier of the Purchase Order. |
| code string | Purchase Order code
Max length: 255 |
| supplier | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| billingAddress | Billing address for the Purchase Order. Must be one of the company addresses. If not provided, the default company address will be used. |
| anyOf | Billing address for the Purchase Order. Must be one of the company addresses. If not provided, the default company address will be used. |
| 0 object | |
| id int | Unique identifier of the address. |
| code string | Address code
Max length: 255 |
| name string | Address name
Max length: 255 |
| city string | Address city
Max length: 255 |
| street string | Address street |
| postalCode string | Address postal code |
| state string | Address state
Max length: 255 |
| country string | Address country (ISO 3166-1 alpha-2 code) |
| default boolean | Is default address |
| 1 all of | |
| 0 | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| createdAt datetime: ISO 8601 | Creation date of the Purchase Order (e.g. 2025-06-21T14:07:17Z) |
| cost number | |
| approvalStatus enum:string | Possible values: DRAFT, IN_REVIEW, APPROVED, CONFIRMED, REJECTED |
| documentStatus enum:string | Possible values: NONE, INQUIRE, ORDER, RECEIPT, INVOICE |
| observations string | Max length: 4000 |
| parameters array: object | |
| name string | |
| value string | |
| notes string | Max length: 5000 |
| externalNotes string | Max length: 5000 |
| status enum:string | Possible values: OPEN, CLOSED, ARCHIVED |
| active boolean | Indicates if the Purchase Order is visible in the tablet |
| receivings array: object | |
| id int | Unique identifier of the receiving. |
| code string | Receiving number
Max length: 255 |
| dueDate datetime: ISO 8601 | Receiving due date (e.g. 2025-06-21T14:07:17Z) |
| requestedDate datetime: ISO 8601 | Receiving requested date (e.g. 2025-06-21T14:07:17Z) |
| deliveryAddress | |
| anyOf | |
| 0 object | |
| id int | Unique identifier of the address. |
| code string | Address code
Max length: 255 |
| name string | Address name
Max length: 255 |
| city string | Address city
Max length: 255 |
| street string | Address street |
| postalCode string | Address postal code |
| state string | Address state
Max length: 255 |
| country string | Address country (ISO 3166-1 alpha-2 code) |
| default boolean | Is default address |
| shippingCost number | |
| cost number | |
| tax number | |
| products array: object | |
| id int | Unique identifier of the receiving product. |
| product | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| variableParameters array: object | |
| name string | |
| value string | |
| quantityOrdered number | |
| unitOfMeasurement | |
| id int | Unique identifier of the referenced entity. |
| code string | Code of the referenced entity.
Max length: 255 |
| name string | Name of the referenced entity.
Max length: 255 |
| anyOf | |
| 0 | |
| 1 | |
| cost number | |
| observations string | Max length: 2000 |
| tax number |
Example
PurchaseOrder successfully created.
Example single Purchase Order creation request with codes
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/purchase-orders' \
-X 'POST' \
-H 'Authorization: ' \
-H 'Content-Type: application/json' \
-d '{
"code": "PO-1001",
"supplier": {
"code": "SupplierA"
},
"billingAddress": {
"id": 1344
},
"createdAt": "2024-04-01T10:00:00Z",
"cost": 81.64,
"approvalStatus": "IN_REVIEW",
"documentStatus": "INQUIRE",
"observations": "Please deliver between 9 AM and 5 PM.",
"parameters": [
{
"name": "Voltage",
"value": "220V"
}
],
"notes": "Handle with care.",
"externalNotes": "Urgent delivery.",
"status": "OPEN",
"active": false,
"receivings": [
{
"code": "Receiving001",
"dueDate": "2024-04-10T10:00:00Z",
"requestedDate": "2024-04-05T10:00:00Z",
"deliveryAddress": {
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT",
"default": true
},
"shippingCost": 25.24,
"cost": 51.1,
"tax": 5.3,
"products": [
{
"id": 1,
"product": {
"code": "ProductA"
},
"parameters": [
{
"name": "Color",
"value": "Red"
}
],
"quantityOrdered": 1,
"unitOfMeasurement": {
"code": "pcs"
},
"cost": 50.0,
"observations": "First product observation.",
"tax": 6.1
}
]
}
]
}'
Show More
Example single Purchase Order creation request with ids
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/purchase-orders' \
-X 'POST' \
-H 'Authorization: ' \
-H 'Content-Type: application/json' \
-d '{
"code": "PO-1001",
"supplier": {
"id": 45
},
"billingAddress": {
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT"
},
"createdAt": "2024-04-01T10:00:00Z",
"cost": 81.64,
"approvalStatus": "IN_REVIEW",
"documentStatus": "INQUIRE",
"observations": "Please deliver between 9 AM and 5 PM.",
"parameters": [
{
"name": "voltage",
"value": "220V"
}
],
"notes": "Handle with care.",
"externalNotes": "Urgent delivery.",
"status": "OPEN",
"active": false,
"receivings": [
{
"code": "Receiving001",
"dueDate": "2024-04-10T10:00:00Z",
"requestedDate": "2024-04-05T10:00:00Z",
"deliveryAddress": {
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT",
"default": true
},
"shippingCost": 25.24,
"cost": 51.1,
"tax": 5.3,
"products": [
{
"id": 1,
"product": {
"id": 45
},
"parameters": [
{
"name": "Color",
"value": "Red"
}
],
"quantityOrdered": 1,
"unitOfMeasurement": {
"id": 12
},
"cost": 50.0,
"observations": "First product observation.",
"tax": 6.1
}
]
}
]
}'
Show More
Response
{
"id": 382,
"code": "PO-1001",
"supplier": {
"id": 12,
"code": "SupplierA",
"name": "Supplier A"
},
"billingAddress": {
"id": 1,
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT"
},
"createdAt": "2024-04-01T10:00:00Z",
"cost": 81.64,
"approvalStatus": "IN_REVIEW",
"documentStatus": "INQUIRE",
"observations": "Please deliver between 9 AM and 5 PM.",
"parameters": [
{
"name": "Voltage",
"value": "220V"
}
],
"notes": "Handle with care.",
"externalNotes": "Urgent delivery.",
"status": "OPEN",
"active": false,
"receivings": [
{
"id": 5,
"code": "Receiving001",
"dueDate": "2024-04-10T10:00:00Z",
"requestedDate": "2024-04-05T10:00:00Z",
"deliveryAddress": {
"id": 1,
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT",
"default": true
},
"shippingCost": 25.24,
"cost": 51.1,
"tax": 5.3,
"products": [
{
"id": 1,
"product": {
"id": 21,
"code": "ProductA",
"name": "Product A 204"
},
"parameters": [
{
"name": "Color",
"value": "Red"
}
],
"quantityOrdered": 1,
"unitOfMeasurement": {
"id": 4,
"code": "pcs",
"name": "pieces"
},
"cost": 50.0,
"observations": "First product observation.",
"tax": 6.1
}
]
}
]
}
Show More