Jump to

• Request
• Response
• Examples

Create a joint venture invoicing partner

post

/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners

Request

Header Parameters

• 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.
• Upsert-Mode:
  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

• businessUnitName: string
  Title: Business Unit

  A field that identifies the display name of the business unit associated with the invoicing partner.
• currencyCode: string
  Title: Preferred Currency

  Maximum Length: 15

  The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.
• customerAccountNumber: string
  Title: Customer Account Number

  Maximum Length: 255

  The account number of the customer.
• customerAddress: string
  Title: Customer Address

  Maximum Length: 290

  The formatted address of the customer.
• customerSetName: string
  Title: Customer Set Name

  Maximum Length: 255

  A field for identifying the customer set name in the customer information for an invoicing partner.The customer set name is associated with the customer site ID.
• customerSiteLocation: string
  Title: Customer Site

  Maximum Length: 255

  The location of the customer site.
• invoicingPartnerDescription: string
  Title: Description

  Maximum Length: 240

  The description of the joint venture invoicing partner.
• invoicingPartnerDFF: array Invoicing Partner Descriptive Flexfields
  Title: Invoicing Partner Descriptive Flexfields

  The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.
• invoicingPartnerShortName: string
  Title: Invoicing Partner

  Maximum Length: 30

  The unique name of the joint venture invoicing partner.
• invoicingPartnerStatus: string
  Title: Status

  Maximum Length: 80

  The status of the joint venture invoicing partner.
• jibOutputFormat: string
  Title: Joint Interest Billing Report Output Format

  The format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner.
• jibTemplateName: string
  Title: Joint Interest Billing Report Template

  Maximum Length: 100

  The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.
• supplierAddress: string
  Title: Supplier Address

  Maximum Length: 290

  The formatted address of the supplier.
• supplierBU: integer
  Title: Supplier BU

  The business unit of the supplier site.
• supplierName: string
  Title: Supplier

  Maximum Length: 360

  The name of the supplier.
• supplierSiteCode: string
  Title: Supplier Site

  Maximum Length: 255

  The site code of the supplier.
• warningMessage: string
  Title: Warning Message

  Indicates if there are any warning messages when creating a joint venture invoicing partner.

