REST API for Oracle Public Sector Permitting and Licensing

Create a set of customer cross reference records

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordCustomerReferences

Request

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

Root Schema : schema

Type: object

Show Source

Address1: string

Maximum Length: 240

The first line of the address.
Address2: string

Maximum Length: 240

The second line of the address.
Address3: string

Maximum Length: 240

The third line of the address.
Address4: string

Maximum Length: 240

The fourth line of the address.
AgencyId: integer (int32)

Default Value: 1

Identifier of the agency.
BillToFlag: string

Maximum Length: 1

Indicates whether the address is a bill to address.
City: string

Maximum Length: 60

The city of the address.
Classification: string

Maximum Length: 3

The customer type.
ContactAddress1: string

Maximum Length: 240

The first line of the contact address.
ContactAddress2: string

Maximum Length: 240

The second line of the contact address.
ContactAddress3: string

Maximum Length: 240

The third line of the contact address.
ContactAddress4: string

Maximum Length: 240

The fourth line of the contact address.
ContactCity: string

Maximum Length: 60

City of the contact address.
ContactCountry: string

Maximum Length: 3

Country of the contact address.
ContactCounty: string

Maximum Length: 6

County of the contact address.
ContactEmailAddress: string

Maximum Length: 150

The email address of the customer contact.
ContactEmailAddress1: string

Maximum Length: 150

Email address of the contact.
ContactFirstName: string

Maximum Length: 150

First Name of the contact.
ContactId: integer (int64)

Identifier of the contact.
ContactLastName: string

Maximum Length: 150

Last Name of the contact.
ContactMiddleName: string

Maximum Length: 60

Middle Name of the contact.
ContactNameSuffix: string

Maximum Length: 30

Name suffix of the contact.
ContactPartyId: integer (int64)

Identifier of the contact.
ContactPersonTitle: string

Maximum Length: 60

Title of the contact.
ContactPhoneAreaCode: string

Maximum Length: 10

The phone area code of the contact.
ContactPhoneCountryCode: string

Maximum Length: 10

The phone country code of contact.
ContactPhoneExtension: string

Maximum Length: 20

The phone number extension of the contact.
ContactPhoneNumber: string

Maximum Length: 40

The phone number of the contact.
ContactPhoneType: string

Maximum Length: 30

The phone number of the contact.
ContactPostalCode: string

Maximum Length: 60

Postal code of the contact address.
ContactPostalPlus4Code: string

Maximum Length: 10

Additional postal code of the contact address.
ContactProvince: string

Maximum Length: 60

Province of the contact address.
ContactRawPhoneNumber: string

Maximum Length: 60

The area code of the unformatted version of the phone for the contact.
ContactState: string

Maximum Length: 60

State of the contact address.
ContactTypeCd: string

Maximum Length: 30

The contact type of the billing account.
Country: string

Maximum Length: 3

The country of the address.
County: string

Maximum Length: 6

The country of the address.
CustAccountId: integer (int64)

Identifier of the customer account.
CustAccountName: string

Maximum Length: 240

Name of the customer.
CustAccountNumber: string

Maximum Length: 30

The customer account number.
CustAcctChoice: string

Maximum Length: 30

The customer account choice.
CustAcctSiteId: integer (int64)

Identifier of the customer account site.
CustAcctVerificationStatus: string

Maximum Length: 30

The status of the customer account cross reference record.
CustPartyId: integer (int64)

Identifier of the customer party.
CustPartyNumber: string

Maximum Length: 30

The customer party number.
CustPartyTypeCd: string

Maximum Length: 30

Code associated with the customer party.
CustSiteUseId: integer (int64)

Identifier of the customer site use.
DunsNumberC: string

Maximum Length: 30

A global business information and insights provider.
DuplicateCheckDoneFlag: string

Maximum Length: 1

Indicates whether duplicate check was done.
DuplicateCheckOption: string

Maximum Length: 30

Indicates whether duplicate check should be done.
EstablishedDate: string (date)

The establishment date of the customer.
InvoiceSystemCd: string

Maximum Length: 30

Identifies the receivables application associated with invoices.
JgzzFiscalCode: string

Maximum Length: 20

