Jump to

• Request
• Response
• Examples

Get an IPAC transaction record

get

/fscmRestApi/resources/11.13.18.05/fedIPACTransactionData/{TransactionDataId}

Request

Path Parameters

• TransactionDataId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

Type: object

Show Source

• AccomplishedDate: string (date)
  Title: Accomplished Date

  The date on which the transaction occurred.
• Accounted: string
  Title: Accounted Flag

  Read Only: true

  Maximum Length: 255

  Value that identifies whether the transaction is accounted.
• AccountingClassificationCode: string
  Title: Accounting Classification Code

  Maximum Length: 30

  Accounting classification code for the transaction.
• AccountingDate: string (date)
  Title: Accounting Date

  Date on which the transaction was accounted in the system.
• ACRN: string
  Title: ACRN

  Maximum Length: 30

  The Accounting Classification Reference Number that identifies a line of accounting on a contract.
• ACTTraceNumber: integer (int64)
  Title: ACT Trace Number

  The Accounting Trace (ACT) number for the transaction being processed.
• CLIN: string
  Title: CLIN

  Maximum Length: 30

  The Contract Line Item Number (CLIN) of the transaction.
• ContactEmailAddress: string
  Title: Contact Email Address

  Maximum Length: 320

  The email address of the contact person.
• ContactName: string
  Title: Contact Name

  Maximum Length: 360

  The name of the contact person for the transaction.
• ContactPhoneNumber: string
  Title: Contact Phone Number

  Maximum Length: 60

  The phone number of the contact person.
• ContractNumber: string
  Title: Contract Number

  Maximum Length: 30

  A unique number used to identify a contract between two trading partners.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time of the creation of the row.
• CreditDebitCode: string
  Title: Credit Debit Code

  Maximum Length: 30

  Identifier for the type of transaction whether it's a credit transaction or a debit transaction.
• CustomerALC: string
  Title: Customer ALC

  Maximum Length: 30

  The agency location code of the customer.
• CustomerId: integer (int64)
  Title: Customer ID

  Unique identifier of the customer.
• CustomerName: string
  Title: Customer Name

  Maximum Length: 360

  Name of the customer involved in the transaction.
• CustomerTransactionId: integer (int64)
  Title: Customer Transaction ID

  Identifier for the customer transaction.
• Description: string
  Title: Description

  Maximum Length: 500

  Additional information to describe and support the transaction.
• DetailAmount: number
  Title: Detail Amount

  The detail amount of the transaction.
• DetailLineNumber: integer (int32)
  Title: Detail Line Number

  The transaction detail line number.
• DocumentId: integer (int64)
  Title: Document ID

  Used to store a unique identifier value which can be used for drill-down or reconciling flexibility.
• DoDAAC: string
  Title: DoDAAC

  Maximum Length: 30

  Identifier for a Department of Defense activity location.
• FSNAAAADSN: integer (int32)
  Title: FSN AAA ADSN

  The accountable station code which is a combination of the Fiscal Station Number (FSN), the Authorization Accounting Activity (AAA), and the Accounting and Disbursing Station Number (ADSN). This is a subdivision of the agency location code (ALC).
• FYObligationId: integer (int64)
  Title: FY Obligation ID

  The obligation identifier for the fiscal year.
• InvoiceAmount: number
  Title: Invoice Amount

  Invoice amount of the transaction.
• InvoiceNumber: string
  Title: Invoice Number

  Maximum Length: 30

  Invoice number of the transaction.
• IPACBillingId: integer (int64)
  Title: IPAC Billing ID

  Billing identification number for the transaction.
• IPACDocumentReferenceNumber: integer (int64)
  Title: IPAC Document Reference Number

  Document reference number for a transaction.
• JASNumber: string
  Title: JAS Number

  Maximum Length: 30

  A number that's a combination of the Job Order Number, Accounting Classification Record Number, and Site-ID for the transaction being processed.
• JobProjectNumber: string
  Title: Job Project Number

  Maximum Length: 30

  The job number of the transaction being processed.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time of the last update of the row.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadDate: string (date)
  Title: Load Date

  The date on which the transaction data was loaded into Oracle Fusion Financials tables.
• Message: string
  Title: Message

  Maximum Length: 500

  Additional description for the transaction activity.
