Jump to

• Request
• Response

Create a student financial transaction

post

/fscmRestApi/resources/11.13.18.05/studentFinancialTransactions

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountType: string
  The account type of the bank account associated with the financial transaction.
• Amount: number
  The line amount of the financial transaction.
• BankAccountNumber: string
  The bank account number associated to the financial transaction.
• BranchNumber: string
  The branch number of the bank associated to the financial transaction.
• BusinessUnitId: integer (int64)
  Unique identifier of the business unit associated to the financial transaction.
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated to the financial transaction.
• CustomerAccountId: integer (int64)
  Unique identifier of the customer account associated to the financial transaction.
• CustomerAccountSiteUseId: integer (int64)
  Unique identifier of the bill to site of the customer account associated to the financial transaction.
• ExternalTrxReference: string
  Maximum Length: 100

  The external transaction reference provided by the third party while posting a transaction.
• FinancialTransactionId: integer (int64)
  The unique identifier of the financial transaction.
• OrderId: string
  Maximum Length: 80

  The payment order number associated to the financial transaction.
• PaymentInstrumentUseId: integer (int64)
  Unique identifier of the payment instrument associated to the financial transaction.
• ReceiptDate: string (date)
  The receipt date associated to the financial transaction.
• ReceiptId: integer (int64)
  Unique identifier of the receipt generated in accounts receivable when the financial transaction is posted.
• ReceiptMethodId: integer (int64)
  Unique identifier of the receipt method associated to the financial transaction.
• ReceiptNumber: string
  Maximum Length: 30

  The receipt number associated to the financial transaction.
• ReceiptPostingStatus: string
  Maximum Length: 30

  Default Value: PENDING

  The posting status of the receipt associated with the financial transaction.
• ReceiptTransactionId: integer (int64)
  The unique identifier of the receipt transaction.
• ReferenceKey: string
  The reference key associated with third party transaction.
• RelatedPartyId: integer
  Unique identifier of the learner for whom the receipt is applied.
• Status: string
  Maximum Length: 30

  Default Value: REQUESTED

  The status of the financial transaction.
