Jump to

• Request
• Response

Create multiple bill calendar records

post

/hcmRestApi/resources/11.13.18.05/benefitBillCalendars

Request

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.
• Upsert-Mode: string
  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

• benefitBillPeriods: array Benefit Bill Periods
  Title: Benefit Bill Periods

  The benefitBillPeriods resource provides details of bill periods within the bill calendars.
• BillCycleId: integer (int64)
  Title: Benefits Bill Cycle ID

  Unique identifier of the bill calendar record.
• BillingFrequency(required): string
  Title: Billing Frequency

  Maximum Length: 200

  Frequency at which billing needs to be generated.
• CalendarName(required): string
  Title: Calendar Name

  Maximum Length: 240

  Name of the bill calendar.
• DaysOverdue(required): integer (int64)
  Title: Days Overdue

  Number of days after the due date.
• Description: string
  Title: Description

  Maximum Length: 400

  Description of the bill calendar.
• PaymentDueDay(required): integer (int64)
  Title: Payment Due Day

  Payment due date.
• PeriodType: string
  Title: Period Type

  Maximum Length: 30

  Type of the bill calendar.

{
    "required":[
        "BillingFrequency",
        "CalendarName",
        "DaysOverdue",
        "PaymentDueDay"
    ],
    "type":"object",
    "properties":{
        "BillCycleId":{
            "title":"Benefits Bill Cycle ID",
            "type":"integer",
            "description":"Unique identifier of the bill calendar record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":200,
            "type":"string",
            "description":"Frequency at which billing needs to be generated.",
            "nullable":false
        },
        "CalendarName":{
            "title":"Calendar Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the bill calendar.",
            "nullable":false
        },
        "DaysOverdue":{
            "title":"Days Overdue",
            "type":"integer",
            "description":"Number of days after the due date.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"Description of the bill calendar.",
            "nullable":true
        },
        "PaymentDueDay":{
            "title":"Payment Due Day",
            "type":"integer",
            "description":"Payment due date.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PeriodType":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of the bill calendar.",
            "nullable":true
        },
        "benefitBillPeriods":{
            "title":"Benefit Bill Periods",
            "type":"array",
            "description":"The benefitBillPeriods resource provides details of bill periods within the bill calendars.",
            "items":{
                "$ref":"#/components/schemas/benefitBillCalendars-benefitBillPeriods-item-post-request"
            }
        }
    }
}

Nested Schema : Benefit Bill Periods

Type: array

Title: Benefit Bill Periods

The benefitBillPeriods resource provides details of bill periods within the bill calendars.

Show Source

• Array of: object benefitBillCalendars-benefitBillPeriods-item-post-request

{
    "title":"Benefit Bill Periods",
    "type":"array",
    "description":"The benefitBillPeriods resource provides details of bill periods within the bill calendars.",
    "items":{
        "$ref":"#/components/schemas/benefitBillCalendars-benefitBillPeriods-item-post-request"
    }
}

Nested Schema : benefitBillCalendars-benefitBillPeriods-item-post-request

Type: object

Show Source

• BillCalendarId: integer (int64)
  Title: Benefits Bill Calendar ID

  Unique identifier of the bill period.
• BillCycleId: integer (int64)
  Title: Benefits Bill Cycle ID

  Unique identifier of the bill calendar.
• BillingPeriod: string
  Title: Billing Period

  Maximum Length: 200

  Name of the billing period.
• BillYear: string
  Title: Year Period

  Maximum Length: 200

  Year in which bill period is created.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Comment for the billing period.
• PaymentDueDate: string (date)
  Title: Payment Due Date

  Payment due date.
• PaymentOverdueDate: string (date)
  Title: Payment Overdue Date

  Payment over due date.
• PeriodEndDate: string (date)
  Bill period end date.
• PeriodStartDate: string (date)
  Title: Period Start Date

  Bill period start date.

