API

Logistics APIs

POST logistics/goods-receptions

Creates a new goods reception

HTTP method POST
URI https://api.rambase.net/logistics/goods-receptions
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 3307, version 6

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>
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
     <Location
Location

This field is optional.

>
7
          <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
8
     </Location>
9
     <Supplier>
10
          <SupplierId
SupplierId

Required/mandatory field

RamBase supplier identifier

Minimum value: 100

>{Integer}</SupplierId>
11
     </Supplier>
12
     <ShipFrom
ShipFrom

This field is optional.

>
13
          <AddressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

>{Integer}</AddressId>
14
     </ShipFrom>
15
     <Shipment
Shipment

This field is optional.

>
16
          <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>
17
          <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>
18
          <ShippingService
ShippingService

This field is optional.

>
19
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
20
          </ShippingService>
21
     </Shipment>
22
     <Payment
Payment

This field is optional.

>
23
          <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>
24
     </Payment>
25
</GoodsReception>
1
{
2
     "goodsReception": {
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
          "location
Location

This field is optional.

": {
8
               "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
9
          },
10
          "supplier": {
11
               "supplierId
SupplierId

Required/mandatory field

RamBase supplier identifier

Minimum value: 100

": "{Integer}"
12
          },
13
          "shipFrom
ShipFrom

This field is optional.

": {
14
               "addressId
AddressId

Address identifier

Minimum value: 1

This field is optional.

": "{Integer}"
15
          },
16
          "shipment
Shipment

This field is optional.

": {
17
               "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}",
18
               "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}",
19
               "shippingService
ShippingService

This field is optional.

": {
20
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
21
               }
22
          },
23
          "payment
Payment

This field is optional.

": {
24
               "paymentTerms
PaymentTerms

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

Applicable domain values can be found here

This field is optional.

": "{String}"
25
          }
26
     }
27
}

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.

Format:
1
<GoodsReception>
2
     <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
3
     <Status
Status

Status of the goods reception

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

>{String}</SuppliersReferenceNumber>
7
     <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
8
     <Type
Type

Type of goods reception

Possible domain values can be found here

>{String}</Type>
9
     <SubType
SubType

Subtype of goods reception

Possible domain values can be found here

>{String}</SubType>
10
     <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

>{String}</Note>
12
     <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.

>{String}</ShipToAttention>
13
     <Location>
14
          <Name
Name

Name of location

>{String}</Name>
15
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
16
     </Location>
17
     <Assignee
Assignee

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

>
18
          <UserId
UserId

User identifier

>{Integer}</UserId>
19
          <Name
Name

Name of the user

>{String}</Name>
20
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
21
          <UserLink
UserLink

User reference

>{String}</UserLink>
22
     </Assignee>
23
     <Supplier>
24
          <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
25
          <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>
26
               <DefaultInvoiceAddress>
27
                    <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
28
                    <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
29
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
30
                    <City
City

City/town/village

>{String}</City>
31
                    <Region
Region

Region/province/state

>{String}</Region>
32
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
33
                    <Country
Country

English name of country.

>{String}</Country>
34
               </DefaultInvoiceAddress>
35
          </Name>
36
          <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
37
     </Supplier>
38
     <Totals>
39
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
40
          <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
41
          <Currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

>{String}</Currency>
42
          <ExchangeRate
ExchangeRate

The exchange rate used in convertion

>{Decimal}</ExchangeRate>
43
          <TotalAmount
TotalAmount

The total amount in company currency, including VAT.

>{Decimal}</TotalAmount>
44
     </Totals>
45
     <ShipTo>
46
          <Name
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>
47
          <Firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
48
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
49
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
50
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
51
          <City
City

City/town/village

>{String}</City>
52
          <Region
Region

Region/province/state

>{String}</Region>
53
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
54
          <Country
Country

English name of country.

>{String}</Country>
55
          <Reference>
56
               <Database
Database

Database of the object

>{String}</Database>
57
               <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
58
               <ItemType
ItemType

Type of item

>{String}</ItemType>
59
               <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
60
               <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
61
               <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
62
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
63
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
64
          </Reference>
65
     </ShipTo>
66
     <ShipFrom>
67
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
68
          <Name
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>
69
          <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
70
          <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
71
          <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
72
          <City
City

City/town/village

>{String}</City>
73
          <Region
Region

Region/province/state

>{String}</Region>
74
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
75
          <Country
Country

English name of country.

>{String}</Country>
76
          <AddressLink
AddressLink

Supplier address reference

>{String}</AddressLink>
77
     </ShipFrom>
78
     <Shipment>
79
          <DeliveryTerms
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>
80
          <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

>{String}</DeliveryTermPlace>
81
          <ArrivingShipment>
82
               <ArrivingWaybill>
83
                    <ArrivingWaybillId
ArrivingWaybillId

Arriving waybill identifier

>{Integer}</ArrivingWaybillId>
84
                    <ArrivingWaybillLink
ArrivingWaybillLink

Arriving waybill reference

>{String}</ArrivingWaybillLink>
85
               </ArrivingWaybill>
86
          </ArrivingShipment>
87
          <ShippingService>
88
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
89
               <Name
Name

Name of shipping service

>{String}</Name>
90
               <Carrier>
91
                    <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
92
                    <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
93
               </Carrier>
94
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
95
          </ShippingService>
96
     </Shipment>
97
     <Payment>
98
          <PaymentTerms
PaymentTerms

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

Possible domain values can be found here

>{String}</PaymentTerms>
99
          <NotificationId
NotificationId

Notification identifier

>{Integer}</NotificationId>
100
          <Status