• SubmitDate: string (date)
  The date of submission of the financial transaction.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the financial transaction.",
            "nullable":false,
            "default":"REQUESTED"
        },
        "ReferenceKey":{
            "type":"string",
            "description":"The reference key associated with third party transaction.",
            "nullable":true
        },
        "SubmitDate":{
            "type":"string",
            "description":"The date of submission of the financial transaction.",
            "format":"date",
            "nullable":false
        },
        "ReceiptTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the receipt transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit associated to the financial transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Amount":{
            "type":"number",
            "description":"The line amount of the financial transaction.",
            "nullable":true
        },
        "OrderId":{
            "maxLength":"80",
            "type":"string",
            "description":"The payment order number associated to the financial transaction.",
            "nullable":true
        },
        "AccountType":{
            "type":"string",
            "description":"The account type of the bank account associated with the financial transaction.",
            "nullable":true
        },
        "ReceiptPostingStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The posting status of the receipt associated with the financial transaction.",
            "nullable":false,
            "default":"PENDING"
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated to the financial transaction.",
            "nullable":false
        },
        "RelatedPartyId":{
            "type":"integer",
            "description":"Unique identifier of the learner for whom the receipt is applied.",
            "nullable":true
        },
        "BranchNumber":{
            "type":"string",
            "description":"The branch number of the bank associated to the financial transaction.",
            "nullable":true
        },
        "ReceiptId":{
            "type":"integer",
            "description":"Unique identifier of the receipt generated in accounts receivable when the financial transaction is posted.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "FinancialTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the financial transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Unique identifier of the customer account associated to the financial transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExternalTrxReference":{
            "maxLength":"100",
            "type":"string",
            "description":"The external transaction reference provided by the third party while posting a transaction.",
            "nullable":true
        },
        "CustomerAccountSiteUseId":{
            "type":"integer",
            "description":"Unique identifier of the bill to site of the customer account associated to the financial transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReceiptMethodId":{
            "type":"integer",
            "description":"Unique identifier of the receipt method associated to the financial transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PaymentInstrumentUseId":{
            "type":"integer",
            "description":"Unique identifier of the payment instrument associated to the financial transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReceiptDate":{
            "type":"string",
            "description":"The receipt date associated to the financial transaction.",
            "format":"date",
            "nullable":false
        },
        "BankAccountNumber":{
            "type":"string",
            "description":"The bank account number associated to the financial transaction.",
            "nullable":true
        },
        "ReceiptNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The receipt number associated to the financial transaction.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AccountType: string
  The account type of the bank account associated with the financial transaction.
• Amount: number
  The line amount of the financial transaction.
• BankAccountNumber: string
  The bank account number associated to the financial transaction.
• BranchNumber: string
  The branch number of the bank associated to the financial transaction.
• BusinessUnitId: integer (int64)
  Unique identifier of the business unit associated to the financial transaction.
• CreationDate: string (date-time)
  Read Only: true

  The date of creation of the financial transaction.
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated to the financial transaction.
• CustomerAccountId: integer (int64)
  Unique identifier of the customer account associated to the financial transaction.
• CustomerAccountSiteUseId: integer (int64)
  Unique identifier of the bill to site of the customer account associated to the financial transaction.
• ExternalTrxReference: string
  Maximum Length: 100

  The external transaction reference provided by the third party while posting a transaction.
• FinancialTransactionId: integer (int64)
  The unique identifier of the financial transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderId: string
  Maximum Length: 80

  The payment order number associated to the financial transaction.
• PaymentInstrumentUseId: integer (int64)
  Unique identifier of the payment instrument associated to the financial transaction.
• ReceiptDate: string (date)
  The receipt date associated to the financial transaction.
• ReceiptId: integer (int64)
  Unique identifier of the receipt generated in accounts receivable when the financial transaction is posted.
• ReceiptMethodId: integer (int64)
  Unique identifier of the receipt method associated to the financial transaction.
• ReceiptNumber: string
  Maximum Length: 30

  The receipt number associated to the financial transaction.
• ReceiptPostingStatus: string
  Maximum Length: 30

  Default Value: PENDING

  The posting status of the receipt associated with the financial transaction.
• ReceiptTransactionId: integer (int64)
  The unique identifier of the receipt transaction.
• ReferenceKey: string
  The reference key associated with third party transaction.
• RelatedPartyId: integer
  Unique identifier of the learner for whom the receipt is applied.
• Status: string
  Maximum Length: 30

  Default Value: REQUESTED

  The status of the financial transaction.
• SubmitDate: string (date)
  The date of submission of the financial transaction.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the financial transaction.",
            "nullable":false,
            "default":"REQUESTED",
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the financial transaction.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceKey":{
            "type":"string",
            "description":"The reference key associated with third party transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "type":"string",
            "description":"The date of submission of the financial transaction.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the receipt transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit associated to the financial transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"The line amount of the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderId":{
            "maxLength":"80",
            "type":"string",
            "description":"The payment order number associated to the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountType":{
            "type":"string",
            "description":"The account type of the bank account associated with the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptPostingStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The posting status of the receipt associated with the financial transaction.",
            "nullable":false,
            "default":"PENDING",
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated to the financial transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "RelatedPartyId":{
            "type":"integer",
            "description":"Unique identifier of the learner for whom the receipt is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "BranchNumber":{
            "type":"string",
            "description":"The branch number of the bank associated to the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptId":{
            "type":"integer",
            "description":"Unique identifier of the receipt generated in accounts receivable when the financial transaction is posted.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinancialTransactionId":{
            "type":"integer",
            "description":"The unique identifier of the financial transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Unique identifier of the customer account associated to the financial transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalTrxReference":{
            "maxLength":"100",
            "type":"string",
            "description":"The external transaction reference provided by the third party while posting a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerAccountSiteUseId":{
            "type":"integer",
            "description":"Unique identifier of the bill to site of the customer account associated to the financial transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceiptMethodId":{
            "type":"integer",
            "description":"Unique identifier of the receipt method associated to the financial transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentInstrumentUseId":{
            "type":"integer",
            "description":"Unique identifier of the payment instrument associated to the financial transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceiptDate":{
            "type":"string",
            "description":"The receipt date associated to the financial transaction.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "BankAccountNumber":{
            "type":"string",
            "description":"The bank account number associated to the financial transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The receipt number associated to the financial transaction.",
            "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