• MiscellaneousInformation: string
  Title: Miscellaneous Information

  Maximum Length: 500

  Additional miscellaneous transaction information.
• NumberOfDetailItems: integer (int32)
  Title: Number of Detail Items

  Number of detail lines in the transaction.
• ObligatingDocumentNumber: string
  Title: Obligating Document Number

  Maximum Length: 30

  The billing agency's internal accounting document associated with a specific bill or disbursement.
• OriginalAccomplishedDate: string (date)
  Title: Original Accomplished Date

  The original accomplished date of the transaction.
• OriginalAccountingDate: string (date)
  Title: Original Accounting Date

  The original accounting date of the transaction.
• OriginalDocumentReferenceNumber: integer (int64)
  Title: Original Document Reference Number

  The original document reference number for the transaction.
• OriginalDoSymbolALC: string
  Title: Original DO Symbol

  Maximum Length: 25

  The IPAC Disbursing Office Symbol (DOS) of the sender of the original payment or collection transaction.
• OriginalTransactionType: string
  Title: Original Transaction Type

  Maximum Length: 30

  The type of the transaction from the original transaction.
• OriginatorALC: string
  Title: Originating ALC

  Maximum Length: 30

  The agency location code (ALC) of the originator.
• PaymentCode: string
  Title: Pay Flag

  Maximum Length: 1

  Indicates whether the payment for the transaction line amount is full or partial.
• PurchaseOrderNumber: string
  Title: Purchase Order Number

  Maximum Length: 30

  The purchase order number of the transaction.
• Quantity: number
  Title: Quantity

  The number of items in the transaction.
• ReceiverBETC: string
  Title: Receiver BETC

  Maximum Length: 8

  The receiver's type of activity.
• ReceiverDepartmentCode: string
  Title: Receiver Department Code

  Maximum Length: 30

  The department code of the receiver.
• ReceiverDUNSorUEI: string
  Title: Receiver D-U-N-S

  Maximum Length: 12

  The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the receiver.
• ReceiverDUNSplus4OrEFT: string
  Title: Receiver D-U-N-S Plus 4

  Maximum Length: 4

  The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the receiver.
• ReceiverTreasuryAccountSymbol: string
  Title: Receiver Treasury Account Symbol

  Maximum Length: 35

  The receiver's treasury account symbol.
• RecordType: string
  Title: Record Type

  Read Only: true

  Maximum Length: 255

  The code for the IPAC transaction record type that indicates whether the transaction is inbound or outbound.
• RequisitionNumber: string
  Title: Requisition Number

  Maximum Length: 30

  The requisition number of the transaction.
• SenderBETC: string
  Title: Sender BETC

  Maximum Length: 8

  The Identifier of the sender's type of activity.
• SenderDoSymbolALC: string
  Title: Sender DO Symbol

  Maximum Length: 25

  The IPAC Disbursing Office Symbol (DOS) for the agency location code (ALC) sending the transaction.
• SenderDUNSorUEI: string
  Title: Sender D-U-N-S

  Maximum Length: 12

  The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the sender.
• SenderDUNSplus4OrEFT: string
  Title: Sender D-U-N-S Plus 4

  Maximum Length: 4

  The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the sender.
• SenderTreasuryAccountSymbol: string
  Title: Sender Treasury Account Symbol

  Maximum Length: 35

  The sender's treasury account symbol.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the record being loaded.
• SubmitterALC: string
  Title: Submitter ALC

  Maximum Length: 30

  The agency location code (ALC) of the submitter.
• TaxpayerNumber: string
  Title: Taxpayer Number

  Maximum Length: 50

  Taxpayer number of the transaction.
• TransactionContactEmailAddress: string
  Title: Transaction Contact

  Maximum Length: 320

  The email address of the IPAC transaction contact of the seller agency.
• TransactionContactPhone: string
  Title: Transaction Contact Phone

  Maximum Length: 60

  The phone number of the IPAC transaction contact of the seller agency.
• TransactionDataId: integer (int64)
  Title: Transaction Data ID

  The unique identifier of the IPAC transaction data.
• TransactionId: integer (int64)
  Title: Transaction ID

  The unique identifier of the IPAC transaction.