The tax attribute.
LnpRecordId: string

Maximum Length: 50

The application identifier.
LnpRecordKey: integer (int64)

The key for the submitted application.
LocationId: integer (int64)

Unique identifier of the customer location.
MatchFoundFlag: string

Maximum Length: 1

Indicates whether duplicate match was found.
MigratedDataFlag: string

Maximum Length: 3

Indicates whether the record is migrated.
NameSuffix: string

Maximum Length: 30

The suffix of the customer with person type.
PartyFirstName: string

Maximum Length: 150

The first name of the customer person type.
PartyLastName: string

Maximum Length: 150

The last name of the customer with person type.
PartyMiddleName: string

Maximum Length: 60

The middle name of the customer with person type.
PartyName: string

Maximum Length: 360

Name of the customer party.
PartySiteId: integer (int64)

Identifier of the party site.
PartySiteName: string

Maximum Length: 240

Name of the party site.
PersonTitle: string

Maximum Length: 60

The title of the customer with person type.
PostalCode: string

Maximum Length: 60

The postal code of the address.
PostalPlus4Code: string

Maximum Length: 10

The postal code plus of the address.
Province: string

Maximum Length: 60

The province of the address.
RecordTypeId: string

Maximum Length: 50

The identifier of the record type.
SetName: string

Maximum Length: 80

Reference set name associated with the billing site.
State: string

Maximum Length: 60

The state of the address.
StatusFlag: string

Maximum Length: 1

The status of the billing account.
TerminationDate: string (date)

The termination date of the customer.
TrxnCustXrefId: string

Maximum Length: 50

Alpha numeric identifier of the record.
TrxnCustXrefKey: integer (int64)

Numeric identifier of the record.
TrxnCustXrefPuid: string

Maximum Length: 480

