Jump to

• Request
• Response

Create one billing plan

post

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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
            }
        },
        "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
        },
        "CancellationEffectiveDate":{
            "type":"string",
            "description":"Date when recurring billing stops and no future billing occurs.",
            "format":"date",
            "nullable":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
        },
        "BillingPeriodNumber":{
            "type":"integer",
            "description":"Timeframe number for the billing start date, end date, or transaction date.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "OverridePeriodAmount":{
            "type":"number",
            "description":"Override amount to apply on the timeframe.",
            "nullable":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
            }
        },
        "PeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Timeframe of the recurring invoice. Values include Day, Week, Month, Quarter, or Year.",
            "nullable":true
        },
        "OverridePeriodQuantity":{
            "type":"number",
            "description":"Quantity to use when calculating recurring billing or credit for the override timeframe.",
            "nullable":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
        },
        "BillingNumberOfPeriods":{
            "type":"integer",
            "description":"Number of timeframes in a recurring invoice.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "BillingPlanTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of billing plan, such as periodic or milestone.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root 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