• TransactionSetId: string
  Title: Transaction Set ID

  Maximum Length: 30

  The code that identifies the transaction set.
• TransactionType: string
  Title: Transaction Type

  Read Only: true

  Maximum Length: 255

  The type of the transaction being processed.
• UnitOfIssue: string
  Title: Unit of Issue

  Maximum Length: 10

  The number of items that are being issued.
• UnitPrice: number
  Title: Unit Price

  The unit price of an item in the transaction.
• UserAttribute1: string
  Title: User Attribute 1

  Maximum Length: 150

  Used for storing User Attribute 8.
• UserAttribute10: string
  Title: User Attribute 10

  Maximum Length: 150

  Used for storing User Attribute 11.
• UserAttribute11: string
  Title: User Attribute 11

  Maximum Length: 150

  Used for storing User Attribute 15
• UserAttribute12: string
  Title: User Attribute 12

  Maximum Length: 150

  Used for storing User Attribute 5.
• UserAttribute13: string
  Title: User Attribute 13

  Maximum Length: 150

  Used for storing User Attribute 4.
• UserAttribute14: string
  Title: User Attribute 14

  Maximum Length: 150

  Used for storing User Attribute 14.
• UserAttribute15: string
  Title: User Attribute 15

  Maximum Length: 150

  Used for storing User Attribute 9.
• UserAttribute2: string
  Title: User Attribute 2

  Maximum Length: 150

  Used for storing User Attribute 1.
• UserAttribute3: string
  Title: User Attribute 3

  Maximum Length: 150

  Used for storing User Attribute 7.
• UserAttribute4: string
  Title: User Attribute 4

  Maximum Length: 150

  Used for storing User Attribute 6.
• UserAttribute5: string
  Title: User Attribute 5

  Maximum Length: 150

  Used for storing User Attribute 10.
• UserAttribute6: string
  Title: User Attribute 6

  Maximum Length: 150

  Used for storing User Attribute 13.
• UserAttribute7: string
  Title: User Attribute 7

  Maximum Length: 150

  Used for storing User Attribute 3.
• UserAttribute8: string
  Title: User Attribute 8

  Maximum Length: 150

  Used for storing User Attribute 12.
• UserAttribute9: string
  Title: User Attribute 9

  Maximum Length: 150

  Used for storing User Attribute 2.
• USSGLTransactionCode: string
  Title: USSGL Transaction Code

  Maximum Length: 30

  USSGL transaction code for outbound transactions.
• VoucherNumber: string
  Title: Voucher Number

  Maximum Length: 30

  The voucher number for the transaction.

