Jump to

• Request
• Response

Get a set of payment checkout data

get

/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}

Request

Path Parameters

• CheckoutId(required): string
  The unique identifier for the checkout data. Generated using the Fusion unique ID API.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

• AccountPurpose: string
  Maximum Length: 30

  The account purpose associated with the payment.
• AccountType: string
  Maximum Length: 30

  The account type associated with the payment.
• ActivityType: string
  Maximum Length: 30

  Default Value: ORA_FEE

  The activity type.
• Address1: string
  Maximum Length: 240

  The first line of the payer billing address. Requires a valid street number and name.
• Address2: string
  Maximum Length: 240

  The second line of the payer billing address such as apartment, suite, unit, building, floor, or village information.
• Address3: string
  Maximum Length: 240

  The third line of the payer billing address.
• Address4: string
  Maximum Length: 240

  The fourth line of the payer billing address.
• AgencyId: integer (int32)
  The unique identifier for the agency associated with the row.
• Amount: number
  The sum of all money required for payment.
• ApplicationReferenceId: string
  Maximum Length: 50

  Information to cross-reference key field values back to the source application or module data.
• AutopayMethod: string
  Maximum Length: 30

  The auto pay method.
• BusinessEntityDbaName: string
  Maximum Length: 100

  Doing business as the name of the business making the payment.
• BusinessEntityId: string
  Maximum Length: 50

  The unique identifier for the business entity associated with this transaction.
• BusinessEntityName: string
  Maximum Length: 100

  The entity name of the business making the payment.
• BusinessEntityPartyId: integer (int64)
  The unique identifier for the business entity party associated with this transaction.
• BusinessLocationId: string
  Maximum Length: 50

  The unique identifier for the location of the business entity.
• BusinessLocationPartyId: integer (int64)
  The unique identifier for the party associated with the business entity location.
• BusinessProfileId: integer (int64)
  The unique identifier for the profile of the business entity associated with this transaction.
• CallbackURL: string
  Maximum Length: 255

  The callback URL used to post payload response data to the consuming application.
• CancelURLCheckout: string
  Maximum Length: 255

  The URL provided by the consuming application. The user is redirected to this URL when the payment is canceled.
• CancelURLPayment: string
  Maximum Length: 255

  The URL used by the payment gateway to redirect after a payment is canceled or not completed. Oracle internal use only.
• CheckoutId: string
  Maximum Length: 18

  The unique identifier for the checkout data. Generated using the Fusion unique ID API.
• CheckoutLin: array Checkout Lines
  Title: Checkout Lines

  The checkout lines resource is used to view, create, delete, or update checkout lines.
• CheckoutMessage: string
  Maximum Length: 255

  Additional information regarding the status of the checkout transaction.
• CheckoutPmt: array Checkout Payments
  Title: Checkout Payments

  The checkout lines resource is used to view, create, delete, or update checkout payments.
• CheckoutStatus: string
  Maximum Length: 1

  The current status of the checkout transaction. Valid values are paid, canceled, or error.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• CreditAmountApplied: number
  Default Value: 0

  The amount of the credit applied to the payment.
• CreditAmountAvailable: number
  Default Value: 0

  The amount available to apply the payment on account credit.
• CreditAppliedFlag: string
  Maximum Length: 1

  Default Value: N

  The payment on account credit is applied.
• CurrencyCode: string
  Maximum Length: 3

  The currency code for the amount field.
• Description: string
  Maximum Length: 100

  The description of the checkout transaction.
• 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.
• PartyId: integer (int64)
  The unique identifier for the party associated with this transaction.
• PayerCity: string
  Maximum Length: 60

  The city of the payer billing address.
• PayerCountryThreeCharacterCode: string
  Maximum Length: 3

  International three-digit country code call prefix of the payer's phone number.
• PayerCountryTwoCharacterCode: string
  Maximum Length: 2

  International two-digit country code call prefix of the payer's phone number.
