URL Expired

The URL for this request expired after 30 days.

200 The requested party group collection

object

atfLicenseExpiration

array

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

atfLicenseNumber

array

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

carrierRegistrationHazMatNumber

array

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

carrierRegistrationNumber

array

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

carrierScac

array

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

carrierTransMethodCode

array

Text field for the carriers transfer method code. Allowed value codes are "C" (Consolidated Freight), "M" (Motor (Common Carrier)), "P" (Vendor owned trucking), and "U" (Private Parcel Service). Visible only for carriers. Read and write.

connectionRelationUrlList

array

contactMechList

array

List of contact mechanisms as defined under resource patterns.

contentList

array

createdDate

array

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

description

array

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

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

guiOptions

array

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

hazMatContactTel

array

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

array

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

array

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

logisticsBillingPricePerProduct

array

Numeric field for the Logistics billing price per product. Visible by default for customers, suppliers, and the PRIMARY partygroup, but can be hidden from application settings. Read and write.

logisticsBillingPricePerProductFormula

array

Text field for the Logistics billing price per product formula. Visible by default for customers, suppliers, and the PRIMARY partygroup, but can be hidden from application settings. Read and write.

logisticsBillingPricePerShipment

array

Numeric field for the Logistics billing price per shipment. Visible by default for customers, suppliers, and the PRIMARY partygroup, but can be hidden from application settings. Read and write.

logisticsBillingPricePerUnit

array

Numeric field for the logistics billing price per unit. Visible by default for customers, suppliers, and the PRIMARY partygroup, but can be hidden from application settings. Read and write.

parentPartyUrl

array

partyTypeId

array

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

array

Primary key for the product resource. Read only

partyUrlList

array

productPriceTypeId

array

Used only with customers. Default price level used when selecting this customer on a sales order.

productStoreUrlList

array

roleTypeIdList

array

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.

saleSourceId

array

Default sale source used when selecting a customer on a sales order.

settlementTermId

array

Used only with customers. Default settlement terms used when selecting this customer on a sales order e.g. COD or Net 15). Must match settlementTermId from the settlementTermList in the customization service

statusId

array

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

systemOfMeasure

array

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

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'} ]

Base URL

https://app.finaleinventory.com/account/api/partygroup

xxxxxxxxxx

curl --request GET \
     --url https://app.finaleinventory.com/account/api/partygroup \
     --header 'accept: application/json' \
     --header 'authorization: Basic ••••'

xxxxxxxxxx

{

"atfLicenseExpiration": [],

"atfLicenseNumber": [],

"carrierRegistrationHazMatNumber": [],

"carrierRegistrationNumber": [],

"carrierScac": [],

"carrierTransMethodCode": [],

"connectionRelationUrlList": [],

"contactMechList": [],

"contentList": [],

"createdDate": [],

"description": [],

"glAccountList": [],

"guiOptions": [],

"hazMatContactTel": [],

"hazMatContractNumber": [],

"lastUpdatedDate": [],

"logisticsBillingPricePerProduct": [],

"logisticsBillingPricePerProductFormula": [],

"logisticsBillingPricePerShipment": [],

"logisticsBillingPricePerUnit": [],

"parentPartyUrl": [],

"partyTypeId": [],

"partyUrl": [],

"partyUrlList": [],

"productPriceTypeId": [],

"productStoreUrlList": [],

"roleTypeIdList": [],

"saleSourceId": [],

"settlementTermId": [],

"statusId": [],

"systemOfMeasure": [],

"userFieldDataList": []

}