Status

Status of the notification

Possible domain values can be found here

>{Integer}</Status>
101
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
102
          <Message
Message

The message from the notification definition, expanded with parameters.

>{String}</Message>
103
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

>{String}</TranslatedMessage>
104
          <NotificationType>
105
               <NotificationTypeId
NotificationTypeId

Notification type identifier

>{String}</NotificationTypeId>
106
               <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

>{String}</Category>
107
               <NotificationTypeLink
NotificationTypeLink

Notification type reference

>{String}</NotificationTypeLink>
108
          </NotificationType>
109
          <NotificationLink
NotificationLink

Notification reference

>{String}</NotificationLink>
110
     </Payment>
111
</GoodsReception>
1
{
2
     "goodsReception": {
3
          "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
4
          "status
Status

Status of the goods reception

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

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

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

": "{String}",
8
          "registrationDate
RegistrationDate

Date of registration

": "{Date}",
9
          "type
Type

Type of goods reception

Possible domain values can be found here

": "{String}",
10
          "subType
SubType

Subtype of goods reception

Possible domain values can be found here

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

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

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

": "{String}",
13
          "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.

": "{String}",
14
          "location": {
15
               "name
Name

Name of location

": "{String}",
16
               "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
17
          },
18
          "assignee
Assignee

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

": {
19
               "userId
UserId

User identifier

": "{Integer}",
20
               "name
Name

Name of the user

": "{String}",
21
               "firstName
FirstName

First name of the user

": "{String}",
22
               "userLink
UserLink

User reference

": "{String}"
23
          },
24
          "supplier": {
25
               "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
26
               "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": {
27
                    "defaultInvoiceAddress": {
28
                         "addressLine1
AddressLine1

First address line

": "{String}",
29
                         "addressLine2
AddressLine2

Second address line

": "{String}",
30
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
31
                         "city
City

City/town/village

": "{String}",
32
                         "region
Region

Region/province/state

": "{String}",
33
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
34
                         "country
Country

English name of country.

": "{String}"
35
                    }
36
               },
37
               "supplierLink
SupplierLink

Supplier reference

": "{String}"
38
          },
39
          "totals": {
40
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
41
               "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}",
42
               "currency
Currency

Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.

": "{String}",
43
               "exchangeRate
ExchangeRate

The exchange rate used in convertion

": "{Decimal}",
44
               "totalAmount
TotalAmount

The total amount in company currency, including VAT.

": "{Decimal}"
45
          },
46
          "shipTo": {
47
               "name
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}",
48
               "firstname
Firstname

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
49
               "addressLine1
AddressLine1

First address line

": "{String}",
50
               "addressLine2
AddressLine2

Second address line

": "{String}",
51
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
52
               "city
City

City/town/village

": "{String}",
53
               "region
Region

Region/province/state

": "{String}",
54
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
55
               "country
Country

English name of country.

": "{String}",
56
               "reference": {
57
                    "database
Database

Database of the object

": "{String}",
58
                    "itemId
ItemId

Item-number of the object

": "{Integer}",
59
                    "itemType
ItemType

Type of item

": "{String}",
60
                    "itemLink
ItemLink

API reference to the item

": "{String}",
61
                    "objectId
ObjectId

Identifier of the object

": "{Integer}",
62
                    "objectType
ObjectType

Type of object

": "{String}",
63
                    "objectLink
ObjectLink

API reference to the object

": "{String}",
64
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
65
               }
66
          },
67
          "shipFrom": {
68
               "addressId
AddressId

Address identifier

": "{Integer}",
69
               "name
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}",
70
               "addressLine1
AddressLine1

First address line

": "{String}",
71
               "addressLine2
AddressLine2

Second address line

": "{String}",
72
               "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
73
               "city
City

City/town/village

": "{String}",
74
               "region
Region

Region/province/state

": "{String}",
75
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
76
               "country
Country

English name of country.

": "{String}",
77
               "addressLink
AddressLink

Supplier address reference

": "{String}"
78
          },
79
          "shipment": {
80
               "deliveryTerms
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}",
81
               "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

": "{String}",
82
               "arrivingShipment": {
83
                    "arrivingWaybill": {
84
                         "arrivingWaybillId
ArrivingWaybillId

Arriving waybill identifier

": "{Integer}",
85
                         "arrivingWaybillLink
ArrivingWaybillLink

Arriving waybill reference

": "{String}"
86
                    }
87
               },
88
               "shippingService": {
89
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
90
                    "name
Name

Name of shipping service

": "{String}",
91
                    "carrier": {
92
                         "carrierId
CarrierId

Carrier identifier

": "{Integer}",
93
                         "carrierLink
CarrierLink

Carrier reference

": "{String}"
94
                    },
95
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
96
               }
97
          },
98
          "payment": {
99
               "paymentTerms
PaymentTerms

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

Possible domain values can be found here

": "{String}",
100
               "notificationId
NotificationId

Notification identifier

": "{Integer}",
101
               "status
Status

Status of the notification

Possible domain values can be found here

": "{Integer}",
102
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
103
               "message
Message

The message from the notification definition, expanded with parameters.

": "{String}",
104
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

": "{String}",
105
               "notificationType": {
106
                    "notificationTypeId
NotificationTypeId

Notification type identifier

": "{String}",
107
                    "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

": "{String}",
108
                    "notificationTypeLink
NotificationTypeLink

Notification type reference

": "{String}"
109
               },
110
               "notificationLink
NotificationLink

Notification reference

": "{String}"
111
          }
112
     }
113
}

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 100033 HTTP 404 Sales order item not found
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