Free cookie consent management tool by TermsFeed

Modifying USASpending

This content applies solely to Award Management, which must be purchased separately from the Appian base platform. This content was written for Appian 24.2 and may not reflect the interfaces or functionality of other Appian versions.

USASpending APIs

Introduction

This page outlines how AM integrates with USASpending.gov and how it allows the solution to reflect the most recent data available.

The base URL endpoint used by the solution is https://api.usaspending.gov/api/. Additional documentation for these APIs can be found here.

USASpending.gov API Endpoints

AM utilizes three APIs to update the award record. The table below lists each USASpending.gov API endpoint and the corresponding Appian object that it's referenced in.

API Endpoint Appian Object
v2/search/spending_by_award/ AS_AM_SearchSpendingByAward
v2/awards/ AS_AM_GetAwardFromUSASpending
v2/transactions/ AS_AM_GetModificationNumberFromUSASpending

The expression rule AS_AM_CDT_mapDataFromUSASpendToAward is used to call these USASpending APIs and will update the award record. Currently, AM extracts the following API fields in order to update the appropriate award record fields:

USASpending API Award Field API Field
v2/search/spending_by_award/ generatedAwardId generated_internal_id
v2/search/spending_by_award/ agencyName Awarding Agency
v2/awards/ awardingOffice awarding_agency.office_agency_name
v2/awards/ fundingOffice funding_agency.office_agency_name
v2/search/spending_by_award/ awardDescription Description
v2/search/spending_by_award/ vendor.vendorName Recipient Name
v2/awards/ vendor.vendorAddress.vendorAddress1 recipient.location.address_line1
v2/awards/ vendor.vendorAddress.vendorAddress2 recipient.location.address_line2
v2/awards/ vendor.vendorAddress.vendorCity recipient.location.city_name
v2/awards/ vendor.vendorAddress.vendorState recipient.location.state_name
v2/awards/ vendor.vendorAddress.vendorCountry recipient.location.country_name
v2/awards/ vendor.vendorAddress.vendorZipCode recipient.location.zip4
v2/awards/ vendor.vendorAddress.vendorZipCodeExt recipient.location.zip5
v2/awards/ vendor.vendorAddress.vendorForeignPostalCode recipient.location.foreign_postal_code
v2/search/spending_by_award/ vendor.dun Recipient DUNS Number
v2/awards/ fundingInformation.obligatedAmount total_obligation
v2/awards/ fundingInformation.currentAwardAmount base_exercised_options
v2/awards/ fundingInformationpotentialAwardAmount base_and_all_options
v2/awards/ fundingInformation.fundsLeft total_obligation*
v2/awards/ fundingInformation.fundingAgency funding_agency.toptier_agency.name
v2/awards/ fundingInformation.awardingAgency awarding_agency.toptier_agency.name
v2/awards/ keyDates.contractStartDate period_of_performance.start_date
v2/awards/ keyDates.currentEndDate period_of_performance.end_date
v2/awards/ keyDates.potentialEndDate period_of_performance.potential_end_date
v2/transactions/ modificationInformation.awardModificationNumber modification_number
v2/awards/ naicsCode latest_transaction_contract_date.naics
v2/awards/ naicsCodeDescription latest_transaction_contract_date.naics_description
v2/awards/ pscCode latest_transaction_contract_date.product_or_service_code
v2/awards/ pscCodeDescription latest_transaction_contract_date.product_or_service_description
awards awardType type

USASpending Nightly Sync

AM offers a nightly process to sync with USASpend and update awards changed in USASpending in the last day.

This process model is AS AM Nightly Sync. This process uses the USASpending's API v2/search/spending_by_award/ in the Appian integration AS_AM_SearchSpendingByAwardForNightlySync to retrieve the data that has been updated in USASpending in the last day. We extract all the corresponding awards by querying the AS_AM_AWARD table based on PIID.

Feedback