Procurement APIs
Purchase order backlog
| Report name | Purchase order backlog |
| Report identifier | 114096 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/114096/result-set?productionWorkOrderId={productionorder}&customersReferenceNumber={customersreferencenumber}&initialOrder={initialorder}&supplierName={suppliername} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 6115, version 12 |
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.
| productionWorkOrderId String, optional | Production work order identifier |
| customersReferenceNumber String, optional | Customers reference number. E.g. the internal sales order id the customer use in their own system. |
| initialOrder String, optional | Initial purchase order identifier |
| supplierName String, optional | Name of supplier (name of company or surname/familyname/lastname of a person) |
| $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.
| AssignmentProductName String | Name of the product. |
| AssignmentQuantity Decimal | Quantity assigned. |
| ConfirmedDate Date | Confirmed delivery date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ConsumptionDate Date | Shipping date retrieved from the assigned item. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| 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. |
| Deviation Integer | The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier. |
| EmployeeId Integer | Employee identifier. Available macros: currentUser() |
| InitialPurchaseOrderId Integer | Identifier of the object. |
| InitialPurchaseOrderItemId Integer | Item-number of the object. |
| ProductName String | Name of the product. |
| ProductType String | Type of product. |
| RemainingQuantity Decimal | The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped. |
| RequestedDate Date | The delivery date as requested by the buyer/purchaser. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ResponsibleId Integer | Employee identifier. Available macros: currentUser() |
| SupplierId String | RamBase supplier identifier. |
| SupplierItemId Integer | Item-number of the object. |
| SupplierItemObjectId Integer | Identifier of the object. |
| SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person). |
Read more about filters and sorting on how to use sortable parameters
| AssignmentProductName String | Name of the product |
| AssignmentQuantity Decimal | Quantity assigned |
| ConfirmedDate Date | Confirmed delivery date |
| ConsumptionDate Date | Shipping date retrieved from the assigned item |
| 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. |
| Deviation Integer | The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier. |
| EmployeeId Integer | Employee identifier |
| InitialPurchaseOrderId Integer | Identifier of the object |
| InitialPurchaseOrderItemId Integer | Item-number of the object |
| ProductName String | Name of the product |
| ProductType String | Type of product |
| RemainingQuantity Decimal | The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped. |
| RequestedDate Date | The delivery date as requested by the buyer/purchaser |
| ResponsibleId Integer | Employee identifier |
| SupplierId String | RamBase supplier identifier |
| SupplierItemId Integer | Item-number of the object |
| SupplierItemObjectId Integer | Identifier of the object |
| SupplierName String | Name of supplier (name of company or surname/familyname/lastname of a person) |
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.
Supplier
Supplier reference
>SupplierId
RamBase supplier identifier
>{String}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
API reference to the item
>{String}</SupplierLink>InitialPurchaseOrderItem
Purchase order item reference
>PurchaseOrderItemId
Item-/line-number of the purchase order
>{Integer}</PurchaseOrderItemId>PurchaseOrder
Purchase order reference
>PurchaseOrderId
Purchase order identifier
>{Integer}</PurchaseOrderId>PurchaseOrderLink
Purchase order reference
>{String}</PurchaseOrderLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>PurchaseOrderItemLink
Purchase order item reference
>{String}</PurchaseOrderItemLink>SupplierItem
Identifier of the SupplierItem
>ItemId
Item-number of the object
>{Integer}</ItemId>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemLink
API reference to the item
>{String}</ItemLink>RemainingQuantity
The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.
>{Decimal}</RemainingQuantity>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>Type
Type of product
>{String}</Type>ProductLink
Product reference
>{String}</ProductLink>RequestedDate
The delivery date as requested by the buyer/purchaser
>{Date}</RequestedDate>ConfirmedDate
Confirmed delivery date
>{Date}</ConfirmedDate>ConsumptionDate
Shipping date retrieved from the assigned item
>{Date}</ConsumptionDate>PlannedOperation
Planned operation identifier
>PlannedOperationId
Planned work order operation identifier
>{Integer}</PlannedOperationId>PlannedStartAt
Date and time of planned start
>{Datetime}</PlannedStartAt>Deviation
The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
>{Integer}</Deviation>Assignment
Assignment reference
>AssignedTo
Assigned to reference
>ItemId
Item-number of the object
>{Integer}</ItemId>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>Quantity
Quantity assigned
>{Decimal}</Quantity>PlannedShipDate
Planned start date for the operation line and for the operation that a material/part line is connected to
>{Date}</PlannedShipDate>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>SentFromSupplier
Date sent from supplier
>{Date}</SentFromSupplier>QuantitySent
Quantity sent
>{Integer}</QuantitySent>PurchaseResponsible
User responsible for the procurement transaction
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>Name
Last name of employee
>{String}</Name>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>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>Supplier
Supplier reference
": {SupplierId
RamBase supplier identifier
": "{String}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
API reference to the item
": "{String}"InitialPurchaseOrderItem
Purchase order item reference
": {PurchaseOrderItemId
Item-/line-number of the purchase order
": "{Integer}",PurchaseOrder
Purchase order reference
": {PurchaseOrderId
Purchase order identifier
": "{Integer}",PurchaseOrderLink
Purchase order reference
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",PurchaseOrderItemLink
Purchase order item reference
": "{String}"SupplierItem
Identifier of the SupplierItem
": {ItemId
Item-number of the object
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemLink
API reference to the item
": "{String}"RemainingQuantity
The remaining quantity of the assignment register. If the owner item is of object type purchase order, purchase order response or production work order, the remaining quantity will be decreased when quantity is forwarded from the object. If the owner item is of object type goods reception, the remaining quantity will be decreased when goods from this object is shipped.
": "{Decimal}",Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",Type
Type of product
": "{String}",ProductLink
Product reference
": "{String}"RequestedDate
The delivery date as requested by the buyer/purchaser
": "{Date}",ConfirmedDate
Confirmed delivery date
": "{Date}",ConsumptionDate
Shipping date retrieved from the assigned item
": "{Date}",PlannedOperation
Planned operation identifier
": {PlannedOperationId
Planned work order operation identifier
": "{Integer}",PlannedStartAt
Date and time of planned start
": "{Datetime}"Deviation
The deviation between Earliest consumption date and Confirmed delivery date, or Requested delivery date if no delivery date is confirmed by the supplier.
": "{Integer}",Assignment
Assignment reference
": {AssignedTo
Assigned to reference
": {ItemId
Item-number of the object
": "{Integer}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product reference
": "{String}"Quantity
Quantity assigned
": "{Decimal}",PlannedShipDate
Planned start date for the operation line and for the operation that a material/part line is connected to
": "{Date}",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}"SentFromSupplier
Date sent from supplier
": "{Date}",QuantitySent
Quantity sent
": "{Integer}",PurchaseResponsible
User responsible for the procurement transaction
": {EmployeeId
Employee identifier
": "{Integer}",Name
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"TargetApplication
Application reference when inspecting a line in a report.
": "{String}"
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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |