Price Book Headers
Subcategories: Price Book Items
The Price Book Header resource is used to view, create, update, and delete the name, description, and status of a price book. It also includes the unique identifier, unique code, and the currency on which the price book amount is based.
|
Resource Plural Label |
Price Book Headers |
|
Resource Name |
priceBookHeaders |
Get All Price Books
Request: GET
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use the listed finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
PrimaryKey |
Finds a Price Book with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Price Book
Request: POST
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Price Book
Request: GET
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Price Book
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Pricebook. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Pricebook
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Price Book
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/priceBookHeaders/{priceBookId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
priceBookId |
Integer |
The unique identifier of the Price Book. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
CurrencyCodeSearchVA |
CurrencyCode |
CurrencyCode |
|
StatusCodeLovForUIVA |
LookupCode |
StatusCode |
|
LOVVA_For___ORACO__Tax1Code_c |
LookupCode |
__ORACO__Tax1Code_c |
|
LOVVA_For___ORACO__Tax1Method_c |
LookupCode |
__ORACO__Tax1Method_c |
|
LOVVA_For___ORACO__Tax2Code_c |
LookupCode |
__ORACO__Tax2Code_c |
|
LOVVA_For___ORACO__Tax2Method_c |
LookupCode |
__ORACO__Tax2Method_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
PricebookId |
integer |
The unique identifier of the price book. |
|
PricebookCode |
string |
The unique code of the price book. |
|
CurrencyCode |
string |
The currency the price book amount is based on. Properties: The maximum length is 15. UI Label: Currency |
|
Name |
string |
The name of the price book. Properties: The maximum length is 150. UI Label: Name |
|
Description |
string |
The description of the price book. Properties: The maximum length is 1999. UI Label: Description |
|
StatusCode |
string |
The status of the price book. Properties: The maximum length is 30. UI Label: Status |
|
CreatedBy |
string |
The user who created the price book. Properties: The maximum length is 64. |
|
CreationDate |
datetime |
The date and time when the price book was created. |
|
LastUpdateDate |
datetime |
The date and time when the price book was last updated. |
|
LastUpdateLogin |
string |
The login of the user who last updated the price book. Properties: The maximum length is 32. |
|
LastUpdatedBy |
string |
The user who last updated the price book. Properties: The maximum length is 64. |
|
UpdateFlag |
boolean |
Indicates whether the price book can be updated. |
|
DeleteFlag |
boolean |
Indicates whether the price book can be deleted. |
|
HeaderExternalSource |
string |
The source for the external key of the price book. Properties: The maximum length is 120. UI Label: Header External Source |
|
HeaderExternalKey |
string |
The external key value for the price book. Properties: The maximum length is 120. UI Label: Header External Key |
|
__ORACO__Tax1Code_c |
string |
The code for tax 1 applicable on the price book. The default value is VAT. Properties: The maximum length is 1500. UI Label: Tax 1 Code |
|
__ORACO__Tax1Method_c |
string |
The method for the application of tax 1 on the price book, such as percentage or amount. The default is percentage. Properties: The maximum length is 1500. UI Label: Tax 1 Method |
|
__ORACO__Tax2Code_c |
string |
The code for tax 2 applicable on the price book. The default value is VAT. Properties: The maximum length is 1500. UI Label: Tax 2 Code |
|
__ORACO__Tax2Method_c |
string |
The method for the application of tax 2 on the price book, such as percentage or amount. The default is percentage. Properties: The maximum length is 1500. UI Label: Tax 2 Method |