Create a payment checkout line
post
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin
Request
Path Parameters
-
CheckoutId(required): string
The unique identifier for the checkout data. Generated using the Fusion unique ID API.
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
Root Schema : schema
Type:
Show Source
object
-
AdapterId: string
Maximum Length:
100
The unique identifier of the payment adapter associated with the agency and payment method. -
Address1: string
Maximum Length:
240
The first line of the permit address. -
Address2: string
Maximum Length:
240
The second line of the permit address, if present. -
Address3: string
Maximum Length:
240
The third line of the permit address, if present. -
Address4: string
Maximum Length:
240
The fourth line of the permit address, if present. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId: string
Maximum Length:
50
The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus: string
Maximum Length:
50
Additional key identifier passed by the consuming application. -
BillAgencyId: integer
(int64)
The unique identifier of the agency associated with the invoice.
-
BillType: string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. -
BusBusinessLegalName: string
Maximum Length:
240
The legal name of a business. -
BusBusinessName: string
Maximum Length:
100
The name of a business. -
BusDbaBusinessName: string
Maximum Length:
100
The doing business as name of a business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier of a business. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier of a business location. -
BusinessLocationPartyId: integer
(int64)
The party identifier of a business location.
-
BusPartyId: integer
(int64)
The party identifier of a business.
-
CaseId: string
Maximum Length:
50
The case identifier for a code enforcement fee. -
CheckoutId: string
Maximum Length:
50
The unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutLineId: integer
(int64)
The unique sequence number for the checkout row generated using the Fusion unique ID API.
-
City: string
Maximum Length:
60
The city in the permit address. -
Classification: string
Maximum Length:
3
The source application that generated the fee. -
Country: string
Maximum Length:
60
The country in the permit address. -
County: string
Maximum Length:
60
The county in the permit address. -
CurrencyCode: string
Maximum Length:
3
The currency code in relation to the item unit price and tax amount. -
Department: string
Maximum Length:
30
A division within the agency devoted to a specific function. -
FeeItemId: string
Maximum Length:
30
The unique identifier for the fee item. -
FeeReferenceId: string
Maximum Length:
50
The reference identifier for the fee item. -
FeeReferencePuid: string
Maximum Length:
480
The PUID reference identifier for the fee item. -
Invoice: string
Maximum Length:
50
The unique billing identifier. -
ItemDescription: string
Maximum Length:
50
Relevant details related to the line item. -
ItemId: string
Maximum Length:
30
The unique identifier of the item to be paid. -
ItemQuantity: integer
Quantity of line items. This value cannot be negative.
-
ItemTaxAmount: number
Default Value:
0
The tax amount to apply to the line item. -
ItemUnitPrice: number
Price per unit of the line item. This value multiplied by the item quantity value equals the total line item amount.
-
OrganizationName: string
Maximum Length:
360
The name of an organization. -
PaymentDate: string
(date)
The date when the checkout was initiated.
-
PaymentHistoryKey: integer
(int64)
The unique payment history value generated using the Fusion unique ID API.
-
PaymentMethodCode: string
Maximum Length:
30
The type of payment selected during checkout. -
PaymentReferenceId: string
Maximum Length:
50
The global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentStatus: string
Maximum Length:
1
The status of the payment request. Valid values are paid, cancelled, or error. -
PostalCode: string
Maximum Length:
60
The postal code in the permit address. -
PostalPlus4Code: string
Maximum Length:
20
The extended postal code in the permit address. -
Province: string
Maximum Length:
60
The province in the permit address. -
RecordId: string
Maximum Length:
50
The source application's record identifier. -
RecordTypeId: string
Maximum Length:
30
The source application's record identifier. -
State: string
Maximum Length:
60
The state in the permit address.
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.
Root Schema : publicSectorCheckouts-CheckoutLin-item-response
Type:
Show Source
object
-
AdapterId: string
Maximum Length:
100
The unique identifier of the payment adapter associated with the agency and payment method. -
Address1: string
Maximum Length:
240
The first line of the permit address. -
Address2: string
Maximum Length:
240
The second line of the permit address, if present. -
Address3: string
Maximum Length:
240
The third line of the permit address, if present. -
Address4: string
Maximum Length:
240
The fourth line of the permit address, if present. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId: string
Maximum Length:
50
The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus: string
Maximum Length:
50
Additional key identifier passed by the consuming application. -
BillAgencyId: integer
(int64)
The unique identifier of the agency associated with the invoice.
-
BillType: string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. -
BusBusinessLegalName: string
Maximum Length:
240
The legal name of a business. -
BusBusinessName: string
Maximum Length:
100
The name of a business. -
BusDbaBusinessName: string
Maximum Length:
100
The doing business as name of a business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier of a business. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier of a business location. -
BusinessLocationPartyId: integer
(int64)
The party identifier of a business location.
-
BusPartyId: integer
(int64)
The party identifier of a business.
-
CaseId: string
Maximum Length:
50
The case identifier for a code enforcement fee. -
CheckoutId: string
Maximum Length:
50
The unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutLineId: integer
(int64)
The unique sequence number for the checkout row generated using the Fusion unique ID API.
-
City: string
Maximum Length:
60
The city in the permit address. -
Classification: string
Maximum Length:
3
The source application that generated the fee. -
Country: string
Maximum Length:
60
The country in the permit address. -
County: string
Maximum Length:
60
The county in the permit address. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
CurrencyCode: string
Maximum Length:
3
The currency code in relation to the item unit price and tax amount. -
Department: string
Maximum Length:
30
A division within the agency devoted to a specific function. -
FeeItemId: string
Maximum Length:
30
The unique identifier for the fee item. -
FeeReferenceId: string
Maximum Length:
50
The reference identifier for the fee item. -
FeeReferencePuid: string
Maximum Length:
480
The PUID reference identifier for the fee item. -
Invoice: string
Maximum Length:
50
The unique billing identifier. -
ItemDescription: string
Maximum Length:
50
Relevant details related to the line item. -
ItemId: string
Maximum Length:
30
The unique identifier of the item to be paid. -
ItemQuantity: integer
Quantity of line items. This value cannot be negative.
-
ItemTaxAmount: number
Default Value:
0
The tax amount to apply to the line item. -
ItemUnitPrice: number
Price per unit of the line item. This value multiplied by the item quantity value equals the total line item amount.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Maximum Length:
360
The name of an organization. -
PaymentDate: string
(date)
The date when the checkout was initiated.
-
PaymentHistoryKey: integer
(int64)
The unique payment history value generated using the Fusion unique ID API.
-
PaymentMethodCode: string
Maximum Length:
30
The type of payment selected during checkout. -
PaymentReferenceId: string
Maximum Length:
50
The global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentStatus: string
Maximum Length:
1
The status of the payment request. Valid values are paid, cancelled, or error. -
PostalCode: string
Maximum Length:
60
The postal code in the permit address. -
PostalPlus4Code: string
Maximum Length:
20
The extended postal code in the permit address. -
Province: string
Maximum Length:
60
The province in the permit address. -
RecordId: string
Maximum Length:
50
The source application's record identifier. -
RecordTypeId: string
Maximum Length:
30
The source application's record identifier. -
State: string
Maximum Length:
60
The state in the permit address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.