Overview
A PriceBook is a set of Products used in Invoice or Claim. To call Invoice endpoint, use one of the URLs from the following tables:
| URL |
GET |
PUT |
POST |
DELETE |
| https://api.mypcorp.com/pricebook |
✔ |
|
|
|
| https://api.mypcorp.com/pricebook/{PriceBookGuid} |
✔ |
|
|
|
NB: Currently, PriceBook endpoint only accepts GET requests. PUT, POST and DELETE requests will be available in the future.
GET
The following table illustrates which fields can be included when receiving a GET response.
PriceBook
| Field Name |
Description |
PriceBookGuid
Guid (Identifier) |
The PriceBook’s id. This is a read only field. |
Name
string |
The name of the PriceBook. |
Products
object |
The items the price book contains, called a Product object. To view the Product’s details, refer to the following Products table. |
Products
| Field Name |
Description |
ProductGuid
Guid (Identifier) |
The Product’s id. This is a read only field. |
Code
string |
The code of the Product. |
Name
string |
The name of the Product. |
LongDescription
string |
The description about the product, more descriptive than Name field. |
Price
decimal |
Price of the product. |
GstInclusive
boolean |
Indicates whether GST is inclusive for the product. |
Example JSON response:
{
"@odata.context": "https://api.mypcorp.com/$metadata#PriceBook(Products())",
"value": [
{
"PriceBookGuid": "5680d3bb-864b-4837-8ced-017f7576cc7a",
"Name": "General NDIS Price Book",
"Products": [
{
"ProductGuid": "e951aa45-69f3-4454-a267-3e94adc27e62",
"Code": "12_026_0128_3_3",
"Name": "Dietician Group Session - Group of 3-QLD-2021",
"LongDescription": "Group based specialist dietary advice on managing diet for well-being due to the impact of their disability. This assumes a group of 3.",
"Price": 60.1600,
"GstInclusive": false
}
]
}
]
}