• PayerCounty: string
  Maximum Length: 60

  The county of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities.
• PayerEmail: string
  Maximum Length: 320

  The email address of the person making the payment.
• PayerFirstName: string
  Maximum Length: 150

  The first name of the person making the payment.
• PayerLastName: string
  Maximum Length: 150

  The last name of the person making the payment.
• PayerMiddleName: string
  Maximum Length: 60

  The middle name of the person making the payment.
• PayerNameSuffix: string
  Maximum Length: 30

  The suffix of the name of the person making the payment.
• PayerPhone: string
  Maximum Length: 60

  The phone number of the person making the payment.
• PayerPostalAddOnCode: string
  Maximum Length: 10

  Additional digits used to identify a specific mail delivery route.
• PayerPostalCode: string
  Maximum Length: 60

  Postal code of the payer billing address. Can be a series of digits or letters or both.
• PayerProvince: string
  Maximum Length: 60

  Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post.
• PayerState: string
  Maximum Length: 60

  State code of the payer billing address. In the US, this is the two character USPS state abbreviation. For example, NY for New York.
• PaymentTrackingData: string
  Maximum Length: 50

  First checkout reference or tracking number passed by the consuming application.
• PaymentTrackingDataPlus: string
  Maximum Length: 50

  Second checkout reference or tracking number passed by the consuming application.
• ProfileId: integer (int64)
  The unique identifier for the profile of the user associated with this transaction.
• ReconcileDatetime: string (date-time)
  The date and time of the payment reconciliation.
• ReconcileStatus: string
  Maximum Length: 30

  The payment reconciliation status.
• ReconcileType: string
  Maximum Length: 30

  Indicates whether the payment was reconciled through an online API or by the ESS job.
• ReturnURLCheckout: string
  Maximum Length: 255

  The URL provided by the consuming application. The user is redirected to this URL after the payment is complete.
• ReturnURLPayment: string
  Maximum Length: 255

  The URL used by the payment gateway to redirect after a successful payment. Oracle internal use only.
• ReversalTransactionType: string
  Maximum Length: 30

  Default Value: ORA_NONE

  Indicates the type of the reversal transaction.
• TrustAccountNumber: string
  Maximum Length: 30

  The deposit account number associated with the payment.
• UnappliedFlag: string
  Maximum Length: 1

  Default Value: N

  Identifies an unapplied payment record.

