Get all IPAC transaction records
get
/fscmRestApi/resources/11.13.18.05/fedIPACTransactionData
Request
Query Parameters
-
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 Finds the federal IPAC transaction record that matches the specified primary key criteria.
Finder Variables- TransactionDataId; integer; The unique identifier of the IPAC transaction data.
- RecordTypeFinder Finds the federal IPAC transaction record that match the specified RecordType; string; finder search criteria.
Finder Variables- RecordType; string; Finds the federal IPAC transaction record that match the specified RecordType; string; finder search criteria.
- PrimaryKey Finds the federal IPAC transaction record that matches the specified primary key criteria.
-
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:- ACRN; string; The Accounting Classification Reference Number that identifies a line of accounting on a contract.
- ACTTraceNumber; integer; The Accounting Trace (ACT) number for the transaction being processed.
- AccomplishedDate; string; The date on which the transaction occurred.
- Accounted; string; Value that identifies whether the transaction is accounted.
- AccountingClassificationCode; string; Accounting classification code for the transaction.
- AccountingDate; string; Date on which the transaction was accounted in the system.
- CLIN; string; The Contract Line Item Number (CLIN) of the transaction.
- ContactEmailAddress; string; The email address of the contact person.
- ContactName; string; The name of the contact person for the transaction.
- ContactPhoneNumber; string; The phone number of the contact person.
- ContractNumber; string; A unique number used to identify a contract between two trading partners.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date and time of the creation of the row.
- CreditDebitCode; string; Identifier for the type of transaction whether it's a credit transaction or a debit transaction.
- CustomerALC; string; The agency location code of the customer.
- CustomerId; integer; Unique identifier of the customer.
- CustomerName; string; Name of the customer involved in the transaction.
- CustomerTransactionId; integer; Identifier for the customer transaction.
- Description; string; Additional information to describe and support the transaction.
- DetailAmount; number; The detail amount of the transaction.
- DetailLineNumber; integer; The transaction detail line number.
- DoDAAC; string; Identifier for a Department of Defense activity location.
- DocumentId; integer; Used to store a unique identifier value which can be used for drill-down or reconciling flexibility.
- FSNAAAADSN; integer; 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; The obligation identifier for the fiscal year.
- IPACBillingId; integer; Billing identification number for the transaction.
- IPACDocumentReferenceNumber; integer; Document reference number for a transaction.
- InvoiceAmount; number; Invoice amount of the transaction.
- InvoiceNumber; string; Invoice number of the transaction.
- JASNumber; string; 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; The job number of the transaction being processed.
- LastUpdateDate; string; The date and time of the last update of the row.
- LastUpdateLogin; string; The session login associated to the user who last updated the row.
- LastUpdatedBy; string; The user who last updated the row.
- LoadDate; string; The date on which the transaction data was loaded into Oracle Fusion Financials tables.
- Message; string; Additional description for the transaction activity.
- MiscellaneousInformation; string; Additional miscellaneous transaction information.
- NumberOfDetailItems; integer; Number of detail lines in the transaction.
- ObligatingDocumentNumber; string; The billing agency's internal accounting document associated with a specific bill or disbursement.
- OriginalAccomplishedDate; string; The original accomplished date of the transaction.
- OriginalAccountingDate; string; The original accounting date of the transaction.
- OriginalDoSymbolALC; string; The IPAC Disbursing Office Symbol (DOS) of the sender of the original payment or collection transaction.
- OriginalDocumentReferenceNumber; integer; The original document reference number for the transaction.
- OriginalTransactionType; string; The type of the transaction from the original transaction.
- OriginatorALC; string; The agency location code (ALC) of the originator.
- PaymentCode; string; Indicates whether the payment for the transaction line amount is full or partial.
- ProcessDate; string; The date on which the IPAC outbound process was run.
- PurchaseOrderNumber; string; The purchase order number of the transaction.
- Quantity; number; The number of items in the transaction.
- ReceiverBETC; string; The receiver's type of activity.
- ReceiverDUNSorUEI; string; The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the receiver.
- ReceiverDUNSplus4OrEFT; string; The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the receiver.
- ReceiverDepartmentCode; string; The department code of the receiver.
- ReceiverTreasuryAccountSymbol; string; The receiver's treasury account symbol.
- RecordType; string; The code for the IPAC transaction record type that indicates whether the transaction is inbound or outbound.
- RequisitionNumber; string; The requisition number of the transaction.
- SenderBETC; string; The Identifier of the sender's type of activity.
- SenderDUNSorUEI; string; The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the sender.
- SenderDUNSplus4OrEFT; string; The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the sender.
- SenderDoSymbolALC; string; The IPAC Disbursing Office Symbol (DOS) for the agency location code (ALC) sending the transaction.
- SenderTreasuryAccountSymbol; string; The sender's treasury account symbol.
- Status; string; The status of the record being loaded.
- SubmitterALC; string; The agency location code (ALC) of the submitter.
- TaxpayerNumber; string; Taxpayer number of the transaction.
- TransactionContactEmailAddress; string; The email address of the IPAC transaction contact of the seller agency.
- TransactionContactPhone; string; The phone number of the IPAC transaction contact of the seller agency.
- TransactionDataId; integer; The unique identifier of the IPAC transaction data.
- TransactionId; integer; The unique identifier of the IPAC transaction.
- TransactionSetId; string; The code that identifies the transaction set.
- TransactionType; string; The type of the transaction being processed.
- USSGLTransactionCode; string; USSGL transaction code for outbound transactions.
- UnitOfIssue; string; The number of items that are being issued.
- UnitPrice; number; The unit price of an item in the transaction.
- UserAttribute1; string; Used for storing User Attribute 8.
- UserAttribute10; string; Used for storing User Attribute 11.
- UserAttribute11; string; Used for storing User Attribute 15
- UserAttribute12; string; Used for storing User Attribute 5.
- UserAttribute13; string; Used for storing User Attribute 4.
- UserAttribute14; string; Used for storing User Attribute 14.
- UserAttribute15; string; Used for storing User Attribute 9.
- UserAttribute2; string; Used for storing User Attribute 1.
- UserAttribute3; string; Used for storing User Attribute 7.
- UserAttribute4; string; Used for storing User Attribute 6.
- UserAttribute5; string; Used for storing User Attribute 10.
- UserAttribute6; string; Used for storing User Attribute 13.
- UserAttribute7; string; Used for storing User Attribute 3.
- UserAttribute8; string; Used for storing User Attribute 12.
- UserAttribute9; string; Used for storing User Attribute 2.
- VoucherNumber; string; The voucher number for the transaction.
-
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: string
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: string
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 TopResponse
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.
Root Schema : fedIPACTransactionData
Type:
Show Source
object-
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : fedIPACTransactionData-item-response
Type:
Show Source
object-
AccomplishedDate: string
(date)
Title:
Accomplished DateThe date on which the transaction occurred. -
Accounted: string
Title:
Accounted FlagRead Only:trueMaximum Length:255Value that identifies whether the transaction is accounted. -
AccountingClassificationCode: string
Title:
Accounting Classification CodeMaximum Length:30Accounting classification code for the transaction. -
AccountingDate: string
(date)
Title:
Accounting DateDate on which the transaction was accounted in the system. -
ACRN: string
Title:
ACRNMaximum Length:30The Accounting Classification Reference Number that identifies a line of accounting on a contract. -
ACTTraceNumber: integer
(int64)
Title:
ACT Trace NumberThe Accounting Trace (ACT) number for the transaction being processed. -
CLIN: string
Title:
CLINMaximum Length:30The Contract Line Item Number (CLIN) of the transaction. -
ContactEmailAddress: string
Title:
Contact Email AddressMaximum Length:320The email address of the contact person. -
ContactName: string
Title:
Contact NameMaximum Length:360The name of the contact person for the transaction. -
ContactPhoneNumber: string
Title:
Contact Phone NumberMaximum Length:60The phone number of the contact person. -
ContractNumber: string
Title:
Contract NumberMaximum Length:30A unique number used to identify a contract between two trading partners. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time of the creation of the row. -
CreditDebitCode: string
Title:
Credit Debit CodeMaximum Length:30Identifier for the type of transaction whether it's a credit transaction or a debit transaction. -
CustomerALC: string
Title:
Customer ALCMaximum Length:30The agency location code of the customer. -
CustomerId: integer
(int64)
Title:
Customer IDUnique identifier of the customer. -
CustomerName: string
Title:
Customer NameMaximum Length:360Name of the customer involved in the transaction. -
CustomerTransactionId: integer
(int64)
Title:
Customer Transaction IDIdentifier for the customer transaction. -
Description: string
Title:
DescriptionMaximum Length:500Additional information to describe and support the transaction. -
DetailAmount: number
Title:
Detail AmountThe detail amount of the transaction. -
DetailLineNumber: integer
(int32)
Title:
Detail Line NumberThe transaction detail line number. -
DocumentId: integer
(int64)
Title:
Document IDUsed to store a unique identifier value which can be used for drill-down or reconciling flexibility. -
DoDAAC: string
Title:
DoDAACMaximum Length:30Identifier for a Department of Defense activity location. -
FSNAAAADSN: integer
(int32)
Title:
FSN AAA ADSNThe 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 IDThe obligation identifier for the fiscal year. -
InvoiceAmount: number
Title:
Invoice AmountInvoice amount of the transaction. -
InvoiceNumber: string
Title:
Invoice NumberMaximum Length:30Invoice number of the transaction. -
IPACBillingId: integer
(int64)
Title:
IPAC Billing IDBilling identification number for the transaction. -
IPACDocumentReferenceNumber: integer
(int64)
Title:
IPAC Document Reference NumberDocument reference number for a transaction. -
JASNumber: string
Title:
JAS NumberMaximum Length:30A 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 NumberMaximum Length:30The job number of the transaction being processed. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The session login associated to the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadDate: string
(date)
Title:
Load DateThe date on which the transaction data was loaded into Oracle Fusion Financials tables. -
Message: string
Title:
MessageMaximum Length:500Additional description for the transaction activity. -
MiscellaneousInformation: string
Title:
Miscellaneous InformationMaximum Length:500Additional miscellaneous transaction information. -
NumberOfDetailItems: integer
(int32)
Title:
Number of Detail ItemsNumber of detail lines in the transaction. -
ObligatingDocumentNumber: string
Title:
Obligating Document NumberMaximum Length:30The billing agency's internal accounting document associated with a specific bill or disbursement. -
OriginalAccomplishedDate: string
(date)
Title:
Original Accomplished DateThe original accomplished date of the transaction. -
OriginalAccountingDate: string
(date)
Title:
Original Accounting DateThe original accounting date of the transaction. -
OriginalDocumentReferenceNumber: integer
(int64)
Title:
Original Document Reference NumberThe original document reference number for the transaction. -
OriginalDoSymbolALC: string
Title:
Original DO SymbolMaximum Length:25The IPAC Disbursing Office Symbol (DOS) of the sender of the original payment or collection transaction. -
OriginalTransactionType: string
Title:
Original Transaction TypeMaximum Length:30The type of the transaction from the original transaction. -
OriginatorALC: string
Title:
Originating ALCMaximum Length:30The agency location code (ALC) of the originator. -
PaymentCode: string
Title:
Pay FlagMaximum Length:1Indicates whether the payment for the transaction line amount is full or partial. -
ProcessDate: string
(date)
Title:
Process DateRead Only:trueThe date on which the IPAC outbound process was run. -
PurchaseOrderNumber: string
Title:
Purchase Order NumberMaximum Length:30The purchase order number of the transaction. -
Quantity: number
Title:
QuantityThe number of items in the transaction. -
ReceiverBETC: string
Title:
Receiver BETCMaximum Length:8The receiver's type of activity. -
ReceiverDepartmentCode: string
Title:
Receiver Department CodeMaximum Length:30The department code of the receiver. -
ReceiverDUNSorUEI: string
Title:
Receiver D-U-N-SMaximum Length:12The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the receiver. -
ReceiverDUNSplus4OrEFT: string
Title:
Receiver D-U-N-S Plus 4Maximum Length:4The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the receiver. -
ReceiverTreasuryAccountSymbol: string
Title:
Receiver Treasury Account SymbolMaximum Length:35The receiver's treasury account symbol. -
RecordType: string
Title:
Record TypeRead Only:trueMaximum Length:255The code for the IPAC transaction record type that indicates whether the transaction is inbound or outbound. -
RequisitionNumber: string
Title:
Requisition NumberMaximum Length:30The requisition number of the transaction. -
SenderBETC: string
Title:
Sender BETCMaximum Length:8The Identifier of the sender's type of activity. -
SenderDoSymbolALC: string
Title:
Sender DO SymbolMaximum Length:25The IPAC Disbursing Office Symbol (DOS) for the agency location code (ALC) sending the transaction. -
SenderDUNSorUEI: string
Title:
Sender D-U-N-SMaximum Length:12The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number of the sender. -
SenderDUNSplus4OrEFT: string
Title:
Sender D-U-N-S Plus 4Maximum Length:4The Dun and Bradstreet Data Universal Numbering System (D-U-N-S) number plus 4 of the sender. -
SenderTreasuryAccountSymbol: string
Title:
Sender Treasury Account SymbolMaximum Length:35The sender's treasury account symbol. -
Status: string
Title:
StatusMaximum Length:30The status of the record being loaded. -
SubmitterALC: string
Title:
Submitter ALCMaximum Length:30The agency location code (ALC) of the submitter. -
TaxpayerNumber: string
Title:
Taxpayer NumberMaximum Length:50Taxpayer number of the transaction. -
TransactionContactEmailAddress: string
Title:
Transaction ContactMaximum Length:320The email address of the IPAC transaction contact of the seller agency. -
TransactionContactPhone: string
Title:
Transaction Contact PhoneMaximum Length:60The phone number of the IPAC transaction contact of the seller agency. -
TransactionDataId: integer
(int64)
Title:
Transaction Data IDThe unique identifier of the IPAC transaction data. -
TransactionId: integer
(int64)
Title:
Transaction IDThe unique identifier of the IPAC transaction. -
TransactionSetId: string
Title:
Transaction Set IDMaximum Length:30The code that identifies the transaction set. -
TransactionType: string
Title:
Transaction TypeRead Only:trueMaximum Length:255The type of the transaction being processed. -
UnitOfIssue: string
Title:
Unit of IssueMaximum Length:10The number of items that are being issued. -
UnitPrice: number
Title:
Unit PriceThe unit price of an item in the transaction. -
UserAttribute1: string
Title:
User Attribute 1Maximum Length:150Used for storing User Attribute 8. -
UserAttribute10: string
Title:
User Attribute 10Maximum Length:150Used for storing User Attribute 11. -
UserAttribute11: string
Title:
User Attribute 11Maximum Length:150Used for storing User Attribute 15 -
UserAttribute12: string
Title:
User Attribute 12Maximum Length:150Used for storing User Attribute 5. -
UserAttribute13: string
Title:
User Attribute 13Maximum Length:150Used for storing User Attribute 4. -
UserAttribute14: string
Title:
User Attribute 14Maximum Length:150Used for storing User Attribute 14. -
UserAttribute15: string
Title:
User Attribute 15Maximum Length:150Used for storing User Attribute 9. -
UserAttribute2: string
Title:
User Attribute 2Maximum Length:150Used for storing User Attribute 1. -
UserAttribute3: string
Title:
User Attribute 3Maximum Length:150Used for storing User Attribute 7. -
UserAttribute4: string
Title:
User Attribute 4Maximum Length:150Used for storing User Attribute 6. -
UserAttribute5: string
Title:
User Attribute 5Maximum Length:150Used for storing User Attribute 10. -
UserAttribute6: string
Title:
User Attribute 6Maximum Length:150Used for storing User Attribute 13. -
UserAttribute7: string
Title:
User Attribute 7Maximum Length:150Used for storing User Attribute 3. -
UserAttribute8: string
Title:
User Attribute 8Maximum Length:150Used for storing User Attribute 12. -
UserAttribute9: string
Title:
User Attribute 9Maximum Length:150Used for storing User Attribute 2. -
USSGLTransactionCode: string
Title:
USSGL Transaction CodeMaximum Length:30USSGL transaction code for outbound transactions. -
VoucherNumber: string
Title:
Voucher NumberMaximum Length:30The voucher number for the transaction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.