ROSE Developers - Web API Reference

Goods Receipt | Goods Receipt Notification

This service manages the data needed for the creation of Goods Receipt Note.

Overview


URL api/{tenantKey}/{orgKey}/goodsReceipt/goodsReceiptNotifications
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET GoodsReceiptNotifications

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See GoodsReceiptNotificationResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications

GET GoodsReceiptNotifications (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See GoodsReceiptNotificationResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications?page={page}&pageSize={pageSize}

GET GoodsReceiptNotification by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See GoodsReceiptNotificationResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications/{id}

GET GoodsReceiptNotification by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
goodsReceiptNotificationKey (int) Goods Receipt Notification.

Response:

When successful, the response body contains the entity record. See GoodsReceiptNotificationResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}

GET Print GoodsReceiptNotification by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications/{id}/print?template={template}

GET Print GoodsReceiptNotification by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
goodsReceiptNotificationKey (int) Goods Receipt Notification.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/print

GET Original Print GoodsReceiptNotificationOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications/{id}/printOriginal?template={template}

GET Original Print GoodsReceiptNotification by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
goodsReceiptNotificationKey (int) Goods Receipt Notification.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/printOriginal

POST Operations

POST GoodsReceiptNotifications

Creates a new entity record.

The following elements are required:

goodsReceiptNotificationResource (ApiGoodsReceiptNotificationResource) The request body should contain the entity record that should be created.
See ApiGoodsReceiptNotificationResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiGoodsReceiptNotificationResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /goodsReceipt/goodsReceiptNotifications

POST Goods Receipt Notification

Inserts a new 'Receipt Notification Line' in the 'Goods Receipt Notification'.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (ApiGoodsReceiptNotificationDocumentLinesResource) The ApiGoodsReceiptNotificationDocumentLinesResource instance.
See ApiGoodsReceiptNotificationDocumentLinesResource.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines

PUT Operations

PUT Set AccountingParty GoodsReceiptNotification

Updates the value of attribute 'AccountingParty' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/accountingParty

PUT Set AccountingPartyAddress GoodsReceiptNotification

Updates the value of attribute 'AccountingPartyAddress' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/accountingPartyAddress

PUT Set AccountingPartyName GoodsReceiptNotification

Updates the value of attribute 'AccountingPartyName' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/accountingPartyName

PUT Set CommitmentReference GoodsReceiptNotificationLine

Updates the value of attribute 'CommitmentReference' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/commitmentReference

PUT Set Company GoodsReceiptNotification

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/company

PUT Set ComplementaryDescription GoodsReceiptNotificationLine

Updates the value of attribute 'ComplementaryDescription' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/complementaryDescription

PUT Set Currency GoodsReceiptNotification

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/currency

PUT Set CustomAttributes GoodsReceiptNotification

Updates the value of attribute 'CustomAttributes' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/customAttributes

PUT Set CustomAttributes GoodsReceiptNotificationLine

Updates the value of attribute 'CustomAttributes' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/customAttributes

PUT Set DeliveryDate GoodsReceiptNotificationLine

Updates the value of attribute 'DeliveryDate' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/deliveryDate

PUT Set DeliveryMode GoodsReceiptNotification

Updates the value of attribute 'DeliveryMode' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/deliveryMode

PUT Set DeliveryTerm GoodsReceiptNotification

Updates the value of attribute 'DeliveryTerm' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/deliveryTerm

PUT Set Description GoodsReceiptNotificationLine

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/description

PUT Set DimensionSet GoodsReceiptNotification

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/dimensionSet

PUT Set DimensionSet GoodsReceiptNotificationLine

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/dimensionSet

PUT Set Discount GoodsReceiptNotification

Updates the value of attribute 'Discount' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/discount

PUT Set Discount1 GoodsReceiptNotificationLine

Updates the value of attribute 'Discount1' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/discount1

PUT Set Discount2 GoodsReceiptNotificationLine

Updates the value of attribute 'Discount2' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/discount2

PUT Set Discount3 GoodsReceiptNotificationLine

Updates the value of attribute 'Discount3' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/discount3

PUT Set DocumentLineStatus GoodsReceiptNotificationLine

Updates the value of attribute 'DocumentLineStatus' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum DocumentLineStatus) The request body should contain the new value for the attribute.
See DocumentLineStatus.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/documentLineStatus

PUT Set DocumentStatus GoodsReceiptNotification