{
    "type":"object",
    "properties":{
        "ReturnURLPayment":{
            "maxLength":255,
            "type":"string",
            "description":"The URL used by the payment gateway to redirect after a successful payment. Oracle internal use only.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile of the user associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditAmountAvailable":{
            "type":"number",
            "description":"The amount available to apply the payment on account credit.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile of the business entity associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayerCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the payer billing address.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelURLPayment":{
            "maxLength":255,
            "type":"string",
            "description":"The URL used by the payment gateway to redirect after a payment is canceled or not completed. Oracle internal use only.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutMessage":{
            "maxLength":255,
            "type":"string",
            "description":"Additional information regarding the status of the checkout transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CallbackURL":{
            "maxLength":255,
            "type":"string",
            "description":"The callback URL used to post payload response data to the consuming application.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code for the amount field.",
            "nullable":false,
            "x-queryable":true
        },
        "PayerFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AutopayMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The auto pay method.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApplicationReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"Information to cross-reference key field values back to the source application or module data.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentTrackingData":{
            "maxLength":50,
            "type":"string",
            "description":"First checkout reference or tracking number passed by the consuming application.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerState":{
            "maxLength":60,
            "type":"string",
            "description":"State code of the payer billing address. In the US, this is the two character USPS state abbreviation. For example, NY for New York.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessLocationPartyId":{
            "type":"integer",
            "description":"The unique identifier for the party associated with the business entity location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayerLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the location of the business entity.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessEntityName":{
            "maxLength":100,
            "type":"string",
            "description":"The entity name of the business making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPurpose":{
            "maxLength":30,
            "type":"string",
            "description":"The account purpose associated with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalTransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of the reversal transaction.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-queryable":true
        },
        "CheckoutPmt":{
            "title":"Checkout Payments",
            "type":"array",
            "description":"The checkout lines resource is used to view, create, delete, or update checkout payments.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCheckouts-CheckoutPmt-item-response"
            }
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business entity associated with this transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the checkout transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for the agency associated with the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "PayerPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the payer billing address. Can be a series of digits or letters or both.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerCountryTwoCharacterCode":{
            "maxLength":2,
            "type":"string",
            "description":"International two-digit country code call prefix of the payer's phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "UnappliedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies an unapplied payment record.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "PayerCountryThreeCharacterCode":{
            "maxLength":3,
            "type":"string",
            "description":"International three-digit country code call prefix of the payer's phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerEmail":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the person making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnURLCheckout":{
            "maxLength":255,
            "type":"string",
            "description":"The URL provided by the consuming application. The user is redirected to this URL after the payment is complete.",
            "nullable":true,
            "x-queryable":true
        },
        "ReconcileType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the payment was reconciled through an online API or by the ESS job.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post.",
            "nullable":true,
            "x-queryable":true
        },
        "ReconcileDatetime":{
            "type":"string",
            "description":"The date and time of the payment reconciliation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PayerMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the payer billing address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditAppliedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The payment on account credit is applied.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CheckoutLin":{
            "title":"Checkout Lines",
            "type":"array",
            "description":"The checkout lines resource is used to view, create, delete, or update checkout lines.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCheckouts-CheckoutLin-item-response"
            }
        },
        "BusinessEntityDbaName":{
            "maxLength":100,
            "type":"string",
            "description":"Doing business as the name of the business making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditAmountApplied":{
            "type":"number",
            "description":"The amount of the credit applied to the payment.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "CheckoutStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The current status of the checkout transaction. Valid values are paid, canceled, or error.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerPostalAddOnCode":{
            "maxLength":10,
            "type":"string",
            "description":"Additional digits used to identify a specific mail delivery route.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTrackingDataPlus":{
            "maxLength":50,
            "type":"string",
            "description":"Second checkout reference or tracking number passed by the consuming application.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"The sum of all money required for payment.",
            "nullable":false,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the payer billing address such as apartment, suite, unit, building, floor, or village information.",
            "nullable":true,
            "x-queryable":true
        },
        "TrustAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The deposit account number associated with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityType":{
            "maxLength":30,
            "type":"string",
            "description":"The activity type.",
            "nullable":true,
            "default":"ORA_FEE",
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the payer billing address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the payer billing address. Requires a valid street number and name.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The suffix of the name of the person making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountType":{
            "maxLength":30,
            "type":"string",
            "description":"The account type associated with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutId":{
            "maxLength":18,
            "type":"string",
            "description":"The unique identifier for the checkout data. Generated using the Fusion unique ID API.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BusinessEntityPartyId":{
            "type":"integer",
            "description":"The unique identifier for the business entity party associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the party associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayerCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerPhone":{
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the person making the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelURLCheckout":{
            "maxLength":255,
            "type":"string",
            "description":"The URL provided by the consuming application. The user is redirected to this URL when the payment is canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "ReconcileStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The payment reconciliation status.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Checkout Lines

Type: array

Title: Checkout Lines

The checkout lines resource is used to view, create, delete, or update checkout lines.

Show Source

• Array of: object publicSectorCheckouts-CheckoutLin-item-response

{
    "title":"Checkout Lines",
    "type":"array",
    "description":"The checkout lines resource is used to view, create, delete, or update checkout lines.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCheckouts-CheckoutLin-item-response"
    }
}

Nested Schema : Checkout Payments

Type: array

Title: Checkout Payments

The checkout lines resource is used to view, create, delete, or update checkout payments.

Show Source

• Array of: object publicSectorCheckouts-CheckoutPmt-item-response

{
    "title":"Checkout Payments",
    "type":"array",
    "description":"The checkout lines resource is used to view, create, delete, or update checkout payments.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCheckouts-CheckoutPmt-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 : publicSectorCheckouts-CheckoutLin-item-response

Type: object

Show Source

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

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

Nested Schema : publicSectorCheckouts-CheckoutPmt-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Identifies the identifier associated with an agency.
• AuthorizationCode: string
  Maximum Length: 10

  Authorization code value returned by the payment gateway or trust account system.
• AuthorizationDttm: string (date-time)
  Title: Authorization Date and Time

  Authorization date and time returned by payment gateway system or trust account system.
• AuthorizationStatus: string
  Maximum Length: 4

  The status value returned by the payment gateway or trust account system.
• CashierId: string
  Title: Cashier ID

  Maximum Length: 50

  The unique identifier for the cashier.
• ChangeAmount: number
  Title: Change Due

  The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.
• CheckAddress: string
  Maximum Length: 240

  The address on the check.
• CheckDate: string (date)
  Title: Check Date

  The date that the check was received from the payer.
• CheckName: string
  Maximum Length: 100

  The name on the check.
• CheckNumber: string
  Title: Check Number

  Maximum Length: 10

  The number of the check that was received from the payer.
• CheckoutId: string
  Maximum Length: 50

  Unique identifier for the checkout data. Generated using the Fusion unique ID API.
• CheckoutPmtId: integer (int64)
  Unique sequence number for the checkout payment row generated using the Fusion unique ID API.
• Comments: string
  Title: Comments

  Maximum Length: 240

  Comments provided for the payment.
• Description: string
  Title: Description

  Maximum Length: 100

  Description provided for the payment.
• DrawerId: string
  Title: Cash Drawer ID

  Maximum Length: 30

  The unique identifier for the cash drawer.
• FirstResponseMessage: string
  Title: Primary Response Message

  Maximum Length: 100

  First part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.
• LineAmount: number
  Title: Amount

  That dollar amount that applies to a line item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayerAddress: string
  Title: Payer Address

  Maximum Length: 240

  The address of the person who made the payment.
• PayerName: string
  Title: Payer Name

  Maximum Length: 100

  The name of the person who made the payment.
• PaymentCurrency: string
  Title: Currency

  Maximum Length: 3

  Currency used for the payment transaction.
• PaymentDate: string (date)
  Title: Payment Date

  Date on which the payment transaction occurred.
• PaymentMethodCode: string
  Title: Payment Method Code

  Maximum Length: 30

  Type of payment selected during checkout.
• PaymentReferenceId: string
  Title: Payment Reference ID

  Maximum Length: 50

  Global unique payment identifier that comprises a 4-character prefix and random digits.
• PaymentTrackingData: string
  Title: Primary Payment Tracking Data

  Maximum Length: 50

  The identifying attribute passed during checkout by the originator of the assessed fees.
• PaymentTrackingDataPlus: string
  Title: Secondary Payment Tracking Data

  Maximum Length: 50

  The additional identifying attribute passed during checkout by the originator of the assessed fees.
• PaymentTransactionId: string
  Title: Payment Transaction ID

  Maximum Length: 50

  Transaction ID/reference number received from the payment gateway or trust account system.
• PrimaryId: string
  Title: Primary ID

  Maximum Length: 3

  The unique identifier for the primary document used to identify the payer of a cash drawer check payment.
• SecondaryId: string
  Title: Secondary ID

  Maximum Length: 3

  The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.
• SecondResponseMessage: string
  Title: Secondary Response Message

  Maximum Length: 100

  Second part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.
• SessionId: string
  Title: Session ID

  Maximum Length: 50

  The unique identifier for the cashier session.
• ThirdResponseMessage: string
  Title: Additional Response Message

  Maximum Length: 100

  Third part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.
• TotalTendAmount: number
  Title: Amount Tendered

  The total amount of money received in payment from the payer. If this amount is more than the amount due, the difference is handed back to the payer.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "title":"Payment Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"Transaction ID/reference number received from the payment gateway or trust account system.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"Description provided for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies the identifier associated with an agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AuthorizationDttm":{
            "title":"Authorization Date and Time",
            "type":"string",
            "description":"Authorization date and time returned by payment gateway system or trust account system.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CashierId":{
            "title":"Cashier ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerAddress":{
            "title":"Payer Address",
            "maxLength":240,
            "type":"string",
            "description":"The address of the person who made the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondResponseMessage":{
            "title":"Secondary Response Message",
            "maxLength":100,
            "type":"string",
            "description":"Second part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentCurrency":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"Currency used for the payment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"Global unique payment identifier that comprises a 4-character prefix and random digits.",
            "nullable":false,
            "x-queryable":true
        },
        "AuthorizationStatus":{
            "maxLength":4,
            "type":"string",
            "description":"The status value returned by the payment gateway or trust account system.",
            "nullable":false,
            "x-queryable":true
        },
        "DrawerId":{
            "title":"Cash Drawer ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutPmtId":{
            "type":"integer",
            "description":"Unique sequence number for the checkout payment row generated using the Fusion unique ID API.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SecondaryId":{
            "title":"Secondary ID",
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalTendAmount":{
            "title":"Amount Tendered",
            "type":"number",
            "description":"The total amount of money received in payment from the payer. If this amount is more than the amount due, the difference is handed back to the payer.",
            "nullable":false,
            "x-queryable":true
        },
        "LineAmount":{
            "title":"Amount",
            "type":"number",
            "description":"That dollar amount that applies to a line item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CheckDate":{
            "title":"Check Date",
            "type":"string",
            "description":"The date that the check was received from the payer.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FirstResponseMessage":{
            "title":"Primary Response Message",
            "maxLength":100,
            "type":"string",
            "description":"First part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.",
            "nullable":true,
            "x-queryable":true
        },
        "SessionId":{
            "title":"Session ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationCode":{
            "maxLength":10,
            "type":"string",
            "description":"Authorization code value returned by the payment gateway or trust account system.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckName":{
            "maxLength":100,
            "type":"string",
            "description":"The name on the check.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"Date on which the payment transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTrackingDataPlus":{
            "title":"Secondary Payment Tracking Data",
            "maxLength":50,
            "type":"string",
            "description":"The additional identifying attribute passed during checkout by the originator of the assessed fees.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments provided for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTrackingData":{
            "title":"Primary Payment Tracking Data",
            "maxLength":50,
            "type":"string",
            "description":"The identifying attribute passed during checkout by the originator of the assessed fees.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The address on the check.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerName":{
            "title":"Payer Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the person who made the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdResponseMessage":{
            "title":"Additional Response Message",
            "maxLength":100,
            "type":"string",
            "description":"Third part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckNumber":{
            "title":"Check Number",
            "maxLength":10,
            "type":"string",
            "description":"The number of the check that was received from the payer.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method Code",
            "maxLength":30,
            "type":"string",
            "description":"Type of payment selected during checkout.",
            "nullable":false,
            "x-queryable":true
        },
        "CheckoutId":{
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier for the checkout data. Generated using the Fusion unique ID API.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeAmount":{
            "title":"Change Due",
            "type":"number",
            "description":"The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryId":{
            "title":"Primary ID",
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the primary document used to identify the payer of a cash drawer check payment.",
            "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"
    }
}

Links

CheckoutLin

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin

Parameters:

• CheckoutId: $request.path.CheckoutId

The checkout lines resource is used to view, create, delete, or update checkout lines.

CheckoutPmt

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt

Parameters:

• CheckoutId: $request.path.CheckoutId

The checkout lines resource is used to view, create, delete, or update checkout payments.

Back to Top