Create a project billing event
post
/fscmRestApi/resources/11.13.18.05/projectBillingEvents
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BillHold: string
Title:
Hold Invoice
Maximum Length:1
Default Value:N
Indicates that the event is held from invoicing. Mandatory for POST and PATCH operations. Valid values are Y - Indefinitely, N - No, and O - Once. The default value is N. -
billingEventDFF: array
Project Billing Event Descriptive Flexfields
Title:
Project Billing Event Descriptive Flexfields
A listing of all the descriptive flexfields available for project billing events. -
BillTrnsAmount: number
Title:
Amount in Bill Transaction Currency
Default Value:0
Amount of the billing event in the transaction currency. Mandatory for all POST and PATCH operations. -
BillTrnsCurrencyCode(required): string
Title:
Bill Transaction Currency
Maximum Length:15
Indicates the code of the transaction currency for the billing event. Mandatory for POST and PATCH operations. Defaults to the contract currency if you only provide the contract number. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit for the event. Mandatory for POST operation. Valid values include any business unit to which a user has access. -
CompletionDate: string
(date)
Title:
Completion Date
The date on which the event is complete and on or after which the event is processed for revenue accrual and invoicing. Not mandatory for creating a billing event but mandatory for processing the event. Mandatory for creating a reversal event if the Reverse This Event in the Next Period attribute is set to Y. -
ContractLineNumber(required): string
Title:
Contract Line Number
Maximum Length:150
Number that identifies the contract line on the event. Mandatory for POST operation.The Contract Line ID attribute is derived from this attribute. Valid values are any line number that exists on the contract specified in the Contract Number attribute and associated to a bill plan. -
ContractNumber(required): string
Title:
Contract Number
Maximum Length:120
Number that uniquely identifies the contract for the event. Mandatory attribute that is used to derive the Contract ID attribute. Valid values are all contracts that belong to the business unit populated on the event in the Business Unit Name attribute and are not in Closed or Cancel status. -
ContractTypeName: string
Title:
Contract Type Name
Maximum Length:150
Name of the type of contract that is assigned to the billing event. Valid values are all the contract types defined in the application. -
EventDescription(required): string
Title:
Description
Maximum Length:240
The description of the event. For billing events, the description is displayed as the invoice line description. Mandatory attribute that is automatically populated during POST and PATCH operations based on the selected event type name if a value is not provided. -
EventId: integer
(int64)
Title:
Billing Event ID
Unique identifier of the billing event. Mandatory for POST operation and automatically generated during the operation. -
EventTypeName(required): string
Title:
Event Type
Maximum Length:240
Name of the event type that classifies the event by category and identifies whether the event is to be used for revenue only, invoice only, or both invoice and revenue. Mandatory for POST operation. Mandatory for PATCH operation if you specify the Contract Line attribute. -
ItemEventFlag: boolean
Title:
Item based event
Maximum Length:1
Default Value:false
Indicates an item based event. -
ItemNumber: string
Title:
Item Number
Maximum Length:300
Number that identifies the item on the event. -
OrganizationName(required): string
Title:
Organization
Maximum Length:240
Name of the organization for the event. Mandatory for POST operation and defaults to the organization associated to the contract on the event. For a PATCH operation the default value is also set to organization on the contract if a value is not provided. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Identifier of the project on the event. Valid values are the project numbers associated to the contract line. Mandatory if the Require Project on Event profile option is set to Yes. This attribute can be populated during POST and PATCH operations. -
Quantity: number
Title:
Quantity
Quantity of the item on the item based event. -
RevenueHold: string
Title:
Hold Revenue
Maximum Length:1
Default Value:N
Indicates that the event is held from recognizing revenue. Mandatory for POST and PATCH operations. Valid values are Y - Indefinitely, N - No, and O - Once. The default value is N. -
ReverseAccrual: string
Title:
Reverse This Event in the Next Period
Maximum Length:1
Default Value:N
Indicates if the event should automatically reverse in the next period. Default value is N. Set the value to Y to have the application automatically create a reversal event. The Completion Date is also mandatory to create a reversal event. -
SourceName: string
Title:
Event Source
Maximum Length:80
Name of the source application from which the event originated. -
SourceReference: string
Title:
Application Source
Maximum Length:80
Identifier of the event in the source application. -
TaskNumber: string
Title:
Transaction Task Number
Maximum Length:100
Identifier of the transaction task on the event. Valid values are tasks that are associated to the contract line and any sub task of an associated task. This attribute can be populated during POST and PATCH operations. -
UnitPrice: number
Price of each unit of item.
-
UOMCode: string
Title:
UOM Code
Maximum Length:3
Unit of measure code.
Nested Schema : Project Billing Event Descriptive Flexfields
Type:
array
Title:
Project Billing Event Descriptive Flexfields
A listing of all the descriptive flexfields available for project billing events.
Show Source
Nested Schema : projectBillingEvents-billingEventDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
EventId: integer
(int64)
Identifier of the event.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectBillingEvents-item-response
Type:
Show Source
object
-
AdjustedEventId: integer
(int64)
Title:
Adjusted Event ID
Read Only:true
Unique identifier of the adjusted event if the billing event is an adjustment of another billing event. This value is automatically populated when the application creates an adjustment billing event. -
Automatic: string
Title:
Automatic
Read Only:true
Maximum Length:1
Default Value:N
Indicates that the event is created automatically by the application. -
BillCurrencyOptCode: string
Title:
Billing Currency Type
Read Only:true
Indicates the code for the classification of the billing currency that is used for invoicing. The billing currency can be contract currency, transaction currency, or user currency. It is defined on the bill plan attached to the contract line selected for the event. -
BillHold: string
Title:
Hold Invoice
Maximum Length:1
Default Value:N
Indicates that the event is held from invoicing. Mandatory for POST and PATCH operations. Valid values are Y - Indefinitely, N - No, and O - Once. The default value is N. -
BillHoldMeaning: string
Title:
Hold Invoice Meaning
Read Only:true
Maximum Length:80
Displays the meaning of the value in the Hold Invoice attribute. Valid values are No, Once, or Indefinitely. -
billingEventDFF: array
Project Billing Event Descriptive Flexfields
Title:
Project Billing Event Descriptive Flexfields
A listing of all the descriptive flexfields available for project billing events. -
BillingResource: string
Title:
Billing Resource
Read Only:true
Maximum Length:240
Name of the billing resource for the billing event. This attribute is automatically populated based on the setup of the Manage Planning and Billing Resource Breakdown Structures. -
BillingResourceId: integer
(int64)
Title:
Billing Resource ID
Read Only:true
Unique identifier of the billing resource. This attribute is automatically derived based on the attributes on the event and the resource breakdown structure. -
BillTrnsAmount: number
Title:
Amount in Bill Transaction Currency
Default Value:0
Amount of the billing event in the transaction currency. Mandatory for all POST and PATCH operations. -
BillTrnsCurrencyCode: string
Title:
Bill Transaction Currency
Maximum Length:15
Indicates the code of the transaction currency for the billing event. Mandatory for POST and PATCH operations. Defaults to the contract currency if you only provide the contract number. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Unique identifier of the business unit for the event. Mandatory for POST operation and derived based on the Business Unit Name attribute. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit for the event. Mandatory for POST operation. Valid values include any business unit to which a user has access. -
CompletionDate: string
(date)
Title:
Completion Date
The date on which the event is complete and on or after which the event is processed for revenue accrual and invoicing. Not mandatory for creating a billing event but mandatory for processing the event. Mandatory for creating a reversal event if the Reverse This Event in the Next Period attribute is set to Y. -
ContractCurrencyAmount: number
Title:
Amount in Contract Currency
Read Only:true
The potential amount of the billing event in the currency of the contract when the event is created or the Amount in Bill Transaction Currency is updated. When the billing event is invoiced or recognized for revenue, this attribute is updated with the actual amount. -
ContractCurrencyCode: string
Title:
Contract Currency
Read Only:true
Maximum Length:15
Indicates the code of the currency for the contract entered on the event. -
ContractCurrencyExchgDate: string
(date)
Title:
Conversion Date
Read Only:true
The exchange date of contract currency used to convert the billing event amount. -
ContractCurrencyExchgRate: number
Title:
Conversion Rate
Read Only:true
The exchange rate of contract currency used to convert the billing event amount. -
ContractCurrencyRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:15
A classification of conversion rates that is used to convert the billing event amount to contract currency. -
ContractId: integer
(int64)
Title:
Contract ID
Read Only:true
Unique identifier of the contract for the event. The Contract ID is mandatory and it is automatically derived based on the Contract Number attribute during POST and PATCH operations. -
ContractLineId: integer
(int64)
Title:
Contract Line ID
Read Only:true
Unique identifier of the contract line for the event. Mandatory for POST and PATCH operations and automatically derived based on the Contract Line Number attribute. -
ContractLineNumber: string
Title:
Contract Line Number
Maximum Length:150
Number that identifies the contract line on the event. Mandatory for POST operation.The Contract Line ID attribute is derived from this attribute. Valid values are any line number that exists on the contract specified in the Contract Number attribute and associated to a bill plan. -
ContractNumber: string
Title:
Contract Number
Maximum Length:120
Number that uniquely identifies the contract for the event. Mandatory attribute that is used to derive the Contract ID attribute. Valid values are all contracts that belong to the business unit populated on the event in the Business Unit Name attribute and are not in Closed or Cancel status. -
ContractRateDateType: string
Title:
Conversion Date Type
Read Only:true
Maximum Length:15
A classification of conversion dates that is used to convert the billing event amount to contract currency. -
ContractRateDateTypeMeaning: string
Title:
Contract Rate Date Type Meaning
Read Only:true
Maximum Length:80
Displays the meaning for the Rate Date Type attribute. -
ContractTypeId: integer
Title:
Contract Type ID
Read Only:true
Identifier of the type of contract on the billing event. This attribute is populated based on the value selected in the Contact Type Name attribute on the event during POST and PATCH operations. -
ContractTypeName: string
Title:
Contract Type Name
Maximum Length:150
Name of the type of contract that is assigned to the billing event. Valid values are all the contract types defined in the application. -
ConversionRateTypeMeaning: string
Title:
Conversion Rate Type Meaning
Read Only:true
Maximum Length:30
Displays the meaning of the value in the Conversion Rate Type attribute. Valid values are Spot, Corporate, User, and Fixed. -
CreatedRequestId: integer
(int64)
Title:
Process Request ID
Read Only:true
Unique identifier of the latest request. -
EventDescription: string
Title:
Description
Maximum Length:240
The description of the event. For billing events, the description is displayed as the invoice line description. Mandatory attribute that is automatically populated during POST and PATCH operations based on the selected event type name if a value is not provided. -
EventId: integer
(int64)
Title:
Billing Event ID
Unique identifier of the billing event. Mandatory for POST operation and automatically generated during the operation. -
EventNumber: integer
(int64)
Title:
Event Number
Read Only:true
Number that identifies the event.This number is automatically populated sequentially as events are created for the selected contract line. -
EventNumberReversed: integer
(int64)
Title:
Reversed Event Number
Read Only:true
Number of the reversed billing event. This occurs when a billing event is cancelled and cannot be deleted and as a result, the event is cancelled by reversing the original event. -
EventTypeCode: string
Title:
Event Type Code
Read Only:true
Maximum Length:1
Default Value:B
Indicates the code for classification of the event. Valid values are R - Revenue only, I - Invoice only, and B - Both invoice and revenue. -
EventTypeId: integer
(int64)
Title:
Event Type ID
Read Only:true
Identifier of the event type.This attribute is derived during POST or PATCH operations based on the value selected in the Event Type Name attribute. Valid values are all active event types. -
EventTypeName: string
Title:
Event Type
Maximum Length:240
Name of the event type that classifies the event by category and identifies whether the event is to be used for revenue only, invoice only, or both invoice and revenue. Mandatory for POST operation. Mandatory for PATCH operation if you specify the Contract Line attribute. -
InvCurrencyDateTypeMeaning: string
Title:
Invoice Currency Date Type Meaning
Read Only:true
Maximum Length:80
Displays the meaning for the value of the Invoice Currency Date Type attribute. -
InvCurrencyRateTypeMeaning: string
Title:
Invoice Currency Rate Type Meaning
Read Only:true
Maximum Length:30
Displays the meaning of the value in the Invoice Currency Rate Type attribute. -
InventoryItemId: integer
(int64)
Title:
Inventory Item Id
Read Only:true
Unique identifier of the item number. -
InvoiceCurrencyCode: string
Title:
Invoice Currency
Read Only:true
Maximum Length:30
Indicates the code of the currency used for the invoice amount of the billing event. -
InvoiceCurrencyDateType: string
Title:
Invoice Currency Date Type
Read Only:true
Maximum Length:30
Indicates the invoice currency date type that is used when the amounts are calculated for the invoice. -
InvoiceCurrencyExchgDate: string
(date)
Title:
Invoice Currency Exchange Date
Read Only:true
Indicates the exchange date for the conversion of the invoice currency. -
InvoiceCurrencyExchgRate: number
Title:
Invoice Currency Exchange Rate
Read Only:true
Indicates the exchange rate used to convert to the invoice currency. -
InvoiceCurrencyRateType: string
Title:
Invoice Currency Rate Type
Read Only:true
Maximum Length:30
Indicates the rate type used to calculate the invoice revenue currency. -
Invoiced: string
Title:
Invoice Status
Read Only:true
Maximum Length:1
Indicates the invoice generation status on the event. Valid values are P - Partial, U - Uninvoiced, F - Fully Invoiced, and A - Pending Adjustment. -
InvoicedAmount: number
Title:
Event Amount in Invoice Revenue Currency
Read Only:true
Indicates the potential event amount in invoice currency. -
InvoicedPercentage: number
Title:
Invoiced Percentage
Read Only:true
Indicates the percent of the total event amount which has been invoiced. -
InvoiceException: string
Title:
Invoice Exception
Read Only:true
Maximum Length:1
Default Value:N
Indicates whether exception occurred on the event during invoice generation. -
InvoicePotentialAmount: number
Title:
Event Amount in Invoice Revenue Currency
Read Only:true
Indicates the potential amount in invoice currency. -
InvoiceStatusMeaning: string
Title:
Invoice Status Meaning
Read Only:true
Maximum Length:80
Indicates that invoice is generated for the event. -
ItemEventFlag: boolean
Title:
Item based event
Maximum Length:1
Default Value:false
Indicates an item based event. -
ItemNumber: string
Title:
Item Number
Maximum Length:300
Number that identifies the item on the event. -
ItemOrganizationId: integer
(int64)
Title:
Item Organization Id
Read Only:true
Unique identifier of the organization to which the item is associated. -
LedgerCurrencyCode: string
Title:
Ledger Currency
Read Only:true
Maximum Length:30
Indicates the currency used for accounting and reporting in a ledger, often referred to as the accounting currency, base currency, or functional currency. -
LedgerInvoiceAmount: number
Title:
Ledger Invoice Amount
Read Only:true
Indicates the invoice amount in ledger currency. -
LedgerRevenueAmount: number
Title:
Ledger Revenue Amount
Read Only:true
Indicates the revenue amount is ledger currency. -
LinkedTaskId: integer
(int64)
Title:
Linked Task ID
Read Only:true
Unique identifier of the linked task when task level linkage is present on the billing event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Title:
Organization ID
Read Only:true
Unique identifier of the organization for the event. Mandatory attribute that is automatically populated based on the value in the Organization attribute. -
OrganizationName: string
Title:
Organization
Maximum Length:240
Name of the organization for the event. Mandatory for POST operation and defaults to the organization associated to the contract on the event. For a PATCH operation the default value is also set to organization on the contract if a value is not provided. -
ProjectCurrencyCode: string
Title:
Project Currency
Read Only:true
Maximum Length:15
Indicates the code of the currency of the project for the billing event. -
ProjectId: integer
(int64)
Title:
Project ID
Read Only:true
Unique identifier of the project for the event. This attribute is populated based on the value in the Project Name attribute for POST and PATCH operations. Mandatory if the Require Project on Event profile option is set to Yes. -
ProjectInvoiceAmount: number
Title:
Project Invoice Amount
Read Only:true
Invoice amount in project currency. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Identifier of the project on the event. Valid values are the project numbers associated to the contract line. Mandatory if the Require Project on Event profile option is set to Yes. This attribute can be populated during POST and PATCH operations. -
ProjectRevenueAmount: number
Title:
Project Revenue Amount
Read Only:true
The revenue amount in project currency. This is calculated by applying the project currency setup conversion rules to the bill transaction base revenue amount during revenue generation. -
Quantity: number
Title:
Quantity
Quantity of the item on the item based event. -
QuantityBilled: number
Title:
Quantity Invoiced
Read Only:true
Quantity of item invoiced. -
QuantityRevenueRecognzd: number
Title:
Quantity Revenue Recognized
Read Only:true
Quantity of item for which revenue is recognized. -
RevenueAmount: number
Title:
Recognized Revenue in Contract Currency
Read Only:true
Indicates the recognized revenue amount in contract currency. -
RevenueCurrencyCode: string
Title:
Invoice Revenue Currency
Read Only:true
Maximum Length:30
Indicates the code of the currency for the revenue amount. -
RevenueException: string
Title:
Revenue Exception
Read Only:true
Maximum Length:1
Default Value:N
Indicates whether exception occured on the event during revenue generation. -
RevenueHold: string
Title:
Hold Revenue
Maximum Length:1
Default Value:N
Indicates that the event is held from recognizing revenue. Mandatory for POST and PATCH operations. Valid values are Y - Indefinitely, N - No, and O - Once. The default value is N. -
RevenueHoldMeaning: string
Title:
Hold Revenue Meaning
Read Only:true
Maximum Length:80
Displays the meaning of the value in the Hold Revenue attribute. Valid values are No, Once, or Indefinitely. -
RevenueRecognized: string
Title:
Revenue Status
Read Only:true
Maximum Length:1
Indicates if revenue is generated on the event. Valid values are P - Partial, U - Unrecognized, F - Fully, A - Pending Adjustment. -
RevenueRecognizedPercentage: number
Title:
Revenue Recognized Percentage
Read Only:true
Indicates the percent of the total event amount which has been recognized as revenue. -
RevenueStatusMeaning: string
Title:
Revenue Status Meaning
Read Only:true
Maximum Length:80
Indicates revenue is generated for the event. -
ReverseAccrual: string
Title:
Reverse This Event in the Next Period
Maximum Length:1
Default Value:N
Indicates if the event should automatically reverse in the next period. Default value is N. Set the value to Y to have the application automatically create a reversal event. The Completion Date is also mandatory to create a reversal event. -
SourceName: string
Title:
Event Source
Maximum Length:80
Name of the source application from which the event originated. -
SourceReference: string
Title:
Application Source
Maximum Length:80
Identifier of the event in the source application. -
TaskId: integer
(int64)
Title:
Project Task ID
Read Only:true
Unique identifier of the task for the event. -
TaskNumber: string
Title:
Transaction Task Number
Maximum Length:100
Identifier of the transaction task on the event. Valid values are tasks that are associated to the contract line and any sub task of an associated task. This attribute can be populated during POST and PATCH operations. -
UnitPrice: number
Price of each unit of item.
-
UnitPriceCurrency: string
Read Only:
true
Currency in which the unit price of item is mentioned. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Unit of measure code. -
UOMName: string
Read Only:
true
Unit of measure name. -
Version: integer
(int64)
Title:
Version
Read Only:true
Indicates the previously active version of the contract or the current version if there is no previously active version.
Nested Schema : Project Billing Event Descriptive Flexfields
Type:
array
Title:
Project Billing Event Descriptive Flexfields
A listing of all the descriptive flexfields available for project billing events.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectBillingEvents-billingEventDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Context of the descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
EventId: integer
(int64)
Identifier of the event.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- billingEventDFF
-
Parameters:
- projectBillingEventsUniqID:
$request.path.projectBillingEventsUniqID
A listing of all the descriptive flexfields available for project billing events. - projectBillingEventsUniqID:
Examples
The following example shows how to create a project billing event by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents
Request Body Example
The following shows an example of the request body in JSON format.
{ "SourceName": "REST01", "SourceReference": "01", "ContractTypeName": "Sell : Project lines", "ContractNumber": "trial6", "ContractLineNumber": "1", "EventTypeName": "Bonus", "EventDescription": "Performance Bonus", "BusinessUnitName":"Vision Operations", "BillTrnsAmount": 5000 }
Response Body Example
The following shows an example of the response body in JSON format.
{ "EventId": 100000015914852, "SourceName": "REST01", "SourceReference": "01", "ContractTypeName": "Sell : Project lines", "ContractNumber": "trial6", "ContractLineNumber": "1", "EventNumber": 3, "OrganizationName": "Vision Services", "EventTypeName": "Bonus", "EventDescription": "Performance Bonus", "RevenueHold": "N", "BillHold": "N", "ProjectNumber": null, "CompletionDate": "2010-01-27", "TaskNumber": null, "BillTrnsAmount": 5000, "ReverseAccrual": "N", "EventTypeId": 10096, "ContractTypeId": 104, "OrganizationId": 458, "ProjectId": null, "TaskId": null, "BillTrnsCurrencyCode": "USD", "EventTypeCode": "B", "ContractId": 100000015569119, "Version": 1, "ContractLineId": 100010032797248, "BusinessUnitName": "Vision Operations", "BusinessUnitId": 204, "Automatic": "N", "BillingResourceId": 24, "AdjustedEventId": null, "EventNumberReversed": null, "ContractCurrencyAmount": 5000, "ContractCurrencyExchgRate": 1, "Invoiced": "U", "InvoiceCurrencyCode": "USD", "InvoicedAmount": 0, "InvoicedPercentage": 0, "RevenueRecognized": "A", "RevenueRecognizedPercentage": 100, "RevenueAmount": 5000, "LedgerCurrencyCode": "USD", "LedgerRevenueAmount": 5000, "LedgerInvoiceAmount": null, "RevenueException": "N", "InvoiceException": "N", "CreatedRequestId": null, "ContractCurrencyCode": "USD", "ContractCurrencyExchgDate": null, "ContractRateDateType": "TRANSACTION", "ContractCurrencyRateType": "Spot", "BillCurrencyOptCode": "CONTRACT", "InvoiceCurrencyDateType": null, "InvoiceCurrencyExchgDate": null, "InvoiceCurrencyExchgRate": 1, "InvoicePotentialAmount": null, "InvoiceCurrencyRateType": null, "RevenueCurrencyCode": "USD", "ProjectInvoiceAmount": null, "ProjectRevenueAmount": null, "LinkedTaskId": null, "ProjectCurrencyCode": null, "BillingResource": "Financial Resources", "RevenueStatusMeaning": "Pending adjustment", "InvoiceStatusMeaning": "Uninvoiced", "RevenueHoldMeaning": "No", "BillHoldMeaning": "No", "InvCurrencyDateTypeMeaning": null, "ContractRateDateTypeMeaning": "Transaction date", "ConversionRateTypeMeaning": "Spot", "InvCurrencyRateTypeMeaning": null, "ItemEventFlag": false, "Quantity": null, "ItemNumber": null, "InventoryItemId": null, "ItemOrganizationId": null, "UOMCode": null, "UOMName": null, "UnitPrice": null, "UnitPriceCurrency": null, "QuantityBilled": null, "QuantityRevenueRecognzd": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852", "name": "projectBillingEvents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852", "name": "projectBillingEvents", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/ContractHeaderVA", "name": "ContractHeaderVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/EventTypePVA", "name": "EventTypePVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/ItemPVA", "name": "ItemPVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/LinkedProjectVA", "name": "LinkedProjectVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/ContractLineVA", "name": "ContractLineVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/BusinessUnitVA", "name": "BusinessUnitVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/ContractTypeVA", "name": "ContractTypeVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/ProjOwningOrgVA", "name": "ProjOwningOrgVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/CurrencyPVA", "name": "CurrencyPVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/UnitOfMeasureVA", "name": "UnitOfMeasureVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/lov/LinkedFinancialTaskVA", "name": "LinkedFinancialTaskVA", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/100000015914852/child/billingEventDFF", "name": "billingEventDFF", "kind": "collection" } ] }
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/latest/projectBillingEvents
Request Body Example
The following shows an example of the request body in JSON format.
{ "BusinessUnitName": "Vision Operations", "ContractTypeName": "Sell : Project lines", "ContractNumber": "Billing_Warehouse", "ContractLineNumber": "2", "EventTypeName": "Item Based Both", "CompletionDate": "2020-01-01", "EventDescription": "Performance Bonus Test", "ItemEventFlag": true, "ItemNumber": "INV-A1", "UOMCode": "EA", "Quantity": 1, "UnitPrice": 10 }
Response Body Example
The following shows an example of the response body in JSON format.
{ "EventId": 300100560991873, "SourceName": null, "SourceReference": null, "ContractTypeName": "Sell : Project lines", "ContractNumber": "Billing_Warehouse", "ContractLineNumber": "2", "EventNumber": 3, "OrganizationName": "Vision Operations", "EventTypeName": "Item Based Both", "EventDescription": "Performance Bonus Test", "RevenueHold": "N", "BillHold": "N", "ProjectNumber": null, "CompletionDate": "2020-01-01", "TaskNumber": null, "BillTrnsAmount": 10.00, "ReverseAccrual": "N", "EventTypeId": 300100541993159, "ContractTypeId": 104, "OrganizationId": 204, "ProjectId": null, "TaskId": null, "BillTrnsCurrencyCode": "USD", "EventTypeCode": "B", "ContractId": 300100090708362, "Version": 1, "ContractLineId": 300100090708373, "BusinessUnitName": "Vision Operations", "BusinessUnitId": 204, "Automatic": "N", "BillingResourceId": null, "AdjustedEventId": null, "EventNumberReversed": null, "ContractCurrencyAmount": 10.00, "ContractCurrencyExchgRate": 1, "Invoiced": "U", "InvoiceCurrencyCode": "USD", "InvoicedAmount": null, "InvoicedPercentage": null, "RevenueRecognized": "U", "RevenueRecognizedPercentage": null, "RevenueAmount": null, "LedgerCurrencyCode": "USD", "LedgerRevenueAmount": null, "LedgerInvoiceAmount": null, "RevenueException": "N", "InvoiceException": "N", "CreatedRequestId": null, "ContractCurrencyCode": "USD", "ContractCurrencyExchgDate": null, "ContractRateDateType": "TRANSACTION", "ContractCurrencyRateType": "Spot", "BillCurrencyOptCode": "CONTRACT", "InvoiceCurrencyDateType": "TRANSACTION", "InvoiceCurrencyExchgDate": null, "InvoiceCurrencyExchgRate": 1, "InvoicePotentialAmount": 10.00, "InvoiceCurrencyRateType": "Spot", "RevenueCurrencyCode": null, "ProjectInvoiceAmount": null, "ProjectRevenueAmount": null, "LinkedTaskId": null, "ProjectCurrencyCode": null, "BillingResource": null, "RevenueStatusMeaning": null, "InvoiceStatusMeaning": null, "RevenueHoldMeaning": null, "BillHoldMeaning": null, "InvCurrencyDateTypeMeaning": null, "ContractRateDateTypeMeaning": null, "ConversionRateTypeMeaning": "Spot", "InvCurrencyRateTypeMeaning": "Spot", "ItemEventFlag": true, "Quantity": 1, "ItemNumber": "INV-A1", "InventoryItemId": 100000012013546, "ItemOrganizationId": 204, "UOMCode": "EA", "UOMName": "EA", "UnitPrice": 10, "UnitPriceCurrency": "USD", "QuantityBilled": null, "QuantityRevenueRecognzd": null, "links": [ { "rel": "self", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873", "name": "projectBillingEvents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873", "name": "projectBillingEvents", "kind": "item" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/ContractHeaderVA", "name": "ContractHeaderVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/EventTypePVA", "name": "EventTypePVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/ItemPVA", "name": "ItemPVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/LinkedProjectVA", "name": "LinkedProjectVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/ContractLineVA", "name": "ContractLineVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/BusinessUnitVA", "name": "BusinessUnitVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/ContractTypeVA", "name": "ContractTypeVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/ProjOwningOrgVA", "name": "ProjOwningOrgVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/CurrencyPVA", "name": "CurrencyPVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/UnitOfMeasureVA", "name": "UnitOfMeasureVA", "kind": "collection" }, { "rel": "lov", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/lov/LinkedFinancialTaskVA", "name": "LinkedFinancialTaskVA", "kind": "collection" }, { "rel": "child", "href": "your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectBillingEvents/300100560991873/child/billingEventDFF", "name": "billingEventDFF", "kind": "collection" } ] }