Retreive a list of project material bookings from your administration. Use offset and limit parameters to retrieve more bookings over multiple calls. It is also possible to retreive only bookings relating to a single project, warehouse or product by using the optional parameters “Project”, “SelectProjectBy”, “Warehouse” and “Product_Number”.
- Request
- Response
Parameters
Limit
Integer
Details
Defines the limit of items to retreive
Offset
Integer
Details
Defines the offset for the retreive
Project
String
Details
Filter the tasks associated with the project by either projectnumber or projectname
SelectProjectBy
String
Details
Allowed values: NAME or NUMBER. Determines wether the value in the parameter 'Project' is the projectname or projectnumber.
EntryDateSince
String
Details
An UNIX timestamp in seconds. Will return only bookings that are created since the specified timestamp.
Product_Number
Long
Details
An optional parameter to retreive only the bookings relating to a product with exactly this articlenumber.
Warehouse
String
Details
An optional parameter to retreive only the bookings relating to a warehouse with exactly this name.
CURL Example
1 |
curl -X GET -H "Content-Type: application/json" -H "ApiKey: b7d343Bnhd436f3ec3bd3504582" -H "Username: [email protected]" "https://rest-api.silvasoft.nl/rest/listprojectmaterialbookingProject=Example&SelectProjectBy=NAME&Limit=10" |
Parameters
Description
String
More info
The description of the booking
EntryDate
Long
More info
An UNIX timestamp in seconds of the bookingdate
Quantity
Float
More info
Quantity of items in this booking
Product_Name
String
More info
The productname relating to this booking
Product_SupplierName
String
More info
The suppliername relating to the product in this booking
Product_SupplierNumber
Integer
More info
The suppliernumber relating to the product in this booking
Batch
String
More info
If the booking is associated to a batch this will show the batch name / number
Shelf
String
More info
If the booking is associated to a shelf this will show the shelf name
Warehouse
String
More info
If the booking is associated to a warehouse this will show the warehouse name
Product_Number
String
More info
The article number (not nessecarily numeric)
Product_PurchasePrice
Float
More info
The latest purchase price
MaterialBookings_Project
Array
More info
An array of the project related to the booking.
MaterialBookings_Project > Name
String
More info
The project name related to the booking.
MaterialBookings_Project > Number
Integer
More info
The project number related to the booking.
MaterialBookings_Project > Customer_Name
String
More info
The customer name related to the project related to the booking.
MaterialBookings_Project > Customer_Number
Integer
More info
The customer number related to the project related to the booking.
MaterialBookings_Project > Description
String
More info
The project description related to the booking.
MaterialBookings_CustomField_Product
Array
More info
An array of custom fields and their values for this product
MaterialBookings_CustomField_Product > Label
String
More info
The custom field name / label
MaterialBookings_CustomField_Product > DataType
String
More info
The datatype of this custom field. Can be used to determine which value field is needed. Possible data types: Decimal, Boolean, String, Integer, DateTime
MaterialBookings_CustomField_Product > DateTimeValue
String Date (dd-MM-yyyy)
More info
The date value of the custom field
MaterialBookings_CustomField_Product > DecimalValue
Float
More info
The decimal value of the custom field
MaterialBookings_CustomField_Product > BooleanValue
Boolean (true|false)
More info
The boolean value of the custom field
MaterialBookings_CustomField_Product > StringValue
String
More info
The string value of the custom field
MaterialBookings_CustomField_Product > IntValue
Integer
More info
The integer value of the custom field
MaterialBookings_CustomField_Product > FieldType
String
More info
The field type as specified in Sivasoft. Possible field types: Integer, Date, Decimal, TextSmall, TextLarge, Hyperlink, Checkbox, List
Response JSON Example
The response order can vary from the parameter order above
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
[ { "Warehouse": "Magazijn Amsterdam", "Description": "test", "Shelf": "2", "Product_Name": "Test API product", "Quantity": "10.00000000", "MaterialBookings_Project": { "Description": "test project", "Number": 1, "Customer_Name": "Customer", "Customer_Number": 33, "Name": "Example project" }, "Product_SupplierName": "test Supplier", "MaterialBookings_CustomField_Product": [ { "DateTimeValue": null, "DecimalValue": "0", "BooleanValue": false, "Label": "Getal", "DataType": "String", "CreateListItem": true, "StringValue": "string", "IntValue": 0, "TypeOfRelation": null, "FieldType": "TextSmall" }, { "DateTimeValue": null, "DecimalValue": "0E-8", "BooleanValue": false, "Label": "Vrije tekst groot", "DataType": "String", "CreateListItem": true, "StringValue": "lots of text", "IntValue": 0, "TypeOfRelation": null, "FieldType": "TextLarge" } ], "Batch": "1", "EntryDate": 1700134795759, "Product_SupplierNumber": 2, "Product_Number": "1", "Product_PurchasePrice": "9.12345000" } ] |