Create a new Product
/ProductsInspect fields and contract →
An Unleashed MCP connector for stock, products, sales orders and purchasing. Explore the coverage and join the access waitlist.
Inventory and orders
MCP XYZ is building an independent Unleashed MCP connector so an AI assistant can work with authorised inventory and order records through the Model Context Protocol. The connector covers documented Unleashed API operations; new access is by invitation from the waitlist, and live business workflows still need validation.
Use the catalogue to check the operations and fields your work needs. If an existing connector is missing a useful action, tell us about it when joining the waitlist. Your software’s permissions and API limits still apply.
Explore documented product, stock-on-hand and warehouse operations for questions about inventory across your business.
Inspect documented operations →Inspect sales-order and customer operations, including the products, quantities and prices retained in their documented fields.
Inspect documented operations →Review the purchase-order, receipt and supplier coverage before planning an authorised purchasing workflow.
Inspect documented operations →“Show stock on hand by warehouse for this product.”
New access starts with the Unleashed waitlist. Tell us which assistant you use and the work you want to do. We’ll contact you about relevant access updates; joining does not create an account or guarantee an invitation date.
Once invited, sign in to MCP XYZ, choose your workspace and add the API ID and key for your authorised Unleashed account. Run the connection check, then add its MCP URL to your assistant. Saved credentials alone do not verify a connection.
Start with read-only access while you explore. Jiffi can handle setup with you. Live business workflows still need validation against an authorised account.
In Claude Desktop or web, open Settings → Connectors → Add custom connector, enter your connection’s MCP URL, then connect and choose access in MCP XYZ.
Read the AI client guide → How access and permissions work →
Documented coverage
145 documented operation variants. Open a contract to inspect its parameters, fields, sources and unresolved behaviour. No provider request is made here.
145 operations match. Showing 41–60.
/ProductsInspect fields and contract →/Products/{productGuid}Inspect fields and contract →/Products/Obsolete/{productGuid}Inspect fields and contract →/PurchaseOrdersInspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/CostsInspect fields and contract →/PurchaseOrdersInspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/LinesInspect fields and contract →/PurchaseOrders/{orderGuid}/ReceiptInspect fields and contract →/PurchaseOrders/{orderGuid}/CompleteInspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/Lines/{lineGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/Lines/{lineGuid}Inspect fields and contract →/SalesOrdersInspect fields and contract →/SalesOrders/{orderGuid}Inspect fields and contract →/SalesOrdersInspect fields and contract →/SalesOrders/{orderGuid}Inspect fields and contract →/SalesOrders/{orderGuid}/LinesInspect fields and contract →Documented contract, live behaviour unverified
unleashed_delete_purchase_orders_linesRead the provider documentation ↗
| Parameter | Required | Provider description |
|---|---|---|
orderGuid | Yes | Provider identifier from the corresponding resource; preserve the documented identifier type. |
lineGuid | Yes | Provider identifier from the corresponding resource; preserve the documented identifier type. |
These source tables cover the resource’s documented methods. Read each table’s heading for its request or response context.
GET Purchase Orders
| Property | Type | Length | Notes |
|---|---|---|---|
| BCSubTotal | Nullable Decimal | Base Currency SubTotal | |
| BCTaxTotal | Nullable Decimal | Base Currency TaxTotal | |
| BCTotal | Nullable Decimal | Base Currency Total | |
| Comments | String | 1024 | |
| CompletedDate | Nullable DateTime | UTC timezone only | |
| CreatedBy | String | 50 | |
| CreatedOn | DateTime | ||
| Currency | Currency | ||
| CustomOrderStatus | String | 15 | |
| DeliveryCity | String | 50 | |
| DeliveryCountry | String | 50 | |
| DeliveryDate | Nullable DateTime | ||
| DeliveryName | String | 50 | |
| DeliveryPostCode | String | 50 | |
| DeliveryRegion | String | 50 | |
| DeliveryStreetAddress | String | 200 | |
| DeliveryStreetAddress2 | String | 200 | |
| DeliverySuburb | String | 50 | |
| DiscountRate | Decimal | ||
| ExchangeRate | Nullable Decimal | ||
| Guid | Guid | ||
| LastModifiedBy | String | 50 | |
| LastModifiedOn | Nullable DateTime | ||
| OrderDate | Nullable DateTime | UTC timezone only | |
| OrderNumber | String | 15 | |
| OrderStatus | String | 50 | Purchase Orders with an "Unapproved" status will return a value of "Parked" for the orderStatus. |
| Printed | Nullable Boolean | ||
| PurchaseOrderLines | PurchaseOrderLine collection | ||
| ReceivedDate | Nullable DateTime | The date the Purchase Order was receipted. UTC timezone only | |
| SalesOrders | SalesOrder collection | A list of orders that are linked to a PurchaseOrder. The Guid and OrderNumber for every SalesOrder linked to a PurchaseOrder will be returned in the collection. | |
| SubTotal | Nullable Decimal | ||
| Supplier | Supplier | ||
| SupplierEORI | String | 20 | |
| SupplierInvoiceDate | Nullable DateTime | UTC timezone only | |
| SupplierRef | String | 500 | |
| Tax | Tax | ||
| TaxCode | String | 50 | |
| TaxRate | Nullable Decimal | ||
| TaxTotal | Nullable Decimal | ||
| Total | Nullable Decimal | ||
| TotalVolume | Nullable Decimal | ||
| TotalWeight | Nullable Decimal | ||
| Warehouse | Warehouse |
GET Purchase Orders
| Property | Type | Length | Notes |
|---|---|---|---|
| BatchNumbers | Batch collection | ||
| BCCostTotal | Decimal | Base Currency CostTotal | |
| BCLandedCost | Decimal | Base Currency LandedCost | |
| BCSubTotal | Nullable Decimal | Base Currency SubTotal | |
| BCUnitPrice | Nullable Decimal | Base Currency UnitPrice | |
| Comments | String | 1024 | |
| CreatedBy | String | 50 | |
| CreatedOn | Nullable DateTime | ||
| DeliveryDate | Nullable DateTime | Date only, no time component. | |
| DiscountedUnitPrice | Decimal | ||
| DiscountRate | Decimal | ||
| Guid | Guid | ||
| LastModifiedBy | String | 256 | |
| LastModifiedOn | Nullable DateTime | ||
| LineNumber | Integer | ||
| LineTax | Nullable Decimal | ||
| LineTaxCode | String | 50 | |
| LineTaxRate | Decimal | ||
| LineTotal | Decimal | ||
| OrderQuantity | Decimal | ||
| PurchaseUnitOrderQuantity | Decimal | ||
| PendingBatchNumbers | PendingBatch collection | Will not return a Guid (only available after the PO is receipted) | |
| PendingSerialNumbers | PendingSerial collection | Will not return a Guid (only available after the PO is receipted) | |
| Product | Product | ||
| PurchaseUnitOrderQuantity | Decimal | ||
| PurchaseUnitReceiptQuantity | Nullable Decimal | ||
| ReceiptQuantity | Nullable Decimal | ||
| SerialNumbers | Serial collection | ||
| UnitOfMeasure | UnitOfMeasure | ||
| UnitPrice | Decimal | ||
| Volume | Nullable Decimal | ||
| Weight | Nullable Decimal |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| BatchNumber | String | 50 |
| ExpiryDate | Date | |
| Guid | Guid | |
| LastModifiedOn | DateTime | |
| Quantity | Decimal |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| BatchNumber | String | 50 |
| CreatedOn | DateTime | |
| ExpiryDate | Date | |
| Quantity | Decimal |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| SerialNumber | String | 50 |
| Guid | Guid | |
| LastModifiedOn | DateTime |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| CreatedOn | DateTime | |
| SerialNumber | String | 50 |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| ProductCode | String | 100 |
| ProductDescription | String | 500 |
| ProductGroup | ProductGroup | |
| SupplierProductCode | String | 100 |
| SupplierProductDescription | String | 500 |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| GroupName | String | 450 |
| LastModifiedOn | Nullable DateTime | |
| ParentGroupGuid | Guid |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| CurrencyCode | String | 3 |
| Description | String | 200 |
| DefaultBuyRate | Nullable Decimal | |
| DefaultSellRate | Nullable Decimal | |
| Guid | Guid | |
| LastModifiedOn | Nullable DateTime |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| OrderNumber | String | 50 |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| SupplierCode | String | 500 |
| SupplierName | String | 500 |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| CanApplyToExpenses | Boolean | |
| CanApplyToRevenue | Boolean | |
| Description | String | 50 |
| Guid | Guid | |
| LastModifiedOn | Nullable DateTime | |
| Obsolete | Boolean | |
| TaxCode | String | 25 |
| TaxRate | Nullable Decimal |
GET Purchase Orders
| Property | Type | Length |
|---|---|---|
| AddressLine1 | String | 500 |
| AddressLine2 | String | 50 |
| City | String | 500 |
| ContactName | String | 50 |
| Country | String | 500 |
| DDINumber | String | 25 |
| FaxNumber | String | 25 |
| Guid | Guid | |
| IsDefault | Boolean | |
| LastModifiedOn | Nullable DateTime | |
| MobileNumber | String | 25 |
| Obsolete | Boolean | |
| PhoneNumber | String | 25 |
| PostCode | String | 500 |
| Region | String | 500 |
| StreetNo | String | 500 |
| Suburb | String | 500 |
| WarehouseCode | String | 15 |
| WarehouseName | String | 100 |
Get Purchase Order Costs
| Property | Type | Length |
|---|---|---|
| AppliedDistributionMethod | String | 15 |
| BCCost | Nullable Decimal | |
| BCTaxCost | Nullable Decimal | |
| BCTotalCost | Nullable Decimal | |
| Cost | Decimal | |
| CostDate | Nullable DateTime | |
| CostExchangeRate | Nullable Decimal | |
| Currency | String | 3 |
| DistributionMethod | String | 15 |
| OrderExchangeRate | Nullable Decimal | |
| Receipted | Boolean | |
| Reference | String | 200 |
| Supplier | Supplier | |
| TaxCode | String | 50 |
| TaxCost | Decimal | |
| TaxRate | Nullable Decimal | |
| TotalCost | Nullable Decimal |
POST/PUT Purchase Orders
| Property | Type | Length | Notes | POST | PUT |
|---|---|---|---|---|---|
| Comments | String | 1024 | |||
| Currency | Currency | Must match supplier's default currency | N/A | ||
| DeliveryCity | String | 50 | |||
| DeliveryCountry | String | 50 | |||
| DeliveryDate | DateTime | ||||
| DeliveryName | String | 50 | |||
| DeliveryPostCode | String | 50 | |||
| DeliveryRegion | String | 50 | |||
| DeliveryStreetAddress | String | 200 | |||
| DeliveryStreetAddress2 | String | 200 | |||
| DeliverySuburb | String | 50 | |||
| DiscountRate | Decimal | Must be between 0 and 1 | |||
| ExchangeRate | Decimal | ||||
| Guid | Guid | Automatically generates a Guid if not provided for POST. Can only be set when adding a record. | Optional | N/A | |
| OrderDate | DateTime | UTC timezone only | |||
| OrderNumber | String | 15 | N/A | ||
| OrderStatus | String | 50 | POST values: Parked , Placed , and Complete PUT values: POST values and Costed | Required | Required |
| PurchaseOrderLines | PurchaseOrderLine collection | At least one with Placed, Costed or Complete status | N/A | ||
| ReceivedDate | DateTime | The date the Purchase Order was receipted. UTC timezone only | N/A | ||
| SubTotal | Decimal (2dp) | Required | N/A | ||
| Supplier | Supplier | Required | Required | ||
| SupplierEORI | String | 20 | If not provided, defaults to the Supplier EORI number | ||
| SupplierInvoiceDate | DateTime | UTC timezone only | |||
| SupplierRef | String | 500 | |||
| Tax | Tax | N/A | |||
| TaxCode | String | 50 | Takes precedence over the Tax object | ||
| TaxRate | Decimal | ||||
| TaxTotal | Decimal (2dp) | Required | N/A | ||
| Total | Decimal (2dp) | Required | N/A | ||
| Warehouse | Warehouse |
POST/PUT Purchase Orders
| Property | Type | Length | POST |
|---|---|---|---|
| Guid | Guid | Optional | |
| CurrencyCode | String | 3 | Optional |
POST/PUT Purchase Orders
| Property | Type | Length | POST |
|---|---|---|---|
| Guid | Guid | Optional | |
| SupplierCode | String | 500 | Optional |
POST/PUT Purchase Orders
| Property | Type | Length | POST |
|---|---|---|---|
| TaxCode | String | 25 | Optional |
| TaxRate | Decimal | Optional |
POST/PUT Purchase Orders
| Property | Type | Length | POST |
|---|---|---|---|
| Guid | Guid | Optional | |
| WarehouseCode | String | 15 | Optional |
POST/PUT Purchase Order Lines
| Property | Type | Length | Notes | POST | PUT |
|---|---|---|---|---|---|
| Comments | String | 1024 | |||
| DeliveryDate | DateTime | ||||
| DiscountRate | Decimal | Must be between 0 and 1 | |||
| DiscountedUnitPrice | Decimal | If DiscountRate is also specified, DiscountedUnitPrice must equal (1 - DiscountRate) * UnitPrice | Unavailable | ||
| Guid | Guid | Optional | N/A | ||
| LineNumber | Integer | Required | N/A | ||
| LineTax | Decimal (2dp) | Follows tax hierarchy: 1. Product 2. Purchase Order 3. Supplier 4. Default Purchase tax | Required | Required | |
| LineTotal | Decimal (2dp) | Required | Required | ||
| OrderQuantity | Decimal (4dp) | Quantity will be treated in the purchasing unit if UnitOfMeasure is provided | Required | Required | |
| PendingBatchNumbers | PendingBatch collection | Add the Pending Batch Number(s) to the collection. These are considered "Pending" until the Purchase Order is receipted using the POST Receipt API | |||
| PendingSerialNumbers | PendingSerial collection | Add the Pending Batch Number(s) to the collection. These are considered "Pending" until the Purchase Order is receipted using the POST Receipt API | |||
| Product | Product | Required | N/A | ||
| ReceiptQuantity | Decimal | Quantity will be treated in the purchasing unit if UnitOfMeasure is provided | |||
| UnitOfMeasure | UnitOfMeasure | Must be a valid purchasing unit for the line product. If not provided, defaults to the product's base unit | N/A | ||
| UnitPrice | Decimal (4dp) | ||||
| Volume | Decimal | If supplied, will override the Product unit's default volume | N/A | ||
| Weight | Decimal | If supplied, will override the Product unit's default weight | N/A |
POST/PUT Purchase Order Lines
| Property | Type | Length | POST |
|---|---|---|---|
| BatchNumber (XML) / Number (JSON) | String | 50 | Required |
| Quantity | Decimal | Required | |
| ExpiryDate | DateTime |
POST/PUT Purchase Order Lines
| Property | Type | Length | POST |
|---|---|---|---|
| SerialNumber (XML) / Identifier (JSON) | String | 50 | Required |
POST/PUT Purchase Order Lines
| Property | Type | Length | POST |
|---|---|---|---|
| Guid | Guid | Optional | |
| ProductCode | String | 100 | Optional |
POST/PUT Purchase Order Lines
| Property | Type | Length | POST |
|---|---|---|---|
| Guid | Guid | Optional | |
| Name | String | 20 | Optional |
GET Purchase Orders
| Filter | Description |
|---|---|
| completedAfter | Returns Purchase Orders completed after the specified date. |
| completedBefore | Returns Purchase Orders completed before the specified date. |
| customOrderStatus | Returns Purchase Orders with the specified custom status. If specified, this filter will override the orderStatus filter. |
| endDate | Only return Purchases with OrderDate before a specified date |
| modifiedSince | Returns Purchase Orders created or edited after a specified date, must be UTC format. |
| orderNumber | Returns a single Purchase Order with the specified order number. If set, it overrides all other filters. |
| orderStatus | If a filter is not provided, returns all non-deleted Purchase Orders. Will return deleted Purchase Orders if explicitly specified as a filter. Recognised values: Parked, Placed, Unapproved, Costed, Receipted, Complete, Deleted. Note : Unapproved purchase orders will return a value of "Parked" for the orderStatus |
| serialBatch | False by default. If set to true then the attributes SerialNumbers, PendingSerialNumbers, BatchNumbers and PendingBatchNumbers are displayed. |
| startDate | Only return Purchases with OrderDate after a specified date |
| supplierCode | Only return suppliers that start with the specific supplier code |
| warehouseCode | Returns Purchase Orders with the specified warehouse code. |
The exact retained JSON includes schemas, nested fields, notes, source evidence and unresolved questions. It is a documented contract, not a live response.
{
"id": "delete_purchase_orders_lines",
"name": "unleashed_delete_purchase_orders_lines",
"resourceId": "Purchases",
"description": "Delete a Purchase Order Line",
"method": "DELETE",
"path": "/PurchaseOrders/{orderGuid}/Lines/{lineGuid}",
"documentationUrl": "https://apidocs.unleashedsoftware.com/Purchases",
"readOnly": false,
"destructive": true,
"idempotent": false,
"pathParameters": [
{
"name": "orderGuid",
"required": true,
"schema": {
"type": "string",
"minLength": 1
},
"description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
},
{
"name": "lineGuid",
"required": true,
"schema": {
"type": "string",
"minLength": 1
},
"description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
}
],
"queryParameters": [],
"requestBodySchema": null,
"responseSchema": null,
"pagination": null,
"notes": [
"Do not automatically replay after an ambiguous transport failure. The documentation does not establish an idempotency-key contract for this operation."
],
"provenance": [
{
"sourceUrl": "https://apidocs.unleashedsoftware.com/Purchases",
"sourceSha256": "73cf19b53dd8fd87d8ca80867c610b3cd6362c61715ac1e7929a303a7350a60b",
"section": "The full range of URIs and HTTP Verbs supported are",
"evidence": "DELETE /PurchaseOrders/{orderGuid}/Lines/{lineGuid}",
"operationDescriptions": [
"Delete a Purchase Order Line"
]
}
],
"confidence": "documented-route",
"unresolved": [
"No authenticated sandbox or production request has verified this operation."
],
"requestFieldTable": null,
"responseFieldTable": null
}{
"id": "Purchases",
"name": "Purchase Orders",
"group": "Editable resources",
"documentationUrl": "https://apidocs.unleashedsoftware.com/Purchases",
"snapshot": "snapshots/Purchases.html",
"sourceSha256": "73cf19b53dd8fd87d8ca80867c610b3cd6362c61715ac1e7929a303a7350a60b",
"fetchedAt": "2026-10-23T14:00:33.606356+00:00",
"operationIds": [
"list_purchase_orders",
"get_purchase_orders",
"list_purchase_orders_costs",
"create_purchase_orders",
"create_purchase_orders_with_guid",
"create_purchase_orders_lines",
"receipt_purchase_orders",
"complete_purchase_orders",
"update_purchase_orders",
"update_purchase_orders_lines",
"delete_purchase_orders",
"delete_purchase_orders_lines"
],
"fieldTables": [
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for GET Purchase Orders",
"rows": [
[
"Property",
"Type",
"Length",
"Notes"
],
[
"BCSubTotal",
"Nullable Decimal",
"",
"Base Currency SubTotal"
],
[
"BCTaxTotal",
"Nullable Decimal",
"",
"Base Currency TaxTotal"
],
[
"BCTotal",
"Nullable Decimal",
"",
"Base Currency Total"
],
[
"Comments",
"String",
"1024",
""
],
[
"CompletedDate",
"Nullable DateTime",
"",
"UTC timezone only"
],
[
"CreatedBy",
"String",
"50",
""
],
[
"CreatedOn",
"DateTime",
"",
""
],
[
"Currency",
"Currency",
"",
""
],
[
"CustomOrderStatus",
"String",
"15",
""
],
[
"DeliveryCity",
"String",
"50",
""
],
[
"DeliveryCountry",
"String",
"50",
""
],
[
"DeliveryDate",
"Nullable DateTime",
"",
""
],
[
"DeliveryName",
"String",
"50",
""
],
[
"DeliveryPostCode",
"String",
"50",
""
],
[
"DeliveryRegion",
"String",
"50",
""
],
[
"DeliveryStreetAddress",
"String",
"200",
""
],
[
"DeliveryStreetAddress2",
"String",
"200",
""
],
[
"DeliverySuburb",
"String",
"50",
""
],
[
"DiscountRate",
"Decimal",
"",
""
],
[
"ExchangeRate",
"Nullable Decimal",
"",
""
],
[
"Guid",
"Guid",
"",
""
],
[
"LastModifiedBy",
"String",
"50",
""
],
[
"LastModifiedOn",
"Nullable DateTime",
"",
""
],
[
"OrderDate",
"Nullable DateTime",
"",
"UTC timezone only"
],
[
"OrderNumber",
"String",
"15",
""
],
[
"OrderStatus",
"String",
"50",
"Purchase Orders with an \"Unapproved\" status will return a value of \"Parked\" for the orderStatus."
],
[
"Printed",
"Nullable Boolean",
"",
""
],
[
"PurchaseOrderLines",
"PurchaseOrderLine collection",
"",
""
],
[
"ReceivedDate",
"Nullable DateTime",
"",
"The date the Purchase Order was receipted. UTC timezone only"
],
[
"SalesOrders",
"SalesOrder collection",
"",
"A list of orders that are linked to a PurchaseOrder. The Guid and OrderNumber for every SalesOrder linked to a PurchaseOrder will be returned in the collection."
],
[
"SubTotal",
"Nullable Decimal",
"",
""
],
[
"Supplier",
"Supplier",
"",
""
],
[
"SupplierEORI",
"String",
"20",
""
],
[
"SupplierInvoiceDate",
"Nullable DateTime",
"",
"UTC timezone only"
],
[
"SupplierRef",
"String",
"500",
""
],
[
"Tax",
"Tax",
"",
""
],
[
"TaxCode",
"String",
"50",
""
],
[
"TaxRate",
"Nullable Decimal",
"",
""
],
[
"TaxTotal",
"Nullable Decimal",
"",
""
],
[
"Total",
"Nullable Decimal",
"",
""
],
[
"TotalVolume",
"Nullable Decimal",
"",
""
],
[
"TotalWeight",
"Nullable Decimal",
"",
""
],
[
"Warehouse",
"Warehouse",
"",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Purchase Order Line",
"rows": [
[
"Property",
"Type",
"Length",
"Notes"
],
[
"BatchNumbers",
"Batch collection",
"",
""
],
[
"BCCostTotal",
"Decimal",
"",
"Base Currency CostTotal"
],
[
"BCLandedCost",
"Decimal",
"",
"Base Currency LandedCost"
],
[
"BCSubTotal",
"Nullable Decimal",
"",
"Base Currency SubTotal"
],
[
"BCUnitPrice",
"Nullable Decimal",
"",
"Base Currency UnitPrice"
],
[
"Comments",
"String",
"1024",
""
],
[
"CreatedBy",
"String",
"50"
],
[
"CreatedOn",
"Nullable DateTime",
""
],
[
"DeliveryDate",
"Nullable DateTime",
"",
"Date only, no time component."
],
[
"DiscountedUnitPrice",
"Decimal",
"",
""
],
[
"DiscountRate",
"Decimal",
"",
""
],
[
"Guid",
"Guid",
"",
""
],
[
"LastModifiedBy",
"String",
"256",
""
],
[
"LastModifiedOn",
"Nullable DateTime",
"",
""
],
[
"LineNumber",
"Integer",
"",
""
],
[
"LineTax",
"Nullable Decimal",
"",
""
],
[
"LineTaxCode",
"String",
"50",
""
],
[
"LineTaxRate",
"Decimal",
"",
""
],
[
"LineTotal",
"Decimal",
"",
""
],
[
"OrderQuantity",
"Decimal",
"",
""
],
[
"PurchaseUnitOrderQuantity",
"Decimal",
"",
""
],
[
"PendingBatchNumbers",
"PendingBatch collection",
"",
"Will not return a Guid (only available after the PO is receipted)"
],
[
"PendingSerialNumbers",
"PendingSerial collection",
"",
"Will not return a Guid (only available after the PO is receipted)"
],
[
"Product",
"Product",
"",
""
],
[
"PurchaseUnitOrderQuantity",
"Decimal",
"",
""
],
[
"PurchaseUnitReceiptQuantity",
"Nullable Decimal",
"",
""
],
[
"ReceiptQuantity",
"Nullable Decimal",
"",
""
],
[
"SerialNumbers",
"Serial collection",
"",
""
],
[
"UnitOfMeasure",
"UnitOfMeasure",
"",
""
],
[
"UnitPrice",
"Decimal",
"",
""
],
[
"Volume",
"Nullable Decimal",
"",
""
],
[
"Weight",
"Nullable Decimal",
"",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Batch",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"BatchNumber",
"String",
"50"
],
[
"ExpiryDate",
"Date",
""
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"DateTime",
""
],
[
"Quantity",
"Decimal",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Pending Batch",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"BatchNumber",
"String",
"50"
],
[
"CreatedOn",
"DateTime",
""
],
[
"ExpiryDate",
"Date",
""
],
[
"Quantity",
"Decimal",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Serial",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"SerialNumber",
"String",
"50"
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"DateTime",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Pending Serial",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CreatedOn",
"DateTime",
""
],
[
"SerialNumber",
"String",
"50"
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Product",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"Guid",
"Guid",
""
],
[
"ProductCode",
"String",
"100"
],
[
"ProductDescription",
"String",
"500"
],
[
"ProductGroup",
"ProductGroup",
""
],
[
"SupplierProductCode",
"String",
"100"
],
[
"SupplierProductDescription",
"String",
"500"
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Product Group",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"Guid",
"Guid",
""
],
[
"GroupName",
"String",
"450"
],
[
"LastModifiedOn",
"Nullable DateTime",
""
],
[
"ParentGroupGuid",
"Guid",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Currency",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CurrencyCode",
"String",
"3"
],
[
"Description",
"String",
"200"
],
[
"DefaultBuyRate",
"Nullable Decimal",
""
],
[
"DefaultSellRate",
"Nullable Decimal",
""
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"Nullable DateTime",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Sales Order",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"Guid",
"Guid",
""
],
[
"OrderNumber",
"String",
"50"
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Supplier",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"Guid",
"Guid",
""
],
[
"SupplierCode",
"String",
"500"
],
[
"SupplierName",
"String",
"500"
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Tax",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CanApplyToExpenses",
"Boolean",
""
],
[
"CanApplyToRevenue",
"Boolean",
""
],
[
"Description",
"String",
"50"
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"Nullable DateTime",
""
],
[
"Obsolete",
"Boolean",
""
],
[
"TaxCode",
"String",
"25"
],
[
"TaxRate",
"Nullable Decimal",
""
]
]
},
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Fields for Warehouse",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"AddressLine1",
"String",
"500"
],
[
"AddressLine2",
"String",
"50"
],
[
"City",
"String",
"500"
],
[
"ContactName",
"String",
"50"
],
[
"Country",
"String",
"500"
],
[
"DDINumber",
"String",
"25"
],
[
"FaxNumber",
"String",
"25"
],
[
"Guid",
"Guid",
""
],
[
"IsDefault",
"Boolean",
""
],
[
"LastModifiedOn",
"Nullable DateTime",
""
],
[
"MobileNumber",
"String",
"25"
],
[
"Obsolete",
"Boolean",
""
],
[
"PhoneNumber",
"String",
"25"
],
[
"PostCode",
"String",
"500"
],
[
"Region",
"String",
"500"
],
[
"StreetNo",
"String",
"500"
],
[
"Suburb",
"String",
"500"
],
[
"WarehouseCode",
"String",
"15"
],
[
"WarehouseName",
"String",
"100"
]
]
},
{
"heading": "Get Purchase Order Costs",
"anchor": "get-purchase-order-costs",
"summary": "Available Fields for GET Purchase Order Costs",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"AppliedDistributionMethod",
"String",
"15"
],
[
"BCCost",
"Nullable Decimal",
""
],
[
"BCTaxCost",
"Nullable Decimal",
""
],
[
"BCTotalCost",
"Nullable Decimal",
""
],
[
"Cost",
"Decimal",
""
],
[
"CostDate",
"Nullable DateTime",
""
],
[
"CostExchangeRate",
"Nullable Decimal",
""
],
[
"Currency",
"String",
"3"
],
[
"DistributionMethod",
"String",
"15"
],
[
"OrderExchangeRate",
"Nullable Decimal",
""
],
[
"Receipted",
"Boolean",
""
],
[
"Reference",
"String",
"200"
],
[
"Supplier",
"Supplier",
""
],
[
"TaxCode",
"String",
"50"
],
[
"TaxCost",
"Decimal",
""
],
[
"TaxRate",
"Nullable Decimal",
""
],
[
"TotalCost",
"Nullable Decimal",
""
]
]
},
{
"heading": "POST/PUT Purchase Orders",
"anchor": "postput-purchase-orders",
"summary": "Available Fields for POST/PUT Purchase Orders",
"rows": [
[
"Property",
"Type",
"Length",
"Notes",
"POST",
"PUT"
],
[
"Comments",
"String",
"1024",
"",
"",
""
],
[
"Currency",
"Currency",
"",
"Must match supplier's default currency",
"",
"N/A"
],
[
"DeliveryCity",
"String",
"50",
"",
"",
""
],
[
"DeliveryCountry",
"String",
"50",
"",
"",
""
],
[
"DeliveryDate",
"DateTime",
"",
"",
"",
""
],
[
"DeliveryName",
"String",
"50",
"",
"",
""
],
[
"DeliveryPostCode",
"String",
"50",
"",
"",
""
],
[
"DeliveryRegion",
"String",
"50",
"",
"",
""
],
[
"DeliveryStreetAddress",
"String",
"200",
"",
"",
""
],
[
"DeliveryStreetAddress2",
"String",
"200",
"",
"",
""
],
[
"DeliverySuburb",
"String",
"50",
"",
"",
""
],
[
"DiscountRate",
"Decimal",
"",
"Must be between 0 and 1",
"",
""
],
[
"ExchangeRate",
"Decimal",
"",
"",
"",
""
],
[
"Guid",
"Guid",
"",
"Automatically generates a Guid if not provided for POST. Can only be set when adding a record.",
"Optional",
"N/A"
],
[
"OrderDate",
"DateTime",
"",
"UTC timezone only",
"",
""
],
[
"OrderNumber",
"String",
"15",
"",
"",
"N/A"
],
[
"OrderStatus",
"String",
"50",
"POST values: Parked , Placed , and Complete PUT values: POST values and Costed",
"Required",
"Required"
],
[
"PurchaseOrderLines",
"PurchaseOrderLine collection",
"",
"At least one with Placed, Costed or Complete status",
"",
"N/A"
],
[
"ReceivedDate",
"DateTime",
"",
"The date the Purchase Order was receipted. UTC timezone only",
"",
"N/A"
],
[
"SubTotal",
"Decimal (2dp)",
"",
"",
"Required",
"N/A"
],
[
"Supplier",
"Supplier",
"",
"",
"Required",
"Required"
],
[
"SupplierEORI",
"String",
"20",
"If not provided, defaults to the Supplier EORI number",
"",
""
],
[
"SupplierInvoiceDate",
"DateTime",
"",
"UTC timezone only",
"",
""
],
[
"SupplierRef",
"String",
"500",
"",
"",
""
],
[
"Tax",
"Tax",
"",
"",
"",
"N/A"
],
[
"TaxCode",
"String",
"50",
"Takes precedence over the Tax object",
"",
""
],
[
"TaxRate",
"Decimal",
"",
"",
"",
""
],
[
"TaxTotal",
"Decimal (2dp)",
"",
"",
"Required",
"N/A"
],
[
"Total",
"Decimal (2dp)",
"",
"",
"Required",
"N/A"
],
[
"Warehouse",
"Warehouse",
"",
"",
"",
""
]
]
},
{
"heading": "POST/PUT Purchase Orders",
"anchor": "postput-purchase-orders",
"summary": "Available Fields for Currency",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"Guid",
"Guid",
"",
"Optional"
],
[
"CurrencyCode",
"String",
"3",
"Optional"
]
]
},
{
"heading": "POST/PUT Purchase Orders",
"anchor": "postput-purchase-orders",
"summary": "Available Fields for Supplier",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"Guid",
"Guid",
"",
"Optional"
],
[
"SupplierCode",
"String",
"500",
"Optional"
]
]
},
{
"heading": "POST/PUT Purchase Orders",
"anchor": "postput-purchase-orders",
"summary": "Available Fields for Tax",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"TaxCode",
"String",
"25",
"Optional"
],
[
"TaxRate",
"Decimal",
"",
"Optional"
]
]
},
{
"heading": "POST/PUT Purchase Orders",
"anchor": "postput-purchase-orders",
"summary": "Available Fields for Warehouse",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"Guid",
"Guid",
"",
"Optional"
],
[
"WarehouseCode",
"String",
"15",
"Optional"
]
]
},
{
"heading": "POST/PUT Purchase Order Lines",
"anchor": "postput-purchase-order-lines",
"summary": "Available Fields for POST/PUT Purchase Order Lines",
"rows": [
[
"Property",
"Type",
"Length",
"Notes",
"POST",
"PUT"
],
[
"Comments",
"String",
"1024",
"",
"",
""
],
[
"DeliveryDate",
"DateTime",
"",
"",
"",
""
],
[
"DiscountRate",
"Decimal",
"",
"Must be between 0 and 1",
"",
""
],
[
"DiscountedUnitPrice",
"Decimal",
"",
"If DiscountRate is also specified, DiscountedUnitPrice must equal (1 - DiscountRate) * UnitPrice",
"Unavailable",
""
],
[
"Guid",
"Guid",
"",
"",
"Optional",
"N/A"
],
[
"LineNumber",
"Integer",
"",
"",
"Required",
"N/A"
],
[
"LineTax",
"Decimal (2dp)",
"",
"Follows tax hierarchy: 1. Product 2. Purchase Order 3. Supplier 4. Default Purchase tax",
"Required",
"Required"
],
[
"LineTotal",
"Decimal (2dp)",
"",
"",
"Required",
"Required"
],
[
"OrderQuantity",
"Decimal (4dp)",
"",
"Quantity will be treated in the purchasing unit if UnitOfMeasure is provided",
"Required",
"Required"
],
[
"PendingBatchNumbers",
"PendingBatch collection",
"",
"Add the Pending Batch Number(s) to the collection. These are considered \"Pending\" until the Purchase Order is receipted using the POST Receipt API",
"",
""
],
[
"PendingSerialNumbers",
"PendingSerial collection",
"",
"Add the Pending Batch Number(s) to the collection. These are considered \"Pending\" until the Purchase Order is receipted using the POST Receipt API",
"",
""
],
[
"Product",
"Product",
"",
"",
"Required",
"N/A"
],
[
"ReceiptQuantity",
"Decimal",
"",
"Quantity will be treated in the purchasing unit if UnitOfMeasure is provided",
"",
""
],
[
"UnitOfMeasure",
"UnitOfMeasure",
"",
"Must be a valid purchasing unit for the line product. If not provided, defaults to the product's base unit",
"",
"N/A"
],
[
"UnitPrice",
"Decimal (4dp)",
"",
"",
"",
""
],
[
"Volume",
"Decimal",
"",
"If supplied, will override the Product unit's default volume",
"",
"N/A"
],
[
"Weight",
"Decimal",
"",
"If supplied, will override the Product unit's default weight",
"",
"N/A"
]
]
},
{
"heading": "POST/PUT Purchase Order Lines",
"anchor": "postput-purchase-order-lines",
"summary": "Available Fields for Pending Batch",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"BatchNumber (XML) / Number (JSON)",
"String",
"50",
"Required"
],
[
"Quantity",
"Decimal",
"",
"Required"
],
[
"ExpiryDate",
"DateTime",
"",
""
]
]
},
{
"heading": "POST/PUT Purchase Order Lines",
"anchor": "postput-purchase-order-lines",
"summary": "Available Fields for Pending Serial",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"SerialNumber (XML) / Identifier (JSON)",
"String",
"50",
"Required"
]
]
},
{
"heading": "POST/PUT Purchase Order Lines",
"anchor": "postput-purchase-order-lines",
"summary": "Available Fields for Product",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"Guid",
"Guid",
"",
"Optional"
],
[
"ProductCode",
"String",
"100",
"Optional"
]
]
},
{
"heading": "POST/PUT Purchase Order Lines",
"anchor": "postput-purchase-order-lines",
"summary": "Available Fields for Unit of Measure",
"rows": [
[
"Property",
"Type",
"Length",
"POST"
],
[
"Guid",
"Guid",
"",
"Optional"
],
[
"Name",
"String",
"20",
"Optional"
]
]
}
],
"filterTables": [
{
"heading": "GET Purchase Orders",
"anchor": "get-purchase-orders",
"summary": "Available Filters for GET Purchase Orders",
"rows": [
[
"Filter",
"Description"
],
[
"completedAfter",
"Returns Purchase Orders completed after the specified date."
],
[
"completedBefore",
"Returns Purchase Orders completed before the specified date."
],
[
"customOrderStatus",
"Returns Purchase Orders with the specified custom status. If specified, this filter will override the orderStatus filter."
],
[
"endDate",
"Only return Purchases with OrderDate before a specified date"
],
[
"modifiedSince",
"Returns Purchase Orders created or edited after a specified date, must be UTC format."
],
[
"orderNumber",
"Returns a single Purchase Order with the specified order number. If set, it overrides all other filters."
],
[
"orderStatus",
"If a filter is not provided, returns all non-deleted Purchase Orders. Will return deleted Purchase Orders if explicitly specified as a filter. Recognised values: Parked, Placed, Unapproved, Costed, Receipted, Complete, Deleted. Note : Unapproved purchase orders will return a value of \"Parked\" for the orderStatus"
],
[
"serialBatch",
"False by default. If set to true then the attributes SerialNumbers, PendingSerialNumbers, BatchNumbers and PendingBatchNumbers are displayed."
],
[
"startDate",
"Only return Purchases with OrderDate after a specified date"
],
[
"supplierCode",
"Only return suppliers that start with the specific supplier code"
],
[
"warehouseCode",
"Returns Purchase Orders with the specified warehouse code."
]
]
}
],
"documentationNotes": [
"The PurchaseOrders resource allows PurchaseOrders to be listed, viewed and created. An individual purchase order’s details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI.",
"",
"Note: Fields that specify the number of decimal places (dp) in their type will round any request values that do not match the specified accuracy.",
"Note: At a minimum, a valid Guid or CurrencyCode is required.",
"Note: At a minimum, a valid Guid or SupplierCode is required.",
"Note: At a minimum, a valid TaxCode or TaxRate is required.",
"Note: At a minimum, a valid Guid or WarehouseCode is required.",
"Note: Fields that specify the number of decimal places (dp) in their type will round any request values that do not match the specified accuracy.",
"Note: At a minimum, a valid Guid or ProductCode is required.",
"Note: At a minimum, a valid Guid or Name is required."
]
}Inspect the Procore catalogue and the approval and account requirements while live acceptance is still pending.
Explore Procore →