Jump to

• Request
• Response
• Examples

Get all bill plans

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan

Request

Path Parameters

• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • BillPlanExtAltKey: Finds the bill plan with the specified alternate key.
    Finder Variables:
    • ExternalReferenceKey; string.
    • ExternalSourceKey; string.
  • PrimaryKey: Finds the bill plan with the specified bill plan ID and major version.
    Finder Variables:
    • BillPlanId; integer; The unique identifier of the bill plan.
    • MajorVersion; integer; The bill plan major version.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BillMethodId; integer; The unique identifier of the bill method.
  • BillMethodName; string; The name of the bill method.
  • BillPlanId; integer; The unique identifier of the bill plan.
  • BillPlanName; string; The name of the bill plan.
  • BillSetNumber; number; The billing set number is used to group invoices.
  • BillToAccountNumber; string; The alternate identifier of the customer to whom invoices should be sent to and is responsible for the payment.
  • BillToContactEmail; string; The email address of the contact person from the Bill-To Customer Site.
  • BillToContactId; integer; The unique identifier of the contact person from the Bill-To Customer Site.
  • BillToContactName; string; The name of the contact person from the Bill-To Customer Site.
  • BillToCustomerAccountId; integer; The unique identifier of the customer to whom invoices should be sent and is responsible for the payment.
  • BillToSite; string; The customer site where the invoices should be sent.
  • BillToSiteUseId; integer; The unique identifier of the site where the invoices should be sent.
  • BillingCurrencyType; string; The currency option for the bill plan.
  • BillingCycle; string; The time period of the billing.
  • BillingCycleId; integer; The unique identifier of the billing cycle.
  • BurdenSchFixedDate; string; The fixed date used to determine the effective rates of the burden schedule.
  • BurdenSchId; integer; The identifier of the burden schedule.
  • BurdenSchedule; string; The burden schedule on the Revenue plan.
  • DocumentNumber; string; The document number on bill plan for letter of credit enabled grants.
  • EventInvoiceFormat; string; The events invoice identifier which summarizes invoice distributions into invoice lines. This option is applicable for events transactions.
  • EventsInvoiceFormatId; integer; The unique identifier of the Events invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for events transactions.
  • ExternalReferenceKey; string; The External Reference key on the bill plan.
  • ExternalSourceKey; string; The External Source key on the bill plan.
  • FederalInvoiceFormat; string; The invoice format for GMS contract invoices.
  • FirstBillingOffsetDays; number; The number of days that elapse between the project start date and the date of the project???s first invoice.
  • InvHdrGroupingOptions; string; The invoice header grouping options of the bill plan.
  • InvoiceComment; string; The invoice comment on the bill plan.
  • InvoiceCurrencyCode; string; The invoice currency code.
  • InvoiceCurrencyConversionDateType; string; The invoice currency date type.
  • InvoiceCurrencyConversionRateType; string; The invoice currency rate type code.
  • InvoiceCurrencyDateType; string; The invoice currency date type code.
  • InvoiceCurrencyExchgDate; string; The invoice currency exchange date.
  • InvoiceCurrencyOptCode; string; The currency option code for bill plan.
  • InvoiceCurrencyRateType; string; The invoice currency rate type code.
  • InvoiceHdrGrpOptName; string; The invoice header grouping option name of the bill plan.
  • InvoiceInstructions; string; The billing instructions on the bill plan.
  • JobBillRateSchId; integer; The unique identifier of the job bill rate schedule.
  • JobRateSchedule; string; The job bill rate schedule.
  • LaborBillBasisCode; string; The labor cost basis code for cost reimbursable.
  • LaborCostBasis; string; The labor cost basis for cost reimbursable.
  • LaborDiscountPercentage; number; The percentage to be discounted from the standard labor bill rate schedule.
  • LaborDiscountReasonCode; string; The labor rate change reason code.
  • LaborInvoiceFormat; string; The labor invoice format which summarizes invoice distributions into invoice lines. This option is applicable for labor transactions.
  • LaborInvoiceFormatId; integer; The unique identifier of the labor invoice format which summarizes invoice distributions into invoice lines. This option is applicable for labor transactions.
  • LaborMarkupPercentage; number; The labor markup percentage.
  • LaborRateChangeReason; string; The labor rate change reason.
  • LaborSchFixedDate; string; The fixed date used to determine the effective bill rates of the standard labor bill rate schedule.
  • LaborTpSchFixedDate; string; The fixed date used to determine the effective rates of the Intercompany Labor Transfer Price Schedule.
  • LaborTpScheduleId; integer; The unique identifier of the labor schedule for Inter Company Transfer Price.
  • LaborTransferPriceSchedule; string; The labor schedule for Inter Company Transfer Price.
  • LocFlag; boolean; Indicates whether the letter of credit is enabled.
  • MajorVersion; integer; The contract Major Version of the bill plan.
  • NlBillBasisCode; string; The non labor cost basis code for cost reimbursable.
  • NlBillRateSchId; integer; The identifier of the non labor bill rate schedule.
  • NlDiscountPercentage; number; The percentage to be discounted from the standard non labor bill rate schedule.
  • NlDiscountReasonCode; string; The non labor rate change reason code.
  • NlInvoiceFormatId; integer; The unique identifier of the non labor invoice format identifier which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions.
  • NlMarkupPercentage; number; The non labor markup percentage.
  • NlSchFixedDate; string; The fixed date used to determine the effective bill rates of the standard non labor bill rate schedule.
  • NlTpSchFixedDate; string; The fixed date used to determine the effective rates of the Intercompany Nonlabor Transfer Price Schedule.
  • NlTpScheduleId; integer; The unique identifier of the non labor Schedule for Inter Company Transfer Price.
  • NonlaborCostBasis; string; The non labor cost basis for cost reimbursable.
  • NonlaborInvoiceFormat; string; The Non Labor invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions.
  • NonlaborRateChangeReason; string; The non labor rate change reason.
  • NonlaborRateSchedule; string; The non labor bill rate schedule.
  • NonlaborTransferPriceSchedule; string; The non labor Schedule for Inter Company Transfer Price.
  • OnHoldFlag; boolean; Indicates whether bill plan can be used to generate invoice.
  • PaymentTerms; string; The terms of the payment.
  • PaymentTermsId; integer; The unique identifier of the payment terms.
  • PersonBillRateSchId; integer; The identifier of the employee bill rate schedule.
  • PersonRateSchedule; string; The employee bill rate schedule.
  • ProjectRoleBillRateSchId; integer; Unique identifier of the project role bill rate schedule
  • ProjectRoleRateScheduleName; string; The project role bill rate schedule name
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : contracts-BillPlan

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object contracts-BillPlan-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : contracts-BillPlan-item-response

Type: object

Show Source

• BillingCurrencyType: string
  Title: Billing Currency Type

  Maximum Length: 80

  The currency option for the bill plan.
• BillingCycle: string
  Title: Billing Cycle

  Maximum Length: 30

  The time period of the billing.
• BillingCycleId: integer (int64)
  Title: Billing Cycle ID

  The unique identifier of the billing cycle.
• BillMethodId: integer (int64)
  Title: Bill Method ID

  The unique identifier of the bill method.
• BillMethodName: string
  Title: Method Name

  Maximum Length: 30

  The name of the bill method.
• BillPlanDescriptiveFlexField: array Bill Plan Flexfields
  Title: Bill Plan Flexfields

  The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information.
