afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/QuoteDocument.json

150 lines
4.3 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"usage",
"field_reference"
],
"title": "QuoteDocument - Data API",
"description": "Represents a quote in document format. Available in API version 18.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ContentVersionDocumentId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "ID for the documents version."
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Defaulted on create, Filter, Restricted picklist",
"description": "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. If the organization has multicurrency and a Pricebook2Id specified on the quote, then the currency value of this field must match the currency of the PricebookEntry objects that are associated with any quote line items it has."
},
"Discount": {
"type": "percent",
"properties": "Filter, Nillable, Sort",
"description": "The discount for the quote used in the document."
},
"Document": {
"type": "base64",
"properties": "Create, Nillable",
"description": "The binary data of the document stored in the QuoteDocument object."
},
"DocumentTemplate": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort",
"description": "The ID of the template used to generate the document."
},
"GrandTotal": {
"type": "currency",
"properties": "Filter, Nillable, Sort",
"description": "Grand total for the quote used in the document."
},
"Name": {
"type": "string",
"properties": "Filter, idLookup, Sort",
"description": "Name of the quote document."
},
"QuoteId": {
"type": "reference",
"properties": "Create, Filter, GroupSort",
"description": "ID for the quote used for the document."
},
"Status": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The status of the document. Possible values are: Completed Failed Generating In Progress None Queued The default value is None."
}
},
"usage": "Use the QuoteDocument object to store a document that can be used to present the quote information to the customer.",
"field_reference": {
"ContentVersionDocumentId": {
"field_label": "Content Version ID",
"type": "reference",
"length": "18"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"Discount": {
"field_label": "Discount",
"type": "percent",
"precision": "5",
"scale": "2"
},
"Document": {
"field_label": "PDF Document",
"type": "base64"
},
"DocumentTemplate": {
"field_label": "Document Template",
"type": "string",
"length": "255"
},
"GrandTotal": {
"field_label": "Grand Total",
"type": "currency",
"precision": "18",
"scale": "2"
},
"Id": {
"field_label": "Quote PDF ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "270"
},
"QuoteId": {
"field_label": "Quote ID",
"type": "reference",
"length": "18"
},
"Status": {
"field_label": "Status",
"type": "picklist",
"length": "40"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"precision",
"scale"
]
}