Procurement APIs
Create a new supplier return
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/returns |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3231, version 7 |
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.
Type
Required/mandatory field
Type of supplier return
Applicable domain values can be found here
>{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>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>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>Type
Required/mandatory field
Type of supplier return
Applicable domain values can be found here
": "{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}",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}"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. |
| $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] |
| $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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
SupplierReturnId
Supplier return identifier
>{Integer}</SupplierReturnId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>ShippingDate
Date of shipment departure
>{Date}</ShippingDate>SuppliersReference
Suppliers/sellers reference. Typically a person.
>{String}</SuppliersReference>SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
>{String}</Note>NetWeight
The net weight of object (excluding packing material) in kilograms
>{Decimal}</NetWeight>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{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.
>{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.
>{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.
>{String}</ShippingAddressEmail>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Firstname/givenname if the supplier is a person
>AddressId
Address identifier
>{Integer}</AddressId>Attention
Attention note.
>{String}</Attention>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>AddressLink
Address reference
>{String}</AddressLink>SupplierLink
Supplier reference
>{String}</SupplierLink>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>FreightAmount
Freight amount in transaction document's currency
>{Decimal}</FreightAmount>TotalAmount
The total amount in object currency, including VAT
>{Decimal}</TotalAmount>Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>FreightAmount
Freight amount in company currency.
>{Decimal}</FreightAmount>TotalAmount
The total amount in company currency, including VAT.
>{Decimal}</TotalAmount>AddressId
Address identifier
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>AddressLink
Address reference
>{String}</AddressLink>Priority
Priority of the shipment
Possible domain values can be found here
>{Integer}</Priority>DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
>{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
>{String}</DeliveryTermPlace>ShipmentId
Shipment identifier
>{Long}</ShipmentId>DepartingWaybillId
Departing waybill identifier
>{Integer}</DepartingWaybillId>DepartingWaybillLink
Departing waybill reference
>{String}</DepartingWaybillLink>ShipmentLink
Shipment reference
>{String}</ShipmentLink>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>{String}</Name>CarrierId
Carrier identifier
>{Integer}</CarrierId>CarrierLink
Carrier reference
>{String}</CarrierLink>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Possible domain values can be found here
>{String}</PaymentTerms>NotificationId
Notification identifier
>{Integer}</NotificationId>Status
Status of the notification
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationLink
Notification reference
>{String}</NotificationLink>SupplierReturnId
Supplier return identifier
": "{Integer}",Status
Status of supplier return
Possible domain values can be found here
": "{Integer}",Type
Type of supplier return
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",ShippingDate
Date of shipment departure
": "{Date}",SuppliersReference
Suppliers/sellers reference. Typically a person.
": "{String}",SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
": "{String}",NetWeight
The net weight of object (excluding packing material) in kilograms
": "{Decimal}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
": "{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.
": "{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.
": "{String}",Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"LocationId
Location identifier
": "{Integer}",Name
Name of location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Firstname/givenname if the supplier is a person
": {AddressId
Address identifier
": "{Integer}",Attention
Attention note.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",AddressLink
Address reference
": "{String}"SupplierLink
Supplier reference
": "{String}"Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",FreightAmount
Freight amount in transaction document's currency
": "{Decimal}",TotalAmount
The total amount in object currency, including VAT
": "{Decimal}",Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",FreightAmount
Freight amount in company currency.
": "{Decimal}",TotalAmount
The total amount in company currency, including VAT.
": "{Decimal}"AddressId
Address identifier
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",AddressLink
Address reference
": "{String}"Priority
Priority of the shipment
Possible domain values can be found here
": "{Integer}",DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
": "{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
": "{String}",ShipmentId
Shipment identifier
": "{Long}",DepartingWaybillId
Departing waybill identifier
": "{Integer}",DepartingWaybillLink
Departing waybill reference
": "{String}"ShipmentLink
Shipment reference
": "{String}"ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": "{String}",CarrierId
Carrier identifier
": "{Integer}",CarrierLink
Carrier reference
": "{String}"ShippingServiceLink
Shipping service reference
": "{String}"PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Possible domain values can be found here
": "{String}",NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"NotificationLink
Notification reference
": "{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 102027 HTTP 400 | Illegal Operation : {0} has finance jobs not executed |
| Error 103343 HTTP 400 | Illegal update : Accountingperiod {0} is closed. |
| Error 103342 HTTP 400 | Illegal Update : Accountingperiod {0} has agio calculations. |
| Error 101069 HTTP 404 | Stock assignment link - document not found |
| Error 108717 HTTP 400 | Base date of rental contract is required |
| Error 100345 HTTP 400 | Location is required |
| Error 108514 HTTP 400 | Invalid invoice frequency |
| Error 102035 HTTP 400 | Effective date is required |
| Error 108421 HTTP 400 | The effective date cannot be later than the expiration date |
| Error 108635 HTTP 400 | Effective date cannot be later then effective date of any contract item |
| 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 108969 HTTP 400 | The selected default check-out location ({0}) is not active |
| Error 108970 HTTP 400 | The selected default check-out location ({0}) is not a rental depot capable location |
| Error 108971 HTTP 400 | The selected default check-in location ({0}) is not active |
| Error 108972 HTTP 400 | The selected default check-in location ({0}) is not a rental depot capable location |
| Error 109335 HTTP 400 | Selected payment term is not supported on rental contract |
| Error 108670 HTTP 400 | Discount percentage must be a number between 0 and 100 |
| Error 109623 HTTP 400 | VAT handling can't be changed since there has been made invoice(s) from this contract |
| Error 109539 HTTP 400 | Dimension value {0} could not be used : Check its FromPeriod and ToPeriod. |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |
| Error 108691 HTTP 400 | Recurring rate is not active |
| Error 108018 HTTP 400 | Currency mismatch |
| Error 108016 HTTP 400 | Product id mismatch |
| Error 108824 HTTP 400 | Cannot apply recurring rate as it is not valid for selected period |
| Error 109556 HTTP 400 | Effective date can not be earlier than quote's expiration date |
| Error 108671 HTTP 400 | The effective date cannot be changed because earlier days have already been invoiced |
| Error 108684 HTTP 400 | The expiration date cannot be changed because later days have already been invoiced |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |
| Error 109306 HTTP 400 | Shipping details can only be updated until an item is shipped |
| Error 109467 HTTP 400 | The rental unit is not available to non-owners for the selected period |
| Error 109315 HTTP 400 | Rental unit is not available within given period |