API

Logistics APIs

PUT logistics/goods-receptions/{goodsReceptionId}

Update provided goods reception

HTTP method PUT
URI https://api.rambase.net/logistics/goods-receptions/{goodsReceptionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {goodsReceptionId} Goods reception identifier
Integer, minimum 10000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3327, version 14

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.

Format:
1
<GoodsReception
GoodsReception

This field is optional.

>
2
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

>{String}</SuppliersReference>
3
     <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers reference number. Typically to an external system.

This field is optional.

>{String}</SuppliersReferenceNumber>
4
     <Currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

>{String}</Currency>
5
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
6
     <ShipToAttention
ShipToAttention

Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.

This field is optional.

>{String}</ShipToAttention>
7
     <Location
Location

This field is optional.

>
8
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
9
     </Location>
10
     <Assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

>
11
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
12
     </Assignee>
13
     <Supplier
Supplier

This field is optional.

>
14
          <SupplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

>{Integer}</SupplierId>
15
     </Supplier>
16
     <ShipFrom
ShipFrom

This field is optional.

>
17
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
18
     </ShipFrom>
19
     <Shipment
Shipment

This field is optional.

>
20
          <DeliveryTerms
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>
21
          <DeliveryTermPlace
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>
22
          <ArrivingShipment
ArrivingShipment

This field is optional.

>
23
               <ArrivingWaybill
ArrivingWaybill

This field is optional.

>
24
                    <ArrivingWaybillId
ArrivingWaybillId

Arriving waybill identifier

Minimum value: 100000

This field is optional.

>{Integer}</ArrivingWaybillId>
25
               </ArrivingWaybill>
26
          </ArrivingShipment>
27
          <ShippingService
ShippingService

This field is optional.

>
28
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
29
          </ShippingService>
30
     </Shipment>
31
     <Payment
Payment

This field is optional.

>
32
          <PaymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Applicable domain values can be found here

This field is optional.

>{String}</PaymentTerms>
33
     </Payment>
34
</GoodsReception>
1
{
2
     "goodsReception
GoodsReception

This field is optional.

": {
3
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

This field is optional.

": "{String}",
4
          "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers reference number. Typically to an external system.

This field is optional.

": "{String}",
5
          "currency
Currency

Three character code following the ISO 4217 standard

Applicable domain values can be found here

This field is optional.

": "{String}",
6
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

This field is optional.

": "{String}",
7
          "shipToAttention
ShipToAttention

Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.

This field is optional.

": "{String}",
8
          "location
Location

This field is optional.

": {
9
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
10
          },
11
          "assignee
Assignee

The user who has been assigned to work with this object.

This field is optional.

": {
12
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
13
          },
14
          "supplier
Supplier

This field is optional.

": {
15
               "supplierId
SupplierId

RamBase supplier identifier

Minimum value: 100

This field is optional.

": "{Integer}"
16
          },
17
          "shipFrom
ShipFrom

This field is optional.

": {
18
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
19
          },
20
          "shipment
Shipment

This field is optional.

": {
21
               "deliveryTerms
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}",
22
               "deliveryTermPlace
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}",
23
               "arrivingShipment
ArrivingShipment

This field is optional.

": {
24
                    "arrivingWaybill
ArrivingWaybill

This field is optional.

": {
25
                         "arrivingWaybillId
ArrivingWaybillId

Arriving waybill identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
26
                    }
27
               },
28
               "shippingService
ShippingService

This field is optional.

": {
29
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
30
               }
31
          },
32
          "payment
Payment

This field is optional.

": {
33
               "paymentTerms
PaymentTerms

Terms of payment. Defaut value is retrieved from the supplier.

Applicable domain values can be found here

This field is optional.

": "{String}"
34
          }
35
     }
36
}

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.

Format:
1
1

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 101746 HTTP 404 Product structure not found. Id: {0}
Error 102201 HTTP 400 New confirmed delivery date must be specified.
Error 104700 HTTP 400 VAT already postponed.
Error 104703 HTTP 400 VAT amount is equal to 0
Error 101494 HTTP 400 Illegal VAT code: Vat code and document has different VAT number
Error 101496 HTTP 400 Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod
Error 101495 HTTP 400 Illegal VAT code: {0}
Error 107641 HTTP 400 VAT code {0} has not an active VAT code setup
Error 100984 HTTP 400 Illegal update. The General ledger posting has ST>4
Error 100985 HTTP 400 Illegal update. The General ledger posting has AGIO-calculation
Error 104521 HTTP 400 Goods reception can only be added to arriving waybill which is ready for goods reception process (status 3) or pending customs documents (status 5)
Error 104522 HTTP 400 Location in goods reception must be equal to location in arriving waybill