Jump to

• Request
• Response

Get all checkout payments

get

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

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
• finder: string
  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:
  
  

  • PrimaryKey: FRD s
    Finder Variables:
    • CheckoutId; string; Unique identifier for the checkout payment data generated using the Fusion unique ID API.
    • CheckoutPmtId; integer; Unique sequence number for the checkout payment row generated using the Fusion unique ID API.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • AgencyId; integer; Identifies the identifier associated with an agency.
  • AuthorizationCode; string; Authorization code value returned by the payment gateway or trust account system.
  • AuthorizationDttm; string; Authorization date and time returned by payment gateway system or trust account system.
  • AuthorizationStatus; string; The status value returned by the payment gateway or trust account system.
  • CashierId; string; The unique identifier for the cashier.
  • ChangeAmount; number; 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; The address on the check.
  • CheckDate; string; The date that the check was received from the payer.
  • CheckName; string; The name on the check.
  • CheckNumber; string; The number of the check that was received from the payer.
  • CheckoutId; string; Unique identifier for the checkout data. Generated using the Fusion unique ID API.
  • CheckoutPmtId; integer; Unique sequence number for the checkout payment row generated using the Fusion unique ID API.
  • Comments; string; Comments provided for the payment.
  • Description; string; Description provided for the payment.
  • DrawerId; string; The unique identifier for the cash drawer.
  • FirstResponseMessage; string; 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; That dollar amount that applies to a line item.
  • PayerAddress; string; The address of the person who made the payment.
  • PayerName; string; The name of the person who made the payment.
  • PaymentCurrency; string; Currency used for the payment transaction.
  • PaymentDate; string; Date on which the payment transaction occurred.
  • PaymentMethodCode; string; Type of payment selected during checkout.
  • PaymentReferenceId; string; Global unique payment identifier that comprises a 4-character prefix and random digits.
  • PaymentTrackingData; string; The identifying attribute passed during checkout by the originator of the assessed fees.
  • PaymentTrackingDataPlus; string; The additional identifying attribute passed during checkout by the originator of the assessed fees.
  • PaymentTransactionId; string; Transaction ID/reference number received from the payment gateway or trust account system.
  • PrimaryId; string; The unique identifier for the primary document used to identify the payer of a cash drawer check payment.
  • SecondResponseMessage; string; 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.
  • SecondaryId; string; The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.
  • SessionId; string; The unique identifier for the cashier session.
  • ThirdResponseMessage; string; 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; 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.
• totalResults: boolean
  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

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCheckouts-CheckoutPmt-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "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-CheckoutPmt-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  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)
  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
  Maximum Length: 50

  The unique identifier for the cashier.
• ChangeAmount: number
  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)
  The date that the check was received from the payer.
• CheckName: string
  Maximum Length: 100

  The name on the check.
• CheckNumber: string
  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
  Maximum Length: 240

  Comments provided for the payment.
• Description: string
  Maximum Length: 100

  Description provided for the payment.
• DrawerId: string
  Maximum Length: 30

  The unique identifier for the cash drawer.
• FirstResponseMessage: string
  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
  That dollar amount that applies to a line item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayerAddress: string
  Maximum Length: 240

  The address of the person who made the payment.
• PayerName: string
  Maximum Length: 100

  The name of the person who made the payment.
• PaymentCurrency: string
  Maximum Length: 3

  Currency used for the payment transaction.
• PaymentDate: string (date)
  Date on which the payment transaction occurred.
• PaymentMethodCode: string
  Maximum Length: 30

  Type of payment selected during checkout.
• PaymentReferenceId: string
  Maximum Length: 50

  Global unique payment identifier that comprises a 4-character prefix and random digits.
• PaymentTrackingData: string
  Maximum Length: 50

  The identifying attribute passed during checkout by the originator of the assessed fees.
• PaymentTrackingDataPlus: string
  Maximum Length: 50

  The additional identifying attribute passed during checkout by the originator of the assessed fees.
• PaymentTransactionId: string
  Maximum Length: 50

  Transaction ID/reference number received from the payment gateway or trust account system.
• PrimaryId: string
  Maximum Length: 3

  The unique identifier for the primary document used to identify the payer of a cash drawer check payment.
• SecondaryId: string
  Maximum Length: 3

  The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.
• SecondResponseMessage: string
  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
  Maximum Length: 50

  The unique identifier for the cashier session.
• ThirdResponseMessage: string
  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
  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":{
            "maxLength":"50",
            "type":"string",
            "description":"Transaction ID/reference number received from the payment gateway or trust account system.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"Description provided for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifies the identifier associated with an agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AuthorizationDttm":{
            "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":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the cashier.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerAddress":{
            "maxLength":"240",
            "type":"string",
            "description":"The address of the person who made the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondResponseMessage":{
            "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":{
            "maxLength":"3",
            "type":"string",
            "description":"Currency used for the payment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "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":{
            "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":{
            "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":{
            "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":{
            "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":{
            "type":"string",
            "description":"The date that the check was received from the payer.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FirstResponseMessage":{
            "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":{
            "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":{
            "type":"string",
            "description":"Date on which the payment transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTrackingDataPlus":{
            "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":{
            "maxLength":"240",
            "type":"string",
            "description":"Comments provided for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTrackingData":{
            "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":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the person who made the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdResponseMessage":{
            "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":{
            "maxLength":"10",
            "type":"string",
            "description":"The number of the check that was received from the payer.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "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":{
            "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":{
            "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"
    }
}

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."
        }
    }
}

Back to Top