### GET /Assemblies Response Example Source: https://apidocs.unleashedsoftware.com/Assemblies This example shows the structure of a successful response when retrieving assembly data using the GET /Assemblies endpoint. ```APIDOC ## GET /Assemblies ### Description Retrieves a list of assemblies. ### Method GET ### Endpoint /Assemblies ### Response #### Success Response (200) - **AssemblyNumber** (string) - The unique identifier for the assembly. - **AssemblyDate** (string) - The date the assembly was created. - **AssemblyType** (string) - The type of assembly. - **AssemblyStatus** (string) - The current status of the assembly. - **CustomAssemblyStatus** (string) - A custom status for the assembly. - **AutoAssembly** (boolean) - Indicates if the assembly was automatically generated. - **Quantity** (number) - The quantity of the assembled product. - **AssembleBy** (string) - The date by which the assembly should be completed. - **Comments** (string) - Any comments related to the assembly. - **CanAssembleQuantity** (number) - The quantity that can still be assembled. - **BatchNumbers** (array) - List of batch numbers associated with the assembly. - **SerialNumbers** (array) - List of serial numbers associated with the assembly. - **Product** (object) - Details of the product being assembled. - **Guid** (string) - The unique identifier for the product. - **ProductCode** (string) - The code of the product. - **ProductDescription** (string) - The description of the product. - **AssemblyLines** (array) - A list of components or sub-assemblies used in this assembly. - **Guid** (string) - The unique identifier for the assembly line item. - **Product** (object) - Details of the product for this line item. - **Guid** (string) - The unique identifier for the product. - **ProductCode** (string) - The code of the product. - **ProductDescription** (string) - The description of the product. - **BatchNumbers** (array) - List of batch numbers for this line item. - **SerialNumbers** (array) - List of serial numbers for this line item. - **Quantity** (number) - The quantity for this line item. - **DisassembleCost** (number) - The cost to disassemble this line item. - **WastageQuantity** (number) - The quantity of wastage for this line item. - **UnitCost** (number) - The cost per unit for this line item. - **TotalCost** (number) - The total cost for this line item. - **LastModifiedOn** (string) - The date and time this line item was last modified. - **SubAssemblyGuid** (string) - The GUID of a sub-assembly, if applicable. - **SupplierCosts** (array) - A list of supplier costs associated with the assembly. - **SourceWarehouse** (object) - Details of the source warehouse. - **WarehouseCode** (string) - The code of the warehouse. - **WarehouseName** (string) - The name of the warehouse. - **IsDefault** (boolean) - Indicates if this is the default warehouse. - **StreetNo** (string) - Street number of the warehouse address. - **AddressLine1** (string) - First line of the warehouse address. - **AddressLine2** (string) - Second line of the warehouse address. - **Suburb** (string) - Suburb of the warehouse address. - **City** (string) - City of the warehouse address. - **Region** (string) - Region of the warehouse address. - **Country** (string) - Country of the warehouse address. - **PostCode** (string) - Postal code of the warehouse address. - **PhoneNumber** (string) - Phone number of the warehouse. - **FaxNumber** (string) - Fax number of the warehouse. - **MobileNumber** (string) - Mobile number of the warehouse. - **DDINumber** (string) - DDI number of the warehouse. - **ContactName** (string) - Contact person at the warehouse. - **Obsolete** (boolean) - Indicates if the warehouse is obsolete. - **Guid** (string) - The unique identifier for the warehouse. - **LastModifiedOn** (string) - The date and time the warehouse was last modified. - **DestinationWarehouse** (object) - Details of the destination warehouse (same structure as SourceWarehouse). - **Total** (number) - The total value of the assembly. - **TotalCost** (number) - The total cost of the assembly. ### Response Example ```json { "AssemblyNumber": "ASM-00000008", "AssemblyDate": "/Date(1540945347866)/", "AssemblyType": "Assembly", "AssemblyStatus": "Completed", "CustomAssemblyStatus": "CustomStatus", "AutoAssembly": true, "Quantity": 4, "AssembleBy": "/Date(1612224000000)/", "Comments": "Created for Invoice SO-00000124.", "CanAssembleQuantity": 5.7, "BatchNumbers": null, "SerialNumbers": null, "Product": { "Guid": "facf323c-44c8-4a96-9cff-0629bd4250c6", "ProductCode": "BOOKSHELF", "ProductDescription": "Wooden Bookshelf" }, "AssemblyLines": [ { "Guid": "abfa6b98-ac83-40ed-b01c-9f018b28460e", "Product": { "Guid": "8333db36-46ca-47f6-9299-3b0c4cd861a2", "ProductCode": "SIDE", "ProductDescription": "Bookshelf Side" }, "BatchNumbers": null, "SerialNumbers": null, "Quantity": 4, "DisassembleCost": null, "WastageQuantity": 0, "UnitCost": 804.596, "TotalCost": 3218.384, "LastModifiedOn": "/Date(1540945347773)/", "SubAssemblyGuid": null }, { "Guid": "abfa6b98-ac83-40ed-b01c-9f018b28460e", "Product": { "Guid": "636725ec-7e68-4139-aea8-14495e510bc6", "ProductCode": "STAIN", "ProductDescription": "Dark Wood Stain" }, "BatchNumbers": null, "SerialNumbers": null, "Quantity": 4, "DisassembleCost": null, "WastageQuantity": 0, "UnitCost": 80.8316, "TotalCost": 323.3264, "LastModifiedOn": "/Date(1540945347804)/", "SubAssemblyGuid": null }, { "Guid": "abfa6b98-ac83-40ed-b01c-9f018b28460e", "Product": { "Guid": "6f9d1c47-aafb-4449-8bfc-e4a950db4110", "ProductCode": "SHELF", "ProductDescription": "Bookshelf Shelf" }, "BatchNumbers": null, "SerialNumbers": null, "Quantity": 40, "DisassembleCost": null, "WastageQuantity": 0, "UnitCost": 86.3154, "TotalCost": 3452.616, "LastModifiedOn": "/Date(1540945347820)/", "SubAssemblyGuid": null }, { "Guid": "abfa6b98-ac83-40ed-b01c-9f018b28460e", "Product": { "Guid": "36ae4925-aa47-48ef-8b52-6c07205dbbec", "ProductCode": "COUCH2", "ProductDescription": "2-Seater Couch" }, "BatchNumbers": null, "SerialNumbers": null, "Quantity": 20, "DisassembleCost": null, "WastageQuantity": 0, "UnitCost": 8.5041, "TotalCost": 170.082, "LastModifiedOn": "/Date(1540945347851)/", "SubAssemblyGuid": null } ], "SupplierCosts": [], "SourceWarehouse": { "WarehouseCode": "HQ", "WarehouseName": "Head Office", "IsDefault": false, "StreetNo": null, "AddressLine1": null, "AddressLine2": null, "Suburb": null, "City": null, "Region": null, "Country": null, "PostCode": null, "PhoneNumber": null, "FaxNumber": null, "MobileNumber": null, "DDINumber": null, "ContactName": null, "Obsolete": false, "Guid": "a6f76423-1363-4421-9db8-16e75b7886b9", "LastModifiedOn": "/Date(1540939798920)/" }, "DestinationWarehouse": { "WarehouseCode": "HQ", "WarehouseName": "Head Office", "IsDefault": false, "StreetNo": null, "AddressLine1": null, "AddressLine2": null, "Suburb": null, "City": null, "Region": null, "Country": null, "PostCode": null, "PhoneNumber": null, "FaxNumber": null, "MobileNumber": null, "DDINumber": null, "ContactName": null, "Obsolete": false, "Guid": "a6f76423-1363-4421-9db8-16e75b7886b9", "LastModifiedOn": "/Date(1540939798920)/" }, "Total": 7164.41, "TotalCost": 7164.41 } ``` ``` -------------------------------- ### POST /Assemblies XML Example Source: https://apidocs.unleashedsoftware.com/Assemblies Provides an example of a POST request for creating an assembly in XML format. Note that user-generated GUIDs are not accepted. ```xml BOOKSHELF MAIN MAIN 10 2021-12-25 Assembly Comments STAIN 5 1 40m 5000h oopsie lisa.brown@unleashedsoftware.com ``` -------------------------------- ### JSON Example for GET /ProductGroups Source: https://apidocs.unleashedsoftware.com/ProductGroups This JSON snippet illustrates the structure of product group data returned by the API, including group name, GUID, and parent group GUID. ```json { "Items": [ { "GroupName": "Shirt", "ParentGroupGuid": "6da57796-ac99-435d-a61b-15bf102d90ff", "Guid": "6c26844f-ea3e-4272-a7eb-87c34e4279ae", "LastModifiedOn": "/Date(1737669611773)/" }, { "GroupName": "Pants", "ParentGroupGuid": "6da57796-ac99-435d-a61b-15bf102d90ff", "Guid": "806b0376-8af3-4863-b795-c978c3d1c699", "LastModifiedOn": "/Date(1737669611773)/" }, { "GroupName": "Jacket", "ParentGroupGuid": "6da57796-ac99-435d-a61b-15bf102d90ff", "Guid": "d867c3b3-1f8e-41ae-9fc8-06c0356a6d9a", "LastModifiedOn": "/Date(1737669611773)/" }, { "GroupName": "Gift", "ParentGroupGuid": null, "Guid": "c67e4db1-cdb1-407b-a2f4-1bab6ad88622", "LastModifiedOn": "/Date(1396146740740)/" }, { "GroupName": "Software", "ParentGroupGuid": null, "Guid": "85aa8531-f234-4110-ad07-dc2d470d7e7a", "LastModifiedOn": "/Date(1396146740740)/" }, { "GroupName": "Vehicle", "ParentGroupGuid": null, "Guid": "b80d1b91-19a7-4955-87a3-c9d8ad8a5e81", "LastModifiedOn": "/Date(1396146740740)/" }, { "GroupName": "Consumable", "ParentGroupGuid": null, "Guid": "c8bd91f4-a254-42cb-9269-4fc0f22b917c", "LastModifiedOn": "/Date(1396146740740)/" }, { "GroupName": "Hardware", "ParentGroupGuid": null, "Guid": "0c856550-e8a6-475f-948a-1d586867534e", "LastModifiedOn": "/Date(1396146740740)/" }, { "GroupName": "Clothing", "ParentGroupGuid": null, "Guid": "6da57796-ac99-435d-a61b-15bf102d90ff", "LastModifiedOn": "/Date(1396146740740)/" } ] } ``` -------------------------------- ### POST /Assemblies JSON Example Source: https://apidocs.unleashedsoftware.com/Assemblies Provides an example of a POST request for creating an assembly in JSON format. Note that user-generated GUIDs are not accepted. ```json { "Product": { "ProductCode": "BOOKSHELF" }, "SourceWarehouse": { "WarehouseCode": "MAIN" }, "DestinationWarehouse": { "WarehouseCode": "MAIN" }, "Quantity": 10, "AssembleBy": "2021-12-25", "Comments": "Assembly Comments", "AssemblyLines": [ { "Product": { "ProductCode": "STAIN" }, "Quantity": 5, "WastageQuantity": 1 } ], "ExpectedDuration": "40m", "ActualDuration": "5000h", "DurationComments": "oopsie", "ProductionPerson": { "Email": "lisa.brown@unleashedsoftware.com" } } ``` -------------------------------- ### GET /Assemblies Response Example Source: https://apidocs.unleashedsoftware.com/Assemblies This snippet shows an example of the XML response received when calling the GET /Assemblies endpoint. It includes details about the assembly, its lines, and associated products. ```APIDOC ## GET /Assemblies ### Description Retrieves a list of assemblies. This example shows the structure of a single assembly object in the response. ### Method GET ### Endpoint /Assemblies ### Response #### Success Response (200) - **Guid** (string) - The unique identifier for the assembly. - **LastModifiedOn** (datetime) - The date and time the assembly was last modified. - **AssemblyNumber** (string) - The unique number assigned to the assembly. - **AssemblyDate** (datetime) - The date the assembly was created. - **AssemblyType** (string) - The type of assembly. - **AssemblyStatus** (string) - The current status of the assembly. - **CustomeAssemblyStatus** (string) - A custom status for the assembly. - **AutoAssembly** (boolean) - Indicates if the assembly is automated. - **Quantity** (decimal) - The quantity of the assembly. - **AssembleBy** (datetime) - The date by which the assembly should be completed. - **Comments** (string) - Any comments related to the assembly. - **CanAssembleQuantity** (decimal) - The quantity that can still be assembled. - **Product** (object) - Details of the product being assembled. - **Guid** (string) - The unique identifier for the product. - **ProductCode** (string) - The code of the product. - **ProductDescription** (string) - The description of the product. - **AssemblyLines** (array) - A list of assembly lines associated with this assembly. - **Guid** (string) - The unique identifier for the assembly line. - **Product** (object) - Details of the product for this assembly line. - **Guid** (string) - The unique identifier for the product. - **ProductCode** (string) - The code of the product. - **ProductDescription** (string) - The description of the product. - **Quantity** (decimal) - The quantity for this assembly line. - **DisassembleCost** (decimal) - The cost to disassemble. - **WastageQuantity** (decimal) - The quantity of wastage. - **UnitCost** (decimal) - The cost per unit. - **TotalCost** (decimal) - The total cost for this line. - **LastModifiedOn** (datetime) - The date and time this line was last modified. - **SubAssemblyGuid** (string) - The GUID of a sub-assembly, if applicable. - **SupplierCosts** (object) - Supplier costs associated with the assembly. - **SourceWarehouse** (object) - Details of the source warehouse. - **Guid** (string) - The unique identifier for the warehouse. - **LastModifiedOn** (datetime) - The date and time the warehouse was last modified. - **WarehouseCode** (string) - The code of the warehouse. - **WarehouseName** (string) - The name of the warehouse. - **IsDefault** (boolean) - Indicates if this is the default warehouse. - **Obsolete** (boolean) - Indicates if the warehouse is obsolete. - **DestinationWarehouse** (object) - Details of the destination warehouse. - **Guid** (string) - The unique identifier for the warehouse. - **LastModifiedOn** (datetime) - The date and time the warehouse was last modified. - **WarehouseCode** (string) - The code of the warehouse. - **WarehouseName** (string) - The name of the warehouse. - **IsDefault** (boolean) - Indicates if this is the default warehouse. - **Obsolete** (boolean) - Indicates if the warehouse is obsolete. - **Total** (decimal) - The total cost of the assembly. - **TotalCost** (decimal) - The total cost including all components. - **DisassembleCostTotal** (decimal) - The total cost to disassemble. - **SupplierCostsTax** (decimal) - The tax on supplier costs. - **SupplierCostsSubTotal** (decimal) - The subtotal of supplier costs. - **SalesOrderNumber** (string) - The sales order number associated with this assembly. - **LastModifiedBy** (string) - The user who last modified the assembly. - **CreatedBy** (string) - The user who created the assembly. - **CreatedOn** (datetime) - The date and time the assembly was created. ### Request Example ```xml b87cfd66-25dd-4cac-95cd-743bc187dd49 2018-10-31T00:22:27.8826027 ASM-00000008 2018-10-31T00:22:27.8669688 Assembly Completed CustomStatus true 4.0000 2021-02-02T00:00:00 Created for Invoice SO-00000124. 5.7000 facf323c-44c8-4a96-9cff-0629bd4250c6 BOOKSHELF Wooden Bookshelf abfa6b98-ac83-40ed-b01c-9f018b28460e 8333db36-46ca-47f6-9299-3b0c4cd861a2 SIDE Bookshelf Side 4.0000 0.0000 804.5960 3218.3840 2018-10-31T00:22:27.7732191 abfa6b98-ac83-40ed-b01c-9f018b28460e 636725ec-7e68-4139-aea8-14495e510bc6 STAIN Dark Wood Stain 4.0000 0.0000 80.8316 323.3264 2018-10-31T00:22:27.804477 abfa6b98-ac83-40ed-b01c-9f018b28460e 6f9d1c47-aafb-4449-8bfc-e4a950db4110 SHELF Bookshelf Shelf 40.0000 0.0000 86.3154 3452.6160 2018-10-31T00:22:27.820095 abfa6b98-ac83-40ed-b01c-9f018b28460e 36ae4925-aa47-48ef-8b52-6c07205dbbec COUCH2 2-Seater Couch 20.0000 0.0000 8.5041 170.0820 2018-10-31T00:22:27.8513394 a6f76423-1363-4421-9db8-16e75b7886b9 2018-10-30T22:49:58.92 HQ Head Office false false a6f76423-1363-4421-9db8-16e75b7886b9 2018-10-30T22:49:58.92 HQ Head Office false false 7164.41 7164.41 0.00 0.00 SO-123456789 test@unleashedsoftware.com test@unleashedsoftware.com 2018-10-31T00:21:52.0491654 ``` ### Response Example ```xml b87cfd66-25dd-4cac-95cd-743bc187dd49 2018-10-31T00:22:27.8826027 ASM-00000008 2018-10-31T00:22:27.8669688 Assembly Completed CustomStatus true 4.0000 2021-02-02T00:00:00 Created for Invoice SO-00000124. 5.7000 facf323c-44c8-4a96-9cff-0629bd4250c6 BOOKSHELF Wooden Bookshelf abfa6b98-ac83-40ed-b01c-9f018b28460e 8333db36-46ca-47f6-9299-3b0c4cd861a2 SIDE Bookshelf Side 4.0000 0.0000 804.5960 3218.3840 2018-10-31T00:22:27.7732191 abfa6b98-ac83-40ed-b01c-9f018b28460e 636725ec-7e68-4139-aea8-14495e510bc6 STAIN Dark Wood Stain 4.0000 0.0000 80.8316 323.3264 2018-10-31T00:22:27.804477 abfa6b98-ac83-40ed-b01c-9f018b28460e 6f9d1c47-aafb-4449-8bfc-e4a950db4110 SHELF Bookshelf Shelf 40.0000 0.0000 86.3154 3452.6160 2018-10-31T00:22:27.820095 abfa6b98-ac83-40ed-b01c-9f018b28460e 36ae4925-aa47-48ef-8b52-6c07205dbbec COUCH2 2-Seater Couch 20.0000 0.0000 8.5041 170.0820 2018-10-31T00:22:27.8513394 a6f76423-1363-4421-9db8-16e75b7886b9 2018-10-30T22:49:58.92 HQ Head Office false false a6f76423-1363-4421-9db8-16e75b7886b9 2018-10-30T22:49:58.92 HQ Head Office false false 7164.41 7164.41 0.00 0.00 SO-123456789 test@unleashedsoftware.com test@unleashedsoftware.com 2018-10-31T00:21:52.0491654 ``` ``` -------------------------------- ### GET /Customers XML Example Source: https://apidocs.unleashedsoftware.com/Customers This XML example shows the structure of the response when retrieving customer data. It includes pagination details and a sample customer record with address information. ```xml 1 200 1 1 b9f21e05-07fe-4d9d-b460-a09db4c3caa1 2019-08-06T01:40:17.0039206
Shipping Main Warehouse 31 Hurstmere Road Takapuna Auckland North Shore New Zealand 0622 false Handle with care. 2024-05-28T22:11:09.6589976 aeae2924-4d66-413c-8faf-463e50d3dc65
WADE2 Wade's Apparel & Accessories2 6cb5d67a-1c96-4fa8-bf59-b23c2d69f22a 2019-06-05T23:42:47.5066667 NZD New Zealand, Dollars true 0.0000 false false false false Cash 6b60e9ce-4e1a-40da-bc0c-144ec9a9958a 20th Month following support@unleashedsoftware.com 2019-08-06T01:35:34.6502961 support@unleashedsoftware.com
``` -------------------------------- ### GET Customer Contacts (XML Example) Source: https://apidocs.unleashedsoftware.com/Customers Example of customer contacts data returned in XML format. This structure includes details for multiple customer contacts. ```xml hsmith@company.com Harold Smith 2af29a88-ce12-45b9-84c1-26e4d2d10227 true false false true e9086f56-6966-4599-9b69-c96aa973e981 false false false false ``` -------------------------------- ### Create Product (XML Example) Source: https://apidocs.unleashedsoftware.com/Products Example of how to create a new product using an XML payload. Ensure all required fields are populated correctly. ```xml c97c6b46-f1cc-4741-b236-f882995e7d9a API_POST_Example_1 API Post Example_1 c97c6b46-f1cc-4741-b236-f882995e7d9d 84a37eba-02c2-44cf-aecd-3b9a492eed3f 5 2 794b39bc-6416-46ec-8149-d12616cbaf3d 1 1.2 10 3 2 false 0.0000 1987.0000 2499.9900 0.0000 false true true false true 555555 description GT AO Angola 62ad81e4-ae76-4357-bfe8-7bef8e1c4c4e Furniture 77b05cc5-4f7b-424c-89c7-63aabda06ef4 Storage dde9f6dd-ad27-407d-ae56-3999112faded Horvik's false false 2.0000 1.0000 1.0000 15.0000 1.2 Comes in two boxes true true 7ab407d9-acb5-4136-86da-f06cf57d8d38 BERRY Berry Boutique 84a37eba-02c2-44cf-aecd-3b9a492eed3f EA false 1 ```