Procurement APIs
Update details of provided supplier return
| HTTP method | PUT |
| URI | https://api.rambase.net/procurement/returns/{supplierReturnId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {supplierReturnId} |
Supplier return identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 3230, version 11 |
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.
SupplierReturn
This field is optional.
>Type
Type of supplier return
Applicable domain values can be found here
This field is optional.
>{String}</Type>SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
>{String}</SuppliersReference>SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
>{String}</Note>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
>{String}</ShippingAddressAttention>ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
>{String}</ShippingAddressPhone>ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
>{String}</ShippingAddressEmail>Assignee
The user who has been assigned to work with this object.
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 1000
This field is optional.
>{Integer}</LocationId>Supplier
This field is optional.
>SupplierId
RamBase supplier identifier
Minimum value: 10000
This field is optional.
>{Integer}</SupplierId>Totals
This field is optional.
>FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
>{Decimal}</FreightAmount>ShippingAddress
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Shipment
This field is optional.
>Priority
Priority of the shipment
Applicable domain values can be found here
This field is optional.
>{Integer}</Priority>DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
>{String}</DeliveryTerms>DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
>{String}</DeliveryTermPlace>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
>{Integer}</ShippingServiceId>SupplierReturn
This field is optional.
": {Type
Type of supplier return
Applicable domain values can be found here
This field is optional.
": "{String}",SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
": "{String}",SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
": "{String}",ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
": "{String}",ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
": "{String}",Assignee
The user who has been assigned to work with this object.
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 1000
This field is optional.
": "{Integer}"Supplier
This field is optional.
": {SupplierId
RamBase supplier identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Totals
This field is optional.
": {FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
": "{Decimal}"ShippingAddress
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"Shipment
This field is optional.
": {Priority
Priority of the shipment
Applicable domain values can be found here
This field is optional.
": "{Integer}",DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
": "{String}",DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
": "{String}",ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
Minimum value: 100000
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 100009 HTTP 400 | Missing required input arguments |
| Error 103837 HTTP 400 | Recalculation failed. Missing product id. |
| Error 103838 HTTP 400 | Recalculation failed. Missing location. |
| Error 101069 HTTP 404 | Stock assignment link - document not found |
| Error 100345 HTTP 400 | Location is required |
| Error 108514 HTTP 400 | Invalid invoice frequency |
| Error 108635 HTTP 400 | Effective date cannot be later then effective date of any contract item |
| Error 108421 HTTP 400 | The effective date cannot be later than the expiration date |
| Error 108735 HTTP 400 | Expiration date of a contract cannot be earlier then expiration date of any of its quotes |
| Error 108674 HTTP 400 | Termination date cannot be earlier then the effective date |
| Error 108675 HTTP 400 | Termination date cannot be later then the expiration date |
| Error 108672 HTTP 400 | Closing date cannot be earlier then the effective date |
| Error 108673 HTTP 400 | Closing date cannot be later then the expiration date |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |
| Error 108680 HTTP 400 | Collection date cannot be earlier then the effective date |
| Error 108681 HTTP 400 | Collection date cannot be earlier then the expected delivery date |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |