Jump to

• Request
• Response
• Examples

Get all joint venture invoicing partners

get

/fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • AltKey: Finds the joint venture invoicing partner that matches the alternate key criteria specified.
    Finder Variables:
    • invoicingPartnerShortName; string; The invoicing partner short name.
  • PrimaryKey: Finds the joint venture invoicing partner that matches the primary key criteria specified.
    Finder Variables:
    • invoicingPartnerId; integer; The unique identifier of the joint venture invoicing partner.
  • invoicingPartnerSearch: Finds one or more joint venture invoicing partners that match the specified search parameters, such as description, short name, supplier name, status, or account name.
    Finder Variables:
    • businessUnitName; string.
    • currencyCode; string.
    • customerAccountName; string; The customer account name for the selected invoicing partner.
    • customerPartyName; string.
    • invoicingPartnerDescription; string; The description of the invoicing partner.
    • invoicingPartnerShortName; string; The unique invoicing partner name, which is stored as the short name.
    • invoicingPartnerStatus; string; The status of the invoicing partner.
    • location; string; The location of the customer site.
    • searchAllText; string; A search value to identify invoicing partners that contain the specified text in any of the string attributes.
    • supplierPartyName; string; The supplier name for the selected invoicing partner.
    • vendorSiteCode; string; The site code of the supplier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • activeFlag; boolean; Indicates whether the joint venture invoicing partner is active or not.
  • businessUnitName; string; A field that identifies the display name of the business unit associated with the invoicing partner.
  • createdBy; string; The user who created the joint venture invoicing partner.
  • creationDate; string; The data and time the joint venture invoicing partner was created.
  • currencyCode; string; 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; The account name of the customer.
  • customerAccountNumber; string; The account number of the customer.
  • customerAddress; string; The formatted address of the customer.
  • customerEmailAddress; string; The email address of the customer.
  • customerPartyName; string; The name of the customer.
  • customerPhone; string; The formatted phone number of the customer.
  • customerSetName; string; 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; The location of the customer site.
  • customerTaxNumber; string; The tax registration number of the customer.
  • invoicingPartnerDescription; string; The description of the joint venture invoicing partner.
  • invoicingPartnerId; integer; The unique identifier of the joint venture invoicing partner.
  • invoicingPartnerName; string; The name of the joint venture invoicing partner.
  • invoicingPartnerShortName; string; The unique name of the joint venture invoicing partner.
  • invoicingPartnerStatus; string; The status of the joint venture invoicing partner.
  • jibOutputFormat; string; The format of the Joint Interest Billing report output that will default on stakeholders associated with this invoicing partner.
  • jibTemplateName; string; The name of the Joint Interest Billing report template that will default on stakeholders associated with this invoicing partner.
  • lastUpdateDate; string; The date and time the joint venture invoicing partner was last updated.
  • lastUpdatedBy; string; The user who last updated the joint venture invoicing partner.
  • supplierAddress; string; The formatted address of the supplier.
  • supplierBU; integer; The business unit of the supplier site.
  • supplierEmailAddress; string; The email address of the supplier.
  • supplierName; string; The name of the supplier.
  • supplierPartyName; string; The name of the party corresponding to the supplier.
  • supplierPhone; string; The formatted phone number of the supplier.
  • supplierSiteCode; string; The site code of the supplier.
  • supplierTaxNumber; string; The tax registration number of the supplier.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/jointVentureInvoicingPartners-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureInvoicingPartners-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureInvoicingPartners-item-response"
    }
}

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-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",
                "dependencies":[
                    "location"
                ]
            },
            "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-hints":{
                "dependencies":[
                    "name"
                ]
            },
            "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",
                "dependencies":[
                    "vendorSiteCode"
                ]
            },
            "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."
        }
    }
}

Back to Top

Examples

The following example shows how to get multiple invoicing partners by submitting a GET request on the REST resource using cURL.

curl -u username:password -i -X GET https://servername.fa.us2.oraclecloud.com/ledgerApi/resources/11.13.18.05/jointVentureInvoicingPartners

