SrfInbound (POST) | GEP TECH DOCUMENTATION

Overview

This API is used to create or update a sourcing request document.

URL Format : https://<Instance>/leosrfcorev2api/api/v1/Inbound/SrfInbound

Request

https://<Instance>/leosrfcorev2api/api/v1/Inbound/SrfInbound

{
   "action": "Create",
   "basicDetail": {
      "name": "SRFMUMQC04",
      "currency": "USD",
      "regions": [
         "371"
      ],
      "requestType": "RFQ",
      "reasonOfCreation": "CTEC",
      "description": "test description",
      "orgEntities": [
         {
            "entityCode": "ORG",
            "entityType": "Organization",
            "lOBEntityCode": "DF"
         }
      ],
      "categories": [
         51336250001717
      ],
      "status": "Pending",
      "isClientCategoryCodeAvailable": false,
      "isRegionIdAvailable": true
   },
   "itemDetails": [
      {
         "action": "Create",
         "itemType": "Material",
         "isManualItem": true,
         "row": [
            {
               "columnName": "Item Number",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Item Name",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Item Description",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Engineering Change",
               "columnValue": 123,
               "isCompositeKey": false
            },
            {
               "columnName": "Item Version",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "User Group",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Receiving Facility Code",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Receiving Facility Name",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Year 1 EAU",
               "columnValue": 123,
               "isCompositeKey": false
            },
            {
               "columnName": "2 year estimated volume",
               "columnValue": 123,
               "isCompositeKey": false
            },
            {
               "columnName": "Link to print and specs",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Link to ETQ",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "APQP",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Org Entity",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Design Control Code",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Unit of Measure",
               "columnValue": "test",
               "isCompositeKey": false
            },
            {
               "columnName": "Receiving Facility Country",
               "columnValue": "test",
               "isCompositeKey": false
            }
         ]
      }
   ],
   "isclientSupplierCode": true,
   "clientSupplierCode": [
      "PC2023.003919"
   ],
   "attachments": [
      {
         "action": "Create",
         "fileId": "MLaUH7SKIPoH6JWRnaBa9RWZ8iB3I6bk2oHaZjFBYxNvgoyfqZ*8DNU5GOLL5fCz",
         "fileName": "ItemMaster_Fri_06_01_2023_638086009688848154 (1).xlsx",
         "fileSize": 150110
      }
   ],
   "notesAndLinks": [
      {
         "action": "Create",
         "name": "test",
         "description": "test",
         "id": "08592f412296794e5422dfc793f8d9f",
         "classificationType": {
            "name": "",
            "id": null,
            "code": "",
            "culture": "enUS",
            "version": "1"
         },
         "visibility": {
            "id": 1,
            "name": "Public",
            "code": "public"
         },
         "flag": {
            "id": 1,
            "name": "Standard",
            "code": "standard"
         }
      }
   ]
}

Response

{
   "name": "Sourcing Request for CBSSAP3",
   "documentNumber": "SRF0006640",
   "documentId": "a546daee606f4ce39dae8ca24faf23ab",
   "clientDocumentId": "",
   "suppliers": [],
   "attachments": [],
   "notesAndLinks": [],
   "items": [
      {
         "itemId": "0341dc884572462a9aeeeeebb08072ef",
         "clientItemId": "232113000"
      }
   ]
}

Data Elements

Field Name	Type	Description
Name	String	Name of the sourcing request.
Document Number	String	Unique number assigned to the document.
Document ID	String	Unique identifier for the document.
Client Document ID	String	Unique identifier for the client document (if applicable).
Suppliers	Array of Objects	List of suppliers associated with the sourcing request.
Attachments	Array of Objects	List of attachments related to the sourcing request.
Notes and Links	Array of Objects	Contains notes and links related to the sourcing request.
Items	Array of Objects	Contains item details associated with the sourcing request.
Item ID	String	Unique identifier for the item.
Client Item ID	String	Unique identifier for the item from the client perspective.

Field Name	Type	Description	Validation
Action	String	Indicates the action to be performed (Create/Update).	Must be either "Create" or "Update"
Document ID / Client Document ID	String	Unique identifier for the document or client document.	Must be a nonempty string
Basic Detail	Object	Contains fundamental information about the document.	Must contain all required fields
Name	String	Name of the document.	Must be a nonempty string
Currency	String	Currency used.	Must be a valid currency code (ISO 4217)
Regions	Array of Strings	List of region identifiers.	Must not be empty
Request Type	String	Type of request.	Must be a nonempty string
Reason of Creation	String	Reason for creating the document.	Must be a nonempty string
Description	String	Description of the document.	Must be a nonempty string
Org Entities	Array of Objects	List of organizational entities associated with the document.	Must contain at least one entity
Entity Code	String	Code representing the entity.	Must be a nonempty string
Entity Type	String	Type of entity.	Must be a nonempty string
LOB Entity Code	String	Line of business code.	Must be a nonempty string
Categories	Array of Numbers	List of category identifiers.	Must not be empty
Status	String	Current status of the document.	Must be a valid status (e.g., Pending, Approved)
Is Client Category Code Available	Boolean	Indicates if the client category code is available.	No specific validation
Is Region ID Available	Boolean	Indicates if the region ID is available.	No specific validation
Item Details	Array of Objects	Contains detailed information about items associated with the document.	Must contain at least one item
Action	String	Action to perform on the item (Create/Update).	Must be either "Create" or "Update"
Item Type	String	Type of item (e.g., Material).	Must be a nonempty string
Is Manual Item	Boolean	Indicates if the item is manually entered.	No specific validation
Array of Objects	Represents columns and their values for the item.	Must contain at least one column
Column Name	String	Name of the column.	Must be a nonempty string
Column Value	Mixed (String, Number)	Value of the column.	Must not be null
Is Composite Key	Boolean	Indicates if this column is part of a composite key.	No specific validation
Is Client Supplier Code	Boolean	Indicates if a client supplier code is associated.	No specific validation
Suppliers	Array of Objects	Contains supplier information.	Must contain at least one supplier
Action	String	Action to perform on the supplier (create).	Must be "create"
Client Supplier Code	String	Unique code for the client supplier.	Must be a nonempty string
Attachments	Array of Objects	List of attachments related to the document.	Must contain at least one attachment
Action	String	Action to perform on the attachment (Create).	Must be "Create"
File ID	String	Unique identifier for the file.	Must be a nonempty string
File Name	String	Name of the file.	Must be a nonempty string
File Size	Number	Size of the file in bytes.	Must be a positive number
Notes and Links	Array of Objects	Contains additional notes and links related to the document.	Must contain at least one note/link
Action	String	Action to perform (Create).	Must be "Create"
Name	String	Name of the note/link.	Must be a nonempty string
Description	String	Description of the note/link.	Must be a nonempty string
ID	String	Unique identifier for the note/link.	Must be a nonempty string
Classification Type	Object	Classification details.	Must contain required fields
Name	String	Name of the classification.	Must be a nonempty string
ID	Mixed (String, Null)	ID of the classification.	Must be a nonempty string or null
Culture	String	Culture identifier.	Must be a nonempty string
Version	String	Version of the classification.	Must be a nonempty string
Visibility	Object	Visibility settings.	Must contain required fields
ID	Number	Unique ID for visibility setting.	Must be a positive number
Name	String	Name of the visibility setting.	Must be a nonempty string
Flag	Object	Flag settings.	Must contain required fields
ID	Number	Unique ID for flag.	Must be a positive number
Name	String	Name of the flag.	Must be a nonempty string