Federal SAM Trading Partner Details
fedSAMVendorDetails Based on 26C
Create, delete and look up Federal SAM Trading Partner Details, with fed SAM exception messages. Actions include submit and submit customer party.
- Operations
- GET (list)GET (one)POST (create)DELETE4 actions
- Record key
SamTradingPartnerId- Required on create
UniqueEntityIdentifier- At a glance
- 118 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails?fields=AccountNumber,AccountType,AccountingStation,AchEmail,AchFax&limit=25&onlyData=true
{
"items": [
{
"AccountNumber": "<string, max 255>",
"AccountType": "<string, max 80>",
"AccountingStation": "<string, max 6>",
"AchEmail": "<string, max 80>",
"AchFax": "<string, max 30>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's 26C REST specification.
Fields 118
| Attribute | Type | Use |
|---|---|---|
AccountNumber | text · max 255 | Read-onlySearchable |
AccountType | text · max 80 | Read-only |
AccountingStation | text · max 6 | Read-only |
AchEmail | text · max 80 | Read-only |
AchFax | text · max 30 | Read-only |
AchNonUSPhone | text · max 30 | Read-only |
AchUSPhone | text · max 30 | Read-only |
ActivationDate | date | Read-only |
AgencyBusinessPurpose | text · max 80 | Read-only |
AgencyLocationCode | text · max 8 | Read-onlySearchable |
ApPocCity | text · max 40 | Read-only |
ApPocCountryCode | text · max 3 | Read-only |
ApPocEmail | text · max 80 | Read-only |
ApPocFaxUSOnly | text · max 30 | Read-only |
ApPocFirstName | text · max 65 | Read-only |
ApPocLastName | text · max 65 | Read-only |
ApPocMiddleInitial | text · max 3 | Read-only |
ApPocNonUSPhone | text · max 30 | Read-only |
ApPocSTAddr1 | text · max 150 | Read-only |
ApPocSTAddr2 | text · max 150 | Read-only |
ApPocStateOrProvince | text · max 55 | Read-only |
ApPocTitle | text · max 50 | Read-only |
ApPocUSPhone | text · max 30 | Read-only |
ApPocUSPhoneExtension | text · max 25 | Read-only |
ApPocZipCodePlus4 | number | Read-only |
ApPocZipOrPostalCode | text · max 50 | Read-only |
ArPocEmail | text · max 80 | Read-only |
ArPocFaxUSOnly | text · max 30 | Read-only |
ArPocFirstName | text · max 65 | Read-only |
ArPocLastName | text · max 65 | Read-only |
ArPocMiddleInitial | text · max 3 | Read-only |
ArPocNonUSPhone | text · max 30 | Read-only |
ArPocTitle | text · max 50 | Read-only |
ArPocUSPhone | text · max 30 | Read-only |
ArPocUSPhoneExtension | text · max 25 | Read-only |
AuthorizationDate | date | Read-only |
AverageAnnualRevenue | text · max 25 | Read-only |
AverageNumberOfEmployees | text · max 25 | Read-only |
BusinessTypesInformation | text · max 255 | Read-onlySearchable |
BusinessUnit | text · max 80 | Read-onlySearchable |
CageCode | text · max 5 | Read-onlySearchable |
CongressionalDistrict | number | Read-only |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
CustomerParty | text · max 80 | Read-onlySearchable |
CustomerPartyId | number | Optional on createSearchable |
CustomerProcessStatus | text · max 255 | Read-only |
DebtSubjectToOffset | text · max 80 | Read-onlySearchable |
DepartmentCode | text · max 2 | Read-only |
DisbursingOfficeSymbol | text · max 5 | Read-only |
DivisionName | text · max 60 | Read-only |
DivisionNumber | text · max 10 | Read-only |
DoDAAC | text · max 9 | Read-onlySearchable |
DoingBusinessAsName | text · max 120 | Read-only |
EFTIndicator | text · max 10 | Optional on createSearchable |
EFTWaiver | text · max 80 | Read-only |
EnableImport | text · max 255 | Read-only |
EntityStructure | text · max 80 | Read-onlySearchable |
EntityURL | text · max 200 | Read-onlySearchable |
ExclusionStatus | text · max 80 | Read-only |
FinancialInstitute | text · max 50 | Read-only |
HQParentUEI | text · max 12 | Read-only |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LegalBusinessName | text · max 120 | Read-onlySearchable |
Location | text · max 255 | Read-onlySearchable |
LockboxNumber | text · max 20 | Read-only |
MailAddrCity | text · max 40 | Read-only |
MailAddrCountry | text · max 3 | Read-only |
MailAddrLine1 | text · max 150 | Read-only |
MailAddrLine2 | text · max 150 | Read-only |
MailAddrStateOrProvince | text · max 55 | Read-only |
MailAddrZipCodePlus4 | number | Read-only |
MailAddrZipPostalCode | text · max 50 | Read-only |
MarketingPartnerIdentificationNumber | text · max 9 | Read-only |
MerchantId1 | text · max 130 | Read-only |
MerchantId2 | text · max 130 | Read-only |
NAICSCodesInformation | text · max 255 | Read-onlySearchable |
NoPublicDisplay | text · max 80 | Read-onlySearchable |
PaidByCreditCard | text · max 80 | Read-only |
PhysAddrCity | text · max 40 | Read-onlySearchable |
PhysAddrCountryCode | text · max 3 | Read-onlySearchable |
PhysAddrLine1 | text · max 150 | Read-only |
PhysAddrLine2 | text · max 150 | Read-only |
PhysAddrProvinceOrState | text · max 55 | Read-onlySearchable |
PhysAddrZipCodePlus4 | number | Read-only |
PhysAddrZipOrPostalCode | text · max 50 | Read-only |
PhysicalAddress | text · max 255 | Read-only |
PrimaryNAICSCode | text · max 6 | Read-only |
PrimaryNAICSDescription | text · max 80 | Read-only |
ProcessStatus | text · max 255 | Read-only |
PscCodesInformation | text · max 255 | Read-onlySearchable |
PurposeOfRegistration | text · max 80 | Read-onlySearchable |
RegistrationExpirationDate | date | Read-only |
RemittanceAddressLine1 | text · max 150 | Read-only |
RemittanceAddressLine2 | text · max 150 | Read-only |
RemittanceCity | text · max 40 | Read-only |
RemittanceCountryCode | text · max 3 | Read-only |
RemittanceName | text · max 120 | Read-only |
RemittanceStateOrProvince | text · max 55 | Read-only |
RemittanceZipCodePlus4 | number | Read-only |
RemittanceZipOrPostalCode | text · max 50 | Read-only |
RoutingNumber | number | Read-only |
SAMRecordLastImportedDate | date-time | Read-only |
SAMRecordLastUpdatedDate | date | Read-only |
SamTradingPartnerId | number | Optional on createSearchable |
SbaBizTypesInformation | text · max 255 | Read-onlySearchable |
SetName | text · max 80 | Read-only |
Source | text · max 80 | Read-only |
Status | text · max 80 | Read-onlySearchable |
Supplier | text · max 80 | Read-only |
SupplierId | number | Optional on createSearchable |
TaxIdentifierNumber | text · max 255 | Read-onlySearchable |
TaxIdentifierType | text · max 1 | Read-only |
TaxpayerName | text · max 120 | Read-onlySearchable |
UltimateParentUEI | text · max 12 | Read-only |
UniqueEntityIdentifier | text · max 12 | Required on createSearchable |
UniqueEntityIdentifierDUNS | text · max 15 | Read-only |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
AltKey·EFTIndicatorUniqueEntityIdentifier
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/fedSAMVendorDetails/{SamTradingPartnerId}/child/<name>. Add them to a GET with expand.
fedSAMExceptionMessagesGET · POST · DELETE Federal SAM Exception Messages · 10 fieldsCodeCreatedByCreationDateDescriptionExceptionUniqueIdJobIdLastUpdateDateLastUpdateLoginLastUpdatedByProcessName
Actions 4
POST …/action/submit·uniqueEntityIdentifierPOST …/action/submitCustomerParty·uniqueEntityIdentifierPOST …/action/unAssignSupplier·uniqueEntityIdentifierPOST …/action/unassignCustomerParty·uniqueEntityIdentifier
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/fedSAMVendorDetailsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
AltKeyfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CustomerPartyId, notcustomerpartyid. - 113 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.