Procurement APIs
List out purchase requirements by subcontractor
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/purchase-requirements-by-subcontractor?locationId={locationId}&supplierId={supplierId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6503, version 54 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| locationId Integer, required |
Location identifier
Minimum: 10000 |
| supplierId Integer, optional |
RamBase supplier identifier
Minimum: 100 |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| DeadlineOverdue() Named filter | Items that have a deadline date earlier than today Deadline date = Date when you need to place a purchase order to receive it in time for the requirement, calculated by subtracting leadtime from required date. |
| MissingResponsible() Named filter | Components in a KIT structure where no responsible purchaser is set The KIT structure is connected to the PWO on these items |
| MyItems() Named filter | Components in a KIT structure where I am the responsible purchaser. The KIT structure is connected to the PWO on these items |
| CustomerId Integer | Customer identifier. |
| CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person). |
| CustomersReferenceNumber String | Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system. |
| DeadlineDate Date | The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| FinanceProjectId Integer | Finance project identifier. |
| FinanceProjectName String | Name of finance project. |
| IsOutsideOfAssignmentWindow Boolean | Indicates that this product is outside of assignment window. |
| ManufacturedProductId Integer | Product identifier. |
| ManufacturedProductName String | Name of production work order item. |
| NetRequirementQuantity Decimal | Required quantity. |
| NoteToPurchaser String | Note for product structure version's material. |
| NoteToSupplier String | Purchase order note for external operation, copied to the Note field at PO item. |
| PreferredSupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
| ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
| ProductionOperationId Integer | Production operation identifier. |
| ProductionOperationName String | Name of production operation. |
| ProductionWorkOrderId Integer | Production work order identifier. |
| ProductionWorkOrderStatus Integer | Status of production work order. |
| PurchaseGroupId String | Purchase group identifier. |
| PurchaseResponsibleEmployeeId Integer | Employee identifier. Available macros: currentUser() |
| PurchaseResponsibleFirstName String | First name of employee. |
| PurchaseResponsibleLastName String | Last name of employee. |
| RequestedDeliveryDate Date | The date the product is due back from the supplier. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| SalesDeliveryProjectId Integer | Sales delivery project identifier. |
| SalesDeliveryProjectName String | Name of sales delivery project. |
| ServicedProductName String | Name of the service product. |
Read more about filters and sorting on how to use sortable parameters
| CustomerId Integer | Customer identifier |
| CustomerName String | Name of customer (name of company or surname/familyname/lastname of a person) |
| CustomersReferenceNumber String | Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system. |
| DeadlineDate Date | The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date. |
| FinanceProjectId Integer | Finance project identifier |
| FinanceProjectName String | Name of finance project |
| IsOutsideOfAssignmentWindow Boolean | Indicates that this product is outside of assignment window |
| ManufacturedProductId Integer | Product identifier |
| ManufacturedProductName String | Name of production work order item |
| NetRequirementQuantity Decimal | Required quantity |
| NoteToPurchaser String | Note for product structure version's material |
| NoteToSupplier String | Purchase order note for external operation, copied to the Note field at PO item |
| PreferredSupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person) |
| ProductDescription String | Description of the item. If not specified, the description is by default copied from the product. |
| ProductionOperationId Integer | Production operation identifier |
| ProductionOperationName String | Name of production operation |
| ProductionWorkOrderId Integer | Production work order identifier |
| ProductionWorkOrderStatus Integer | Status of production work order |
| PurchaseGroupId String | Purchase group identifier |
| PurchaseResponsibleEmployeeId Integer | Employee identifier |
| PurchaseResponsibleFirstName String | First name of employee |
| PurchaseResponsibleLastName String | Last name of employee |
| RequestedDeliveryDate Date | The date the product is due back from the supplier. |
| SalesDeliveryProjectId Integer | Sales delivery project identifier |
| SalesDeliveryProjectName String | Name of sales delivery project |
| ServicedProductName String | Name of the service product |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
PurchaseRequirementsBySubcontractorId
Purchase requirements by subcontractor identifier
>{Integer}</PurchaseRequirementsBySubcontractorId>NetRequirementQuantity
Required quantity
>{Decimal}</NetRequirementQuantity>RequestedDeliveryDate
The date the product is due back from the supplier.
>{Date}</RequestedDeliveryDate>DeadlineDate
The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date.
>{Date}</DeadlineDate>ProductId
Product identifier
>{Integer}</ProductId>Name
The product being serviced
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>Status
Status of production work order
Possible domain values can be found here
>{Integer}</Status>ManufacturedProductName
Name of production work order item
>{String}</ManufacturedProductName>CustomersReferenceNumber
Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
>{String}</CustomersReferenceNumber>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>PlannedOperationId
Planned work order operation identifier
>{Integer}</PlannedOperationId>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductId
Product identifier
>{String}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product identifier
>{String}</ProductLink>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>NoteToSupplier
Purchase order note for external operation, copied to the Note field at PO item
>{String}</NoteToSupplier>LeadTime
Material lead time in days for external operations
>{Integer}</LeadTime>NoteToPurchaser
Note for product structure version's material
>{String}</NoteToPurchaser>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>ProductStructureVersionLink
Product structure reference
>{String}</ProductStructureVersionLink>PlannedFinishedAt
Date and time planned to finish. Specified by the planned work order operation.
>{Datetime}</PlannedFinishedAt>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>Name
Name of production operation
>{String}</Name>SerialNumber
Serial number
>{String}</SerialNumber>SubcontractorId
Subcontractor identifier
>{Integer}</SubcontractorId>StandardLeadTime
Leadtime in days
>{Integer}</StandardLeadTime>IsPreferred
When creating a new structure (KIT) the system will pick values from the preferred supplier and calculate the leadtime for the outsourced operation
>{Boolean}</IsPreferred>To
Transporttime in days from manufacturer premises to supplier
>{Integer}</To>From
Transporttime in days from supplier to manufacturer premises
>{Integer}</From>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier reference
>{String}</SupplierLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>PurchaseRequirementsBySubcontractorId
Purchase requirements by subcontractor identifier
": "{Integer}",NetRequirementQuantity
Required quantity
": "{Decimal}",RequestedDeliveryDate
The date the product is due back from the supplier.
": "{Date}",DeadlineDate
The latest date for placing a purchase order for this product to receive it in time for the requirement. Calculated by subtracting leadtime from required date.
": "{Date}",ProductId
Product identifier
": "{Integer}",Name
The product being serviced
": "{String}",ProductLink
Product reference
": "{String}"ProductionWorkOrderId
Production work order identifier
": "{Integer}",Status
Status of production work order
Possible domain values can be found here
": "{Integer}",ManufacturedProductName
Name of production work order item
": "{String}",CustomersReferenceNumber
Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
": "{String}",ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"PlannedOperationId
Planned work order operation identifier
": "{Integer}",ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductId
Product identifier
": "{String}",Name
Name of the product
": "{String}",ProductLink
Product identifier
": "{String}"ProductionOperationLink
Production operation reference
": "{String}"NoteToSupplier
Purchase order note for external operation, copied to the Note field at PO item
": "{String}",LeadTime
Material lead time in days for external operations
": "{Integer}",NoteToPurchaser
Note for product structure version's material
": "{String}",ProductStructureVersionId
Product structure identifier
": "{Integer}",ProductStructureVersionLink
Product structure reference
": "{String}"PlannedFinishedAt
Date and time planned to finish. Specified by the planned work order operation.
": "{Datetime}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",Name
Name of production operation
": "{String}"SerialNumber
Serial number
": "{String}"SubcontractorId
Subcontractor identifier
": "{Integer}",StandardLeadTime
Leadtime in days
": "{Integer}",IsPreferred
When creating a new structure (KIT) the system will pick values from the preferred supplier and calculate the leadtime for the outsourced operation
": "{Boolean}",To
Transporttime in days from manufacturer premises to supplier
": "{Integer}",From
Transporttime in days from supplier to manufacturer premises
": "{Integer}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 99946 HTTP 400 | {0}: Missing mandatory arguments {1} |
| Error 101746 HTTP 404 | Product structure not found. Id: {0} |