Procurement APIs
Get purchase order document transaction details
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/orders/{purchaseOrderId}/items/{itemId}/document-transactions/{documentTransactionId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderId} |
Purchase order identifier
Integer, minimum 100000 |
| - URI parameter {itemId} |
Item-/line-number of the purchase order
Integer, minimum 1 |
| - URI parameter {documentTransactionId} |
Document transaction identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 5000, version 13 |
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.
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
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.
DocumentTransactionId
Document transaction identifier
>{Integer}</DocumentTransactionId>TriggeredAt
Date and time of creation
>{Datetime}</TriggeredAt>TriggeredBy
Who triggered the transaction
>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>OrderedQuantity
Purchase order quantity
>{Decimal}</OrderedQuantity>OrderedAmount
Purchase order amount
>{Decimal}</OrderedAmount>ConfirmedQuantity
Confirmed quantity
>{Decimal}</ConfirmedQuantity>ConfirmedAmount
Confirmed amount
>{Decimal}</ConfirmedAmount>ReceivedQuantity
Received quantity
>{Decimal}</ReceivedQuantity>ReceivedAmount
Received amount
>{Decimal}</ReceivedAmount>InvoicedQuantity
Invoiced quantity
>{Decimal}</InvoicedQuantity>InvoicedAmount
Invoice amount
>{Decimal}</InvoicedAmount>CanceledQuantity
Canceled quantity
>{Decimal}</CanceledQuantity>CanceledAmount
Canceled amount
>{Decimal}</CanceledAmount>ClosedWithoutInvoiceQuantity
Closed without invoice quantity
>{Decimal}</ClosedWithoutInvoiceQuantity>ClosedWithoutInvoiceAmount
Closed without invoice amount
>{Decimal}</ClosedWithoutInvoiceAmount>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>DocumentTransactionId
Document transaction identifier
": "{Integer}",TriggeredAt
Date and time of creation
": "{Datetime}",TriggeredBy
Who triggered the transaction
": {UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"Type
Type of the transaction
Possible domain values can be found here
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",OrderedQuantity
Purchase order quantity
": "{Decimal}",OrderedAmount
Purchase order amount
": "{Decimal}",ConfirmedQuantity
Confirmed quantity
": "{Decimal}",ConfirmedAmount
Confirmed amount
": "{Decimal}",ReceivedQuantity
Received quantity
": "{Decimal}",ReceivedAmount
Received amount
": "{Decimal}",InvoicedQuantity
Invoiced quantity
": "{Decimal}",InvoicedAmount
Invoice amount
": "{Decimal}",CanceledQuantity
Canceled quantity
": "{Decimal}",CanceledAmount
Canceled amount
": "{Decimal}",ClosedWithoutInvoiceQuantity
Closed without invoice quantity
": "{Decimal}",ClosedWithoutInvoiceAmount
Closed without invoice amount
": "{Decimal}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{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 101814 HTTP 404 | Employee not found |
| Error 106352 HTTP 404 | Purchase order assignment movement not found |