Jump to

• Request
• Response

Create a set of cross reference data

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/CustomerCrossReference

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address1: string
  Title: First Address Line

  Maximum Length: 240
• Address2: string
  Title: Second Address Line

  Maximum Length: 240
• Address3: string
  Title: Third Address Line

  Maximum Length: 240
• Address4: string
  Title: Fourth Address Line

  Maximum Length: 240
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1
• BillToFlag: string
  Title: Bill-To Mark

  Maximum Length: 1
• CallingMode: string
  Maximum Length: 80
• City: string
  Title: City

  Maximum Length: 60
• Classification: string
  Title: Classification

  Maximum Length: 3
• ContactAddress1: string
  Title: First Address Line

  Maximum Length: 240
• ContactAddress2: string
  Title: Second Address Line

  Maximum Length: 240
• ContactAddress3: string
  Title: Third Address Line

  Maximum Length: 240
• ContactAddress4: string
  Title: Fourth Address Line

  Maximum Length: 240
• ContactCity: string
  Title: City

  Maximum Length: 60
• ContactCountry: string
  Title: Country

  Maximum Length: 3
• ContactCounty: string
  Title: County

  Maximum Length: 60
• ContactEmailAddress: string
  Title: Email Address

  Maximum Length: 150
• ContactEmailAddress1: string
  Title: Email Address

  Maximum Length: 150
• ContactFirstName: string
  Maximum Length: 150
• ContactId: integer (int64)
  Title: Contact ID
• ContactLastName: string
  Maximum Length: 150
• ContactMiddleName: string
  Maximum Length: 60
• ContactNameSuffix: string
  Maximum Length: 30
• ContactPartyId: integer (int64)
• ContactPersonTitle: string
  Maximum Length: 60
• ContactPhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 10
• ContactPhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10
• ContactPhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20
• ContactPhoneNumber: string
  Title: Phone Number

  Maximum Length: 40
• ContactPhoneType: string
  Title: Phone Type

  Maximum Length: 30
• ContactPostalCode: string
  Title: Postal Code

  Maximum Length: 60
• ContactPostalPlus4Code: string
  Title: Postal Plus4 Code

  Maximum Length: 10
• ContactProvince: string
  Maximum Length: 60
• ContactRawPhoneNumber: string
  Title: Raw Phone Number

  Maximum Length: 60
• ContactState: string
  Title: State

  Maximum Length: 60
• ContactTypeCd: string
  Title: Contact Type Code

  Maximum Length: 30
• Country: string
  Title: Country

  Maximum Length: 3
• County: string
  Title: County

  Maximum Length: 60
• CustAccountId: integer (int64)
  Title: Customer Account ID
• CustAccountName: string
  Title: Account Name

  Maximum Length: 240
• CustAccountNumber: string
  Title: Customer Account Number

  Maximum Length: 30
• CustAcctChoice: string
  Title: Customer Account Choice

  Maximum Length: 30
• CustAcctSiteId: integer (int64)
  Title: Customer Account Site ID
• CustAcctVerificationStatus: string
  Title: Customer Account Verification Status

  Maximum Length: 30
• CustPartyId: integer (int64)
  Title: Party ID
• CustPartyNumber: string
  Title: Party Number

  Maximum Length: 30
• CustPartyTypeCd: string
  Title: Party Type Code

  Maximum Length: 30
• CustSiteUseId: integer (int64)
  Title: Site Use ID
• DunsNumberC: string
  Title: D-U-N-S Number

  Maximum Length: 30
• DuplicateCheckDoneFlag: string
  Title: Duplicate Check Mark

  Maximum Length: 1
• DuplicateCheckOption: string
  Title: Duplicate Check Option

  Maximum Length: 30
• EstablishedDate: string (date)
  Title: Established Date
• InvoiceSystemCd: string
  Title: Invoice System Code

  Maximum Length: 30
• JgzzFiscalCode: string
  Title: Taxpayer Identifier

  Maximum Length: 20
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50
• LnpRecordKey: integer (int64)
  Title: Record Key
• LocationId: integer (int64)
  Title: Location ID
• MatchFoundFlag: string
  Title: Match Found Flag

  Maximum Length: 1
• MigratedDataFlag: string
  Title: Migrated Data Check

  Maximum Length: 3
• NameSuffix: string
  Title: Name Suffix

  Maximum Length: 30
