Jump to

• Request
• Response
• Examples

Create a salesperson reference account

post

/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BusinessUnit: string
  Title: Business Unit

  A unit of an enterprise that performs one or more business functions that can be rolled up in a management hierarchy. The business unit is part of the unique set that identifies a reference account.
• FreightAccountCombination: string
  Title: Freight Account Combination

  The accounting flexfield combination for the Freight account.
• ReceivablesAccountCombination: string
  Title: Receivables Account Combination

  The accounting flexfield combination for the Receivables account.
• RevenueAccountCombination: string
  Title: Revenue Account Combination

  The accounting flexfield combination for the Revenue account.
• SalespersonId: integer
  Title: Salesperson ID

  The unique identifier of the salesperson.
• SalespersonName: string
  Title: Salesperson Name

  Maximum Length: 360

  The name of the salesperson. The salesperson name is part of the unique set that identifies a reference account.
• SalespersonNumber: string
  Title: Salesperson Number

  Maximum Length: 120

  The number that identifies the salesperson. The salesperson number is part of the unique set that identifies a reference account.

{
    "type":"object",
    "properties":{
        "SalespersonNumber":{
            "title":"Salesperson Number",
            "maxLength":120,
            "type":"string",
            "description":"The number that identifies the salesperson. The salesperson number is part of the unique set that identifies a reference account.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SalesrepNumber"
                ]
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"string",
            "description":"A unit of an enterprise that performs one or more business functions that can be rolled up in a management hierarchy. The business unit is part of the unique set that identifies a reference account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BU_NAME"
                ]
            }
        },
        "ReceivablesAccountCombination":{
            "title":"Receivables Account Combination",
            "type":"string",
            "description":"The accounting flexfield combination for the Receivables account.",
            "nullable":true,
            "x-queryable":false
        },
        "RevenueAccountCombination":{
            "title":"Revenue Account Combination",
            "type":"string",
            "description":"The accounting flexfield combination for the Revenue account.",
            "nullable":true,
            "x-queryable":false
        },
        "SalespersonName":{
            "title":"Salesperson Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the salesperson. The salesperson name is part of the unique set that identifies a reference account.",
            "nullable":true
        },
        "SalespersonId":{
            "title":"Salesperson ID",
            "type":"integer",
            "description":"The unique identifier of the salesperson.",
            "nullable":false
        },
        "FreightAccountCombination":{
            "title":"Freight Account Combination",
            "type":"string",
            "description":"The accounting flexfield combination for the Freight account.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : salespersonReferenceAccounts-item-response

Type: object

Show Source

• BusinessUnit: string
  Title: Business Unit

  A unit of an enterprise that performs one or more business functions that can be rolled up in a management hierarchy. The business unit is part of the unique set that identifies a reference account.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• FreightAccountCombination: string
  Title: Freight Account Combination

  The accounting flexfield combination for the Freight account.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• Ledger: string
  Title: Ledger

  Read Only: true

  Maximum Length: 30

  A ledger at the business unit level which holds all the accounting information details.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReceivablesAccountCombination: string
  Title: Receivables Account Combination

  The accounting flexfield combination for the Receivables account.
• RevenueAccountCombination: string
  Title: Revenue Account Combination

  The accounting flexfield combination for the Revenue account.
• SalespersonEndDate: string (date)
  Title: Salesperson End Date

  Read Only: true

  The date when the salesperson is terminated.
• SalespersonId: integer
  Title: Salesperson ID

  The unique identifier of the salesperson.
• SalespersonName: string
  Title: Salesperson Name

  Maximum Length: 360

  The name of the salesperson. The salesperson name is part of the unique set that identifies a reference account.
• SalespersonNumber: string
  Title: Salesperson Number

  Maximum Length: 120

  The number that identifies the salesperson. The salesperson number is part of the unique set that identifies a reference account.
• SalespersonSet: string
  Title: Salesperson Set

  Read Only: true

  Maximum Length: 80

  The reference set assigned to the salesperson during salesperson creation to support data partitioning.
• SalespersonStartDate: string (date)
  Title: Salesperson Start Date

  Read Only: true

  The date when the salesperson is hired.
• SalespersonStatus: string
  Title: Salesperson Status

  Read Only: true

  Maximum Length: 80

  The status of the salesperson. Valid values are Active and Inactive.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceivablesAccountCombination":{
            "title":"Receivables Account Combination",
            "type":"string",
            "description":"The accounting flexfield combination for the Receivables account.",
            "nullable":true,
            "x-queryable":false
        },
        "Ledger":{
            "title":"Ledger",
            "maxLength":30,
            "type":"string",
            "description":"A ledger at the business unit level which holds all the accounting information details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SalespersonNumber":{
            "title":"Salesperson Number",
            "maxLength":120,
            "type":"string",
            "description":"The number that identifies the salesperson. The salesperson number is part of the unique set that identifies a reference account.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SalesrepNumber"
                ]
            },
            "x-queryable":true
        },
        "SalespersonSet":{
            "title":"Salesperson Set",
            "maxLength":80,
            "type":"string",
            "description":"The reference set assigned to the salesperson during salesperson creation to support data partitioning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SalespersonStartDate":{
            "title":"Salesperson Start Date",
            "type":"string",
            "description":"The date when the salesperson is hired.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"string",
            "description":"A unit of an enterprise that performs one or more business functions that can be rolled up in a management hierarchy. The business unit is part of the unique set that identifies a reference account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BU_NAME"
                ]
            },
            "x-queryable":true
        },
        "RevenueAccountCombination":{
            "title":"Revenue Account Combination",
            "type":"string",
            "description":"The accounting flexfield combination for the Revenue account.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SalespersonName":{
            "title":"Salesperson Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the salesperson. The salesperson name is part of the unique set that identifies a reference account.",
            "nullable":true,
            "x-queryable":true
        },
        "SalespersonId":{
            "title":"Salesperson ID",
            "type":"integer",
            "description":"The unique identifier of the salesperson.",
            "nullable":false,
            "x-queryable":true
        },
        "FreightAccountCombination":{
            "title":"Freight Account Combination",
            "type":"string",
            "description":"The accounting flexfield combination for the Freight account.",
            "nullable":true,
            "x-queryable":false
        },
        "SalespersonStatus":{
            "title":"Salesperson Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the salesperson. Valid values are Active and Inactive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalespersonEndDate":{
            "title":"Salesperson End Date",
            "type":"string",
            "description":"The date when the salesperson is terminated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 create a salesperson reference account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "SalespersonName": "Caroline Snel",
    "SalespersonNumber": "999990000955248",
    "BusinessUnit": "Vision India Corp",
    "ReceivablesAccountCombination": "01-430-5800-1400-000",
    "FreightAccountCombination": "01-430-5800-1400-000",
    "RevenueAccountCombination": "00-000-1100-1100-100"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "SalespersonId": 100000008143166,
    "SalespersonNumber": "999990000955248",
    "SalespersonName": "Caroline Snel",
    "BusinessUnit": "Vision India Corp",
    "ReceivablesAccountCombination": "01-430-5800-1400-000",
    "FreightAccountCombination": "01-430-5800-1400-000",
    "RevenueAccountCombination": "00-000-1100-1100-100",
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts/00030000000EACED0005770800005AF310F6813E0000000C52415F53414C4553524550530000000EACED00057708000110F0811A38A7",
            "name": "salespersonReferenceAccounts",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts/00030000000EACED0005770800005AF310F6813E0000000C52415F53414C4553524550530000000EACED00057708000110F0811A38A7",
            "name": "salespersonReferenceAccounts",
            "kind": "item"
        },
        ...
    ]
}

Back to Top