Procurement APIs
Update provided purchase contract
| HTTP method | PUT |
| URI | https://api.rambase.net/procurement/contracts/{purchaseContractId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseContractId} |
Purchase contract identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 3937, version 5 |
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.
PurchaseContract
This field is optional.
>Title
The title of the purchase contract
This field is optional.
>{String}</Title>Description
The description of what the contract is about
This field is optional.
>{String}</Description>Category
The type of the contract.
Examples: Automatic or Consent
Applicable domain values can be found here
This field is optional.
>{Integer}</Category>Supplier
This field is optional.
>SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
>{Integer}</SupplierId>Contact
Link to the suppliers contact person
This field is optional.
>ContactId
Contact identifier
Minimum value: 100000
This field is optional.
>{Integer}</ContactId>Validity
This field is optional.
>EffectiveDate
The start of the purchase contract
This field is optional.
>{Date}</EffectiveDate>ExpirationDate
The end of the purchase contract
This field is optional.
>{Date}</ExpirationDate>IsTerminable
Specifies if the contract is terminable not not
This field is optional.
>{Boolean}</IsTerminable>TerminationNoticePeriod
The length in days of the termination period. This will not have a meaning if the contract in non-terminable
Minimum value: 0
This field is optional.
>{Integer}</TerminationNoticePeriod>RenewalDueDays
The minimum number of days before EndDate where the contract can be either cancelled (if set to automatically renew) or renewed (if set to be renewed by consent)
Minimum value: 0
This field is optional.
>{Integer}</RenewalDueDays>Value
This field is optional.
>Currency
Three character code following the ISO 4217 standard
This field is optional.
>{String}</Currency>ValuePerPeriod
The monetary value per period
This field is optional.
>{Decimal}</ValuePerPeriod>PeriodSpecification
The periodic schedule of the contract.
Values:
- Month = 30 days
- Week = 7 days
- Year = 365 days
- Quarter = 90 days
Applicable domain values can be found here
This field is optional.
>{Integer}</PeriodSpecification>MainResponsible
The link to the main responsible employee. This is also the main contact point for the contract from the suppliers point of view
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>BackupResponsible
Link to the PID responsible if the main responsible is not available
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>PurchaseContract
This field is optional.
": {Title
The title of the purchase contract
This field is optional.
": "{String}",Description
The description of what the contract is about
This field is optional.
": "{String}",Category
The type of the contract.
Examples: Automatic or Consent
Applicable domain values can be found here
This field is optional.
": "{Integer}",Supplier
This field is optional.
": {SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
": "{Integer}"Contact
Link to the suppliers contact person
This field is optional.
": {ContactId
Contact identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Validity
This field is optional.
": {EffectiveDate
The start of the purchase contract
This field is optional.
": "{Date}",ExpirationDate
The end of the purchase contract
This field is optional.
": "{Date}",IsTerminable
Specifies if the contract is terminable not not
This field is optional.
": "{Boolean}",TerminationNoticePeriod
The length in days of the termination period. This will not have a meaning if the contract in non-terminable
Minimum value: 0
This field is optional.
": "{Integer}",RenewalDueDays
The minimum number of days before EndDate where the contract can be either cancelled (if set to automatically renew) or renewed (if set to be renewed by consent)
Minimum value: 0
This field is optional.
": "{Integer}"Value
This field is optional.
": {Currency
Three character code following the ISO 4217 standard
This field is optional.
": "{String}",ValuePerPeriod
The monetary value per period
This field is optional.
": "{Decimal}",PeriodSpecification
The periodic schedule of the contract.
Values:
- Month = 30 days
- Week = 7 days
- Year = 365 days
- Quarter = 90 days
Applicable domain values can be found here
This field is optional.
": "{Integer}"MainResponsible
The link to the main responsible employee. This is also the main contact point for the contract from the suppliers point of view
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"BackupResponsible
Link to the PID responsible if the main responsible is not available
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
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.
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 101119 HTTP 404 | Shipping service was not found |
| Error 101376 HTTP 400 | ShippingService is not active (status 4) |
| Error 101375 HTTP 400 | Direction of the Shipping Service mismatch with type of transaction document |
| Error 101399 HTTP 400 | Customer account in shipping service mismatch with this customer account |
| Error 101385 HTTP 400 | The carrier that offers this shipping service is not activ (status 4) |
| Error 104984 HTTP 400 | Expiration date is required |
| Error 104985 HTTP 400 | Main responsible is required |