Party Group

Please refer to the API documentation section for the most up-to-date information
https://developer.finaleinventory.com/reference/start

--

The party group resource represents that people and organizations that interact with Finale Inventory: customers, suppliers, carriers, and company using Finale.

The company using Finale is represented by a party group with the well known value for the partyId field of PRIMARY. The information for this partygroup is display in application settings under the company info tab.

The other party groups have values for the partyId field assigned at creation and are distinguished by the values in the roleTypeIdList field. Party groups with SUPPLIER in the roleTypeIdList are displayed on the suppliers screen. Party groups with CUSTOMER in the roleTypeIdList are displayed on the customers screen. Party groups with CARRIER in the roleTypeIdList are displayed in Application Settings, under the Selling tab, on the Shipping sub-tab.

Fields for the party group service.

• atfLicenseExpiration

  Text field for the ATF license expiration limited to 255 Unicode characters. Visible by default for customers, suppliers, and the PRIMARY partygroup, but can hidden from application settings. Read and write.

• atfLicenseNumber

  Text field for the ATF license number limited to 255 Unicode characters. Visible by default for customers, suppliers, and the PRIMARY partygroup, but can hidden from application settings. Read and write.

• carrierRegistrationHazMatNumber

  Text field for the carriers hazardous material registration number limited to 255 Unicode characters. Visible only for carriers. Read and write.

• carrierRegistrationNumber

  Text field for the carriers registration number limited to 255 Unicode characters. Visible only for carriers. Read and write.

• carrierScac

  Text field for the carriers SCAC code limited to 255 Unicode characters. Visible only for carriers. Read and write.

• contactMechList

  List of contact mechanisms as defined under resource patterns.

• contentList

• createdDate

  Timestamp object was created. Set automatically by the server. Read only.

• description

  Text field for notes on the party group. No hard length limit, but it is always downloaded to the browser. Visible for customers and suppliers. Read and write.

• glAccountList

  Array of values for general ledger accounts for the party group.

• groupName

  Text field for the name of the party group limited to 100 Unicode characters. Visible for all party types. Read and write.

• guiOptions

  Used only for the PRIMARY party group to hold preferences specified in application settings. Preferences format is not documented and may change.

• hazMatContactTel

  Text field for the hazardous material contact telephone number limited to 255 Unicode characters. Visible by default for only for the PRIMARY partygroup, but can displayed for customers and suppliers from application settings. Read and write.

• hazMatContractNumber

  Text field for the hazardous material contact contract number limited to 255 Unicode characters. Visible by default for only for the PRIMARY partygroup, but can displayed for customers and suppliers from application settings. Read and write.

• lastUpdatedDate

  Timestamp object was last modified. Set automatically by the server. Read only.

• partyTypeId

  The type of party. Currently always returns the value PARTY_GROUP, but may contain other values in the future (for example PERSON to represent an individual as opposed to an organization). Read only.

• partyUrl

  Primary key for the product resource. Read only

• roleTypeIdList

  List of roles for the party group. Currently Finale expects this to be an array with a single role, but in the future there may be multiple roles in the list. The role or roles in the list must be one of the following values CUSTOMER, SUPPLIER, or CARRIER. There may be other roles defined in the future, for example USER for the personal information corresponding to a user account on the system. The PRIMARY partygroup has a null value for roleTypeIdList.

• statusId

  Status of the product. Must by one of the following values: PARTY_ENABLED or PARTY_DISABLED. Read and write.

• systemOfMeasure

  User only for the PRIMARY party group to hold the system of measure (English or Metric). Null means English and SI means metric. Other values not allowed.

• userFieldDataList

  Array of values for user defined fields on the Party. Each value in the array is an object with the keys attrName and attrValue. The attrName is the internal name of a user defined field as listed in the customization service. Other systems integrating with Finale can store information in the userFieldDataList. Other systems should prefix their attrName with the string "integration_" to avoid conflicting with keys created by Finale. The attrValue is the string representation of the value for this Party for the user defined field. Both are limited to 255 Unicode characters. To make tracking and syncing changes to other systems, the field attrValueLastUpdatedDate be set instead of the field attrValue. When attrValue is not set and attrValueLastUpdatedDate is set to true, then the server sets the value to same value as the lastUpdatedDate. This allows easy searching for entities that have been updated since the last time they were synced to an external system.

  Example:

  userFieldDataList:[ {attrName:'user_10000', attrValue:'7/2/2010'}, {attrName:'integration_10004', attrValue:'3/12/2011'} ]