Updates the value of attribute 'DocumentStatus' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (enum DocumentStatus) The request body should contain the new value for the attribute.
See DocumentStatus.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentStatus

PUT Set GoodsReceiptNoteType GoodsReceiptNotification

Updates the value of attribute 'GoodsReceiptNoteType' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/goodsReceiptNoteType

PUT Set GoodsReceiptNotificationKey GoodsReceiptNotification

Updates the value of attribute 'GoodsReceiptNotificationKey' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/goodsReceiptNotificationKey

PUT Set IsActive GoodsReceiptNotification

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/isActive

PUT Set Item GoodsReceiptNotificationLine

Updates the value of attribute 'Item' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/item

PUT Set ItemTaxSchema GoodsReceiptNotificationLine

Updates the value of attribute 'ItemTaxSchema' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/itemTaxSchema

PUT Set LoadingBuildingNumber GoodsReceiptNotification

Updates the value of attribute 'LoadingBuildingNumber' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/loadingBuildingNumber

PUT Set LoadingCityName GoodsReceiptNotification

Updates the value of attribute 'LoadingCityName' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/loadingCityName

PUT Set LoadingCountry GoodsReceiptNotification

Updates the value of attribute 'LoadingCountry' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/loadingCountry

PUT Set LoadingPoint GoodsReceiptNotification

Updates the value of attribute 'LoadingPoint' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/loadingPoint

PUT Set LoadingPostalZone GoodsReceiptNotification

Updates the value of attribute 'LoadingPostalZone' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/loadingPostalZone

PUT Set LoadingStreetName GoodsReceiptNotification

Updates the value of attribute 'LoadingStreetName' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/loadingStreetName

PUT Set LogisticsProcess GoodsReceiptNotification

Updates the value of attribute 'LogisticsProcess' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (enum LogisticsProcess) The request body should contain the new value for the attribute.
See LogisticsProcess.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/logisticsProcess

PUT Set OpenQuantity GoodsReceiptNotificationLine

Updates the value of attribute 'OpenQuantity' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/openQuantity

PUT Set Party GoodsReceiptNotification

Updates the value of attribute 'Party' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/party

PUT Set PartyAddress GoodsReceiptNotification

Updates the value of attribute 'PartyAddress' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/partyAddress

PUT Set PartyName GoodsReceiptNotification

Updates the value of attribute 'PartyName' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/partyName

PUT Set PartyTaxId GoodsReceiptNotification

Updates the value of attribute 'PartyTaxId' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/partyTaxId

PUT Set PartyTaxSchema GoodsReceiptNotificationLine

Updates the value of attribute 'PartyTaxSchema' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/partyTaxSchema

PUT Set PaymentMethod GoodsReceiptNotification

Updates the value of attribute 'PaymentMethod' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/paymentMethod

PUT Set PaymentTerm GoodsReceiptNotification

Updates the value of attribute 'PaymentTerm' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/paymentTerm

PUT Set Quantity GoodsReceiptNotificationLine

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/quantity

PUT Set SourceDoc GoodsReceiptNotification

Updates the value of attribute 'SourceDoc' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/sourceDoc

PUT Set SourceDocDate GoodsReceiptNotification

Updates the value of attribute 'SourceDocDate' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/sourceDocDate

PUT Set SourceDocId GoodsReceiptNotification

Updates the value of attribute 'SourceDocId' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/sourceDocId

PUT Set SourceDocLine GoodsReceiptNotificationLine

Updates the value of attribute 'SourceDocLine' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/sourceDocLine

PUT Set SourceDocLineId GoodsReceiptNotificationLine

Updates the value of attribute 'SourceDocLineId' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/sourceDocLineId

PUT Set SourceOrder GoodsReceiptNotificationLine

Updates the value of attribute 'SourceOrder' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/sourceOrder

PUT Set SourceOrderId GoodsReceiptNotificationLine

Updates the value of attribute 'SourceOrderId' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/sourceOrderId

PUT Set SourceOrderLine GoodsReceiptNotificationLine

Updates the value of attribute 'SourceOrderLine' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/sourceOrderLine

PUT Set SourceOrderLineId GoodsReceiptNotificationLine

Updates the value of attribute 'SourceOrderLineId' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/sourceOrderLineId

PUT Set SourceOrderSchemaEntityId GoodsReceiptNotificationLine

Updates the value of attribute 'SourceOrderSchemaEntityId' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/sourceOrderSchemaEntityId