{
    "type":"object",
    "properties":{
        "supplierName":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the supplier.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "customerAddress":{
            "title":"Customer Address",
            "maxLength":"290",
            "type":"string",
            "description":"The formatted address of the customer.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "customerAddress1",
                    "customerAddress2",
                    "customerAddress3",
                    "customerAddress4",
                    "customerCity",
                    "customerCountry",
                    "customerCounty",
                    "customerPostalCode",
                    "customerProvince",
                    "customerState"
                ]
            }
        },
        "supplierAddress":{
            "title":"Supplier Address",
            "maxLength":"290",
            "type":"string",
            "description":"The formatted address of the supplier.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "supplierAddress1",
                    "supplierAddress2",
                    "supplierAddress3",
                    "supplierAddress4",
                    "supplierCity",
                    "supplierCountry",
                    "supplierCounty",
                    "supplierPostalCode",
                    "supplierProvince",
                    "supplierState"
                ]
            }
        },
        "businessUnitName":{
            "title":"Business Unit",
            "type":"string",
            "description":"A field that identifies the display name of the business unit associated with the invoicing partner.",
            "nullable":true
        },
        "customerSetName":{
            "title":"Customer Set Name",
            "maxLength":"255",
            "type":"string",
            "description":"A field for identifying the customer set name in the customer information for an invoicing partner.The customer set name is associated with the customer site ID.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "warningMessage":{
            "title":"Warning Message",
            "type":"string",
            "description":"Indicates if there are any warning messages when creating a joint venture invoicing partner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "customerAccountNumber":{
            "title":"Customer Account Number",
            "maxLength":"255",
            "type":"string",
            "description":"The account number of the customer.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "customerSiteLocation":{
            "title":"Customer Site",
            "maxLength":"255",
            "type":"string",
            "description":"The location of the customer site.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "supplierSiteCode":{
            "title":"Supplier Site",
            "maxLength":"255",
            "type":"string",
            "description":"The site code of the supplier.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "invoicingPartnerDFF":{
            "title":"Invoicing Partner Descriptive Flexfields",
            "type":"array",
            "description":"The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.",
            "items":{
                "$ref":"#/components/schemas/jointVentureInvoicingPartners-invoicingPartnerDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "jibOutputFormat":{
            "title":"Joint Interest Billing Report Output Format",
            "type":"string",
            "description":"The format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "reportOutputFormatLookupCode"
                ]
            }
        },
        "invoicingPartnerStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "invoicingPartnerShortName":{
            "title":"Invoicing Partner",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "supplierBU":{
            "title":"Supplier BU",
            "type":"integer",
            "description":"The business unit of the supplier site.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "invoicingPartnerDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "currencyCode":{
            "title":"Preferred Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "jibTemplateName":{
            "title":"Joint Interest Billing Report Template",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : Invoicing Partner Descriptive Flexfields

Type: array

Title: Invoicing Partner Descriptive Flexfields

The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.

Show Source

• Array of: object schema

{
    "title":"Invoicing Partner Descriptive Flexfields",
    "type":"array",
    "description":"The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.",
    "items":{
        "$ref":"#/components/schemas/jointVentureInvoicingPartners-invoicingPartnerDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The descriptive flexfield context name for the joint venture invoicing partner.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The descriptive flexfield context display value for the joint venture invoicing partner.
• InvoicingPartnerId: integer (int64)
  The unique identifier of the joint venture invoicing partner.

{
    "type":"object",
    "properties":{
        "InvoicingPartnerId":{
            "type":"integer",
            "description":"The unique identifier of the joint venture invoicing partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The descriptive flexfield context display value for the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"The descriptive flexfield context name for the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : jointVentureInvoicingPartners-item-response

Type: object

Show Source

• activeFlag: boolean
  Title: Invoicing Partner Active

  Read Only: true

  Indicates whether the joint venture invoicing partner is active or not.
• businessUnitName: string
  Title: Business Unit

  A field that identifies the display name of the business unit associated with the invoicing partner.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the joint venture invoicing partner.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The data and time the joint venture invoicing partner was created.
• currencyCode: string
  Title: Preferred Currency

  Maximum Length: 15

  The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.
• customerAccountName: string
  Title: Customer

  Read Only: true

  Maximum Length: 240

  The account name of the customer.
• customerAccountNumber: string
  Title: Customer Account Number

  Maximum Length: 255

  The account number of the customer.
• customerAddress: string
  Title: Customer Address

  Maximum Length: 290

  The formatted address of the customer.
• customerEmailAddress: string
  Title: Customer Email

  Read Only: true

  Maximum Length: 320

  The email address of the customer.
• customerPartyName: string
  Title: Customer

  Read Only: true

  Maximum Length: 360

  The name of the customer.
• customerPhone: string
  Title: Customer Phone

  Read Only: true

  The formatted phone number of the customer.
• customerSetName: string
  Title: Customer Set Name

  Maximum Length: 255

  A field for identifying the customer set name in the customer information for an invoicing partner.The customer set name is associated with the customer site ID.
• customerSiteLocation: string
  Title: Customer Site

  Maximum Length: 255

  The location of the customer site.
• customerTaxNumber: string
  Title: Customer Tax Registration Number

  Read Only: true

  The tax registration number of the customer.
• invoicingPartnerDescription: string
  Title: Description

  Maximum Length: 240

  The description of the joint venture invoicing partner.
• invoicingPartnerDFF: array Invoicing Partner Descriptive Flexfields
  Title: Invoicing Partner Descriptive Flexfields

  The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.
• invoicingPartnerId: integer (int64)
  Title: Invoicing Partner ID

  Read Only: true

  The unique identifier of the joint venture invoicing partner.
• invoicingPartnerName: string
  Title: Invoicing Partner

  Read Only: true

  Maximum Length: 30

  The name of the joint venture invoicing partner.
• invoicingPartnerShortName: string
  Title: Invoicing Partner

  Maximum Length: 30

  The unique name of the joint venture invoicing partner.
• invoicingPartnerStatus: string
  Title: Status

  Maximum Length: 80

  The status of the joint venture invoicing partner.
• jibOutputFormat: string
  Title: Joint Interest Billing Report Output Format

  The format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner.
• jibTemplateName: string
  Title: Joint Interest Billing Report Template

  Maximum Length: 100

  The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the joint venture invoicing partner was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the joint venture invoicing partner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• supplierAddress: string
  Title: Supplier Address

  Maximum Length: 290

  The formatted address of the supplier.
• supplierBU: integer
  Title: Supplier BU

  The business unit of the supplier site.
• supplierEmailAddress: string
  Title: Supplier Email

  Read Only: true

  Maximum Length: 320

  The email address of the supplier.
• supplierName: string
  Title: Supplier

  Maximum Length: 360

  The name of the supplier.
• supplierPartyName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  The name of the party corresponding to the supplier.
• supplierPhone: string
  Title: Supplier Phone

  Read Only: true

  The formatted phone number of the supplier.
• supplierSiteCode: string
  Title: Supplier Site

  Maximum Length: 255

  The site code of the supplier.
• supplierTaxNumber: string
  Title: Supplier Tax Registration Number

  Read Only: true

  The tax registration number of the supplier.
• warningMessage: string
  Title: Warning Message

  Indicates if there are any warning messages when creating a joint venture invoicing partner.

{
    "type":"object",
    "properties":{
        "invoicingPartnerName":{
            "title":"Invoicing Partner",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the joint venture invoicing partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "customerSetName":{
            "title":"Customer Set Name",
            "maxLength":"255",
            "type":"string",
            "description":"A field for identifying the customer set name in the customer information for an invoicing partner.The customer set name is associated with the customer site ID.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the joint venture invoicing partner was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "customerEmailAddress":{
            "title":"Customer Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "customerAccountName":{
            "title":"Customer",
            "maxLength":"240",
            "type":"string",
            "description":"The account name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "customerSiteLocation":{
            "title":"Customer Site",
            "maxLength":"255",
            "type":"string",
            "description":"The location of the customer site.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "customerPhone":{
            "title":"Customer Phone",
            "type":"string",
            "description":"The formatted phone number of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "customerPhoneAreaCode",
                    "customerPhoneCountryCode",
                    "customerPhoneExtension",
                    "customerPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "invoicingPartnerStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "invoicingPartnerId":{
            "title":"Invoicing Partner ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture invoicing partner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "customerPartyName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "supplierBU":{
            "title":"Supplier BU",
            "type":"integer",
            "description":"The business unit of the supplier site.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "invoicingPartnerDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "jibTemplateName":{
            "title":"Joint Interest Billing Report Template",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "activeFlag":{
            "title":"Invoicing Partner Active",
            "type":"boolean",
            "description":"Indicates whether the joint venture invoicing partner is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "supplierName":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the supplier.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "customerAddress":{
            "title":"Customer Address",
            "maxLength":"290",
            "type":"string",
            "description":"The formatted address of the customer.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "customerAddress1",
                    "customerAddress2",
                    "customerAddress3",
                    "customerAddress4",
                    "customerCity",
                    "customerCountry",
                    "customerCounty",
                    "customerPostalCode",
                    "customerProvince",
                    "customerState"
                ]
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the joint venture invoicing partner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "supplierAddress":{
            "title":"Supplier Address",
            "maxLength":"290",
            "type":"string",
            "description":"The formatted address of the supplier.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "supplierAddress1",
                    "supplierAddress2",
                    "supplierAddress3",
                    "supplierAddress4",
                    "supplierCity",
                    "supplierCountry",
                    "supplierCounty",
                    "supplierPostalCode",
                    "supplierProvince",
                    "supplierState"
                ]
            },
            "x-queryable":true
        },
        "businessUnitName":{
            "title":"Business Unit",
            "type":"string",
            "description":"A field that identifies the display name of the business unit associated with the invoicing partner.",
            "nullable":true,
            "x-queryable":true
        },
        "supplierPartyName":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party corresponding to the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "supplierEmailAddress":{
            "title":"Supplier Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "warningMessage":{
            "title":"Warning Message",
            "type":"string",
            "description":"Indicates if there are any warning messages when creating a joint venture invoicing partner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "supplierTaxNumber":{
            "title":"Supplier Tax Registration Number",
            "type":"string",
            "description":"The tax registration number of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "customerTaxNumber":{
            "title":"Customer Tax Registration Number",
            "type":"string",
            "description":"The tax registration number of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "customerAccountNumber":{
            "title":"Customer Account Number",
            "maxLength":"255",
            "type":"string",
            "description":"The account number of the customer.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The data and time the joint venture invoicing partner was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "supplierSiteCode":{
            "title":"Supplier Site",
            "maxLength":"255",
            "type":"string",
            "description":"The site code of the supplier.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "invoicingPartnerDFF":{
            "title":"Invoicing Partner Descriptive Flexfields",
            "type":"array",
            "description":"The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.",
            "items":{
                "$ref":"#/components/schemas/jointVentureInvoicingPartners-invoicingPartnerDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "supplierPhone":{
            "title":"Supplier Phone",
            "type":"string",
            "description":"The formatted phone number of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "supplierPhoneAreaCode",
                    "supplierPhoneCountryCode",
                    "supplierPhoneExtension",
                    "supplierPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "jibOutputFormat":{
            "title":"Joint Interest Billing Report Output Format",
            "type":"string",
            "description":"The format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "reportOutputFormatLookupCode"
                ]
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture invoicing partner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "invoicingPartnerShortName":{
            "title":"Invoicing Partner",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Preferred Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code used when creating invoices for the partner. If the currency code isn't populated, the stakeholder's currency will be used.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Invoicing Partner Descriptive Flexfields

Type: array

Title: Invoicing Partner Descriptive Flexfields

The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.

Show Source

• Array of: object jointVentureInvoicingPartners-invoicingPartnerDFF-item-response

{
    "title":"Invoicing Partner Descriptive Flexfields",
    "type":"array",
    "description":"The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.",
    "items":{
        "$ref":"#/components/schemas/jointVentureInvoicingPartners-invoicingPartnerDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : jointVentureInvoicingPartners-invoicingPartnerDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The descriptive flexfield context name for the joint venture invoicing partner.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The descriptive flexfield context display value for the joint venture invoicing partner.
• InvoicingPartnerId: integer (int64)
  The unique identifier of the joint venture invoicing partner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InvoicingPartnerId":{
            "type":"integer",
            "description":"The unique identifier of the joint venture invoicing partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The descriptive flexfield context display value for the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"The descriptive flexfield context name for the joint venture invoicing partner.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Links

invoicingPartnerDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}/child/invoicingPartnerDFF

Parameters:

• invoicingPartnerId: $request.path.invoicingPartnerId

The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.

Back to Top

Examples

The following example shows how to create an invoicing partner by submitting a POST request on the REST resource using cURL.

curl -u username:password -i -X POST -H "Content-Type: application/json" -d https://servername.fa.us2.oraclecloud.com/ledgerApi/resources/11.13.18.05/jointVentureInvoicingPartners

Request Body Example

The following shows an example of the request body in JSON format.

{
"customerSetName":"Vision Operations",
"invoicingPartnerShortName":"GOILBASINPROM",
"invoicingPartnerDescription": "Refinery and Oil Corporation",
"customerAccountNumber":"3560",
"supplierName": "Green Corp",
"supplierBU": 204,
"supplierSiteCode":"POZ14170",
"invoicingPartnerStatus": "Active"
}

Response Header Example

The following shows an example of the response header.

<Enter the Response header>

Response Body Example

The following shows an example of the response body in JSON format.

{
  "invoicingPartnerDescription" : "Refinery and Oil Corporation",
  "invoicingPartnerId" : 300100186133327,
  "invoicingPartnerName" : "GOILBASINPROM",
  "invoicingPartnerShortName" : "GOILBASINPROM",
  "supplierPartyName" : "Green Corp",
  "customerPartyName" : "Seven Corporation",
  "supplierBU" : 204,
  "supplierSiteCode" : "POZ14170",
  "supplierName" : "Green Corp",
  "invoicingPartnerStatus" : "Active",
  "customerTaxNumber" : null,
  "supplierTaxNumber" : null,
  "customerAccountNumber" : "3560",
  "customerSetName" : "Vision Operations",
  "customerSiteLocation" : null,
  "warningMessage" : "JV-6165020-The supplier and customer associated with the invoicing partner are different as they have different party IDs.",
  "customerAccountName" : "Green, Inc.",
  "createdBy" : "username",
  "creationDate" : "2020-02-12T10:33:00+00:00",
  "lastUpdatedBy" : "username",
  "lastUpdateDate" : "2020-02-12T10:33:00.159+00:00",
  "supplierAddress" : "900 Long Ridge Road,Stamford,CT,US,06902",
  "customerAddress" : "900 Long Ridge Road,Stamford,CT,US,06902",
  "supplierEmailAddress" : null,
  "customerEmailAddress" : null,
  "supplierPhone" : null,
  "customerPhone" : null,
  "activeFlag" : true
}

Back to Top