{
    "type":"object",
    "properties":{
        "LoadDate":{
            "title":"Load Date",
            "type":"string",
            "description":"The date on which the transaction data was loaded into Oracle Fusion Financials tables.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractNumber":{
            "title":"Contract Number",
            "maxLength":30,
            "type":"string",
            "description":"A unique number used to identify a contract between two trading partners.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute9":{
            "title":"User Attribute 9",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 2.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "description":"Used to store a unique identifier value which can be used for drill-down or reconciling flexibility.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserAttribute6":{
            "title":"User Attribute 6",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 13.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute5":{
            "title":"User Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 10.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverDUNSplus4OrEFT":{
            "title":"Receiver D-U-N-S Plus 4",
            "maxLength":4,
            "type":"string",
            "description":"The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the receiver.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute8":{
            "title":"User Attribute 8",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 12.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute7":{
            "title":"User Attribute 7",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 3.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute2":{
            "title":"User Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 1.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionContactPhone":{
            "title":"Transaction Contact Phone",
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the IPAC transaction contact of the seller agency.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute1":{
            "title":"User Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 8.",
            "nullable":true,
            "x-queryable":true
        },
        "IPACDocumentReferenceNumber":{
            "title":"IPAC Document Reference Number",
            "type":"integer",
            "description":"Document reference number for a transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserAttribute4":{
            "title":"User Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 6.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute3":{
            "title":"User Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 7.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalTransactionType":{
            "title":"Original Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the transaction from the original transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "DetailAmount":{
            "title":"Detail Amount",
            "type":"number",
            "description":"The detail amount of the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "SenderTreasuryAccountSymbol":{
            "title":"Sender Treasury Account Symbol",
            "maxLength":35,
            "type":"string",
            "description":"The sender's treasury account symbol.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfIssue":{
            "title":"Unit of Issue",
            "maxLength":10,
            "type":"string",
            "description":"The number of items that are being issued.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionSetId":{
            "title":"Transaction Set ID",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the transaction set.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxpayerNumber":{
            "title":"Taxpayer Number",
            "maxLength":50,
            "type":"string",
            "description":"Taxpayer number of the 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"
            }
        },
        "InvoiceNumber":{
            "title":"Invoice Number",
            "maxLength":30,
            "type":"string",
            "description":"Invoice number of the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiverDUNSorUEI":{
            "title":"Receiver D-U-N-S",
            "maxLength":12,
            "type":"string",
            "description":"The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the receiver.",
            "nullable":true,
            "x-queryable":true
        },
        "SenderDoSymbolALC":{
            "title":"Sender DO Symbol",
            "maxLength":25,
            "type":"string",
            "description":"The IPAC Disbursing Office Symbol (DOS) for the agency location code (ALC) sending the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the record being loaded.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderDUNSorUEI":{
            "title":"Sender D-U-N-S",
            "maxLength":12,
            "type":"string",
            "description":"The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the sender.",
            "nullable":true,
            "x-queryable":true
        },
        "ACTTraceNumber":{
            "title":"ACT Trace Number",
            "type":"integer",
            "description":"The Accounting Trace (ACT) number for the transaction being processed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":30
            },
            "x-queryable":true
        },
        "VoucherNumber":{
            "title":"Voucher Number",
            "maxLength":30,
            "type":"string",
            "description":"The voucher number for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerTransactionId":{
            "title":"Customer Transaction ID",
            "type":"integer",
            "description":"Identifier for the customer transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"Unique identifier of the customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmitterALC":{
            "title":"Submitter ALC",
            "maxLength":30,
            "type":"string",
            "description":"The agency location code (ALC) of the submitter.",
            "nullable":true,
            "x-queryable":true
        },
        "DetailLineNumber":{
            "title":"Detail Line Number",
            "type":"integer",
            "description":"The transaction detail line number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the IPAC transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JASNumber":{
            "title":"JAS Number",
            "maxLength":30,
            "type":"string",
            "description":"A number that's a combination of the Job Order Number, Accounting Classification Record Number, and Site-ID for the transaction being processed.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalDocumentReferenceNumber":{
            "title":"Original Document Reference Number",
            "type":"integer",
            "description":"The original document reference number for the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiverBETC":{
            "title":"Receiver BETC",
            "maxLength":8,
            "type":"string",
            "description":"The receiver's type of activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ACRN":{
            "title":"ACRN",
            "maxLength":30,
            "type":"string",
            "description":"The Accounting Classification Reference Number that identifies a line of accounting on a contract.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":255,
            "type":"string",
            "description":"The type of the transaction being processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"Additional information to describe and support the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "title":"Message",
            "maxLength":500,
            "type":"string",
            "description":"Additional description for the transaction activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneNumber":{
            "title":"Contact Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the contact person.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"Invoice amount of the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingDate":{
            "title":"Accounting Date",
            "type":"string",
            "description":"Date on which the transaction was accounted in the system.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FYObligationId":{
            "title":"FY Obligation ID",
            "type":"integer",
            "description":"The obligation identifier for the fiscal year.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":30,
            "type":"string",
            "description":"The requisition number of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverDepartmentCode":{
            "title":"Receiver Department Code",
            "maxLength":30,
            "type":"string",
            "description":"The department code of the receiver.",
            "nullable":true,
            "x-queryable":true
        },
        "DoDAAC":{
            "title":"DoDAAC",
            "maxLength":30,
            "type":"string",
            "description":"Identifier for a Department of Defense activity location.",
            "nullable":true,
            "x-queryable":true
        },
        "SenderDUNSplus4OrEFT":{
            "title":"Sender D-U-N-S Plus 4",
            "maxLength":4,
            "type":"string",
            "description":"The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the sender.",
            "nullable":true,
            "x-queryable":true
        },
        "CLIN":{
            "title":"CLIN",
            "maxLength":30,
            "type":"string",
            "description":"The Contract Line Item Number (CLIN) of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditDebitCode":{
            "title":"Credit Debit Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifier for the type of transaction whether it's a credit transaction or a debit transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ObligatingDocumentNumber":{
            "title":"Obligating Document Number",
            "maxLength":30,
            "type":"string",
            "description":"The billing agency's internal accounting document associated with a specific bill or disbursement.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Record Type",
            "maxLength":255,
            "type":"string",
            "description":"The code for the IPAC transaction record type that indicates whether the transaction is inbound or outbound.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerName":{
            "title":"Customer Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer involved in the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "JobProjectNumber":{
            "title":"Job Project Number",
            "maxLength":30,
            "type":"string",
            "description":"The job number of the transaction being processed.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalAccomplishedDate":{
            "title":"Original Accomplished Date",
            "type":"string",
            "description":"The original accomplished date of the transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfDetailItems":{
            "title":"Number of Detail Items",
            "type":"integer",
            "description":"Number of detail lines in the transaction.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "PaymentCode":{
            "title":"Pay Flag",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the payment for the transaction line amount is full or partial.",
            "nullable":true,
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "title":"Purchase Order Number",
            "maxLength":30,
            "type":"string",
            "description":"The purchase order number of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Accounted":{
            "title":"Accounted Flag",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies whether the transaction is accounted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserAttribute12":{
            "title":"User Attribute 12",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 5.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute13":{
            "title":"User Attribute 13",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 4.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The number of items in the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingClassificationCode":{
            "title":"Accounting Classification Code",
            "maxLength":30,
            "type":"string",
            "description":"Accounting classification code for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute10":{
            "title":"User Attribute 10",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 11.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginatorALC":{
            "title":"Originating ALC",
            "maxLength":30,
            "type":"string",
            "description":"The agency location code (ALC) of the originator.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute11":{
            "title":"User Attribute 11",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 15",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalDoSymbolALC":{
            "title":"Original DO Symbol",
            "maxLength":25,
            "type":"string",
            "description":"The IPAC Disbursing Office Symbol (DOS) of the sender of the original payment or collection transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "FSNAAAADSN":{
            "title":"FSN AAA ADSN",
            "type":"integer",
            "description":"The accountable station code which is a combination of the Fiscal Station Number (FSN), the Authorization Accounting Activity (AAA), and the Accounting and Disbursing Station Number (ADSN). This is a subdivision of the agency location code (ALC).",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "UserAttribute14":{
            "title":"User Attribute 14",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 14.",
            "nullable":true,
            "x-queryable":true
        },
        "UserAttribute15":{
            "title":"User Attribute 15",
            "maxLength":150,
            "type":"string",
            "description":"Used for storing User Attribute 9.",
            "nullable":true,
            "x-queryable":true
        },
        "AccomplishedDate":{
            "title":"Accomplished Date",
            "type":"string",
            "description":"The date on which the transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of an item in the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionContactEmailAddress":{
            "title":"Transaction Contact",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the IPAC transaction contact of the seller agency.",
            "nullable":true,
            "x-queryable":true
        },
        "USSGLTransactionCode":{
            "title":"USSGL Transaction Code",
            "maxLength":30,
            "type":"string",
            "description":"USSGL transaction code for outbound transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerALC":{
            "title":"Customer ALC",
            "maxLength":30,
            "type":"string",
            "description":"The agency location code of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Contact Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact person.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalAccountingDate":{
            "title":"Original Accounting Date",
            "type":"string",
            "description":"The original accounting date of the transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverTreasuryAccountSymbol":{
            "title":"Receiver Treasury Account Symbol",
            "maxLength":35,
            "type":"string",
            "description":"The receiver's treasury account symbol.",
            "nullable":true,
            "x-queryable":true
        },
        "SenderBETC":{
            "title":"Sender BETC",
            "maxLength":8,
            "type":"string",
            "description":"The Identifier of the sender's type of activity.",
            "nullable":true,
            "x-queryable":true
        },
        "MiscellaneousInformation":{
            "title":"Miscellaneous Information",
            "maxLength":500,
            "type":"string",
            "description":"Additional miscellaneous transaction information.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact person for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDataId":{
            "title":"Transaction Data ID",
            "type":"integer",
            "description":"The unique identifier of the IPAC transaction data.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IPACBillingId":{
            "title":"IPAC Billing ID",
            "type":"integer",
            "description":"Billing identification number for the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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

Examples

The following example shows how to retrieve an IPAC transaction record by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedIPACTransactionData/{TransactionDataId}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "TransactionDataId": 100106196959914,
    "LoadDate": "2025-03-15",
    "ProcessDate": "2025-03-15",
    "Status": "SUCCESS",
    "Message": null,
    "TransactionId": 28872889,
    "DetailLineNumber": 1,
    "DocumentId": null,
    "InvoiceNumber": "CSNG260923480034",
    "InvoiceAmount": 549.77,
    "UserAttribute1": null,
    "UserAttribute2": null,
    "UserAttribute3": null,
    "UserAttribute4": null,
    "UserAttribute5": null,
    "UserAttribute6": null,
    "UserAttribute7": null,
    "UserAttribute8": null,
    "UserAttribute9": null,
    "UserAttribute10": null,
    "UserAttribute11": null,
    "UserAttribute12": null,
    "UserAttribute13": null,
    "UserAttribute14": null,
    "UserAttribute15": null,
    "SubmitterALC": "20180032",
    "OriginatorALC": "20180032",
    "CustomerALC": "20050000",
    "ContactName": "REDACTED",
    "ContactEmailAddress": "REDACTED",
    "ContactPhoneNumber": null,
    "NumberOfDetailItems": 4,
    "AccomplishedDate": "2023-10-05",
    "AccountingDate": "2023-10-31",
    "PurchaseOrderNumber": "NA",
    "CLIN": "NA",
    "RequisitionNumber": "NA",
    "Quantity": 1,
    "UnitOfIssue": "EA",
    "UnitPrice": 78.46,
    "DetailAmount": 78.46,
    "PaymentCode": "F",
    "FYObligationId": null,
    "ReceiverTreasuryAccountSymbol": "020        X5511000",
    "ReceiverBETC": "COLL",
    "SenderTreasuryAccountSymbol": "020        F3887001",
    "SenderBETC": "DISBBCA",
    "ReceiverDepartmentCode": null,
    "AccountingClassificationCode": "NA",
    "ACRN": "NA",
    "JobProjectNumber": "NA",
    "JASNumber": "NA",
    "FSNAAAADSN": 0,
    "ObligatingDocumentNumber": "Cross Servicing",
    "ACTTraceNumber": 3000000000000,
    "Description": "DMSC CSNG",
    "MiscellaneousInformation": "CSNG Client information: Contact [e-mail] at 1-800-555-0100",
    "OriginalTransactionType": null,
    "IPACDocumentReferenceNumber": 91374527,
    "DoDAAC": null,
    "TransactionContactEmailAddress": "[e-mail]",
    "TransactionContactPhone": "NA",
    "VoucherNumber": null,
    "OriginalAccomplishedDate": null,
    "OriginalAccountingDate": null,
    "OriginalDocumentReferenceNumber": null,
    "OriginalDoSymbolALC": null,
    "SenderDoSymbolALC": "D0913",
    "ContractNumber": "NA",
    "ReceiverDUNSorUEI": null,
    "ReceiverDUNSplus4OrEFT": null,
    "SenderDUNSorUEI": null,
    "SenderDUNSplus4OrEFT": null,
    "USSGLTransactionCode": null,
    "TaxpayerNumber": null,
    "TransactionSetId": null,
    "IPACBillingId": null,
    "CustomerId": null,
    "CustomerName": null,
    "CreditDebitCode": null,
    "CustomerTransactionId": null,
    "RecordType": "Inbound",
    "TransactionType": "Payment",
    "Accounted": "No",
    "CreatedBy": "username",
    "CreationDate": "2025-03-05T16:15:46+00:00",
    "LastUpdatedBy": "username",
    "LastUpdateDate": "2025-03-15T05:40:02+00:00",
    "LastUpdateLogin": "305B4CF734663046E063AD4F060AF1CF",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedIPACTransactionData/100106196959914",
            "name": "fedIPACTransactionData",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedIPACTransactionData/100106196959914",
            "name": "fedIPACTransactionData",
            "kind": "item"
        }
    ]
}

Back to Top