PUT Set SourceSchemaEntity GoodsReceiptNotification

Updates the value of attribute 'SourceSchemaEntity' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/sourceSchemaEntity

PUT Set TaxIncluded GoodsReceiptNotification

Updates the value of attribute 'TaxIncluded' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/taxIncluded

PUT Set Unit GoodsReceiptNotificationLine

Updates the value of attribute 'Unit' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/unit

PUT Set UnitPrice GoodsReceiptNotificationLine

Updates the value of attribute 'UnitPrice' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/unitPrice

PUT Set UnloadingBuildingNumber GoodsReceiptNotification

Updates the value of attribute 'UnloadingBuildingNumber' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/unloadingBuildingNumber

PUT Set UnloadingCityName GoodsReceiptNotification

Updates the value of attribute 'UnloadingCityName' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/unloadingCityName

PUT Set UnloadingCountry GoodsReceiptNotification

Updates the value of attribute 'UnloadingCountry' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/unloadingCountry

PUT Set UnloadingPoint GoodsReceiptNotification

Updates the value of attribute 'UnloadingPoint' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/unloadingPoint

PUT Set UnloadingPostalZone GoodsReceiptNotification

Updates the value of attribute 'UnloadingPostalZone' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/unloadingPostalZone

PUT Set UnloadingStreetName GoodsReceiptNotification

Updates the value of attribute 'UnloadingStreetName' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/unloadingStreetName

PUT Set Warehouse GoodsReceiptNotificationLine

Updates the value of attribute 'Warehouse' in the specified entity record.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}/warehouse

DELETE Operations

DELETE Receipt Notification Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
companyKey (string) The company key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}/documentLines/{lineId}

DELETE GoodsReceiptNotification by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /goodsReceipt/goodsReceiptNotifications/{id}

DELETE GoodsReceiptNotification by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
goodsReceiptNotificationKey (int) Goods Receipt Notification.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /goodsReceipt/goodsReceiptNotifications/{companyKey}/{goodsReceiptNotificationKey}

Resources


ApiGoodsReceiptNotificationDocumentLinesResource

The following elements are required:

item (string) Item.
unitPrice (decimal) Unit Price.
unit (string) Unit.
partyTaxSchema (string) Party Tax Schema.
itemTaxSchema (string) Item Tax Schema.
documentLineStatus (enum DocumentLineStatus) Document Line Status.
See DocumentLineStatus.
sourceDocLine (int) Source Doc. Line.
sourceDocLineId (Guid) Source Doc. Line Id.

The following elements are optional:

description (string) Description.
complementaryDescription (string) Complementary Description.
deliveryDate (DateTime) Delivery Date.
quantity (decimal) Quantity.
openQuantity (decimal) Open Quantity.
discount1 (decimal) Discount 1.
discount2 (decimal) Discount 2.
discount3 (decimal) Discount 3.
warehouse (string) Warehouse.
sourceOrder (string) Order.
sourceOrderId (Guid) Order Id.
sourceOrderLine (int) Line.
sourceOrderLineId (Guid) Line Id.
sourceOrderSchemaEntityId (Guid) Order Schema Entity Id.
dimensionSet (string) Dimension Set.
commitmentReference (string) The state supplier commitment reference.
customAttributes (string) The order line custom attributes.


ApiGoodsReceiptNotificationResource

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
goodsReceiptNoteType (string) Goods Receipt Note Type.
company (string) Company.
currency (string) Currency.
documentStatus (enum DocumentStatus) Document Status.
See DocumentStatus.
party (string) Party.
loadingCountry (string) Loading Country.
unloadingCountry (string) Unloading Country.
paymentMethod (string) Payment Method.
paymentTerm (string) Payment Term.
accountingParty (string) Accounting Party.

The following elements are optional:

deliveryTerm (string) Delivery Term.
partyName (string) Party Name.
partyAddress (string) Party Address.
partyTaxId (string) Party Tax ID.
discount (decimal) Discount.
logisticsProcess (enum LogisticsProcess) Logistics Process.
See LogisticsProcess.
loadingPoint (string) Loading Point.
loadingStreetName (string) Loading Street Name.
loadingBuildingNumber (string) Loading Building Number.
loadingPostalZone (string) Loading Postal Zone.
loadingCityName (string) Loading City Name.
unloadingPoint (string) Unloading Point.
unloadingStreetName (string) Unloading Street Name.
unloadingBuildingNumber (string) Unloading Building Number.
unloadingPostalZone (string) Unloading Postal Zone.
unloadingCityName (string) Unloading City Name.
sourceSchemaEntity (string) Source Schema Entity.
sourceDoc (string) Source Doc.
sourceDocId (Guid) Source Doc. Id.
sourceDocDate (DateTimeOffset) Source Doc. Date.
taxIncluded (bool) Tax Included.
accountingPartyName (string) Accounting Party Name.
accountingPartyAddress (string) Accounting Party Address.
documentLines (List of ApiGoodsReceiptNotificationDocumentLinesResource) Document Lines.
See ApiGoodsReceiptNotificationDocumentLinesResource.
deliveryMode (string) Delivery Mode.
dimensionSet (string) Dimension Set.
customAttributes (string) The order custom attributes.


GoodsReceiptNotificationLineResource

The following elements are required:

item (string) Item.
unitPrice (decimal) Unit Price.
unit (string) Unit.
partyTaxSchema (string) Party Tax Schema.
itemTaxSchema (string) Item Tax Schema.
documentLineStatus (enum DocumentLineStatus) Document Line Status.
See DocumentLineStatus.
sourceDocLine (int) Source Doc. Line.
sourceDocLineId (Guid) Source Doc. Line Id.
itemType (enum ItemType) Item Type.
See ItemType.

The following elements are optional:

description (string) Description.
complementaryDescription (string) Complementary Description.
deliveryDate (DateTime) Delivery Date.
quantity (decimal) Quantity.
openQuantity (decimal) Open Quantity.
discount1 (decimal) Discount 1.
discount2 (decimal) Discount 2.
discount3 (decimal) Discount 3.
warehouse (string) Warehouse.
sourceOrder (string) Order.
sourceOrderId (Guid) Order Id.
sourceOrderLine (int) Line.
sourceOrderLineId (Guid) Line Id.
sourceOrderSchemaEntityId (Guid) Order Schema Entity Id.
dimensionSet (string) Dimension Set.
commitmentReference (string) The state supplier commitment reference.
customAttributes (string) The order line custom attributes.


GoodsReceiptNotificationResource

The following elements are required:

goodsReceiptNotificationKey (int) Goods Receipt Notification.
goodsReceiptNoteType (string) Goods Receipt Note Type.
(fk) Allowed value: the natural key of a record of type GoodsReceiptNoteType. These records are accessibly through the GoodsReceiptNoteTypes service.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
currency (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
documentStatus (enum DocumentStatus) Document Status.
See DocumentStatus.
party (string) Party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
loadingCountry (string) Loading Country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
unloadingCountry (string) Unloading Country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
paymentMethod (string) Payment Method.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
paymentTerm (string) Payment Term.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
accountingParty (string) Accounting Party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.

The following elements are optional:

deliveryTerm (string) Delivery Term.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
partyName (string) Party Name.
partyAddress (string) Party Address.
partyTaxId (string) Party Tax ID.
discount (decimal) Discount.
logisticsProcess (enum LogisticsProcess) Logistics Process.
See LogisticsProcess.
loadingPoint (string) Loading Point.
loadingStreetName (string) Loading Street Name.
loadingBuildingNumber (string) Loading Building Number.
loadingPostalZone (string) Loading Postal Zone.
loadingCityName (string) Loading City Name.
unloadingPoint (string) Unloading Point.
unloadingStreetName (string) Unloading Street Name.
unloadingBuildingNumber (string) Unloading Building Number.
unloadingPostalZone (string) Unloading Postal Zone.
unloadingCityName (string) Unloading City Name.
sourceSchemaEntity (string) Source Schema Entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
sourceDoc (string) Source Doc.
sourceDocId (Guid) Source Doc. Id.
sourceDocDate (DateTimeOffset) Source Doc. Date.
taxIncluded (bool) Tax Included.
accountingPartyName (string) Accounting Party Name.
accountingPartyAddress (string) Accounting Party Address.
documentLines (List of GoodsReceiptNotificationLineResource) Document Lines.
See GoodsReceiptNotificationLineResource.
deliveryMode (string) Delivery Mode.
(fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
dimensionSet (string) Dimension Set.
(fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
customAttributes (string) The order custom attributes.


Enumerations


DocumentLineStatus

1 Open
2 Completed


DocumentStatus

1 Open
2 Completed
3 Processing


ItemType

1 Item
2 Service


LogisticsProcess

1 Sales
2 Purchases
3 OwnAssetMovements