ROSE Developers - Web API Reference

Goods Receipt | Goods Receipt

The Goods Receipt Note represents the document that serves as a confirmation to the receipt of materials.

Overview


URL api/{tenantKey}/{orgKey}/goodsReceipt/goodsReceiptNotes
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 GoodsReceiptNotes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /goodsReceipt/goodsReceiptNotes

GET GoodsReceiptNotes (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 GoodsReceiptNoteResource.

Response status codes:

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

Resource URL:

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

GET GoodsReceiptNote 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 GoodsReceiptNoteResource.

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/goodsReceiptNotes/{id}

GET GoodsReceiptNote by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

Response:

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

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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}

GET Print GoodsReceiptNote 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/goodsReceiptNotes/{id}/print?template={template}

GET Print GoodsReceiptNote by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/print

GET Original Print GoodsReceiptNoteOriginal 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/goodsReceiptNotes/{id}/printOriginal?template={template}

GET Original Print GoodsReceiptNote by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal

POST Operations

POST GoodsReceiptNotes

Creates a new entity record.

The following elements are required:

goodsReceiptNoteResource (ApiGoodsReceiptNoteResource) The request body should contain the entity record that should be created.
See ApiGoodsReceiptNoteResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiGoodsReceiptNoteResource.

Response status codes:

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

Resource URL:

POST /goodsReceipt/goodsReceiptNotes

POST Goods Receipt

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey (string) The company key.
value (ApiGoodsReceiptNoteDocumentLinesResource) The ApiGoodsReceiptNoteDocumentLinesResource instance.
See ApiGoodsReceiptNoteDocumentLinesResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines

POST To Return Order

The To Return Order end point is used to create a return order based on a Goods Receipt Note.

The following elements are required:

goodsReceiptNotesReturnOrder (GoodsReceiptNotesReturnOrder) The Goods Receipt Notes Return Order resource (company key + document key).

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a unique identifier.

Resource URL:

POST /goodsReceipt/goodsReceiptNotes/toReturnOrder

PUT Operations

PUT Set AccountingPartyTaxId GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyTaxId

PUT Set CommitmentReference GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/commitmentReference

PUT Set ComplementaryDescription GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/complementaryDescription

PUT Set DeliveryDate GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/deliveryDate

PUT Set DeliveryMode GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryMode

PUT Set Description GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/description

PUT Set DimensionSet GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSet

PUT Set DimensionSetJson GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson

PUT Set DocumentDate GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentDate

PUT Set EmailTo GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/emailTo

PUT Set IsActive GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive

PUT Set IsReturned GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/isReturned

PUT Set LoadingBuildingNumber GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingBuildingNumber

PUT Set LoadingCityName GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCityName

PUT Set LoadingCountry GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCountry

PUT Set LoadingDateTime GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingDateTime

PUT Set LoadingPoint GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPoint

PUT Set LoadingPointAddress GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPointAddress

PUT Set LoadingPostalZone GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPostalZone

PUT Set LoadingStreetName GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingStreetName

PUT Set LogisticsPartyName GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/logisticsPartyName

PUT Set LogisticsPartyTaxId GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/logisticsPartyTaxId

PUT Set NonDeductibleAmount GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/nonDeductibleAmount

PUT Set Note GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/note

PUT Set NoteToRecipient GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient

PUT Set Notification GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/notification

PUT Set PrintedReportName GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName

PUT Set Remarks GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks

PUT Set SourceOrder GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrder

PUT Set SourceOrderId GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderId

PUT Set SourceOrderLine GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLine

PUT Set SourceOrderLineId GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLineId

PUT Set SourceOrderSchemaEntityId GoodsReceiptNoteLine

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderSchemaEntityId

PUT Set UnloadingBuildingNumber GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingBuildingNumber

PUT Set UnloadingCityName GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCityName

PUT Set UnloadingCountry GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCountry

PUT Set UnloadingDateTime GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingDateTime

PUT Set UnloadingPoint GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPoint

PUT Set UnloadingPointAddress GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPointAddress

