Supplier Management

Get Involved. Join the Conversation.

Topic

    Hong Gao
    Supplier Attributes Queryable in REST Service
    Topic posted February 28, 2019 by Hong GaoGold Medal: 3,500+ Points, tagged Web Services 
    129 Views, 1 Comment
    Title:
    Supplier Attributes Queryable in REST Service
    Summary:
    List of supplier and its child entity attributes that are queryable using REST GET operation (19A)
    Content:

    In Supplier REST GET operation, you can use q to specify a filter for the items to be returned from the collection.  For example, the following URL will return suppliers with Supplier Type of Services:

    https://<server>/fscmRestApi/resources/latest/suppliers?q=SupplierType="Services"

    The attribute used by the query parameter q has to be queryable. Not all supplier profile attributes are queryable.  You can use URLs like below to find out the queryable property for supplier entity attributes:

    https://<server>/fscmRestApi/resources/latest/suppliers/describe

    https://<server>/fscmRestApi/resources/latest/suppliers/<SupplierId>/child/addresses/describe

    For a quick reference for release 19A, here is the list of all the queryable attributes for supplier and its child entities:

    Supplier

    • SupplierId
    • Supplier
    • SupplierNumber
    • AlternateName
    • TaxOrganizationTypeCode
    • TaxOrganizationType
    • SupplierTypeCode
    • SupplierType
    • ParentSupplierId
    • ParentSupplier
    • CreationDate
    • DUNSNumber
    • TaxRegistrationNumber
    • TaxpayerId
    • FiscalYearEndMonth

    Addresses

    • SupplierAddressId
    • AddressName
    • CountryCode
    • Country
    • AddressLine1
    • AddressLine2
    • AddressLine3
    • AddressLine4
    • City
    • State
    • PostalCode
    • PostalCodeExtension
    • Province
    • County
    • Building
    • FloorNumber
    • PhoneticAddress
    • LanguageCode
    • Language
    • Addressee
    • GlobalLocationNumber
    • AdditionalAddressAttribute1
    • AdditionalAddressAttribute2
    • AdditionalAddressAttribute3
    • AdditionalAddressAttribute4
    • AdditionalAddressAttribute5
    • AddressPurposeOrderingFlag
    • AddressPurposeRemitToFlag
    • AddressPurposeRFQOrBiddingFlag
    • PhoneCountryCode
    • PhoneAreaCode
    • PhoneNumber
    • PhoneExtension
    • FaxCountryCode
    • FaxAreaCode
    • FaxNumber
    • Email
    • InactiveDate
    • Status

    Contacts

    • SupplierContactId
    • SalutationCode
    • Salutation
    • FirstName
    • MiddleName
    • LastName
    • JobTitle
    • AdministrativeContactFlag
    • PhoneCountryCode
    • PhoneAreaCode
    • PhoneNumber
    • PhoneExtension
    • MobileCountryCode
    • MobileAreaCode
    • MobileNumber
    • FaxCountryCode
    • FaxAreaCode
    • FaxNumber
    • Email
    • Status
    • InactiveDate
    • PersonProfileId

    Contact Addresses

    • SupplierContactAddressId
    • SupplierAddressId
    • AddressName

    Sites

    • SupplierSiteId
    • SupplierSite
    • ProcurementBU
    • SupplierAddressName
    • Status

    Site Assignments

    • AssignmentId
    • ClientBUId
    • ClientBU
    • BillToBUId
    • BillToBU
    • ShipToLocationId
    • ShipToLocation
    • BillToLocationId
    • BillToLocation
    • UseWithholdingTaxFlag
    • WithholdingTaxGroupId
    • WithholdingTaxGroup
    • ChartOfAccountsId
    • LiabilityDistributionId
    • PrepaymentDistributionId
    • BillPayableDistributionId
    • DistributionSetId
    • DistributionSet
    • InactiveDate
    • Status

    Business Classifications

    • ClassificationId
    • ClassificationCode
    • Classification
    • SubclassificationCode
    • Subclassification
    • Status
    • CertifyingAgencyId
    • CertifyingAgency
    • OtherCertifyingAgency
    • CertificateNumber
    • CertificateStartDate
    • CertificateExpirationDate
    • Notes
    • ProvidedByUserFirstName
    • ProvidedByUserLastName
    • ConfirmedOnDate

    Products & Services

    • SupplierProductsServicesId
    • ProductsServicesCategoryId
    • CategoryName
    • CategoryDescription
    • CategoryType

    Attachments

    • AttachedDocumentId
    • LastUpdateDate
    • LastUpdatedBy
    • DatatypeCode
    • FileName
    • DmFolderPath
    • Url
    • CategoryName
    • UserName
    • Uri
    • FileUrl
    • UploadedText
    • UploadedFileContentType
    • UploadedFileLength
    • UploadedFileName
    • ContentRepositoryFileShared
    • Title
    • Description
    • ErrorStatusCode
    • ErrorStatusMessage
    • CreatedBy
    • CreationDate
    • FileContents
    • ExpirationDate
    • LastUpdatedByUserName
    • CreatedByUserName

    Refer to the documentation links below for using GET method for REST service & Supplier REST service API:

    https://docs.oracle.com/en/cloud/saas/procurement/19a/fapra/Resource_Methods.html

    https://docs.oracle.com/en/cloud/saas/procurement/19a/fapra/api-suppliers.html

    Comment

     

    • Niamath Jeddy

      Thanks for sharing Hong.

      Would it be a good idea to have this included in the specific REST service documentation? That way anyone referencing the documentation will be aware of it and leverage.

       

      Regards,

      Niamath