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.

Before After
/externalcustomers /externalCustomers
/salesitems /salesItems
/customerinvoices /customerInvoices
/catalogitems /catalogItems

 

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


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