Create an item in the payment cart
post
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts
Create an item in the payment cart
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPaymentCarts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier for the public sector agency.
-
Amount(optional):
number
Title:
Amount
The total fees for the permit. -
Applicant(optional):
integer(int64)
The user who submitted the permit application.
-
ApplicantName(optional):
string
Maximum Length:
450
The name of the permit applicant. -
AssociatedProject(optional):
array Associated Projects
Title:
Associated Projects
The payment carts resource is used by public users to manage fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed. -
CartId(optional):
integer(int64)
The unique identifier for the current payment cart.
-
CartItemType(optional):
string
Maximum Length:
3
The record type of the cart item, such as a permit, business license, professional license, or planning and zoning record. -
CartOwner(optional):
integer(int64)
The identifier for user profile associated with the payment cart.
-
CartStatus(optional):
string
Maximum Length:
10
The status of the payment cart item. -
CreatedBy(optional):
string
Maximum Length:
64
The user who added the item to the payment cart. -
CreationDate(optional):
string(date-time)
The date when the item was added to the payment cart.
-
CurrencyCode(optional):
string
Maximum Length:
3
The payment currency code. -
LastUpdateDate(optional):
string(date-time)
The date when the payment cart item was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the payment cart item. -
links(optional):
array Items
Title:
Items
Link Relations -
Originator(optional):
string
Maximum Length:
3
The user who submitted the permit. -
RecordId(optional):
string
Title:
Record ID
Maximum Length:50
The record identifier for the permit. -
RecordKey(optional):
integer(int64)
The unique identifier for the record key, such as the key for a permit.
Nested Schema : Associated Projects
Type:
array
Title:
Associated Projects
The payment carts resource is used by public users to manage fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed.
Show Source
Nested Schema : publicSectorPaymentCarts-AssociatedProject-item
Type:
Show Source
object
-
links(optional):
array Items
Title:
Items
Link Relations -
ProjectCode(optional):
string
Maximum Length:
30
The unique identifier for a project. -
ProjectName(optional):
string
Maximum Length:
50
The user-friendly name for a project. -
RecordKey(optional):
integer(int64)
The unique identifier for the record key, such as the key for a permit.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPaymentCarts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier for the public sector agency.
-
Amount(optional):
number
Title:
Amount
The total fees for the permit. -
Applicant(optional):
integer(int64)
The user who submitted the permit application.
-
ApplicantName(optional):
string
Maximum Length:
450
The name of the permit applicant. -
AssociatedProject(optional):
array Associated Projects
Title:
Associated Projects
The payment carts resource is used by public users to manage fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed. -
CartId(optional):
integer(int64)
The unique identifier for the current payment cart.
-
CartItemType(optional):
string
Maximum Length:
3
The record type of the cart item, such as a permit, business license, professional license, or planning and zoning record. -
CartOwner(optional):
integer(int64)
The identifier for user profile associated with the payment cart.
-
CartStatus(optional):
string
Maximum Length:
10
The status of the payment cart item. -
CreatedBy(optional):
string
Maximum Length:
64
The user who added the item to the payment cart. -
CreationDate(optional):
string(date-time)
The date when the item was added to the payment cart.
-
CurrencyCode(optional):
string
Maximum Length:
3
The payment currency code. -
LastUpdateDate(optional):
string(date-time)
The date when the payment cart item was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the payment cart item. -
links(optional):
array Items
Title:
Items
Link Relations -
Originator(optional):
string
Maximum Length:
3
The user who submitted the permit. -
RecordId(optional):
string
Title:
Record ID
Maximum Length:50
The record identifier for the permit. -
RecordKey(optional):
integer(int64)
The unique identifier for the record key, such as the key for a permit.
Nested Schema : Associated Projects
Type:
array
Title:
Associated Projects
The payment carts resource is used by public users to manage fees for payment by adding permits to the cart that are ready for checkout and removing permits from the cart as needed.
Show Source
Nested Schema : publicSectorPaymentCarts-AssociatedProject-item
Type:
Show Source
object
-
links(optional):
array Items
Title:
Items
Link Relations -
ProjectCode(optional):
string
Maximum Length:
30
The unique identifier for a project. -
ProjectName(optional):
string
Maximum Length:
50
The user-friendly name for a project. -
RecordKey(optional):
integer(int64)
The unique identifier for the record key, such as the key for a permit.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.