Jump to

• Request
• Response
• Examples

Get all billing plans

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/billingPlans

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines 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:
  
  

  • PrimaryKey: Find billing plan details according to the source billing plan identifier.
    Finder Variables:
    • SourceBillingPlanId; string; Value that identifies the billing plan. The source application assigns this value.
  • findBySourceBillingPlanId: Find billing plan details according to the source billing plan identifier.
    Finder Variables:
    • SourceBillingPlanId; string; Value that identifies the billing plan. The source application assigns this value.
• 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:
  

  • BillingNumberOfPeriods; integer; Number of timeframes in a recurring invoice.
  • BillingPeriodEndDate; string; End date of the billing timeframe. The application sets this date to the contract end date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the end date to the billing end date of the subsequent billing timeframe.
  • BillingPeriodNumber; integer; Timeframe number for the billing start date, end date, or transaction date.
  • BillingPeriodStartDate; string; Start date of the billing timeframe. The application sets this date to the contract start date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the start date to the billing start date of the subsequent billing timeframe.
  • BillingPlanTypeCode; string; Abbreviation that identifies the type of billing plan, such as periodic or milestone.
  • BillingTransactionDate; string; Date when the first invoice occurs when the sales order uses a recurring invoice. If the invoice covers only part of an invoice timeframe, then this attribute stores the date of the subsequent invoice.
  • CancellationEffectiveDate; string; Date when recurring billing stops and no future billing occurs.
  • OverridePeriod; integer; Timeframe that includes an override amount. For example, the first invoice is for timeframe 1, the second invoice is for timeframe 2, and so on.
  • OverridePeriodAmount; number; Override amount to apply on the timeframe.
  • OverridePeriodQuantity; number; Quantity to use when calculating recurring billing or credit for the override timeframe.
  • PeriodicityCode; string; Timeframe of the recurring invoice. Values include Day, Week, Month, Quarter, or Year.
  • SourceBillingPlanId; string; Value that uniquely identifies the billing plan. This value is assigned by the source application.
• 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:
  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.

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 : salesOrdersForOrderHubRequests-lines-billingPlans

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHubRequests-lines-billingPlans-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object salesOrdersForOrderHubRequests-lines-billingPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHubRequests-lines-billingPlans-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 : salesOrdersForOrderHubRequests-lines-billingPlans-item-response

Type: object

Show Source

• BillingNumberOfPeriods: integer (int32)
  Number of timeframes in a recurring invoice.
• BillingPeriodEndDate: string (date)
  End date of the billing timeframe. The application sets this date to the contract end date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the end date to the billing end date of the subsequent billing timeframe.
• BillingPeriodNumber: integer (int32)
  Timeframe number for the billing start date, end date, or transaction date.
• BillingPeriodStartDate: string (date)
  Start date of the billing timeframe. The application sets this date to the contract start date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the start date to the billing start date of the subsequent billing timeframe.
• BillingPlanTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of billing plan, such as periodic or milestone.
• BillingTransactionDate: string (date)
  Date when the first invoice occurs when the sales order uses a recurring invoice. If the invoice covers only part of an invoice timeframe, then this attribute stores the date of the subsequent invoice.
• CancellationEffectiveDate: string (date)
  Date when recurring billing stops and no future billing occurs.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverridePeriod: integer (int32)
  Timeframe that includes an override amount. For example, the first invoice is for timeframe 1, the second invoice is for timeframe 2, and so on.
• OverridePeriodAmount: number
  Override amount to apply on the timeframe.
• OverridePeriodQuantity: number
  Quantity to use when calculating recurring billing or credit for the override timeframe.
• PeriodicityCode: string
  Maximum Length: 30

  Timeframe of the recurring invoice. Values include Day, Week, Month, Quarter, or Year.
• SourceBillingPlanId: string
  Maximum Length: 50

  Value that uniquely identifies the billing plan. This value is assigned by the source application.

{
    "type":"object",
    "properties":{
        "SourceBillingPlanId":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the billing plan. This value is assigned by the source application.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BillingPeriodEndDate":{
            "type":"string",
            "description":"End date of the billing timeframe. The application sets this date to the contract end date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the end date to the billing end date of the subsequent billing timeframe.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CancellationEffectiveDate":{
            "type":"string",
            "description":"Date when recurring billing stops and no future billing occurs.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BillingTransactionDate":{
            "type":"string",
            "description":"Date when the first invoice occurs when the sales order uses a recurring invoice. If the invoice covers only part of an invoice timeframe, then this attribute stores the date of the subsequent invoice.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BillingPeriodNumber":{
            "type":"integer",
            "description":"Timeframe number for the billing start date, end date, or transaction date.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "OverridePeriodAmount":{
            "type":"number",
            "description":"Override amount to apply on the timeframe.",
            "nullable":true,
            "x-queryable":true
        },
        "OverridePeriod":{
            "type":"integer",
            "description":"Timeframe that includes an override amount. For example, the first invoice is for timeframe 1, the second invoice is for timeframe 2, and so on.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Timeframe of the recurring invoice. Values include Day, Week, Month, Quarter, or Year.",
            "nullable":true,
            "x-queryable":true
        },
        "OverridePeriodQuantity":{
            "type":"number",
            "description":"Quantity to use when calculating recurring billing or credit for the override timeframe.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingPeriodStartDate":{
            "type":"string",
            "description":"Start date of the billing timeframe. The application sets this date to the contract start date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the start date to the billing start date of the subsequent billing timeframe.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillingNumberOfPeriods":{
            "type":"integer",
            "description":"Number of timeframes in a recurring invoice.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BillingPlanTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of billing plan, such as periodic or milestone.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Back to Top

Examples

This example describes how to get all billing plans.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -i -X GET \
-H "Authorization:Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==" \
-H "REST-Framework-Version:4" \
-H "prefer:return=representation" \
-H "Content-Type:application/json" \
'https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/billingPlans'

Example Response Body

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

{
	"items" : [ {
		"BillingPeriodEndDate" : null,
		"BillingPeriodNumber" : null,
		"BillingPeriodStartDate" : null,
		"BillingPlanTypeCode" : null,
		"BillingTransactionDate" : null,
		"CancellationEffectiveDate" : null,
		"BillingNumberOfPeriods" : 12,
		"OverridePeriod" : 1,
		"OverridePeriodAmount" : 20,
		"OverridePeriodQuantity" : null,
		"PeriodicityCode" : null,
		"SourceBillingPlanId" : "SK-BATCH-1006-D3-BPI",
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/billingPlans/00060000000EACED00057708000001764CC49C2A00000014534B2D42415443482D313030362D44332D425049000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
			"name" : "billingPlans",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/billingPlans/00060000000EACED00057708000001764CC49C2A00000014534B2D42415443482D313030362D44332D425049000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
			"name" : "billingPlans",
			"kind" : "item"
		}, {
			"rel" : "parent",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
			"name" : "lines",
			"kind" : "item"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/billingPlans",
		"name" : "billingPlans",
		"kind" : "collection"
	} ]
}

Back to Top