Jump to

• Request
• Response

Get a receivable receipt record

get

/fscmRestApi/resources/11.13.18.05/publicSectorReceivableReceipts/{ReceiptHistoryKey}

Request

Path Parameters

• ReceiptHistoryKey: integer
  Unique identifier for the transaction.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorReceivableReceipts-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Fhe agency ID associated with the record.
• InvoiceSystem(optional): string
  Maximum Length: 15

  The code of the ERP receivable application.
• InvoiceSystemDescr(optional): string
  Maximum Length: 80

  The description of of ERP receivable application.
• ItemRecKey(optional): integer(int32)
  The payment history line key for a payment history record.
• links(optional): array Items
  Title: Items

  Link Relations
• PaymentHistoryKey(optional): integer(int64)
  The payment history key for a payment history record.
• PaymentMethodCode(optional): string
  Maximum Length: 30

  The payment method code.
• PaymentMethodDescr(optional): string
  Maximum Length: 80

  The payment method code description.
• PaymentReferenceId(optional): string
  Maximum Length: 50

  The global unique ID for a payment.
• ReceiptAmount(optional): number
  Title: Receivable Receipt Amount

  The monetary amount of the receipt.
• ReceiptCurrency(optional): string
  Title: Receivable Receipt Currency

  Maximum Length: 3

  The currency of the receipt amount.
• ReceiptDate(optional): string(date)
  The date that the receipt was created.
• ReceiptHistoryKey(optional): integer(int64)
  Unique identifier for the transaction.
• ReceiptId(optional): string
  Title: Receivable Receipt ID

  Maximum Length: 100

  The identifier of the receipt in ERP Receivables.
• ReceiptNumber(optional): string
  Maximum Length: 50

  The receipt number assigned by the application.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"Fhe agency ID associated with the record."
        },
        "InvoiceSystem":{
            "maxLength":15,
            "type":"string",
            "description":"The code of the ERP receivable application."
        },
        "InvoiceSystemDescr":{
            "maxLength":80,
            "type":"string",
            "description":"The description of of ERP receivable application."
        },
        "ItemRecKey":{
            "format":"int32",
            "type":"integer",
            "description":"The payment history line key for a payment history record."
        },
        "PaymentHistoryKey":{
            "format":"int64",
            "type":"integer",
            "description":"The payment history key for a payment history record."
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The payment method code."
        },
        "PaymentMethodDescr":{
            "maxLength":80,
            "type":"string",
            "description":"The payment method code description."
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The global unique ID for a payment."
        },
        "ReceiptAmount":{
            "type":"number",
            "description":"The monetary amount of the receipt.",
            "title":"Receivable Receipt Amount"
        },
        "ReceiptCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"The currency of the receipt amount.",
            "title":"Receivable Receipt Currency"
        },
        "ReceiptDate":{
            "format":"date",
            "type":"string",
            "description":"The date that the receipt was created."
        },
        "ReceiptHistoryKey":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier for the transaction."
        },
        "ReceiptId":{
            "maxLength":100,
            "type":"string",
            "description":"The identifier of the receipt in ERP Receivables.",
            "title":"Receivable Receipt ID"
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The receipt number assigned by the application."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top