• BillPlanId: integer (int64)
  Title: Bill Plan ID

  The unique identifier of the bill plan.
• BillPlanName: string
  Title: Name

  Maximum Length: 30

  The name of the bill plan.
• BillPlanTranslation: array Bill Plan Translations
  Title: Bill Plan Translations

  The bill plan translations resource is used to view and update contract bill plan translation information.
• BillSetNumber: number
  Title: Bill Set

  The billing set number is used to group invoices.
• BillToAccountNumber: string
  Title: Bill-to Account Number

  Maximum Length: 30

  The alternate identifier of the customer to whom invoices should be sent to and is responsible for the payment.
• BillToContactEmail: string
  Title: Bill-to Contact E-mail

  The email address of the contact person from the Bill-To Customer Site.
• BillToContactId: integer (int64)
  Title: Bill-to Contact

  The unique identifier of the contact person from the Bill-To Customer Site.
• BillToContactName: string
  Title: Bill-to Contact

  Maximum Length: 360

  The name of the contact person from the Bill-To Customer Site.
• BillToCustomerAccountId: integer (int64)
  Title: Bill-to Account Number

  The unique identifier of the customer to whom invoices should be sent and is responsible for the payment.
• BillToSite: string
  Title: Bill-to Site

  Maximum Length: 150

  The customer site where the invoices should be sent.
• BillToSiteUseId: integer (int64)
  Title: Bill-to Site

  The unique identifier of the site where the invoices should be sent.
• BurdenSchedule: string
  Title: Burden Schedule

  Maximum Length: 30

  The burden schedule on the Revenue plan.
• BurdenSchFixedDate: string (date)
  Title: Fixed Date

  The fixed date used to determine the effective rates of the burden schedule.
• BurdenSchId: integer (int64)
  Title: Burden Schedule ID

  The identifier of the burden schedule.
• DocumentNumber: string
  Title: Document Number

  Maximum Length: 240

  The document number on bill plan for letter of credit enabled grants.
• EventInvoiceFormat: string
  Title: Event Format

  Maximum Length: 30

  The events invoice identifier which summarizes invoice distributions into invoice lines. This option is applicable for events transactions.
• EventsInvoiceFormatId: integer (int64)
  Title: Event Invoice Format ID

  The unique identifier of the Events invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for events transactions.
• ExternalReferenceKey: string
  Maximum Length: 150

  The External Reference key on the bill plan.
• ExternalSourceKey: string
  Maximum Length: 150

  The External Source key on the bill plan.
• FederalInvoiceFormat: string
  Title: Federal Invoice Format

  Maximum Length: 80

  The invoice format for GMS contract invoices.
• FirstBillingOffsetDays: number
  Title: First Bill Offset Days

  The number of days that elapse between the project start date and the date of the project???s first invoice.
• InvHdrGroupingOptions: string
  Title: Invoice Grouping

  Maximum Length: 2000

  The invoice header grouping options of the bill plan.
• InvoiceComment: string
  Title: Invoice Comment

  Maximum Length: 240

  The invoice comment on the bill plan.
• InvoiceCurrencyCode: string
  Title: Invoice Revenue Currency

  Maximum Length: 30

  The invoice currency code.
• InvoiceCurrencyConversionDateType: string
  Title: Conversion Date Type

  Maximum Length: 80

  The invoice currency date type.
• InvoiceCurrencyConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The invoice currency rate type code.
• InvoiceCurrencyDateType: string
  Title: Currency Conversion Date Type Code

  Maximum Length: 30

  The invoice currency date type code.
• InvoiceCurrencyExchgDate: string (date)
  Title: Conversion Date

  The invoice currency exchange date.
• InvoiceCurrencyOptCode: string
  Title: Billing Currency Type Code

  Maximum Length: 30

  The currency option code for bill plan.
• InvoiceCurrencyRateType: string
  Title: Currency Conversion Rate Type Code

  Maximum Length: 30

  The invoice currency rate type code.
• InvoiceHdrGrpOptName: string
  Title: Invoice Grouping

  Maximum Length: 80

  The invoice header grouping option name of the bill plan.
• InvoiceInstructions: string
  Title: Billing Instructions

  Maximum Length: 240

  The billing instructions on the bill plan.
• JobAssignmentOverride: array Job Assignment Overrides
  Title: Job Assignment Overrides

  The resource is used to view, create, update, delete job assignment override details
• JobBillRateSchId: integer (int64)
  Title: Job Rate Schedule

  The unique identifier of the job bill rate schedule.
• JobRateOverride: array Job Rate Overrides
  Title: Job Rate Overrides

  The resource is used to view, create, update, delete job rate override details.
• JobRateSchedule: string
  Title: Job Rate Schedule

  Maximum Length: 30

  The job bill rate schedule.
• JobTitleOverride: array Job Title Overrides
  Title: Job Title Overrides

  The resource is used to view, create, update, delete job title override details.
• LaborBillBasisCode: string
  Title: Labor Cost Basis Code

  Maximum Length: 30

  The labor cost basis code for cost reimbursable.
• LaborCostBasis: string
  Title: Labor Cost Basis

  Maximum Length: 80

  The labor cost basis for cost reimbursable.
• LaborDiscountPercentage: number
  Title: Discount Percentage

  The percentage to be discounted from the standard labor bill rate schedule.
• LaborDiscountReasonCode: string
  Title: Labor Discount Reason Code

  Maximum Length: 30

  The labor rate change reason code.
• LaborInvoiceFormat: string
  Maximum Length: 30

  The labor invoice format which summarizes invoice distributions into invoice lines. This option is applicable for labor transactions.
• LaborInvoiceFormatId: integer (int64)
  Title: Labor Invoice Format ID

  The unique identifier of the labor invoice format which summarizes invoice distributions into invoice lines. This option is applicable for labor transactions.
• LaborMarkupPercentage: number
  Title: Labor Markup Percentage

  The labor markup percentage.
• LaborMultiplierOverride: array Labor Multiplier Overrides
  Title: Labor Multiplier Overrides

  The resource is used to view, create, update, delete labor multiplier override details.
• LaborRateChangeReason: string
  Title: Labor Rate Change Reason

  Maximum Length: 80

  The labor rate change reason.
• LaborSchFixedDate: string (date)
  Title: Fixed Date

  The fixed date used to determine the effective bill rates of the standard labor bill rate schedule.
• LaborTpScheduleId: integer
  Title: Labor Transfer Price Schedule ID

  The unique identifier of the labor schedule for Inter Company Transfer Price.
• LaborTpSchFixedDate: string (date)
  Title: Fixed Date

  The fixed date used to determine the effective rates of the Intercompany Labor Transfer Price Schedule.
• LaborTransferPriceSchedule: string
  Title: Labor Transfer Price Schedule

  Maximum Length: 50

  The labor schedule for Inter Company Transfer Price.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocFlag: boolean
  Title: Enable letter of credit

  Maximum Length: 1

  Indicates whether the letter of credit is enabled.
• MajorVersion: integer (int64)
  The contract Major Version of the bill plan.
• NlBillBasisCode: string
  Title: Nonlabor Cost Basis Code

  Maximum Length: 30

  The non labor cost basis code for cost reimbursable.
• NlBillRateSchId: integer (int64)
  Title: Nonlabor Rate Schedule

  The identifier of the non labor bill rate schedule.