Response Body Example

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

{
  "items" : [ {
    "invoicingPartnerDescription" : "CTS1",
    "invoicingPartnerId" : 300100184808020,
    "invoicingPartnerName" : "CTS1",
    "invoicingPartnerShortName" : "CTS1",
    "supplierPartyName" : "Big Computers",
    "customerPartyName" : "Vision Corporation",
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : "Big Computers",
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : "AGHLM5614F",
    "supplierTaxNumber" : null,
    "customerAccountNumber" : "CDRM_196203",
    "customerSetName" : null,
    "customerSiteLocation" : "CDRM_173210",
    "warningMessage" : null,
    "customerAccountName" : "Purchase Account For HEPP",
    "createdBy" : "username",
    "creationDate" : "2020-01-22T10:07:54+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-22T10:07:54.484+00:00",
    "supplierAddress" : null,
    "customerAddress" : "900 Long Ridge Road,Stamford,CT,US,06902",
    "supplierEmailAddress" : null,
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : null,
    "activeFlag" : true
  }, {
    "invoicingPartnerDescription" : "Central Region Supplier",
    "invoicingPartnerId" : 300100185016428,
    "invoicingPartnerName" : "CAAZPROM-C",
    "invoicingPartnerShortName" : "CAAZPROM-C",
    "supplierPartyName" : "Large and Associates",
    "customerPartyName" : null,
    "supplierBU" : null,
    "supplierSiteCode" : "POZ13819",
    "supplierName" : "Large and Associates",
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : null,
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : null,
    "createdBy" : "username",
    "creationDate" : "2020-01-30T18:02:36+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-30T18:02:36.059+00:00",
    "supplierAddress" : "315 Park Avenue South,New York,NY,US,10010",
    "customerAddress" : null,
    "supplierEmailAddress" : null,
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : null,
    "activeFlag" : true
  }, {
    "invoicingPartnerDescription" : "COC US",
    "invoicingPartnerId" : 300100184918301,
    "invoicingPartnerName" : "GASYPROM-SHUIC2",
    "invoicingPartnerShortName" : "GASYPROM-SHUIC2",
    "supplierPartyName" : "Di Edwards",
    "customerPartyName" : null,
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : "Di Edwards",
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : null,
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : null,
    "createdBy" : "username",
    "creationDate" : "2020-01-27T05:20:25+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-27T05:20:25.051+00:00",
    "supplierAddress" : null,
    "customerAddress" : null,
    "supplierEmailAddress" : "[e-mail]",
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : null,
    "activeFlag" : true
  }, {
    "invoicingPartnerDescription" : "IP for ESS UI 2",
    "invoicingPartnerId" : 300100185190979,
    "invoicingPartnerName" : "NDESSIP2",
    "invoicingPartnerShortName" : "NDESSIP2",
    "supplierPartyName" : null,
    "customerPartyName" : "w_Green Corp",
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : null,
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : "3708",
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : "w_Green Corp",
    "createdBy" : "username",
    "creationDate" : "2020-02-07T07:09:28+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-02-07T07:09:28.036+00:00",
    "supplierAddress" : null,
    "customerAddress" : "5901 Indian School Road NE,Suite 204,Albuquerque,NM,US,87110",
    "supplierEmailAddress" : null,
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : null,
    "activeFlag" : true
  }, {
    "invoicingPartnerDescription" : "INVOICING PENNYPACK",
    "invoicingPartnerId" : 300100184869565,
    "invoicingPartnerName" : "CRUDDO",
    "invoicingPartnerShortName" : "CRUDDO",
    "supplierPartyName" : null,
    "customerPartyName" : "PennyPack Systems",
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : null,
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : "4725",
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : null,
    "createdBy" : "username",
    "creationDate" : "2020-01-23T09:46:54+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-23T09:46:54.048+00:00",
    "supplierAddress" : null,
    "customerAddress" : "4190 Network Circle,Santa Clara,CA,US,95054",
    "supplierEmailAddress" : null,
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : "1-650-555 1812",
    "activeFlag" : true
  }, {
    "invoicingPartnerDescription" : "INVOICING PARTNER1",
    "invoicingPartnerId" : 300100184918340,
    "invoicingPartnerName" : "GSYPROM-OPDP1UI1",
    "invoicingPartnerShortName" : "GSYPROM-OPDP1UI1",
    "supplierPartyName" : null,
    "customerPartyName" : "Dealer B Region",
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : null,
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : "4723",
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : null,
    "createdBy" : "username",
    "creationDate" : "2020-01-27T05:20:44+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-27T05:20:44.026+00:00",
    "supplierAddress" : null,
    "customerAddress" : "6031 Connection Drive,Irving TX,US,75039",
    "supplierEmailAddress" : null,
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : "1-650-555 1221",
    "activeFlag" : true
  },{
    "invoicingPartnerDescription" : "INVOICING PARTNER2",
    "invoicingPartnerId" : 300100184918342,
    "invoicingPartnerName" : "GSYPROM-OPDP1UI2",
    "invoicingPartnerShortName" : "GSYPROM-OPDP1UI2",
    "supplierPartyName" : null,
    "customerPartyName" : "Seven Corporation",
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : null,
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : "3512",
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : "Seven Corporation",
    "createdBy" : "username",
    "creationDate" : "2020-01-27T05:20:45+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-27T05:20:45.032+00:00",
    "supplierAddress" : null,
    "customerAddress" : "330 rue St-Vallier Est,Bureau 130,Quebec,CA,G1K 9C5",
    "supplierEmailAddress" : null,
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : null,
    "activeFlag" : true
  }, {
    "invoicingPartnerDescription" : "INVOICING PARTNER3",
    "invoicingPartnerId" : 300100184918343,
    "invoicingPartnerName" : "GSYPROM-OPDP1UI3",
    "invoicingPartnerShortName" : "GSYPROM-OPDP1UI3",
    "supplierPartyName" : null,
    "customerPartyName" : "Tall Manufacturing",
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : null,
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : "3474",
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : "Tall Manufacturing",
    "createdBy" : "username",
    "creationDate" : "2020-01-27T05:20:45+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-27T05:20:45.026+00:00",
    "supplierAddress" : null,
    "customerAddress" : "51 Prosta Street,Warsaw,PL,00-838",
    "supplierEmailAddress" : null,
    "customerEmailAddress" : null,
    "supplierPhone" : null,
    "customerPhone" : null,
    "activeFlag" : true
  }, {
    "invoicingPartnerDescription" : "INVOICING TALL",
    "invoicingPartnerId" : 300100184869563,
    "invoicingPartnerName" : "GSYPROM-OPDUI01",
    "invoicingPartnerShortName" : "GSYPROM-OPDUI01",
    "supplierPartyName" : null,
    "customerPartyName" : "Tall Manufacturing",
    "supplierBU" : null,
    "supplierSiteCode" : null,
    "supplierName" : null,
    "invoicingPartnerStatus" : "Active",
    "customerTaxNumber" : null,
    "supplierTaxNumber" : null,
    "customerAccountNumber" : "4726",
    "customerSetName" : null,
    "customerSiteLocation" : null,
    "warningMessage" : null,
    "customerAccountName" : null,
    "createdBy" : "username",
    "creationDate" : "2020-01-23T09:40:09+00:00",
    "lastUpdatedBy" : "username",
    "lastUpdateDate" : "2020-01-23T09:40:09.040+00:00",
    "supplierAddress" : null,
    "customerAddress" : "5901 Indian School Road NE,Suite 204,Albuquerque,NM,US,87110",
    "supplierEmailAddress" : null,
    "customerEmailAddress" : "[e-mail]",
    "supplierPhone" : null,
    "customerPhone" : "1-650-555 1122",
    "activeFlag" : true
  }, 

Back to Top