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

252 lines
14 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "Expense - Data API",
"description": "Represents an expense linked to a work order. Service resource technicians can log expenses, such as tools or travel costs. This object is available in API version 49.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"AccountId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the account associated with the linked work order."
},
"Amount": {
"type": "currency",
"properties": "Create, Filter, Sort, Update",
"description": "The amount of the expense."
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization."
},
"Description": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "A description for the expense."
},
"Discount": {
"type": "percent",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The percentage deducted from the Subtotal price. Available in version 51.0 and later."
},
"ExpenseEndDate": {
"type": "date",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "If the expense was incurred over multiple days, the Expense End Date is the last day that the expense covers."
},
"ExpenseNumber": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The number that uniquely identifies the expense."
},
"ExpenseStartDate": {
"type": "date",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "If the expense was incurred over multiple days, the Expense Start Date is the first day that the expense covers."
},
"ExpenseType": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
"description": "The type of expense. Possible values are: Billable Non-Billable The default value is Billable."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed a record related to this record."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID of the user who owns the expense record."
},
"Quantity": {
"type": "double",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The number of items purchased in this record. Available in version 51.0 and later."
},
"Subtotal": {
"type": "currency",
"properties": "Filter, Nillable, Sort",
"description": "The subtotal price calculated as the product of Quantity and UnitPrice. Available in version 51.0 and later. This is a calculated field."
},
"Title": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A title that identifies the expense. This field is available in API version 50.0 and later."
},
"TotalPrice": {
"type": "currency",
"properties": "Filter, Nillable, Sort",
"description": "The total price of the transaction which is equal to the discounted subtotal: Subtotal - (Discount * Subtotal). Available in version 51.0 and later. This is a calculated field."
},
"TransactionDate": {
"type": "date",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The day that the expense was incurred, or the payment date for the expense."
},
"UnitPrice": {
"type": "currency",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The price of one item on the record. Available in version 51.0 and later."
},
"WorkOrderId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the work order associated with the expense."
}
},
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **ExpenseChangeEvent (API version 55.0)**: Change events are available for the object.\n- **ExpenseFeed**: Feed tracking is available for the object.\n- **ExpenseHistory**: History is available for tracked fields of the object.\n- **ExpenseOwnerSharingRule**: Sharing rules are available for the object.\n- **ExpenseShare**: Sharing is available for the object.",
"wsdl_segment": "```xml\n<complexType name=\"Expense\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Account\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n <element name=\"AccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ActivityHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Amount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Discount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ExpenseEndDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"ExpenseNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ExpenseReportEntries\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ExpenseStartDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"ExpenseType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Quantity\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Subtotal\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>
"field_reference": {
"AccountId": {
"field_label": "Account ID",
"type": "reference",
"length": "18"
},
"Amount": {
"field_label": "Amount",
"type": "currency",
"precision": "18",
"scale": "2"
},
"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"
},
"Description": {
"field_label": "Description",
"type": "textarea",
"length": "32000"
},
"Discount": {
"field_label": "Discount",
"type": "percent",
"precision": "5",
"scale": "2"
},
"ExpenseEndDate": {
"field_label": "End Date",
"type": "date"
},
"ExpenseNumber": {
"field_label": "Expense Name",
"type": "string",
"length": "255"
},
"ExpenseStartDate": {
"field_label": "Start Date",
"type": "date"
},
"ExpenseType": {
"field_label": "Expense Type",
"type": "picklist",
"length": "40"
},
"Id": {
"field_label": "Expense 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"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"Quantity": {
"field_label": "Quantity",
"type": "double",
"precision": "12",
"scale": "2"
},
"Subtotal": {
"field_label": "Subtotal",
"type": "currency",
"precision": "18",
"scale": "2"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Title": {
"field_label": "Title",
"type": "string",
"length": "255"
},
"TotalPrice": {
"field_label": "Total Price",
"type": "currency",
"precision": "18",
"scale": "2"
},
"TransactionDate": {
"field_label": "Transaction Date",
"type": "date"
},
"UnitPrice": {
"field_label": "Unit Price",
"type": "currency",
"precision": "18",
"scale": "2"
},
"WorkOrderId": {
"field_label": "Work Order ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"precision",
"scale"
]
}