• NlDiscountPercentage: number
  Title: Discount Percentage

  The percentage to be discounted from the standard non labor bill rate schedule.
• NlDiscountReasonCode: string
  Title: Nonlabor Discount Reason Code

  Maximum Length: 30

  The non labor rate change reason code.
• NlInvoiceFormatId: integer (int64)
  Title: Nonlabor Invoice Format ID

  The unique identifier of the non labor invoice format identifier which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions.
• NlMarkupPercentage: number
  Title: Nonlabor Markup Percentage

  The non labor markup percentage.
• NlSchFixedDate: string (date)
  Title: Fixed Date

  The fixed date used to determine the effective bill rates of the standard non labor bill rate schedule.
• NlTpScheduleId: integer
  Title: Nonlabor Transfer Price Schedule ID

  The unique identifier of the non labor Schedule for Inter Company Transfer Price.
• NlTpSchFixedDate: string (date)
  Title: Fixed Date

  The fixed date used to determine the effective rates of the Intercompany Nonlabor Transfer Price Schedule.
• NonlaborCostBasis: string
  Title: Nonlabor Cost Basis

  Maximum Length: 80

  The non labor cost basis for cost reimbursable.
• NonlaborInvoiceFormat: string
  Title: Nonlabor Format

  Maximum Length: 30

  The Non Labor invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions.
• NonlaborRateChangeReason: string
  Title: Nonlabor Rate Change Reason

  Maximum Length: 80

  The non labor rate change reason.
• NonLaborRateOverride: array Non Labor Rate Overrides
  Title: Non Labor Rate Overrides

  The resource is used to view, create, update, delete non labor multiplier override details.
• NonlaborRateSchedule: string
  Title: Nonlabor Rate Schedule

  Maximum Length: 30

  The non labor bill rate schedule.
• NonlaborTransferPriceSchedule: string
  Title: Nonlabor Transfer Price Schedule

  Maximum Length: 50

  The non labor Schedule for Inter Company Transfer Price.
• OnHoldFlag: boolean
  Title: On hold

  Maximum Length: 1

  Default Value: false

  Indicates whether bill plan can be used to generate invoice.
• PaymentTerms: string
  Title: Payment Terms

  Maximum Length: 15

  The terms of the payment.
• PaymentTermsId: integer (int64)
  Title: Payment Term ID

  The unique identifier of the payment terms.
• PersonBillRateSchId: integer (int64)
  Title: Person Rate Schedule

  The identifier of the employee bill rate schedule.
• PersonRateOverride: array Person Rate Overrides
  Title: Person Rate Overrides

  The resource is used to view, create, update, delete person rate override details.
• PersonRateSchedule: string
  Title: Person Rate Schedule

  Maximum Length: 30

  The employee bill rate schedule.
• ProjectRoleBillRateSchId: integer (int64)
  Title: Project Role Rate Schedule ID

  Unique identifier of the project role bill rate schedule
• ProjectRoleRateScheduleName: string
  Title: Project Role Rate Schedule

  Maximum Length: 30

  The project role bill rate schedule name

