Free cookie consent management tool by TermsFeed

USASpending Integration

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

Award Management integrates with USASpending.gov to keep award records up to date with the most recent federal spending data. The base URL endpoint used by the solution is https://api.usaspending.gov/api/.

This page describes the API endpoints, field mappings, and nightly sync process that keep Award Management synchronized with USASpending.gov.

API endpoints

Award Management uses three USASpending.gov API endpoints to update award records:

API endpoint Appian integration object
v2/search/spending_by_award/ AS_AM_SearchSpendingByAward
v2/awards/ AS_AM_GetAwardFromUSASpending
v2/transactions/ AS_AM_GetModificationNumberFromUSASpending

The AS_AM_CDT_mapDataFromUSASpendToAward expression rule calls these APIs and updates the award record with the returned data.

Field mappings

The following table lists the USASpending API fields that Award Management extracts and the corresponding award record fields they populate:

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/ fundingInformation.potentialAwardAmount 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_data.naics
v2/awards/ naicsCodeDescription latest_transaction_contract_data.naics_description
v2/awards/ pscCode latest_transaction_contract_data.product_or_service_code
v2/awards/ pscCodeDescription latest_transaction_contract_data.product_or_service_description
v2/awards/ awardType type

* Funds Left is a calculated field. Award Management derives it by subtracting the award's invoiced amount from the total_obligation value returned by USASpending.gov.

Nightly sync

Award Management runs a nightly process to sync with USASpending.gov and update awards that changed in USASpending in the last day.

The AS AM Nightly Sync For USA Spending process model uses the v2/search/spending_by_award/ endpoint via the AS_AM_SearchSpendingByAwardForNightlySync integration to retrieve recently updated data. It then queries the AS_AM_AWARD table by PIID to match and update the corresponding award records.

Vendor data handling after vendor migration

In AM 2.6 and later, the USASpending sync integrates with Acquisition Central's unified vendor data model after the vendor data migration is complete. Acquisition Central (GSM) replaces the legacy AM vendor registry as the authoritative source for vendor identity. The per-award transactional vendor record continues to store award-specific vendor data such as address and CAGE code.

How the sync identifies vendors

The USASpending sync determines whether a vendor already exists in Acquisition Central by matching on the exact combination of UEI and CAGE code from USASpending.gov against existing Acquisition Central vendor records. Both values must match exactly for a positive match, including null values:

  • UEI match + CAGE match: The sync identifies an existing Acquisition Central vendor.
  • UEI match + CAGE mismatch: No match. A null CAGE is treated as a distinct value representing the corporate entity generically, not as a wildcard.

The following table illustrates the match logic:

Incoming UEI Incoming CAGE Existing AC UEI Existing AC CAGE Result
1234 null 1234 null Match
1234 null 1234 5678 No match
1234 5678 1234 5678 Match
1234 5678 1234 null No match
1234 9999 1234 5678 No match

Sync scenarios after vendor migration

The USASpending sync only processes awards that already exist in AM. The sync does not create new award records. Three scenarios determine how vendor data is handled:

Scenario 1: No match in Acquisition Central

When the UEI + CAGE combination from USASpending.gov does not match any existing Acquisition Central vendor, the sync:

  1. Creates a new vendor record in Acquisition Central with the USASpending.gov vendor data.
  2. Updates the existing per-award vendor record with the USASpending.gov vendor data.
  3. Links the award to the newly created Acquisition Central vendor.

Scenario 2: Match found, same vendor as currently linked

When the UEI + CAGE combination matches an Acquisition Central vendor that is already linked to the award, the sync:

  1. Updates the existing per-award vendor record with all vendor data from USASpending.gov, including name, address, CAGE, and UEI.
  2. Does not modify the Acquisition Central vendor record. SAM.gov is the authoritative source for Acquisition Central vendor data.
  3. The award's link to the Acquisition Central vendor remains unchanged.

Scenario 3: Match found, different vendor than currently linked

When the UEI + CAGE combination matches an Acquisition Central vendor that is different from the one currently linked to the award, the sync:

  1. Updates the existing per-award vendor record with all vendor data from USASpending.gov.
  2. Relinks the award to the correct Acquisition Central vendor matching the incoming UEI + CAGE.
  3. Does not modify either Acquisition Central vendor record.

Note:  Scenario 3 preserves existing behavior where USASpending data changes the vendor on an award due to contract novation, error correction, or corporate restructuring. The only new element is relinking the Acquisition Central vendor reference to stay consistent with the updated vendor data.

Data preserved during sync

The USASpending sync preserves the following data on the per-award vendor record:

  • Vendor POC: USASpending.gov does not provide point-of-contact information. The existing POC value on the per-award vendor record is preserved during all sync updates.

Deprecated components

The following components are deprecated in AM 2.6 and no longer used by the USASpending sync after vendor migration:

  • AS AM Update Ref Vendor From USA Spend process model.
  • AS_AM_UT_updateRefVendorDetailsFromUSASpending expression rule.
  • AS_AM_UT_updateRuntimeVendorDetailsAfterUsaSpendSync expression rule. Replaced with new logic that writes directly to the per-award vendor record and performs the Acquisition Central vendor lookup.

Feedback