• PartyFirstName: string
  Title: Party First Name

  Maximum Length: 150
• PartyLastName: string
  Title: Party Last Name

  Maximum Length: 150
• PartyMiddleName: string
  Title: Party Middle Name

  Maximum Length: 60
• PartyName: string
  Title: Party Name

  Maximum Length: 360
• PartySiteId: integer (int64)
• PartySiteName: string
  Title: Party Site Name

  Maximum Length: 240
• PersonTitle: string
  Title: Person Title

  Maximum Length: 60
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60
• PostalPlus4Code: string
  Title: Postal Plus4 Code

  Maximum Length: 10
• ProfileClassName: string
  Maximum Length: 30
• Province: string
  Title: Province

  Maximum Length: 60
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 50
• SameBusEntityFlag: string
  Title: Same as business entity

  Maximum Length: 1
• SameMailAddressFlag: string
  Title: Same as business mailing address

  Maximum Length: 1
• SetName: string
  Title: Set Name

  Maximum Length: 80
• State: string
  Title: State

  Maximum Length: 60
• StatusFlag: string
  Title: Status

  Maximum Length: 1
• TerminationDate: string (date)
  Title: Termination Date
• TrxnCustXrefId: string
  Maximum Length: 50
• TrxnCustXrefKey: integer (int64)
• TrxnCustXrefPuid: string
  Maximum Length: 480

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"First Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "Address2":{
            "title":"Second Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "Address3":{
            "title":"Third Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "Address4":{
            "title":"Fourth Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "BillToFlag":{
            "title":"Bill-To Mark",
            "maxLength":1,
            "type":"string",
            "nullable":false
        },
        "CallingMode":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "nullable":false
        },
        "ContactAddress1":{
            "title":"First Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "ContactAddress2":{
            "title":"Second Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "ContactAddress3":{
            "title":"Third Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "ContactAddress4":{
            "title":"Fourth Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "ContactCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactCountry":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "ContactCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactEmailAddress":{
            "title":"Email Address",
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "ContactEmailAddress1":{
            "title":"Email Address",
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "ContactFirstName":{
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactLastName":{
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "ContactMiddleName":{
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactNameSuffix":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactPersonTitle":{
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactPhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "ContactPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "ContactPhoneExtension":{
            "title":"Phone Extension",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "ContactPhoneNumber":{
            "title":"Phone Number",
            "maxLength":40,
            "type":"string",
            "nullable":true
        },
        "ContactPhoneType":{
            "title":"Phone Type",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "ContactPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactPostalPlus4Code":{
            "title":"Postal Plus4 Code",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "ContactProvince":{
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactRawPhoneNumber":{
            "title":"Raw Phone Number",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "ContactTypeCd":{
            "title":"Contact Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "CustAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustAccountName":{
            "title":"Account Name",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "CustAccountNumber":{
            "title":"Customer Account Number",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "CustAcctChoice":{
            "title":"Customer Account Choice",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "CustAcctSiteId":{
            "title":"Customer Account Site ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustAcctVerificationStatus":{
            "title":"Customer Account Verification Status",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "CustPartyId":{
            "title":"Party ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustPartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "CustPartyTypeCd":{
            "title":"Party Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "CustSiteUseId":{
            "title":"Site Use ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DunsNumberC":{
            "title":"D-U-N-S Number",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "DuplicateCheckDoneFlag":{
            "title":"Duplicate Check Mark",
            "maxLength":1,
            "type":"string",
            "nullable":false
        },
        "DuplicateCheckOption":{
            "title":"Duplicate Check Option",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "EstablishedDate":{
            "title":"Established Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "InvoiceSystemCd":{
            "title":"Invoice System Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "JgzzFiscalCode":{
            "title":"Taxpayer Identifier",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "LnpRecordKey":{
            "title":"Record Key",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MatchFoundFlag":{
            "title":"Match Found Flag",
            "maxLength":1,
            "type":"string",
            "nullable":false
        },
        "MigratedDataFlag":{
            "title":"Migrated Data Check",
            "maxLength":3,
            "type":"string",
            "nullable":false
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "PartyFirstName":{
            "title":"Party First Name",
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "PartyLastName":{
            "title":"Party Last Name",
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "PartyMiddleName":{
            "title":"Party Middle Name",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "nullable":true
        },
        "PartySiteId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartySiteName":{
            "title":"Party Site Name",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "PersonTitle":{
            "title":"Person Title",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus4 Code",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "ProfileClassName":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "SameBusEntityFlag":{
            "title":"Same as business entity",
            "maxLength":1,
            "type":"string",
            "nullable":true
        },
        "SameMailAddressFlag":{
            "title":"Same as business mailing address",
            "maxLength":1,
            "type":"string",
            "nullable":true
        },
        "SetName":{
            "title":"Set Name",
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "StatusFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "nullable":false
        },
        "TerminationDate":{
            "title":"Termination Date",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "TrxnCustXrefId":{
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "TrxnCustXrefKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TrxnCustXrefPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorRecords-CustomerCrossReference-item-response

Type: object

Show Source

• Address1: string
  Title: First Address Line

  Maximum Length: 240
• Address2: string
  Title: Second Address Line

  Maximum Length: 240
• Address3: string
  Title: Third Address Line

  Maximum Length: 240
• Address4: string
  Title: Fourth Address Line

  Maximum Length: 240
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1
• BillToFlag: string
  Title: Bill-To Mark

  Maximum Length: 1
• CallingMode: string
  Maximum Length: 80
• City: string
  Title: City

  Maximum Length: 60
• Classification: string
  Title: Classification

  Maximum Length: 3
• ContactAddress1: string
  Title: First Address Line

  Maximum Length: 240
• ContactAddress2: string
  Title: Second Address Line

  Maximum Length: 240
• ContactAddress3: string
  Title: Third Address Line

  Maximum Length: 240
• ContactAddress4: string
  Title: Fourth Address Line

  Maximum Length: 240
• ContactCity: string
  Title: City

  Maximum Length: 60
• ContactCountry: string
  Title: Country

  Maximum Length: 3
• ContactCounty: string
  Title: County

  Maximum Length: 60
• ContactEmailAddress: string
  Title: Email Address

  Maximum Length: 150
• ContactEmailAddress1: string
  Title: Email Address

  Maximum Length: 150
• ContactFirstName: string
  Maximum Length: 150
• ContactId: integer (int64)
  Title: Contact ID
• ContactLastName: string
  Maximum Length: 150
• ContactMiddleName: string
  Maximum Length: 60
• ContactNameSuffix: string
  Maximum Length: 30
• ContactPartyId: integer (int64)
• ContactPersonTitle: string
  Maximum Length: 60
• ContactPhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 10
• ContactPhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10
• ContactPhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20
• ContactPhoneNumber: string
  Title: Phone Number

  Maximum Length: 40
• ContactPhoneType: string
  Title: Phone Type

  Maximum Length: 30
• ContactPostalCode: string
  Title: Postal Code

  Maximum Length: 60
• ContactPostalPlus4Code: string
  Title: Postal Plus4 Code

  Maximum Length: 10
• ContactProvince: string
  Maximum Length: 60
• ContactRawPhoneNumber: string
  Title: Raw Phone Number

  Maximum Length: 60
• ContactState: string
  Title: State

  Maximum Length: 60
• ContactTypeCd: string
  Title: Contact Type Code

  Maximum Length: 30
• Country: string
  Title: Country

  Maximum Length: 3
• County: string
  Title: County

  Maximum Length: 60
• CustAccountId: integer (int64)
  Title: Customer Account ID
• CustAccountName: string
  Title: Account Name

  Maximum Length: 240
• CustAccountNumber: string
  Title: Customer Account Number

  Maximum Length: 30
• CustAcctChoice: string
  Title: Customer Account Choice

  Maximum Length: 30
• CustAcctSiteId: integer (int64)
  Title: Customer Account Site ID
• CustAcctVerificationStatus: string
  Title: Customer Account Verification Status

  Maximum Length: 30
• CustPartyId: integer (int64)
  Title: Party ID
• CustPartyNumber: string
  Title: Party Number

  Maximum Length: 30
• CustPartyTypeCd: string
  Title: Party Type Code

  Maximum Length: 30
• CustSiteUseId: integer (int64)
  Title: Site Use ID
• DunsNumberC: string
  Title: D-U-N-S Number

  Maximum Length: 30
• DuplicateCheckDoneFlag: string
  Title: Duplicate Check Mark

  Maximum Length: 1
• DuplicateCheckOption: string
  Title: Duplicate Check Option

  Maximum Length: 30
• EstablishedDate: string (date)
  Title: Established Date
• InvoiceSystemCd: string
  Title: Invoice System Code

  Maximum Length: 30
• JgzzFiscalCode: string
  Title: Taxpayer Identifier

  Maximum Length: 20
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50
• LnpRecordKey: integer (int64)
  Title: Record Key
• LocationId: integer (int64)
  Title: Location ID
• MatchFoundFlag: string
  Title: Match Found Flag

  Maximum Length: 1
• MigratedDataFlag: string
  Title: Migrated Data Check

  Maximum Length: 3
• NameSuffix: string
  Title: Name Suffix

  Maximum Length: 30
• PartyFirstName: string
  Title: Party First Name

  Maximum Length: 150
• PartyLastName: string
  Title: Party Last Name

  Maximum Length: 150
• PartyMiddleName: string
  Title: Party Middle Name

  Maximum Length: 60
• PartyName: string
  Title: Party Name

  Maximum Length: 360
• PartySiteId: integer (int64)
• PartySiteName: string
  Title: Party Site Name

  Maximum Length: 240
• PersonTitle: string
  Title: Person Title

  Maximum Length: 60
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60
• PostalPlus4Code: string
  Title: Postal Plus4 Code

  Maximum Length: 10
• ProfileClassName: string
  Maximum Length: 30
• Province: string
  Title: Province

  Maximum Length: 60
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 50
• SameBusEntityFlag: string
  Title: Same as business entity

  Maximum Length: 1
• SameMailAddressFlag: string
  Title: Same as business mailing address

  Maximum Length: 1
• SetName: string
  Title: Set Name

  Maximum Length: 80
• State: string
  Title: State

  Maximum Length: 60
• StatusFlag: string
  Title: Status

  Maximum Length: 1
• TerminationDate: string (date)
  Title: Termination Date
• TrxnCustXrefId: string
  Maximum Length: 50
• TrxnCustXrefKey: integer (int64)
• TrxnCustXrefPuid: string
  Maximum Length: 480

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"First Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Second Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Third Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Fourth Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "BillToFlag":{
            "title":"Bill-To Mark",
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CallingMode":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ContactAddress1":{
            "title":"First Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress2":{
            "title":"Second Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress3":{
            "title":"Third Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress4":{
            "title":"Fourth Address Line",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactCountry":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Email Address",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmailAddress1":{
            "title":"Email Address",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactFirstName":{
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPersonTitle":{
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneExtension":{
            "title":"Phone Extension",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneNumber":{
            "title":"Phone Number",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneType":{
            "title":"Phone Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPostalPlus4Code":{
            "title":"Postal Plus4 Code",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactProvince":{
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactRawPhoneNumber":{
            "title":"Raw Phone Number",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeCd":{
            "title":"Contact Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CustAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustAccountName":{
            "title":"Account Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CustAccountNumber":{
            "title":"Customer Account Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CustAcctChoice":{
            "title":"Customer Account Choice",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CustAcctSiteId":{
            "title":"Customer Account Site ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustAcctVerificationStatus":{
            "title":"Customer Account Verification Status",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CustPartyId":{
            "title":"Party ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustPartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CustPartyTypeCd":{
            "title":"Party Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CustSiteUseId":{
            "title":"Site Use ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DunsNumberC":{
            "title":"D-U-N-S Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "DuplicateCheckDoneFlag":{
            "title":"Duplicate Check Mark",
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "DuplicateCheckOption":{
            "title":"Duplicate Check Option",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "EstablishedDate":{
            "title":"Established Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceSystemCd":{
            "title":"Invoice System Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "JgzzFiscalCode":{
            "title":"Taxpayer Identifier",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record Key",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MatchFoundFlag":{
            "title":"Match Found Flag",
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "title":"Migrated Data Check",
            "maxLength":3,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PartyFirstName":{
            "title":"Party First Name",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PartyLastName":{
            "title":"Party Last Name",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PartyMiddleName":{
            "title":"Party Middle Name",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Party Site Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Person Title",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus4 Code",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileClassName":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "SameBusEntityFlag":{
            "title":"Same as business entity",
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SameMailAddressFlag":{
            "title":"Same as business mailing address",
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SetName":{
            "title":"Set Name",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StatusFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "TerminationDate":{
            "title":"Termination Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TrxnCustXrefId":{
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "TrxnCustXrefKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TrxnCustXrefPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top