{
    "type":"object",
    "properties":{
        "BillMethodId":{
            "title":"Bill Method ID",
            "type":"integer",
            "description":"The unique identifier of the bill method.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillMethodName":{
            "title":"Method Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the bill method.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillPlanDescriptiveFlexField":{
            "title":"Bill Plan Flexfields",
            "type":"array",
            "description":"The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-BillPlanDescriptiveFlexField-item-response"
            },
            "x-cardinality":"1"
        },
        "BillPlanId":{
            "title":"Bill Plan ID",
            "type":"integer",
            "description":"The unique identifier of the bill plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillPlanName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the bill plan.",
            "nullable":false,
            "x-queryable":true
        },
        "BillPlanTranslation":{
            "title":"Bill Plan Translations",
            "type":"array",
            "description":"The bill plan translations resource is used to view and update contract bill plan translation information.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-BillPlanTranslation-item-response"
            }
        },
        "BillSetNumber":{
            "title":"Bill Set",
            "type":"number",
            "description":"The billing set number is used to group invoices.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToAccountNumber":{
            "title":"Bill-to Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the customer to whom invoices should be sent to and is responsible for the payment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillToContactEmail":{
            "title":"Bill-to Contact E-mail",
            "type":"string",
            "description":"The email address of the contact person from the Bill-To Customer Site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToContactId":{
            "title":"Bill-to Contact",
            "type":"integer",
            "description":"The unique identifier of the contact person from the Bill-To Customer Site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BillToCustomerAccountId"
                ]
            },
            "x-queryable":true
        },
        "BillToContactName":{
            "title":"Bill-to Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact person from the Bill-To Customer Site.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillToCustomerAccountId":{
            "title":"Bill-to Account Number",
            "type":"integer",
            "description":"The unique identifier of the customer to whom invoices should be sent and is responsible for the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToSite":{
            "title":"Bill-to Site",
            "maxLength":150,
            "type":"string",
            "description":"The customer site where the invoices should be sent.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillToSiteUseId":{
            "title":"Bill-to Site",
            "type":"integer",
            "description":"The unique identifier of the site where the invoices should be sent.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BillToCustomerAccountId"
                ]
            },
            "x-queryable":true
        },
        "BillingCurrencyType":{
            "title":"Billing Currency Type",
            "maxLength":80,
            "type":"string",
            "description":"The currency option for the bill plan.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingCycle":{
            "title":"Billing Cycle",
            "maxLength":30,
            "type":"string",
            "description":"The time period of the billing.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillingCycleId":{
            "title":"Billing Cycle ID",
            "type":"integer",
            "description":"The unique identifier of the billing cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BurdenSchFixedDate":{
            "title":"Fixed Date",
            "type":"string",
            "description":"The fixed date used to determine the effective rates of the burden schedule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BurdenSchId":{
            "title":"Burden Schedule ID",
            "type":"integer",
            "description":"The identifier of the burden schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BurdenSchedule":{
            "title":"Burden Schedule",
            "maxLength":30,
            "type":"string",
            "description":"The burden schedule on the Revenue plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":240,
            "type":"string",
            "description":"The document number on bill plan for letter of credit enabled grants.",
            "nullable":true,
            "x-queryable":true
        },
        "EventInvoiceFormat":{
            "title":"Event Format",
            "maxLength":30,
            "type":"string",
            "description":"The events invoice identifier which summarizes invoice distributions into invoice lines. This option is applicable for events transactions.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EventsInvoiceFormatId":{
            "title":"Event Invoice Format ID",
            "type":"integer",
            "description":"The unique identifier of the Events invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for events transactions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "maxLength":150,
            "type":"string",
            "description":"The External Reference key on the bill plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "maxLength":150,
            "type":"string",
            "description":"The External Source key on the bill plan.",
            "nullable":true,
            "x-queryable":true
        },
        "FederalInvoiceFormat":{
            "title":"Federal Invoice Format",
            "maxLength":80,
            "type":"string",
            "description":"The invoice format for GMS contract invoices.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FirstBillingOffsetDays":{
            "title":"First Bill Offset Days",
            "type":"number",
            "description":"The number of days that elapse between the project start date and the date of the project???s first invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "InvHdrGroupingOptions":{
            "title":"Invoice Grouping",
            "maxLength":2000,
            "type":"string",
            "description":"The invoice header grouping options of the bill plan.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceComment":{
            "title":"Invoice Comment",
            "maxLength":240,
            "type":"string",
            "description":"The invoice comment on the bill plan.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "title":"Invoice Revenue Currency",
            "maxLength":30,
            "type":"string",
            "description":"The invoice currency code.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceCurrencyOptCode"
                ]
            },
            "x-queryable":true
        },
        "InvoiceCurrencyConversionDateType":{
            "title":"Conversion Date Type",
            "maxLength":80,
            "type":"string",
            "description":"The invoice currency date type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InvoiceCurrencyConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The invoice currency rate type code.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Conversion Rate Type"
                },
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InvoiceCurrencyDateType":{
            "title":"Currency Conversion Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The invoice currency date type code.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceCurrencyOptCode"
                ]
            },
            "x-queryable":true
        },
        "InvoiceCurrencyExchgDate":{
            "title":"Conversion Date",
            "type":"string",
            "description":"The invoice currency exchange date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceCurrencyDateType",
                    "InvoiceCurrencyOptCode"
                ]
            },
            "x-queryable":true
        },
        "InvoiceCurrencyOptCode":{
            "title":"Billing Currency Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The currency option code for bill plan.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceCurrencyRateType":{
            "title":"Currency Conversion Rate Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The invoice currency rate type code.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceCurrencyOptCode"
                ]
            },
            "x-queryable":true
        },
        "InvoiceHdrGrpOptName":{
            "title":"Invoice Grouping",
            "maxLength":80,
            "type":"string",
            "description":"The invoice header grouping option name of the bill plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InvoiceInstructions":{
            "title":"Billing Instructions",
            "maxLength":240,
            "type":"string",
            "description":"The billing instructions on the bill plan.",
            "nullable":true,
            "x-queryable":true
        },
        "JobAssignmentOverride":{
            "title":"Job Assignment Overrides",
            "type":"array",
            "description":"The resource is used to view, create, update, delete job assignment override details",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-JobAssignmentOverride-item-response"
            }
        },
        "JobBillRateSchId":{
            "title":"Job Rate Schedule",
            "type":"integer",
            "description":"The unique identifier of the job bill rate schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobRateOverride":{
            "title":"Job Rate Overrides",
            "type":"array",
            "description":"The resource is used to view, create, update, delete job rate override details.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-JobRateOverride-item-response"
            }
        },
        "JobRateSchedule":{
            "title":"Job Rate Schedule",
            "maxLength":30,
            "type":"string",
            "description":"The job bill rate schedule.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "JobTitleOverride":{
            "title":"Job Title Overrides",
            "type":"array",
            "description":"The resource is used to view, create, update, delete job title override details.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-JobTitleOverride-item-response"
            }
        },
        "LaborBillBasisCode":{
            "title":"Labor Cost Basis Code",
            "maxLength":30,
            "type":"string",
            "description":"The labor cost basis code for cost reimbursable.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborCostBasis":{
            "title":"Labor Cost Basis",
            "maxLength":80,
            "type":"string",
            "description":"The labor cost basis for cost reimbursable.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LaborDiscountPercentage":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"The percentage to be discounted from the standard labor bill rate schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborDiscountReasonCode":{
            "title":"Labor Discount Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The labor rate change reason code.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborInvoiceFormat":{
            "maxLength":30,
            "type":"string",
            "description":"The labor invoice format  which  summarizes invoice distributions into invoice lines. This option is applicable for labor transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborInvoiceFormatId":{
            "title":"Labor Invoice Format ID",
            "type":"integer",
            "description":"The unique identifier of the labor invoice format which summarizes invoice distributions into invoice lines. This option is applicable for labor transactions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LaborMarkupPercentage":{
            "title":"Labor Markup Percentage",
            "type":"number",
            "description":"The labor markup percentage.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborMultiplierOverride":{
            "title":"Labor Multiplier Overrides",
            "type":"array",
            "description":"The resource is used to view, create, update, delete labor multiplier override details.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-LaborMultiplierOverride-item-response"
            }
        },
        "LaborRateChangeReason":{
            "title":"Labor Rate Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"The labor rate change reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LaborSchFixedDate":{
            "title":"Fixed Date",
            "type":"string",
            "description":"The fixed date used to determine the effective bill rates of the standard labor bill rate schedule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LaborTpSchFixedDate":{
            "title":"Fixed Date",
            "type":"string",
            "description":"The fixed date used to determine the effective rates of the Intercompany Labor Transfer Price Schedule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LaborTpScheduleId":{
            "title":"Labor Transfer Price Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the labor schedule for Inter Company Transfer Price.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborTransferPriceSchedule":{
            "title":"Labor Transfer Price Schedule",
            "maxLength":50,
            "type":"string",
            "description":"The labor schedule for Inter Company Transfer Price.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LocFlag":{
            "title":"Enable letter of credit",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the letter of credit is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The contract Major Version of the bill plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NlBillBasisCode":{
            "title":"Nonlabor Cost Basis Code",
            "maxLength":30,
            "type":"string",
            "description":"The non labor cost basis code for cost reimbursable.",
            "nullable":true,
            "x-queryable":true
        },
        "NlBillRateSchId":{
            "title":"Nonlabor Rate Schedule",
            "type":"integer",
            "description":"The identifier of the non labor bill rate schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NlDiscountPercentage":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"The percentage to be discounted from the standard non labor bill rate schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "NlDiscountReasonCode":{
            "title":"Nonlabor Discount Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The non labor rate change reason code.",
            "nullable":true,
            "x-queryable":true
        },
        "NlInvoiceFormatId":{
            "title":"Nonlabor Invoice Format ID",
            "type":"integer",
            "description":"The unique identifier of the non labor invoice format identifier which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NlMarkupPercentage":{
            "title":"Nonlabor Markup Percentage",
            "type":"number",
            "description":"The non labor markup percentage.",
            "nullable":true,
            "x-queryable":true
        },
        "NlSchFixedDate":{
            "title":"Fixed Date",
            "type":"string",
            "description":"The fixed date used to determine the effective bill rates of the standard non labor bill rate schedule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NlTpSchFixedDate":{
            "title":"Fixed Date",
            "type":"string",
            "description":"The fixed date used to determine the effective rates of the Intercompany Nonlabor Transfer Price Schedule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NlTpScheduleId":{
            "title":"Nonlabor Transfer Price Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the non labor Schedule for Inter Company Transfer Price.",
            "nullable":true,
            "x-queryable":true
        },
        "NonLaborRateOverride":{
            "title":"Non Labor Rate Overrides",
            "type":"array",
            "description":"The resource is used to view, create, update, delete non labor multiplier override details.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-NonLaborRateOverride-item-response"
            }
        },
        "NonlaborCostBasis":{
            "title":"Nonlabor Cost Basis",
            "maxLength":80,
            "type":"string",
            "description":"The non labor cost basis for cost reimbursable.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "NonlaborInvoiceFormat":{
            "title":"Nonlabor Format",
            "maxLength":30,
            "type":"string",
            "description":"The Non Labor invoice Format which summarizes invoice distributions into invoice lines. This option is applicable for non labor transactions.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "NonlaborRateChangeReason":{
            "title":"Nonlabor Rate Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"The non labor rate change reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "NonlaborRateSchedule":{
            "title":"Nonlabor Rate Schedule",
            "maxLength":30,
            "type":"string",
            "description":"The non labor bill rate schedule.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "NonlaborTransferPriceSchedule":{
            "title":"Nonlabor Transfer Price Schedule",
            "maxLength":50,
            "type":"string",
            "description":"The non labor Schedule for Inter Company Transfer Price.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OnHoldFlag":{
            "title":"On hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether bill plan can be used to generate invoice.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PaymentTerms":{
            "title":"Payment Terms",
            "maxLength":15,
            "type":"string",
            "description":"The terms of the payment.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PaymentTermsId":{
            "title":"Payment Term ID",
            "type":"integer",
            "description":"The unique identifier of the payment terms.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonBillRateSchId":{
            "title":"Person Rate Schedule",
            "type":"integer",
            "description":"The identifier of the employee bill rate schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonRateOverride":{
            "title":"Person Rate Overrides",
            "type":"array",
            "description":"The resource is used to view, create, update, delete person rate override details.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillPlan-PersonRateOverride-item-response"
            }
        },
        "PersonRateSchedule":{
            "title":"Person Rate Schedule",
            "maxLength":30,
            "type":"string",
            "description":"The employee bill rate schedule.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProjectRoleBillRateSchId":{
            "title":"Project Role Rate Schedule ID",
            "type":"integer",
            "description":"Unique identifier of the project role bill rate schedule",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectRoleRateScheduleName":{
            "title":"Project Role Rate Schedule",
            "maxLength":30,
            "type":"string",
            "description":"The project role bill rate schedule name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Bill Plan Flexfields

Type: array

Title: Bill Plan Flexfields

The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information.

Show Source

• Array of: object contracts-BillPlan-BillPlanDescriptiveFlexField-item-response

{
    "title":"Bill Plan Flexfields",
    "type":"array",
    "description":"The bill plan fexfields resource is used to view, create, and update contract bill plan flexfield information.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-BillPlanDescriptiveFlexField-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Bill Plan Translations

Type: array

Title: Bill Plan Translations

The bill plan translations resource is used to view and update contract bill plan translation information.

Show Source

• Array of: object contracts-BillPlan-BillPlanTranslation-item-response

{
    "title":"Bill Plan Translations",
    "type":"array",
    "description":"The bill plan translations resource is used to view and update contract bill plan translation information.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-BillPlanTranslation-item-response"
    }
}

Nested Schema : Job Assignment Overrides

Type: array

Title: Job Assignment Overrides

The resource is used to view, create, update, delete job assignment override details

Show Source

• Array of: object contracts-BillPlan-JobAssignmentOverride-item-response

{
    "title":"Job Assignment Overrides",
    "type":"array",
    "description":"The resource is used to view, create, update, delete job assignment override details",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-JobAssignmentOverride-item-response"
    }
}

Nested Schema : Job Rate Overrides

Type: array

Title: Job Rate Overrides

The resource is used to view, create, update, delete job rate override details.

Show Source

• Array of: object contracts-BillPlan-JobRateOverride-item-response

{
    "title":"Job Rate Overrides",
    "type":"array",
    "description":"The resource is used to view, create, update, delete job rate override details.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-JobRateOverride-item-response"
    }
}

Nested Schema : Job Title Overrides

Type: array

Title: Job Title Overrides

The resource is used to view, create, update, delete job title override details.

Show Source

• Array of: object contracts-BillPlan-JobTitleOverride-item-response

{
    "title":"Job Title Overrides",
    "type":"array",
    "description":"The resource is used to view, create, update, delete job title override details.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-JobTitleOverride-item-response"
    }
}

Nested Schema : Labor Multiplier Overrides

Type: array

Title: Labor Multiplier Overrides

The resource is used to view, create, update, delete labor multiplier override details.

Show Source

• Array of: object contracts-BillPlan-LaborMultiplierOverride-item-response

{
    "title":"Labor Multiplier Overrides",
    "type":"array",
    "description":"The resource is used to view, create, update, delete labor multiplier override details.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-LaborMultiplierOverride-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Non Labor Rate Overrides

Type: array

Title: Non Labor Rate Overrides

The resource is used to view, create, update, delete non labor multiplier override details.

Show Source

• Array of: object contracts-BillPlan-NonLaborRateOverride-item-response

{
    "title":"Non Labor Rate Overrides",
    "type":"array",
    "description":"The resource is used to view, create, update, delete non labor multiplier override details.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-NonLaborRateOverride-item-response"
    }
}

Nested Schema : Person Rate Overrides

Type: array

Title: Person Rate Overrides

The resource is used to view, create, update, delete person rate override details.

Show Source

• Array of: object contracts-BillPlan-PersonRateOverride-item-response

{
    "title":"Person Rate Overrides",
    "type":"array",
    "description":"The resource is used to view, create, update, delete person rate override details.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillPlan-PersonRateOverride-item-response"
    }
}

Nested Schema : contracts-BillPlan-BillPlanDescriptiveFlexField-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• BillPlanId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)

{
    "type":"object",
    "properties":{
        "BillPlanId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Prompt"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Prompt"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : contracts-BillPlan-BillPlanTranslation-item-response

Type: object

Show Source

• BillPlanDesc: string
  Maximum Length: 240

  The revenue plan description.
• BillPlanId: integer (int64)
  The unique identifier of the bill or revenue plan in the bill or revenue plan translation resource.
• BillPlanName: string
  Maximum Length: 30

  The bill or revenue plan name in the bill or revenue plan translation resource.
• InvoiceComment: string
  Maximum Length: 240

  The invoice comment in the bill plan translation resource.
• InvoiceInstructions: string
  Maximum Length: 240

  The billing instructions in the bill plan translation resource.
• Language: string
  Maximum Length: 4

  The translation language in the bill or revenue plan translation resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  The contract version in the bill or revenue plan translation resource.
• ObjectVersionNumber: integer (int32)
  The revenue plan object version.
• SourceLang: string
  Maximum Length: 4

  The source language in the bill or revenue plan translation resource.

{
    "type":"object",
    "properties":{
        "BillPlanDesc":{
            "maxLength":240,
            "type":"string",
            "description":"The revenue plan description.",
            "nullable":true,
            "x-queryable":true
        },
        "BillPlanId":{
            "type":"integer",
            "description":"The unique identifier of the bill or revenue plan in the bill or revenue plan translation resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillPlanName":{
            "maxLength":30,
            "type":"string",
            "description":"The bill or revenue plan name in the bill or revenue plan translation resource.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceComment":{
            "maxLength":240,
            "type":"string",
            "description":"The invoice comment in the bill plan translation resource.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceInstructions":{
            "maxLength":240,
            "type":"string",
            "description":"The billing instructions in the bill plan translation resource.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"The translation language in the bill or revenue plan translation resource.",
            "nullable":false,
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The contract version in the bill or revenue plan translation resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The revenue plan object version.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"The source language in the bill or revenue plan translation resource.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : contracts-BillPlan-JobAssignmentOverride-item-response

Type: object

Show Source

• BillingTitle: string
  Title: Billing Title Override

  Maximum Length: 80

  Name of the override job title being assigned to the person for this bill plan. Used to display on the invoice to the customer.
• ContractLineId: integer (int64)
  Title: Contract Line ID

  Unique identifier of the contract line for which the job assignment override is defined.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  The contract line for which the job assignment override is defined.
• EmailAddress: string
  Title: Email

  Maximum Length: 240

  The email address for whom the job assignment override is defined.
• EndDateActive: string (date)
  Title: End Date

  The date to which a job assignment override applies.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the job assignment override in the source application. Used to identify job assignment overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application from where the job assignment override originates. Used to identify job assignment overrides created through external webservices.
• JobAssignmentOverrideId: integer (int64)
  Title: Job Assignment Override ID

  The unique identifier of the job assignment override on the bill plan that identifies the negotiated job assigned to a specific person, rather than the normal job for that person.
• JobCode: string
  Title: Job Code

  The job code of the override being assigned to the person for this bill or revenue plan.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier of the override job being assigned to the person for this bill or revenue plan.
• JobName: string
  Title: Job Name

  Maximum Length: 240

  The job name of the override being assigned to the person for this bill or revenue plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  The version of the contract containing this particular set of job assignment override details.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person for whom the job assignment override is defined.
• PersonName: string
  Title: Person

  Maximum Length: 2000

  The person for whom the job assignment override is defined.
• PersonNumber: string
  Title: Person Number

  Maximum Length: 30

  The person number for whom the job assignment override is defined.
• StartDateActive: string (date)
  Title: Start Date

  The date from which a job assignment override applies.

{
    "type":"object",
    "properties":{
        "BillingTitle":{
            "title":"Billing Title Override",
            "maxLength":80,
            "type":"string",
            "description":"Name of the override job title being assigned to the person for this bill plan. Used to display on the invoice to the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the job assignment override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":150,
            "type":"string",
            "description":"The contract line for which the job assignment override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"The email address for whom the job assignment override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PersonName"
                ]
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date to which a job assignment override applies.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the job assignment override in the source application. Used to identify job assignment overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application from where the job assignment override originates. Used to identify job assignment overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "JobAssignmentOverrideId":{
            "title":"Job Assignment Override ID",
            "type":"integer",
            "description":"The unique identifier of the job assignment override on the bill plan that identifies the negotiated job assigned to a specific person, rather than the normal job for that person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"The job code of the override being assigned to the person for this bill or revenue plan.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier of the override job being assigned to the person for this bill or revenue plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "maxLength":240,
            "type":"string",
            "description":"The job name of the override being assigned to the person for this bill or revenue plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"The version of the contract containing this particular set of job assignment override details.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person for whom the job assignment override is defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "EmailAddress",
                    "PersonName",
                    "PersonNumber"
                ]
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person",
            "maxLength":2000,
            "type":"string",
            "description":"The person for whom the job assignment override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The person number for whom the job assignment override is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "EmailAddress",
                    "PersonName"
                ]
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which a job assignment override applies.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : contracts-BillPlan-JobRateOverride-item-response

Type: object

Show Source

• BillRateOverrideId: integer (int64)
  Title: Job Rate Override ID

  Unique identifier of the bill rate override.
• BillRateUnitCode: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 30

  Default Value: HOURS

  The bill rate unit code.
• ContractLineId: integer (int64)
  Title: Contract Line ID

  Unique identifier of the contract line for which the bill rate override applies.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  Contract line number for which the bill rate override applies.
• DiscountPercentage: number
  Title: Discount Percentage

  Discount percentage applied to the bill rate.
• EndDateActive: string (date)
  Title: End Date

  Date till which bill rate override is effective.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the override in the source application. Used to identify overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices.
• JobCode: string
  Title: Job Code

  Code of the job for which bill rate is being overriden.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier of the job for which bill rate is being overridden.
• JobName: string
  Title: Job

  Maximum Length: 240

  Name of the job for which bill rate is being overridden.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  Current version of a record.
• Rate: number
  Title: Rate

  Amount billed to the customer for an item.
• RateCurrency: string
  Title: Currency

  Maximum Length: 80

  Currency of the bill rate override.
• RateCurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Currency code of the bill rate override.
• RateDiscountReason: string
  Title: Discount Reason

  Maximum Length: 80

  Reason for applying a discount.
• RateDiscReasonCode: string
  Title: Discount Reason

  Maximum Length: 30

  Reason code for applying a discount.
• StartDateActive: string (date)
  Title: Start Date

  Date from which bill rate override is effective.

{
    "type":"object",
    "properties":{
        "BillRateOverrideId":{
            "title":"Job Rate Override ID",
            "type":"integer",
            "description":"Unique identifier of the bill rate override.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillRateUnitCode":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The bill rate unit code.",
            "nullable":true,
            "readOnly":true,
            "default":"HOURS",
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the bill rate override applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":150,
            "type":"string",
            "description":"Contract line number for which the bill rate override applies.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DiscountPercentage":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"Discount percentage applied to the bill rate.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"Date till which bill rate override is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the override in the source application. Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application where the override is created.  Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"Code of the job for which bill rate is being overriden.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier of the job for which  bill rate is being overridden.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job",
            "maxLength":240,
            "type":"string",
            "description":"Name of the job  for which  bill rate is being overridden.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Current version of a record.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"Amount billed to the customer for an item.",
            "nullable":true,
            "x-queryable":true
        },
        "RateCurrency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency of the bill rate override.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RateCurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Currency code of the bill rate override.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDiscReasonCode":{
            "title":"Discount Reason",
            "maxLength":30,
            "type":"string",
            "description":"Reason code for applying a discount.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDiscountReason":{
            "title":"Discount Reason",
            "maxLength":80,
            "type":"string",
            "description":"Reason for applying a discount.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"Date from which bill rate override is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : contracts-BillPlan-JobTitleOverride-item-response

Type: object

Show Source

• BillingTitle: string
  Title: Billing Title Override

  Maximum Length: 80

  Name of the override job title being assigned to the job for this bill plan. Used to display on the invoice to the customer.
• ContractLineId: integer (int64)
  Title: Contract Line ID

  Unique identifier of the contract line for which the job title override is defined.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  The contract line number for which the job title override is defined.
• EndDateActive: string (date)
  Title: End Date

  The date to which a job title override applies.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the job title override in the source application. Used to identify job title overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application from where the job title override originates. Used to identify job title overrides created through external webservices.
• JobCode: string
  Title: Job Code

  Code of the job for which the job title override is defined.
• JobId: integer (int64)
  Title: Job ID

  Unique identifier of the job for which the job title override is defined.
• JobName: string
  Title: Job Name

  Maximum Length: 240

  Name for the Job for which the job title override is defined.
• JobTitleOverrideId: integer (int64)
  Title: Job Title Override ID

  Unique identifier of the job title override on the bill plan that identifies the negotiated job title assigned to a specific person, rather than the normal title for that person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  Version of the contract containing this particular set of job title override details.
• StartDateActive: string (date)
  Title: Start Date

  The date from which a job title override applies.

{
    "type":"object",
    "properties":{
        "BillingTitle":{
            "title":"Billing Title Override",
            "maxLength":80,
            "type":"string",
            "description":"Name of the override job title being assigned to the job for this bill plan. Used to display on the invoice to the customer.",
            "nullable":false,
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the job title override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":150,
            "type":"string",
            "description":"The contract line number for which the job title override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date to which a job title override applies.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the job title override in the source application. Used to identify job title overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application from where the job title override originates. Used to identify job title overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"Code of the job for which the job title override is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier of the job for which the job title override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "maxLength":240,
            "type":"string",
            "description":"Name for the Job for which the job title override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "JobTitleOverrideId":{
            "title":"Job Title Override ID",
            "type":"integer",
            "description":"Unique identifier of the job title override on the bill plan that identifies the negotiated job title assigned to a specific person, rather than the normal title for that person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Version of the contract containing this particular set of job title override details.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which a job title override applies.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : contracts-BillPlan-LaborMultiplierOverride-item-response

Type: object

Show Source

• ContractLineId: integer (int64)
  Title: Contract Line ID

  Unique identifier of the contract line for which the labor multiplier override applies.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  Contract line number for which labor mutliplier override applies.
• EndDateActive: string (date)
  Title: End Date

  The date to which a labor multiplier override applies.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices.
• LaborMultiplier: number
  Title: Multiplier

  Labor multiplier.
• LaborMultiplierId: integer (int64)
  Title: Labor Multiplier ID

  Unique identifier of the labor multiplier override on the bill plan or revenue plan that identifies the negotiated value to be multiplied by the cost rate for labor.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  Version of the contract containing this particular set of labor multiplier override details.
• StartDateActive: string (date)
  Title: Start Date

  The date from which a labor multiplier override applies.

{
    "type":"object",
    "properties":{
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the labor multiplier override applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":150,
            "type":"string",
            "description":"Contract line number for which labor mutliplier override applies.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date to which a labor multiplier override applies.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application where the override is created.  Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application where the override is created.  Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "LaborMultiplier":{
            "title":"Multiplier",
            "type":"number",
            "description":"Labor multiplier.",
            "nullable":false,
            "x-queryable":true
        },
        "LaborMultiplierId":{
            "title":"Labor Multiplier ID",
            "type":"integer",
            "description":"Unique identifier of the labor multiplier override on the bill plan or revenue plan that identifies the negotiated value to be multiplied by the cost rate for labor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Version of the contract containing this particular set of labor multiplier override details.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which a labor multiplier override applies.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : contracts-BillPlan-NonLaborRateOverride-item-response

Type: object

Show Source

• BillRateOverrideId: integer (int64)
  Title: Nonlabor Rate Override ID

  Unique identifier of the bill rate override.
• ContractLineId: integer (int64)
  Title: Contract Line ID

  Unique identifier of the contract line for which the bill rate override applies.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  Contract line number for which the bill rate override applies.
• DiscountPercentage: number
  Title: Discount Percentage

  Discount percentage applied to the bill rate.
• EndDateActive: string (date)
  Title: End Date

  Date till which bill rate override is effective.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type ID

  Unique identifier of the expenditure type for which the bill rate is being overridden.
• ExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  Expenditure type name for which the bill rate is being overridden.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the override in the source application. Used to identify overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  Current version of a record.
• MarkupPercentage: number
  Title: Markup Percentage

  Markup percentage applied to the bill rate.
• NonLaborResourceId: integer (int64)
  Title: Nonlabor Resource ID

  Unique identifier of the non labor resource for which the bill rate is being overridden.
• NonLaborResourceName: string
  Title: Nonlabor Resource

  Maximum Length: 240

  Non labor resource name for which the bill rate is being overridden.
• OrganizationId: integer (int64)
  Title: Organization ID

  Unique identifier of the organization for which the bill rate overrides are being defined.
• OrganizationName: string
  Title: Organization

  Maximum Length: 240

  Name of the organization for which the bill rate overrides are being defined.
• Rate: number
  Title: Rate

  Amount billed to the customer for an item.
• RateCurrency: string
  Title: Currency

  Maximum Length: 80

  Currency of the bill rate override.
• RateCurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Currency code of the bill rate override.
• RateDiscountReason: string
  Title: Rate Change Reason

  Maximum Length: 80

  Reason for applying a discount.
• RateDiscReasonCode: string
  Title: Rate Change Reason Code

  Maximum Length: 30

  Reason code for applying a discount.
• StartDateActive: string (date)
  Title: Start Date

  Date from which bill rate override is effective.

{
    "type":"object",
    "properties":{
        "BillRateOverrideId":{
            "title":"Nonlabor Rate Override ID",
            "type":"integer",
            "description":"Unique identifier of the bill rate override.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the bill rate override applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":150,
            "type":"string",
            "description":"Contract line number for which the bill rate override applies.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DiscountPercentage":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"Discount percentage applied to the bill rate.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"Date till which bill rate override is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "title":"Expenditure Type ID",
            "type":"integer",
            "description":"Unique identifier of the expenditure type for which the bill rate is being overridden.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"Expenditure type name for which the bill rate is being overridden.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the override in the source application. Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application where the override is created.  Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Current version of a record.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MarkupPercentage":{
            "title":"Markup Percentage",
            "type":"number",
            "description":"Markup percentage applied to the bill rate.",
            "nullable":true,
            "x-queryable":true
        },
        "NonLaborResourceId":{
            "title":"Nonlabor Resource ID",
            "type":"integer",
            "description":"Unique identifier of the non labor resource for which the bill rate is being overridden.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ExpenditureTypeId",
                    "ExpenditureTypeName"
                ]
            },
            "x-queryable":true
        },
        "NonLaborResourceName":{
            "title":"Nonlabor Resource",
            "maxLength":240,
            "type":"string",
            "description":"Non labor resource name for which the bill rate is being overridden.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ExpenditureTypeId",
                    "ExpenditureTypeName"
                ]
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Unique identifier of the organization for which the bill rate overrides are being defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ExpenditureTypeId",
                    "ExpenditureTypeName",
                    "NonLaborResourceId",
                    "NonLaborResourceName"
                ]
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization for which the bill rate overrides are being defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ExpenditureTypeId",
                    "ExpenditureTypeName",
                    "NonLaborResourceId",
                    "NonLaborResourceName"
                ]
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"Amount billed to the customer for an item.",
            "nullable":true,
            "x-queryable":true
        },
        "RateCurrency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency of the bill rate override.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RateCurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Currency code of the bill rate override.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDiscReasonCode":{
            "title":"Rate Change Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason code for applying a discount.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDiscountReason":{
            "title":"Rate Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"Reason for applying a discount.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"Date from which bill rate override is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : contracts-BillPlan-PersonRateOverride-item-response

Type: object

Show Source

• BillRateOverrideId: integer (int64)
  Title: Person Rate Override ID

  Unique identifier of the bill rate override.
• ContractLineId: integer (int64)
  Title: Contract Line ID

  Unique identifier of the contract line for which the bill rate override applies.
• ContractLineNumber: string
  Title: Contract Line Number

  Maximum Length: 150

  Contract line number for which the bill rate override applies.
• DiscountPercentage: number
  Title: Discount Percentage

  Discount percentage applied to the bill rate.
• EndDateActive: string (date)
  Title: End Date

  Date till which bill rate override is effective.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Unique identifier of the override in the source application. Used to identify overrides created through external webservices.
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Default Value: 1

  Current version of a record.
• PersonEmail: string
  Title: Person Email

  Maximum Length: 240

  Email of the person whose bill rate is being overridden.
• PersonId: integer (int64)
  Title: Person ID

  Unique identifier of the person whose bill rate is being overridden.
• PersonName: string
  Title: Person

  Maximum Length: 240

  Name of the person whose bill rate is being overridden.
• Rate: number
  Title: Rate

  Amount billed to the customer for an item.
• RateCurrency: string
  Title: Currency

  Maximum Length: 80

  Currency of the bill rate override.
• RateCurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Currency code of the bill rate override.
• RateDiscountReason: string
  Title: Rate Change Reason

  Maximum Length: 80

  Reason for applying a discount.
• RateDiscReasonCode: string
  Title: Rate Change Reason Code

  Maximum Length: 30

  Reason code for applying a discount.
• StartDateActive: string (date)
  Title: Start Date

  Date from which bill rate override is effective.

{
    "type":"object",
    "properties":{
        "BillRateOverrideId":{
            "title":"Person Rate Override ID",
            "type":"integer",
            "description":"Unique identifier of the bill rate override.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the bill rate override applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":150,
            "type":"string",
            "description":"Contract line number for which the bill rate override applies.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DiscountPercentage":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"Discount percentage applied to the bill rate.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"Date till which bill rate override is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the override in the source application. Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application where the override is created. Used to identify overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Current version of a record.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonEmail":{
            "title":"Person Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the person whose bill rate is being overridden.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person whose bill rate is being overridden.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person whose bill rate is being overridden.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"Amount billed to the customer for an item.",
            "nullable":true,
            "x-queryable":true
        },
        "RateCurrency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency of the bill rate override.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RateCurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Currency code of the bill rate override.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDiscReasonCode":{
            "title":"Rate Change Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason code for applying a discount.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDiscountReason":{
            "title":"Rate Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"Reason for applying a discount.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"Date from which bill rate override is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

The following example shows how to get all bill plans by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillPlan

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "BillPlanId": 200000000000002,
            "MajorVersion": 1,
            "BillMethodId": 1005,
            "BillMethodName": "Fixed Price Invoice",
            "BillPlanName": "Invoice Plan - FP",
            "InvoiceCurrencyOptCode": "CONTRACT",
            "BillingCurrencyType": "Contract",
            "PaymentTermsId": 1000,
            "PaymentTerms": "2/10, Net 30",
            "BillSetNumber": 1,
            "InvHdrGroupingOptions": null,
            "InvoiceHdrGrpOptName": null,
            "BillToCustomerAccountId": 1001,
            "BillToAccountNumber": "1001",
            "BillToSiteUseId": 1006,
            "BillToSite": "New York (OPS)",
            "BillToContactId": 1009,
            "BillToContactName": "Mike Kenton",
            "BillToContactEmail": "[e-mail]",
            "BillingCycleId": 1000000000001,
            "BillingCycle": null,
            "LaborInvoiceFormatId": 100000010695006,
            "LaborInvoiceFormat": "Time and Material",
            "NlInvoiceFormatId": 100000011410001,
            "NonlaborInvoiceFormat": "NL  Work Site Exp Cat Format",
            "EventsInvoiceFormatId": 100000011407004,
            "EventInvoiceFormat": "Event Type Format",
            "FirstBillingOffsetDays": 7,
            "InvoiceInstructions": null,
            "InvoiceComment": "Trial Invoice",
            "PersonBillRateSchId": 1228,
            "PersonRateSchedule": null,
            "JobBillRateSchId": 1229,
            "JobRateSchedule": null,
            "LaborSchFixedDate": null,
            "LaborDiscountPercentage": null,
            "LaborDiscountReasonCode": null,
            "LaborRateChangeReason": null,
            "NlBillRateSchId": 1231,
            "NonlaborRateSchedule": null,
            "NlSchFixedDate": null,
            "NlDiscountPercentage": null,
            "NlDiscountReasonCode": null,
            "NonlaborRateChangeReason": null,
            "BurdenSchId": null,
            "BurdenSchedule": null,
            "BurdenSchFixedDate": null,
            "LaborTpScheduleId": null,
            "LaborTransferPriceSchedule": null,
            "LaborTpSchFixedDate": null,
            "NlTpScheduleId": null,
            "NonlaborTransferPriceSchedule": null,
            "NlTpSchFixedDate": null,
            "OnHoldFlag": false,
            "ExternalSourceKey": null,
            "ExternalReferenceKey": null,
            "InvoiceCurrencyDateType": null,
            "InvoiceCurrencyConversionDateType": null,
            "InvoiceCurrencyExchgDate": null,
            "InvoiceCurrencyRateType": null,
            "InvoiceCurrencyConversionRateType": null,
            "InvoiceCurrencyCode": null,
            "NlBillBasisCode": null,
            "NonlaborCostBasis": null,
            "LaborBillBasisCode": null,
            "LaborCostBasis": null,
            "LaborMarkupPercentage": null,
            "NlMarkupPercentage": null,
            "DocumentNumber": null,
            "LocFlag": null,
            "FederalInvoiceFormat": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001",
                    "name": "BillPlan",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001",
                    "name": "BillPlan",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915",
                    "name": "contracts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/EventsInvoiceFormatVA",
                    "name": "EventsInvoiceFormatVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/InvoiceConversionRateTypeVA",
                    "name": "InvoiceConversionRateTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/InvoiceFormatPVA",
                    "name": "InvoiceFormatPVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/BillingCycleVA",
                    "name": "BillingCycleVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/InvoiceConvDateTypeLookupVA",
                    "name": "InvoiceConvDateTypeLookupVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/BillToContactVA",
                    "name": "BillToContactVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/EmployeeRateScheduleVA",
                    "name": "EmployeeRateScheduleVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/LaborCostBasisVA",
                    "name": "LaborCostBasisVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/BillingMethodVA",
                    "name": "BillingMethodVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/NonLaborInvoiceFormatVA",
                    "name": "NonLaborInvoiceFormatVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/BillToSiteUseVA",
                    "name": "BillToSiteUseVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/JobRateScheduleVA",
                    "name": "JobRateScheduleVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/NonLaborCostBasisVA",
                    "name": "NonLaborCostBasisVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/NonLaborDiscountReasonVA",
                    "name": "NonLaborDiscountReasonVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/PaymentTermVA",
                    "name": "PaymentTermVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/LaborInvoiceFormatVA",
                    "name": "LaborInvoiceFormatVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/TransferPriceScheduleVA",
                    "name": "TransferPriceScheduleVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/BurdenScheduleVA",
                    "name": "BurdenScheduleVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/BillToContactNameVA",
                    "name": "BillToContactNameVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/BillingCurrencyTypeVA",
                    "name": "BillingCurrencyTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/JobBillRateSchIdVA",
                    "name": "JobBillRateSchIdVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/LaborDiscountReasonVA",
                    "name": "LaborDiscountReasonVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/InvHdrGrpOptionVA",
                    "name": "InvHdrGrpOptionVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/CustomerAccountVA",
                    "name": "CustomerAccountVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/lov/NonLaborRateScheduleVA",
                    "name": "NonLaborRateScheduleVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/BillPlanDescriptiveFlexField",
                    "name": "BillPlanDescriptiveFlexField",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/BillPlanTranslation",
                    "name": "BillPlanTranslation",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/JobAssignmentOverride",
                    "name": "JobAssignmentOverride",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/JobRateOverride",
                    "name": "JobRateOverride",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/JobTitleOverride",
                    "name": "JobTitleOverride",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/LaborMultiplierOverride",
                    "name": "LaborMultiplierOverride",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/NonLaborRateOverride",
                    "name": "NonLaborRateOverride",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan/00020000000EACED000577080000B5E620F480020000000EACED000577080000000000000001/child/PersonRateOverride",
                    "name": "PersonRateOverride",
                    "kind": "collection"
                }
            ]
        },
  .....
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430915/child/BillPlan",
            "name": "BillPlan",
            "kind": "collection"
        }
    ]
}

Back to Top