University of Wisconsin–Madison

Naming convention update migration guide

The Finance API is standardizing all our naming conventions, which had wandered a bit. All endpoints, attribute names, and filters will now use camel case when combining multiple words. Users of the Finance API will need to update their integrations to recognize the new names.

Details of the elements whose names will change are in the tables below. If you prefer the command line, the same data is also formatted for easy find & replace below the tables.

BeforeAfter
/externalcustomers/externalCustomers
/salesitems/salesItems
/customerinvoices/customerInvoices
/catalogitems/catalogItems

 

ResourceBeforeAfter
externalCustomersaddress_line_1addressLine1
externalCustomersaddress_line_2addressLine2
externalCustomersaddress_line_3addressLine3
externalCustomersstate_codestateCode
externalCustomerscountry_codecountryCode
externalCustomersaddress_idaddressId
externalCustomersaddress_usageaddressUsage
salesItemsgroup_itemgroupItem
salesItemsgroup_reference_idgroupReferenceId
salesItemsunit_priceunitPrice
customerInvoicesamount_dueamountDue
customerInvoicesbill_to_contact_cust_invoice_docbillToContactCustInvoiceDoc
customerInvoicescustomer_bill_to_addresscustomerBillToAddress
customerInvoicesdue_datedueDate
customerInvoicesinvoice_dateinvoiceDate
customerInvoicesnet_invoice_amountnetInvoiceAmount
customerInvoicespayment_termspaymentTerms
customerInvoicestax_amounttaxAmount
customerInvoicestotal_invoice_amounttotalInvoiceAmount
catalogItemsref_idrefId
catalogItemscatalog_itemcatalogItem
catalogItemsitem_descriptionitemDescription
catalogItemsitem_nameitemName
catalogItemsresource_providerresourceProvider
catalogItemsunit_of_measureunitOfMeasure
catalogItemsuom_edi_code_iduomEdiCodeId
hierarchiesparent_idparentId
hierarchiesstart_datestartDate
isdsprovider_idproviderId
isdsline_numberlineNumber
isdsspend_categoryspendCategory
isdsunit_costunitCost
isdsextended_amountextendedAmount
isdsline_datelineDate
isdsexpenditure_treatmentexpenditureTreatment
sponsorsname_uppernameUpper
sponsorssponsor_date_addedsponsorDateAdded
sponsorssponsor_status_codesponsorStatusCode
sponsorssponsor_typesponsorType
sponsorssponsor_type_codesponsorTypeCode
sponsorssponsor_frn_flagsponsorFrnFlag
sponsorssponsor_wisc_flagsponsorWiscFlag
sponsorssponsor_address1sponsorAddress1
sponsorssponsor_citysponsorCity
sponsorssponsor_status_codesponsorState
sponsorssponsor_state_codesponsorStateCode
sponsorssponsor_zip_codesponsorZipCode
sponsorssponsor_countrysponsorCountry


s/externalcustomers/externalCustomers/g
s/salesitems/salesItems/g
s/customerinvoices/customerInvoices/g
s/catalogitems/catalogItems/g
s/address_line_1/addressLine1/g
s/address_line_2/addressLine2/g
s/address_line_3/addressLine3/g
s/state_code/stateCode/g
s/country_code/countryCode/g
s/address_id/addressId/g
s/address_usage/addressUsage/g
s/group_item/groupItem/g
s/group_reference_id/groupReferenceId/g
s/unit_price/unitPrice/g
s/amount_due/amountDue/g
s/bill_to_contact_cust_invoice_doc/billToContactCustInvoiceDoc/g
s/customer_bill_to_address/customerBillToAddress/g
s/due_date/dueDate/g
s/invoice_date/invoiceDate/g
s/net_invoice_amount/netInvoiceAmount/g
s/payment_terms/paymentTerms/g
s/tax_amount/taxAmount/g
s/total_invoice_amount/totalInvoiceAmount/g
s/ref_id/refId/g
s/catalog_item/catalogItem/g
s/item_description/itemDescription/g
s/item_name/itemName/g
s/resource_provider/resourceProvider/g
s/unit_of_measure/unitOfMeasure/g
s/uom_edi_code_id/uomEdiCodeId/g
s/parent_id/parentId/g
s/start_date/startDate/g
s/provider_id/providerId/g
s/line_number/lineNumber/g
s/spend_category/spendCategory/g
s/unit_cost/unitCost/g
s/extended_amount/extendedAmount/g
s/line_date/lineDate/g
s/expenditure_treatment/expenditureTreatment/g
s/name_upper/nameUpper/g
s/sponsor_date_added/sponsorDateAdded/g
s/sponsor_status_code/sponsorStatusCode/g
s/sponsor_type/sponsorType/g
s/sponsor_type_code/sponsorTypeCode/g
s/sponsor_frn_flag/sponsorFrnFlag/g
s/sponsor_wisc_flag/sponsorWiscFlag/g
s/sponsor_address1/sponsorAddress1/g
s/sponsor_city/sponsorCity/g
s/sponsor_status_code/sponsorState/g
s/sponsor_state_code/sponsorStateCode/g
s/sponsor_zip_code/sponsorZipCode/g
s/sponsor_country/sponsorCountry/g