Customer reference public identifier on the cross reference table.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the record is migrated.",
            "nullable":false
        },
        "DuplicateCheckOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether duplicate check should be done.",
            "nullable":false
        },
        "ContactCountry":{
            "maxLength":3,
            "type":"string",
            "description":"Country of the contact address.",
            "nullable":true
        },
        "ContactPhoneType":{
            "maxLength":30,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true
        },
        "CustPartyId":{
            "type":"integer",
            "description":"Identifier of the customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer party.",
            "nullable":true
        },
        "ContactEmailAddress1":{
            "maxLength":150,
            "type":"string",
            "description":"Email address of the contact.",
            "nullable":true
        },
        "StatusFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the billing account.",
            "nullable":false
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the customer with person type.",
            "nullable":true
        },
        "ContactPostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"Additional postal code of the contact address.",
            "nullable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The customer type.",
            "nullable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartySiteName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the party site.",
            "nullable":true
        },
        "NameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The suffix of the customer with person type.",
            "nullable":true
        },
        "DuplicateCheckDoneFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether duplicate check was done.",
            "nullable":false
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"Identifier of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TrxnCustXrefKey":{
            "type":"integer",
            "description":"Numeric identifier of the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CustAcctVerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the customer account cross reference record.",
            "nullable":false
        },
        "ContactProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Province of the contact address.",
            "nullable":true
        },
        "TrxnCustXrefPuid":{
            "maxLength":480,
            "type":"string",
            "description":"Customer reference public identifier on the cross reference table.",
            "nullable":false
        },
        "CustAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The customer account number.",
            "nullable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address.",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The key for the submitted application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the address.",
            "nullable":true
        },
        "ContactLastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last Name of the contact.",
            "nullable":true
        },
        "ContactCounty":{
            "maxLength":6,
            "type":"string",
            "description":"County of the contact address.",
            "nullable":true
        },
        "PartyMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the customer with person type.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus of the address.",
            "nullable":true
        },
        "PartyLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the customer with person type.",
            "nullable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the address.",
            "nullable":true
        },
        "CustPartyTypeCd":{
            "maxLength":30,
            "type":"string",
            "description":"Code associated with the customer party.",
            "nullable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the address.",
            "nullable":true
        },
        "BillToFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the address is a bill to address.",
            "nullable":false
        },
        "ContactTypeCd":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type of the billing account.",
            "nullable":true
        },
        "ContactState":{
            "maxLength":60,
            "type":"string",
            "description":"State of the contact address.",
            "nullable":true
        },
        "InvoiceSystemCd":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the receivables application associated with invoices.",
            "nullable":true
        },
        "TrxnCustXrefId":{
            "maxLength":50,
            "type":"string",
            "description":"Alpha numeric identifier of the record.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "CustAcctChoice":{
            "maxLength":30,
            "type":"string",
            "description":"The customer account choice.",
            "nullable":false
        },
        "ContactPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true
        },
        "CustAccountName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true
        },
        "ContactAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the contact address.",
            "nullable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Identifier of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "County":{
            "maxLength":6,
            "type":"string",
            "description":"The country of the address.",
            "nullable":true
        },
        "ContactPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the contact.",
            "nullable":true
        },
        "CustSiteUseId":{
            "type":"integer",
            "description":"Identifier of the customer site use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true
        },
        "RecordTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the record type.",
            "nullable":false
        },
        "ContactCity":{
            "maxLength":60,
            "type":"string",
            "description":"City of the contact address.",
            "nullable":true
        },
        "ContactFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First Name of the contact.",
            "nullable":true
        },
        "DunsNumberC":{
            "maxLength":30,
            "type":"string",
            "description":"A global business information and insights provider.",
            "nullable":true
        },
        "CustPartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The customer party number.",
            "nullable":true
        },
        "ContactPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the contact address.",
            "nullable":true
        },
        "JgzzFiscalCode":{
            "maxLength":20,
            "type":"string",
            "description":"The tax attribute.",
            "nullable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The application identifier.",
            "nullable":false
        },
        "ContactMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"Middle Name of the contact.",
            "nullable":true
        },
        "MatchFoundFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether duplicate match was found.",
            "nullable":false
        },
        "ContactPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension of the contact.",
            "nullable":true
        },
        "TerminationDate":{
            "type":"string",
            "description":"The termination date of the customer.",
            "format":"date",
            "nullable":true
        },
        "ContactRawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"The area code of the unformatted version of the phone for the contact.",
            "nullable":true
        },
        "ContactNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"Name suffix of the contact.",
            "nullable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true
        },
        "ContactPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of contact.",
            "nullable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier of the customer location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true
        },
        "SetName":{
            "maxLength":80,
            "type":"string",
            "description":"Reference set name associated with the billing site.",
            "nullable":true
        },
        "ContactPersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"Title of the contact.",
            "nullable":true
        },
        "EstablishedDate":{
            "type":"string",
            "description":"The establishment date of the customer.",
            "format":"date",
            "nullable":false
        },
        "PartyFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the customer person type.",
            "nullable":true
        },
        "ContactEmailAddress":{
            "maxLength":150,
            "type":"string",
            "description":"The email address of the customer contact.",
            "nullable":true
        },
        "ContactAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the contact address.",
            "nullable":true
        },
        "ContactAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the contact address.",
            "nullable":true
        },
        "CustAcctSiteId":{
            "type":"integer",
            "description":"Identifier of the customer account site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the contact address.",
            "nullable":true
        },
        "CustAccountId":{
            "type":"integer",
            "description":"Identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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.

Root Schema : publicSectorRecordCustomerReferences-item-response

Type: object

Show Source

Address1: string

Maximum Length: 240

The first line of the address.
Address2: string

Maximum Length: 240

The second line of the address.
Address3: string

Maximum Length: 240

The third line of the address.
Address4: string

Maximum Length: 240

The fourth line of the address.
AgencyId: integer (int32)

Default Value: 1

Identifier of the agency.
BillToFlag: string

Maximum Length: 1

Indicates whether the address is a bill to address.
City: string

Maximum Length: 60

The city of the address.
Classification: string

Maximum Length: 3

The customer type.
ContactAddress1: string

Maximum Length: 240

The first line of the contact address.
ContactAddress2: string

Maximum Length: 240

The second line of the contact address.
ContactAddress3: string

Maximum Length: 240

The third line of the contact address.
ContactAddress4: string

Maximum Length: 240

The fourth line of the contact address.
ContactCity: string

Maximum Length: 60

City of the contact address.
ContactCountry: string

Maximum Length: 3

Country of the contact address.
ContactCounty: string

Maximum Length: 6

County of the contact address.
ContactEmailAddress: string

Maximum Length: 150

The email address of the customer contact.
ContactEmailAddress1: string

Maximum Length: 150

Email address of the contact.
ContactFirstName: string

Maximum Length: 150

First Name of the contact.
ContactId: integer (int64)

Identifier of the contact.
ContactLastName: string

Maximum Length: 150

Last Name of the contact.
ContactMiddleName: string

Maximum Length: 60

Middle Name of the contact.
ContactNameSuffix: string

Maximum Length: 30

Name suffix of the contact.
ContactPartyId: integer (int64)

Identifier of the contact.
ContactPersonTitle: string

Maximum Length: 60

Title of the contact.
ContactPhoneAreaCode: string

Maximum Length: 10

The phone area code of the contact.
ContactPhoneCountryCode: string

Maximum Length: 10

The phone country code of contact.
ContactPhoneExtension: string

Maximum Length: 20

The phone number extension of the contact.
ContactPhoneNumber: string

Maximum Length: 40

The phone number of the contact.
ContactPhoneType: string

Maximum Length: 30

The phone number of the contact.
ContactPostalCode: string

Maximum Length: 60

Postal code of the contact address.
ContactPostalPlus4Code: string

Maximum Length: 10

Additional postal code of the contact address.
ContactProvince: string

Maximum Length: 60

Province of the contact address.
ContactRawPhoneNumber: string

Maximum Length: 60

The area code of the unformatted version of the phone for the contact.
ContactState: string

Maximum Length: 60

State of the contact address.
ContactTypeCd: string

Maximum Length: 30

The contact type of the billing account.
Country: string

Maximum Length: 3

The country of the address.
County: string

Maximum Length: 6

The country of the address.
CustAccountId: integer (int64)

Identifier of the customer account.
CustAccountName: string

Maximum Length: 240

Name of the customer.
CustAccountNumber: string

Maximum Length: 30

The customer account number.
CustAcctChoice: string

Maximum Length: 30

The customer account choice.
CustAcctSiteId: integer (int64)

Identifier of the customer account site.
CustAcctVerificationStatus: string

Maximum Length: 30

The status of the customer account cross reference record.
CustPartyId: integer (int64)

Identifier of the customer party.
CustPartyNumber: string

Maximum Length: 30

The customer party number.
CustPartyTypeCd: string

Maximum Length: 30

Code associated with the customer party.
CustSiteUseId: integer (int64)

Identifier of the customer site use.
DunsNumberC: string

Maximum Length: 30

A global business information and insights provider.
DuplicateCheckDoneFlag: string

Maximum Length: 1

Indicates whether duplicate check was done.
DuplicateCheckOption: string

Maximum Length: 30

Indicates whether duplicate check should be done.
EstablishedDate: string (date)

The establishment date of the customer.
InvoiceSystemCd: string

Maximum Length: 30

Identifies the receivables application associated with invoices.
JgzzFiscalCode: string

Maximum Length: 20

The tax attribute.
links: array Links

Title: Links

The link relations associated with the resource instance.
LnpRecordId: string

Maximum Length: 50

The application identifier.
LnpRecordKey: integer (int64)

The key for the submitted application.
LocationId: integer (int64)

Unique identifier of the customer location.
MatchFoundFlag: string

Maximum Length: 1

Indicates whether duplicate match was found.
MigratedDataFlag: string

Maximum Length: 3

Indicates whether the record is migrated.
NameSuffix: string

Maximum Length: 30

The suffix of the customer with person type.
PartyFirstName: string

Maximum Length: 150

The first name of the customer person type.
PartyLastName: string

Maximum Length: 150

The last name of the customer with person type.
PartyMiddleName: string

Maximum Length: 60

The middle name of the customer with person type.
PartyName: string

Maximum Length: 360

Name of the customer party.
PartySiteId: integer (int64)

Identifier of the party site.
PartySiteName: string

Maximum Length: 240

Name of the party site.
PersonTitle: string

Maximum Length: 60

The title of the customer with person type.
PostalCode: string

Maximum Length: 60

The postal code of the address.
PostalPlus4Code: string

Maximum Length: 10

The postal code plus of the address.
Province: string

Maximum Length: 60

The province of the address.
RecordTypeId: string

Maximum Length: 50

The identifier of the record type.
SetName: string

Maximum Length: 80

Reference set name associated with the billing site.
State: string

Maximum Length: 60

The state of the address.
StatusFlag: string

Maximum Length: 1

The status of the billing account.
TerminationDate: string (date)

The termination date of the customer.
TrxnCustXrefId: string

Maximum Length: 50

Alpha numeric identifier of the record.
TrxnCustXrefKey: integer (int64)

Numeric identifier of the record.
TrxnCustXrefPuid: string

Maximum Length: 480

Customer reference public identifier on the cross reference table.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the record is migrated.",
            "nullable":false,
            "x-queryable":true
        },
        "DuplicateCheckOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether duplicate check should be done.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactCountry":{
            "maxLength":3,
            "type":"string",
            "description":"Country of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneType":{
            "maxLength":30,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CustPartyId":{
            "type":"integer",
            "description":"Identifier of the customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer party.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmailAddress1":{
            "maxLength":150,
            "type":"string",
            "description":"Email address of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the billing account.",
            "nullable":false,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the customer with person type.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"Additional postal code of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The customer type.",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySiteName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The suffix of the customer with person type.",
            "nullable":true,
            "x-queryable":true
        },
        "DuplicateCheckDoneFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether duplicate check was done.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"Identifier of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrxnCustXrefKey":{
            "type":"integer",
            "description":"Numeric identifier of the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CustAcctVerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the customer account cross reference record.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Province of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "TrxnCustXrefPuid":{
            "maxLength":480,
            "type":"string",
            "description":"Customer reference public identifier on the cross reference table.",
            "nullable":false,
            "x-queryable":true
        },
        "CustAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The customer account number.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The key for the submitted application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last Name of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactCounty":{
            "maxLength":6,
            "type":"string",
            "description":"County of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the customer with person type.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the customer with person type.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "CustPartyTypeCd":{
            "maxLength":30,
            "type":"string",
            "description":"Code associated with the customer party.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the address is a bill to address.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactTypeCd":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type of the billing account.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactState":{
            "maxLength":60,
            "type":"string",
            "description":"State of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceSystemCd":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the receivables application associated with invoices.",
            "nullable":true,
            "x-queryable":true
        },
        "TrxnCustXrefId":{
            "maxLength":50,
            "type":"string",
            "description":"Alpha numeric identifier of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CustAcctChoice":{
            "maxLength":30,
            "type":"string",
            "description":"The customer account choice.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "CustAccountName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Identifier of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":6,
            "type":"string",
            "description":"The country of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CustSiteUseId":{
            "type":"integer",
            "description":"Identifier of the customer site use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactCity":{
            "maxLength":60,
            "type":"string",
            "description":"City of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First Name of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "DunsNumberC":{
            "maxLength":30,
            "type":"string",
            "description":"A global business information and insights provider.",
            "nullable":true,
            "x-queryable":true
        },
        "CustPartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The customer party number.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "JgzzFiscalCode":{
            "maxLength":20,
            "type":"string",
            "description":"The tax attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The application identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"Middle Name of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "MatchFoundFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether duplicate match was found.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "TerminationDate":{
            "type":"string",
            "description":"The termination date of the customer.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactRawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"The area code of the unformatted version of the phone for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"Name suffix of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier of the customer location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "SetName":{
            "maxLength":80,
            "type":"string",
            "description":"Reference set name associated with the billing site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"Title of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EstablishedDate":{
            "type":"string",
            "description":"The establishment date of the customer.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the customer person type.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "maxLength":150,
            "type":"string",
            "description":"The email address of the customer contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "CustAcctSiteId":{
            "type":"integer",
            "description":"Identifier of the customer account site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the contact address.",
            "nullable":true,
            "x-queryable":true
        },
        "CustAccountId":{
            "type":"integer",
            "description":"Identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}