{
    "type":"object",
    "properties":{
        "BillCalendarId":{
            "title":"Benefits Bill Calendar ID",
            "type":"integer",
            "description":"Unique identifier of the bill period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BillCycleId":{
            "title":"Benefits Bill Cycle ID",
            "type":"integer",
            "description":"Unique identifier of the bill calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BillYear":{
            "title":"Year Period",
            "maxLength":200,
            "type":"string",
            "description":"Year in which bill period is created.",
            "nullable":false
        },
        "BillingPeriod":{
            "title":"Billing Period",
            "maxLength":200,
            "type":"string",
            "description":"Name of the billing period.",
            "nullable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Comment for the billing period.",
            "nullable":true
        },
        "PaymentDueDate":{
            "title":"Payment Due Date",
            "type":"string",
            "description":"Payment due date.",
            "format":"date",
            "nullable":false
        },
        "PaymentOverdueDate":{
            "title":"Payment Overdue Date",
            "type":"string",
            "description":"Payment over due date.",
            "format":"date",
            "nullable":false
        },
        "PeriodEndDate":{
            "type":"string",
            "description":"Bill period end date.",
            "format":"date",
            "nullable":false
        },
        "PeriodStartDate":{
            "title":"Period Start Date",
            "type":"string",
            "description":"Bill period start date.",
            "format":"date",
            "nullable":false
        }
    }
}

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 : benefitBillCalendars-item-response

Type: object

Show Source

• benefitBillPeriods: array Benefit Bill Periods
  Title: Benefit Bill Periods

  The benefitBillPeriods resource provides details of bill periods within the bill calendars.
• BillCycleId: integer (int64)
  Title: Benefits Bill Cycle ID

  Unique identifier of the bill calendar record.
• BillingFrequency: string
  Title: Billing Frequency

  Maximum Length: 200

  Frequency at which billing needs to be generated.
• BillingFrequencyMeaning: string
  Read Only: true

  Maximum Length: 255

  Frequency at which billing needs to be generated.
• CalendarName: string
  Title: Calendar Name

  Maximum Length: 240

  Name of the bill calendar.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the bill calendar record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the bill calendar was created.
• DaysOverdue: integer (int64)
  Title: Days Overdue

  Number of days after the due date.
• Description: string
  Title: Description

  Maximum Length: 400

  Description of the bill calendar.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the bill calendar record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the bill calendar record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentDueDay: integer (int64)
  Title: Payment Due Day

  Payment due date.
• PeriodType: string
  Title: Period Type

  Maximum Length: 30

  Type of the bill calendar.
• PeriodTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Type of the bill calendar.

{
    "type":"object",
    "properties":{
        "BillCycleId":{
            "title":"Benefits Bill Cycle ID",
            "type":"integer",
            "description":"Unique identifier of the bill calendar record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":200,
            "type":"string",
            "description":"Frequency at which billing needs to be generated.",
            "nullable":false,
            "x-queryable":true
        },
        "BillingFrequencyMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Frequency at which billing needs to be generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CalendarName":{
            "title":"Calendar Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the bill calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the bill calendar record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the bill calendar was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysOverdue":{
            "title":"Days Overdue",
            "type":"integer",
            "description":"Number of days after the due date.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"Description of the bill calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the bill calendar record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the bill calendar record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentDueDay":{
            "title":"Payment Due Day",
            "type":"integer",
            "description":"Payment due date.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodType":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of the bill calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the bill calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "benefitBillPeriods":{
            "title":"Benefit Bill Periods",
            "type":"array",
            "description":"The benefitBillPeriods resource provides details of bill periods within the bill calendars.",
            "items":{
                "$ref":"#/components/schemas/benefitBillCalendars-benefitBillPeriods-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Benefit Bill Periods

Type: array

Title: Benefit Bill Periods

The benefitBillPeriods resource provides details of bill periods within the bill calendars.

Show Source

• Array of: object benefitBillCalendars-benefitBillPeriods-item-response

{
    "title":"Benefit Bill Periods",
    "type":"array",
    "description":"The benefitBillPeriods resource provides details of bill periods within the bill calendars.",
    "items":{
        "$ref":"#/components/schemas/benefitBillCalendars-benefitBillPeriods-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 : benefitBillCalendars-benefitBillPeriods-item-response

Type: object

Show Source

• BillCalendarId: integer (int64)
  Title: Benefits Bill Calendar ID

  Unique identifier of the bill period.
• BillCycleId: integer (int64)
  Title: Benefits Bill Cycle ID

  Unique identifier of the bill calendar.
• BillingPeriod: string
  Title: Billing Period

  Maximum Length: 200

  Name of the billing period.
• BillYear: string
  Title: Year Period

  Maximum Length: 200

  Year in which bill period is created.
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Comment for the billing period.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the bill period record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the bill period was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the bill period record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the bill period record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentDueDate: string (date)
  Title: Payment Due Date

  Payment due date.
• PaymentOverdueDate: string (date)
  Title: Payment Overdue Date

  Payment over due date.
• PeriodEndDate: string (date)
  Bill period end date.
• PeriodStartDate: string (date)
  Title: Period Start Date

  Bill period start date.

{
    "type":"object",
    "properties":{
        "BillCalendarId":{
            "title":"Benefits Bill Calendar ID",
            "type":"integer",
            "description":"Unique identifier of the bill period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillCycleId":{
            "title":"Benefits Bill Cycle ID",
            "type":"integer",
            "description":"Unique identifier of the bill calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillYear":{
            "title":"Year Period",
            "maxLength":200,
            "type":"string",
            "description":"Year in which bill period is created.",
            "nullable":false,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Billing Period",
            "maxLength":200,
            "type":"string",
            "description":"Name of the billing period.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Comment for the billing period.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the bill period record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the bill period was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the bill period record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the bill period record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentDueDate":{
            "title":"Payment Due Date",
            "type":"string",
            "description":"Payment due date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentOverdueDate":{
            "title":"Payment Overdue Date",
            "type":"string",
            "description":"Payment over due date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodEndDate":{
            "type":"string",
            "description":"Bill period end date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Period Start Date",
            "type":"string",
            "description":"Bill period start date.",
            "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 : 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."
        }
    }
}

Links

benefitBillPeriods

Operation: /hcmRestApi/resources/11.13.18.05/benefitBillCalendars/{BillCycleId}/child/benefitBillPeriods

Parameters:

• BillCycleId: $request.path.BillCycleId

The benefitBillPeriods resource provides details of bill periods within the bill calendars.

Back to Top