1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Billing and Payment
  4. Checkouts
  5. Checkout Lines

Get all payment checkout lines

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • FeeReferencePUIDKey: Finds the checkout data that matches the PUID key.
      Finder Variables:
      • FeeReferencePuid; string; The PUID key for an item in the checkout line.
    • PrimaryKey: Finds the checkout line data that matches the primary key criteria specified.
      Finder Variables:
      • CheckoutId; string; Unique identifier for the checkout data generated using the Fusion unique ID API.
      • CheckoutLineId; integer; Unique sequence number for the checkout row generated using the Fusion unique ID API.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AdapterId; string; The unique identifier of the payment adapter associated with the agency and payment method.
    • Address1; string; The first line of the permit address.
    • Address2; string; The second line of the permit address, if present.
    • Address3; string; The third line of the permit address, if present.
    • Address4; string; The fourth line of the permit address, if present.
    • AgencyId; integer; The unique identifier of the agency associated with the row.
    • ApplicationReferenceId; string; The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart.
    • ApplicationReferenceIdPlus; string; Additional key identifier passed by the consuming application.
    • BillAgencyId; integer; The unique identifier of the agency associated with the invoice.
    • BillType; string; Determines the default invoice values for invoice form and invoice number ID.
    • BusBusinessLegalName; string; The legal name of a business.
    • BusBusinessName; string; The name of a business.
    • BusDbaBusinessName; string; The doing business as name of a business.
    • BusPartyId; integer; The party identifier of a business.
    • BusinessEntityId; string; The unique identifier of a business.
    • BusinessLocationId; string; The unique identifier of a business location.
    • BusinessLocationPartyId; integer; The party identifier of a business location.
    • CaseId; string; The case identifier for a code enforcement fee.
    • CheckoutId; string; The unique identifier for the checkout data. Generated using the Fusion unique ID API.
    • CheckoutLineId; integer; The unique sequence number for the checkout row generated using the Fusion unique ID API.
    • City; string; The city in the permit address.
    • Classification; string; The source application that generated the fee.
    • Country; string; The country in the permit address.
    • County; string; The county in the permit address.
    • CreationDate; string; The date and time when the row was created.
    • CurrencyCode; string; The currency code in relation to the item unit price and tax amount.
    • Department; string; A division within the agency devoted to a specific function.
    • FeeItemId; string; The unique identifier for the fee item.
    • FeeReferenceId; string; The reference identifier for the fee item.
    • FeeReferencePuid; string; The PUID reference identifier for the fee item.
    • Invoice; string; The unique billing identifier.
    • ItemDescription; string; Relevant details related to the line item.
    • ItemId; string; The unique identifier of the item to be paid.
    • ItemQuantity; integer; Quantity of line items. This value cannot be negative.
    • ItemTaxAmount; number; 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; The date and time when the row was last updated.
    • OrganizationName; string; The name of an organization.
    • PaymentDate; string; The date when the checkout was initiated.
    • PaymentHistoryKey; integer; The unique payment history value generated using the Fusion unique ID API.
    • PaymentMethodCode; string; The type of payment selected during checkout.
    • PaymentReferenceId; string; The global unique payment identifier that comprises a 4-character prefix and random digits.
    • PaymentStatus; string; The status of the payment request. Valid values are paid, cancelled, or error.
    • PostalCode; string; The postal code in the permit address.
    • PostalPlus4Code; string; The extended postal code in the permit address.
    • Province; string; The province in the permit address.
    • RecordId; string; The source application's record identifier.
    • RecordTypeId; string; The source application's record identifier.
    • State; string; The state in the permit address.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-CheckoutLin
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorCheckouts-CheckoutLin-item-response
Type: object
Show Source
Back to Top