PUT Set UnloadingPostalZone GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPostalZone

PUT Set UnloadingStreetName GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingStreetName

PUT Set VehiclePlateNumber GoodsReceiptNote

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

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/vehiclePlateNumber

PUT Set Custom Attribute GoodsReceiptNote

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/{customAttributeName}

PUT Set Custom Attribute GoodsReceiptNoteLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Goods Receipt Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}

DELETE GoodsReceiptNote 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/goodsReceiptNotes/{id}

DELETE GoodsReceiptNote by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

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/goodsReceiptNotes/{companyKey}/{documentType}/{serie}/{seriesNumber}

Resources


ApiGoodsReceiptNoteDocumentLinesResource

The following elements are required:

description (string) The line item description.
warehouse (string) The warehouse where the goods are to be received.
quantity (decimal) The quantity fot the goods receipt (in transaction unit).
deliveryDate (DateTime) Expected reception date.
nonDeductibleAmount (MoneyResource) Calculate line non deductible amount.
See MoneyResource .

The following elements are optional:

complementaryDescription (string) The receipt line item complementary description.
dimensionSet (string) The dimension set. Infered from the materials dimensions..
dimensionSetJson (string) Dimension Set Json.
sourceOrder (string) The order that origin this line.
sourceOrderId (Guid) The order id that origin this line.
sourceOrderLine (int) The order line index that origin this line.
sourceOrderLineId (Guid) The order line id that origin this line.
sourceOrderSchemaEntityId (Guid) The order schema id that origin this line.
commitmentReference (string) The state supplier commitment reference.


ApiGoodsReceiptNoteResource

The following elements are required:

documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
documentDate (DateTime) The date when the document is issued.
isReturned (bool) Is true if is a return document.

The following elements are optional:

logisticsPartyName (string) The party name. It is inferred from the party.
logisticsPartyTaxId (string) The party tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities.
accountingPartyTaxId (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
note (string) The document's note.
remarks (string) The goods receipt remarks.
loadingPoint (string) The physical location where the goods are loaded. The default is the company physical location.
loadingStreetName (string) The street name of the physical location where the goods are loaded. The default is the company physical location.
loadingBuildingNumber (string) The building number of the physical location where the goods are loaded. The default is the company physical location.
loadingCityName (string) The city of the physical location where the goods are loaded. The default is the company physical location.
loadingPostalZone (string) The postal zone of the physical location where the goods are loaded. The default is the company physical location.
loadingCountry (string) The country of the physical location where the goods are loaded. The default is the company country.
loadingPointAddress (string) The physical location address where the goods are loaded. The default is the company physical location address.
loadingDateTime (DateTimeOffset) The goods loading date and time from the loading physical location. The default is the invoice creation date and time.
unloadingPoint (string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is customer address.
unloadingStreetName (string) The street name of the physical location where the goods are unloaded. The default is customer address street name.
unloadingBuildingNumber (string) The building number of the physical location where the goods are unloaded. The default is customer address building number.
unloadingCityName (string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingPostalZone (string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCountry (string) The physical location address country where the goods are unloaded. The default is customer address country.
unloadingPointAddress (string) The physical location address where the goods are unloaded. The default is customer address.
unloadingDateTime (DateTimeOffset) The goods unloading date and time on the unloading physical location.
vehiclePlateNumber (string) The vehicle's plate used to transport the goods.
noteToRecipient (string) The note to the invoice recipient.
documentLines (List of ApiGoodsReceiptNoteDocumentLinesResource) The document lines.
See ApiGoodsReceiptNoteDocumentLinesResource.
notification (string) The invoice's notification configuration. Inferred from the invoice type.
emailTo (string) The email(s) to send invoice notification. Inferred from the notification.
deliveryMode (string) The good receipt delivey mode. (ex: mail).
dimensionSet (string) The dimension set.
dimensionSetJson (string) Dimension Set Json.
printedReportName (string) Indicates the report name used to print the document. Internally determined.


GoodsReceiptNoteLineResource

The following elements are required:

item (string) The item representing the good or service to be received.
description (string) The line item description.
unit (string) The unit used to make the goods receipt transaction.
warehouse (string) The warehouse where the goods are to be received.
conversionFactor (decimal) The conversion between the transaction unit and the base unit.
unitCost (MoneyResource) The cost per unit for the stock entry.
See MoneyResource .
quantity (decimal) The quantity fot the goods receipt (in transaction unit).
unitPrice (MoneyResource) The price per unit for the goods receipt.
See MoneyResource .
taxTotal (MoneyResource) The total tax amount of the line.
See MoneyResource .
deliveryDate (DateTime) Expected reception date.
allowanceChargeAmount (MoneyResource) The total discounts of the line. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The line item amount excluding taxes. Internally calculated.
See MoneyResource .
lineExtensionAmount (MoneyResource) The net amount of the line item. Internally calculated.
See MoneyResource .
grossValue (MoneyResource) The line value before taxes or discounts. Internally calculated.
See MoneyResource .
itemTaxSchema (string) The receipt line item tax schema. The tax schema identifies the group of taxes a item is liable for.
partyTaxSchema (string) The receipt customer party tax schema. The tax schema identifies the group of taxes a party is liable for.
currency (string) The money’s unit. Inferred from the goods receipt currency.
documentLineStatus (enum DocumentLineStatus) The line status (ex: Completed, Open).
See DocumentLineStatus.
itemType (enum ItemType) The invoice's line item type. Inferred from the sales item type.
See ItemType.
nonDeductibleAmount (MoneyResource) Calculate line non deductible amount.
See MoneyResource .

The following elements are optional:

baseUnit (string) The item base unit.
inventoryAmount (decimal) The amount that the stock will be affected.
discount1 (decimal) The line's item discount 1 percentage.
discount2 (decimal) The line's item discount 2 percentage.
discount3 (decimal) The line's item discount 3 percentage.
complementaryDescription (string) The receipt line item complementary description.
sourceSchemaEntity (string) The schema’s entity from originating document, possible values: Orders, GoodsReturns.
sourceDoc (string) The source document using the format {..} when the invoice is transformed from another document. Internally determined.
sourceDocId (Guid) The source document identifier when the invoice is transformed from other source document. Internally determined.
sourceDocLine (int) The source document's line number, when the invoice was transformed. Internally determined.
sourceDocLineId (Guid) The source document's line identifier, when the invoice was transformed. Internally determined.
logisticsItemId (Guid) The logistic doument. Internally determined.
goodsReceiptNotificationLineId (Guid) The line identifier of the goods receipt notification.
dimensionSet (string) The dimension set. Infered from the materials dimensions..
printAllDiscounts (string) The line all discounts.
printTaxCodes (string) The line tax codes.
dimensionSetJson (string) Dimension Set Json.
sourceOrder (string) The order that origin this line.
sourceOrderId (Guid) The order id that origin this line.
sourceOrderLine (int) The order line index that origin this line.
sourceOrderLineId (Guid) The order line id that origin this line.
sourceOrderSchemaEntityId (Guid) The order schema id that origin this line.
commitmentReference (string) The state supplier commitment reference.


GoodsReceiptNoteResource

The following elements are required:

company (string) The goods receipt company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
documentType (string) Defines the goods receipt purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
(fk) Allowed value: the natural key of a record of type GoodsReceiptNoteType. These records are accessibly through the GoodsReceiptNoteTypes service.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
party (string) The party that receives or consumes products (goods or services).
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
accountingParty (string) The party designated as the party to whom the invoice should be sent for payment. It may or may not be the party to whom the goods or services are delivered.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
documentDate (DateTime) The date when the document is issued.
exchangeRate (decimal) The rate that translates the values in the document from the document currency to company base currency. By default the system uses the exchange rates table at the document date.
postingDate (DateTime) The date when the document is posted.
grossValue (MoneyResource) The total’s value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource .
discount (decimal) The discount's percentage. The default is defined on the supplier party.
allowanceChargeAmount (MoneyResource) The total’s discount over goods and services. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The invoice's total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource .
taxTotal (MoneyResource) The total’s tax value of goods and services. Internally calculated.
See MoneyResource .
payableAmount (MoneyResource) The invoice's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
currency (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
paymentTerm (string) The invoice's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
paymentMethod (string) The invoice's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
documentStatus (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus.
autoCreated (bool) Used to indicate if the goods receipt was automatically created.
logisticsProcess (enum LogisticsProcess) Used to determine if the goods receipt is from the purchases process or sales process (return).
See LogisticsProcess.
journalType (string) The journal type to be used when posting in accounting. Infered from the invoice type.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
journalNumber (int) The journal number assigned in accounting.
isReturned (bool) Is true if is a return document.

The following elements are optional:

logisticsPartyId (Guid) The party that receives or consumes products (goods or services).
logisticsPartyName (string) The party name. It is inferred from the party.
logisticsPartyTaxId (string) The party tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities.
logisticsPartyAddress (string) The party address. It is inferred from the customer party.
accountingPartyName (string) The accounting's party name. It is inferred from the accounting party.
accountingPartyTaxId (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
accountingPartyAddress (string) The accounting's customer address. It is inferred from the accounting party.
note (string) The document's note.
exchangeRateDate (DateTime) The exchange rate creation date.
remarks (string) The goods receipt remarks.
isPrinted (bool) Indicates if the invoice has been printed. Internally determined.
taxIncluded (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the invoice series.
loadingPoint (string) The physical location where the goods are loaded. The default is the company physical location.
loadingStreetName (string) The street name of the physical location where the goods are loaded. The default is the company physical location.
loadingBuildingNumber (string) The building number of the physical location where the goods are loaded. The default is the company physical location.
loadingCityName (string) The city of the physical location where the goods are loaded. The default is the company physical location.
loadingPostalZone (string) The postal zone of the physical location where the goods are loaded. The default is the company physical location.
loadingCountry (string) The country of the physical location where the goods are loaded. The default is the company country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
loadingPointAddress (string) The physical location address where the goods are loaded. The default is the company physical location address.
loadingDateTime (DateTimeOffset) The goods loading date and time from the loading physical location. The default is the invoice creation date and time.
unloadingPoint (string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is customer address.
unloadingStreetName (string) The street name of the physical location where the goods are unloaded. The default is customer address street name.
unloadingBuildingNumber (string) The building number of the physical location where the goods are unloaded. The default is customer address building number.
unloadingCityName (string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingPostalZone (string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCountry (string) The physical location address country where the goods are unloaded. The default is customer address country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
unloadingPointAddress (string) The physical location address where the goods are unloaded. The default is customer address.
unloadingDateTime (DateTimeOffset) The goods unloading date and time on the unloading physical location.
vehiclePlateNumber (string) The vehicle's plate used to transport the goods.
noteToRecipient (string) The note to the invoice recipient.
deliveryTerm (string) The invoice's delivery term. The conditions in a sales or transportation contract that specify the means of transportation.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
documentLines (List of GoodsReceiptNoteLineResource) The document lines.
See GoodsReceiptNoteLineResource.
legalStamp (string) In some countries, the documents issued by a company have to contain mandatory remarks, clearly visible in printing, which may vary according to the document. These texts are printed under the signature terms. Internally determined.
notification (string) The invoice's notification configuration. Inferred from the invoice type.
(fk) Allowed value: the natural key of a record of type Notification.
emailTo (string) The email(s) to send invoice notification. Inferred from the notification.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
accountingDocument (string) The accounting document that was assigned in accounting.
deliveryMode (string) The good receipt delivey mode. (ex: mail).
(fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
dimensionSet (string) The dimension set.
(fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
dimensionSetJson (string) Dimension Set Json.
printedReportName (string) Indicates the report name used to print the document. Internally determined.
isReprinted (bool) Indicates if the document has been reprinted. Internally determined.
isSigned (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.


GoodsReceiptNotesReturnOrder

The following elements are required:

company (string) Company.
document (string) The source document key.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

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