Shipping | Delivery

Service to manage entities of type 'Delivery'.

Overview

api/{tenantKey}/{orgKey}/shipping/deliveries

URL	api/{tenantKey}/{orgKey}/shipping/deliveries
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Deliveries
- POST Communicate To Tax Authority
PUT:
DELETE:
- DELETE Delivery by identifier
- DELETE Delivery by key

All Resources

This service uses the following resources:

ApiDeliveryDocumentLinesResource
ApiDeliveryResource
DeliveryLineResource
DeliveryResource
StandardDeliveryDocumentLinesResource
StandardDeliveryResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

DocumentLineStatus
DocumentStatus
ItemType
LogisticsProcess

GET Operations

GET Deliveries

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/shipping/deliveries

GET /shipping/deliveries

GET Deliveries (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 DeliveryResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/shipping/deliveries?page={page}&pageSize={pageSize}

GET /shipping/deliveries?page={page}&pageSize={pageSize}

GET Delivery 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 DeliveryResource.

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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{id}

GET /shipping/deliveries/{id}

GET Delivery by key

Returns the entity record that matches the specified key.

The following elements are required:

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

Response:

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

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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}

GET /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}

GET Print Delivery 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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{id}/print?template={template}

GET /shipping/deliveries/{id}/print?template={template}

GET Print Delivery by key

Prints the specified entity record.

The following elements are required:

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

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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/print

GET /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/print

GET Original Print DeliveryOriginal 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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{id}/printOriginal?template={template}

GET /shipping/deliveries/{id}/printOriginal?template={template}

GET Original Print Delivery by key

Prints the specified entity record.

The following elements are required:

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

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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/printOriginal

GET /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/printOriginal

POST Operations

POST Deliveries

Creates a new entity record.

The following elements are required:

deliveryResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/shipping/deliveries

POST /shipping/deliveries

POST Communicate To Tax Authority

Custom operation 'CommunicateToTaxAuthority'.

The following elements are required:

deliveryId

(Guid) DeliveryId.

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

Resource URL:

api/{tenantKey}/{orgKey}/shipping/deliveries/communicateToTaxAuthority/{deliveryId}

POST /shipping/deliveries/communicateToTaxAuthority/{deliveryId}

PUT Operations

PUT Set ATDocCodeID Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/aTDocCodeID

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/aTDocCodeID

PUT Set CommitmentReference DeliveryLine

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/commitmentReference

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/commitmentReference

PUT Set ComplementaryDescription DeliveryLine

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/complementaryDescription

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/complementaryDescription

PUT Set DeliveryDate DeliveryLine

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/deliveryDate

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/deliveryDate

PUT Set Description DeliveryLine

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/description

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/description

PUT Set DocumentLineStatus DeliveryLine

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/documentLineStatus

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/documentLineStatus

PUT Set EmailTo Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/emailTo

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/emailTo

PUT Set IsActive Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/isActive

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/isActive

PUT Set IsSeriesCommunicated Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/isSeriesCommunicated

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/isSeriesCommunicated

PUT Set LoadingBuildingNumber Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingBuildingNumber

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingBuildingNumber

PUT Set LoadingCityName Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingCityName

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingCityName

PUT Set LoadingCountry Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingCountry

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingCountry

PUT Set LoadingDateTime Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingDateTime

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingDateTime

PUT Set LoadingPoint Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingPoint

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingPoint

PUT Set LoadingPointAddress Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingPointAddress

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingPointAddress

PUT Set LoadingPostalZone Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingPostalZone

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingPostalZone

PUT Set LoadingStreetName Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingStreetName

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/loadingStreetName

PUT Set Note Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/note

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/note

PUT Set NoteToRecipient Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/noteToRecipient

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/noteToRecipient

PUT Set Remarks Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/remarks

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/remarks

PUT Set UnloadingBuildingNumber Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingBuildingNumber

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingBuildingNumber

PUT Set UnloadingCityName Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingCityName

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingCityName

PUT Set UnloadingCountry Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingCountry

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingCountry

PUT Set UnloadingDateTime Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingDateTime

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingDateTime

PUT Set UnloadingPoint Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingPoint

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingPoint

PUT Set UnloadingPointAddress Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingPointAddress

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingPointAddress

PUT Set UnloadingPostalZone Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingPostalZone

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingPostalZone

PUT Set UnloadingStreetName Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingStreetName

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/unloadingStreetName

PUT Set UseCurrentDate Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/useCurrentDate

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/useCurrentDate

PUT Set VehiclePlateNumber Delivery

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

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/vehiclePlateNumber

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/vehiclePlateNumber

PUT Set Custom Attribute Delivery

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

The following elements are required:

companyKey	(string) The company key.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/{customAttributeName}

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/{customAttributeName}

PUT Set Custom Attribute DeliveryLine

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

The following elements are required:

companyKey	(string) The company key.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/{customAttributeName}

PUT /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}/documentLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Delivery 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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{id}

DELETE /shipping/deliveries/{id}

DELETE Delivery by key

Deletes the entity record that matches the specified key.

The following elements are required:

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

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:

api/{tenantKey}/{orgKey}/shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}

DELETE /shipping/deliveries/{companyKey}/{seriesNumber}/{serie}/{documentType}

Resources

ApiDeliveryDocumentLinesResource

The following elements are required:

description	(string) The delivery's line item description. The default is defined on the sales item.
quantity	(decimal) The delivery's line item quantity. The default is 1.
unitPrice	(decimal) The delivery's line item unit price. The default price is loaded from the sales item prices when there is a match on the combination of price list, currency, tax included and unit.
deliveryDate	(DateTime) The delivery's line expected delivery date.
unit	(string) The delivery's line item sales unit. The default sales unit is defined on the sales item.
item	(string) The item representing the good to be delivered.
warehouse	(string) The item's warehouse.
documentLineStatus	(enum DocumentLineStatus) The document's line status. The default is Open. See DocumentLineStatus.

The following elements are optional:

discount1	(decimal) The delivery line item's discount 1 percentage. The default is 0.
discount2	(decimal) The delivery line item's discount 2 percentage. The default is 0. This discount is applied over the remaining value after discount 1 is applied.
discount3	(decimal) The delivery line item's discount 3 percentage. The default is 0. This discount is applied over the remaining value after discount 1 and 2 are is applied.
complementaryDescription	(string) The delivery's line item complementary description. The default is defined on the sales item.
commitmentReference	(string) Commitment Reference.

ApiDeliveryResource

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
paymentMethod	(string) The financial's 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.
currency	(string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). 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.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created.
party	(string) The party that receives the goods. Depending on source document it can be either a customer or a supplier.
logisticsPartyName	(string) The party's name. It is inferred from the party.
logisticsPartyAddress	(string) The party's address. It is inferred from the party.
accountingParty	(string) The party's designated in the delivery as the party to whom the delivery should be sent for payment. It may or may not be the party to whom the goods are delivered. The default is defined on the party.
exchangeRate	(decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
loadingDateTime	(DateTimeOffset) The goods loading date and time from the loading physical location. The default is the delivery creation date and time.
loadingCountry	(string) The country of the physical location where the goods are loaded. The default is the company country.
unloadingDateTime	(DateTimeOffset) The goods unloading date and time on the unloading physical location.
unloadingCountry	(string) The physical location address country where the goods are unloaded. The default is customer address country.
useCurrentDate	(bool) Determines whether the current date is used as de Loading Date or not.
company	(string) The company's code is the central organizational unit within the system.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
paymentTerm	(string) The 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.
documentLines	(List of ApiDeliveryDocumentLinesResource) The delivery's lines. See ApiDeliveryDocumentLinesResource.
note	(string) The delivery's note.
logisticsPartyTaxId	(string) The party's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. It is inferred from the party.
accountingPartyName	(string) The accounting's party name. It is inferred from the accounting party.
accountingPartyAddress	(string) The accounting's customer 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.
exchangeRateDate	(DateTime) The exchange rate's creation date.
remarks	(string) The delivery's 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.
loadingPostalZone	(string) The postal zone 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.
loadingPointAddress	(string) The physical location address where the goods are loaded. The default is the company physical location address.
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.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingPointAddress	(string) The physical location address where the goods are unloaded. The default is customer address.
vehiclePlateNumber	(string) The vehicle's plate used to transport the goods.
manualNumber	(int) The delivery's manual serie number. Applicable only when the delivery type series is defined as manual.
manualSerie	(string) The delivery's manual serie. Applicable only when the delivery type series is defined as manual.
manualDate	(DateTime) The delivery's manual date. Applicable only when the delivery type series is defined as manual.
noteToRecipient	(string) The note to the delivery recipient.
aTDocCodeID	(string) The document's code returned by the Fiscal Authority upon comunication.
address	(string) The alternative party's address key to be used on the delivery. The alternative addresses keys are defined on the party additional addresses. When defined overrides the party address and unloading address values.
warehouse	(string) The delivery's warehouse defines the warehouse from where the goods are shipped . Infered from the selected shipping request lines it must be the same for all delivery lines.
emailTo	(string) The email(s) to send delivery notification. Inferred from the notification.
priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.

DeliveryLineResource

The following elements are required:

description	(string) The delivery's line item description. The default is defined on the sales item.
quantity	(decimal) The delivery's line item quantity. The default is 1.
unitPrice	(decimal) The delivery's line item unit price. The default price is loaded from the sales item prices when there is a match on the combination of price list, currency, tax included and unit.
deliveryDate	(DateTime) The delivery's line expected delivery date.
taxTotal	(decimal) The total's amount of taxes for this line. Internally calculated.
allowanceChargeAmount	(decimal) The total amount of taxes for this line. Internally calculated.
taxExclusiveAmount	(decimal) The delivery's line net value. The line value after discounts, excluding taxes. Internally calculated.
grossValue	(decimal) The delivery's line value before taxes or discounts. Internally calculated.
conversionFactor	(decimal) The delivery's line unit conversion factor. Internally determined.
lineExtensionAmount	(decimal) The delivery's line payable amount. The line value including taxes and discounts. Internally calculated.
unitCost	(decimal) The delivery's line item cost by unit. Internally calculated.
unit	(string) The delivery's line item sales unit. The default sales unit is defined on the sales item.
itemTaxSchema	(string) The delivery's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
partyTaxSchema	(string) The delivery's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
item	(string) The item representing the good to be delivered.
warehouse	(string) The item's warehouse.
currency	(string) The money's unit. Inferred from the delivery currency.
documentLineStatus	(enum DocumentLineStatus) The document's line status. The default is Open. See DocumentLineStatus.
itemType	(enum ItemType) The delivery's line item type. Inferred from the item type. Internally determined. See ItemType.

The following elements are optional:

discount1	(decimal) The delivery line item's discount 1 percentage. The default is 0.
discount2	(decimal) The delivery line item's discount 2 percentage. The default is 0. This discount is applied over the remaining value after discount 1 is applied.
discount3	(decimal) The delivery line item's discount 3 percentage. The default is 0. This discount is applied over the remaining value after discount 1 and 2 are is applied.
sourceSchemaEntity	(string) The schema entity from originating document, possible values: Quotations, Orders, Deliveries, Invoices, GoodsReturns, CreditNotes, DebitNotes.
sourceDoc	(string) The source document using the format {..} when the delivery was transformed. The source document is usually the order. Internally determined.
sourceDocId	(Guid) The unique identitifer of the source document whose type is defined in the SourceSchemaEntity. The source document is usually the order. Internally determined.
sourceDocLine	(int) The source document's line number, when the delivery was transformed. Internally determined.
sourceDocLineId	(Guid) The source document's line identifier, when the delivery was transformed. Internally determined.
inventoryAmount	(decimal) The inventory's amount.
complementaryDescription	(string) The delivery's line item complementary description. The default is defined on the sales item.
baseUnit	(string) The delivery's line item base unit. The default base unit is defined on the item.
logisticsItemId	(Guid) The unique identitifer of the item, logistics extension data. Internally determined.
shippingRequestLineId	(Guid) The unique identifier of the shipping request line. Internally determined.
transactionAccount	(string) The delivery's line item transaction account. Inferred from the item cost account from the income account. Internally determined.
printTaxCodes	(string) Print Tax Codes.
printAllDiscounts	(string) Discount.
commitmentReference	(string) Commitment Reference.

DeliveryResource

The following elements are required:

seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type. (fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting. (fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service.
paymentMethod	(string) The financial's 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.
currency	(string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). 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.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created.
party	(string) The party that receives the goods. Depending on source document it can be either a customer or a supplier. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
logisticsPartyName	(string) The party's name. It is inferred from the party.
logisticsPartyAddress	(string) The party's address. It is inferred from the party.
accountingParty	(string) The party's designated in the delivery as the party to whom the delivery should be sent for payment. It may or may not be the party to whom the goods are delivered. The default is defined on the party. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
exchangeRate	(decimal) The price of one country's currency expressed in another country's currency. In other words, the rate at which one currency can be exchanged for another. The default is inferred using the defined exchange rates on the system for the document date and currency.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
grossValue	(decimal) The total value of goods before taxes or discounts. Internally calculated.
allowanceChargeAmount	(decimal) The total discount over goods. Internally calculated.
taxExclusiveAmount	(decimal) The delivery's total net value. Total value of goods after discounts, excluding taxes. Internally calculated.
taxTotal	(decimal) The total's tax value of goods. Internally calculated.
payableAmount	(decimal) The delivery's payable amount. Total value of goods including taxes and discounts. Internally calculated.
loadingDateTime	(DateTimeOffset) The goods loading date and time from the loading physical location. The default is the delivery creation date and time.
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.
unloadingDateTime	(DateTimeOffset) The goods unloading date and time on the unloading physical location.
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.
isATDocCodeIDEditable	(bool) Indicates whether de ATDocCodeID is editable or not.
isGlobal	(bool) Indicates whether this delivery is a global delivery or not.
endCustomer	(bool) Indicates whether this delivery was made for an end customer.
useCurrentDate	(bool) Determines whether the current date is used as de Loading Date or not.
company	(string) The company's 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.
documentStatus	(enum DocumentStatus) The document's status. Internally determined. See DocumentStatus.
logisticsProcess	(enum LogisticsProcess) The logistic's process. See LogisticsProcess.
autoCreated	(bool) Auto Created.
isManual	(bool) Defines if the delivery type series is defined as manual. Internally determined.
isExternal	(bool) Defines if the delivery type series is defined as external. Internally determined.
isWsCommunicable	(bool) The legal fiscal document type defined on the delivery type. Inferred from the delivery type.
excludeFromBilling	(bool) Exclude From Billing.
discountInValueAmount	(decimal) Discount In Value.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
paymentTerm	(string) The 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.
documentLines	(List of DeliveryLineResource) The delivery's lines. See DeliveryLineResource.
taxIncluded	(bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the delivery series.
note	(string) The delivery's note.
logisticsPartyId	(Guid) The party's unique identifier. It is inferred from the party. Internally setted.
logisticsPartyTaxId	(string) The party's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. It is inferred from the party.
accountingPartyName	(string) The accounting's party name. It is inferred from the accounting party.
accountingPartyAddress	(string) The accounting's customer 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.
exchangeRateDate	(DateTime) The exchange rate's creation date.
remarks	(string) The delivery's 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.
loadingPostalZone	(string) The postal zone 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.
loadingPointAddress	(string) The physical location address where the goods are loaded. The default is the company physical location address.
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.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingPointAddress	(string) The physical location address where the goods are unloaded. The default is customer address.
vehiclePlateNumber	(string) The vehicle's plate used to transport the goods.
hash	(string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
hashControl	(string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
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.
isPrinted	(bool) Indicates if the delivery has been printed. Internally determined.
manualNumber	(int) The delivery's manual serie number. Applicable only when the delivery type series is defined as manual.
manualSerie	(string) The delivery's manual serie. Applicable only when the delivery type series is defined as manual.
manualDate	(DateTime) The delivery's manual date. Applicable only when the delivery type series is defined as manual.
noteToRecipient	(string) The note to the delivery recipient.
aTDocCodeID	(string) The document's code returned by the Fiscal Authority upon comunication.
address	(string) The alternative party's address key to be used on the delivery. The alternative addresses keys are defined on the party additional addresses. When defined overrides the party address and unloading address values. (fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
warehouse	(string) The delivery's warehouse defines the warehouse from where the goods are shipped . Infered from the selected shipping request lines it must be the same for all delivery lines. (fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service.
isManualSerie	(bool) Defines if the delivery type series is defined as manual. Internally determined.
fiscalDocumentType	(string) The legal fiscal's document type defined on the delivery type. Inferred from the delivery type. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
notification	(string) The delivery's notification configuration. Inferred from the delivery type. (fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service.
emailTo	(string) The email(s) to send delivery notification. Inferred from the notification.
priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup. (fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service.
hasSourceDoc	(bool) Defines if the delivery was created from other document. Internally determined.
printAllDiscounts	(string) Discount.
aTCUD	(string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
aTQRCode	(string) Unique fiscal document bidimensional QR code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
aTQRCodeNotValued	(string) Unique fiscal document bidimensional QR code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
printedReportName	(string) Printed Report Name.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.

StandardDeliveryDocumentLinesResource

The following elements are required:

item	(string) The item representing the good to be delivered.
description	(string) The delivery's line item description. The default is defined on the sales item.
lineExtensionAmount	(decimal) The delivery's line payable amount. The line value including taxes and discounts. Internally calculated.
unit	(string) The delivery's line item sales unit. The default sales unit is defined on the sales item.
unitPrice	(decimal) The delivery's line item unit price. The default price is loaded from the sales item prices when there is a match on the combination of price list, currency, tax included and unit.
quantity	(decimal) The delivery's line item quantity. The default is 1.
warehouse	(string) The item's warehouse.

StandardDeliveryResource

The following elements are required:

documentDate	(DateTime) The date when the document is issued.
payableAmount	(decimal) The delivery's payable amount. Total value of goods including taxes and discounts. Internally calculated.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the delivery type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the delivery type and serie. Part of the document natural key.
documentType	(string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default delivery type is defined in the sales setup configuration setting.
party	(string) The party that receives the goods. Depending on source document it can be either a customer or a supplier.
company	(string) The company's code is the central organizational unit within the system.
autoCreated	(bool) Auto Created.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
isWsCommunicable	(bool) The legal fiscal document type defined on the delivery type. Inferred from the delivery type.
logisticsProcess	(enum LogisticsProcess) The logistic's process. See LogisticsProcess.
discountInValueAmount	(decimal) Discount In Value.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
paymentTerm	(string) The 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.
documentLines	(List of StandardDeliveryDocumentLinesResource) The delivery's lines. See StandardDeliveryDocumentLinesResource.
fiscalDocumentType	(string) The legal fiscal's document type defined on the delivery type. Inferred from the delivery type.
note	(string) The delivery's note.
isPrinted	(bool) Indicates if the delivery has been printed. Internally determined.
aTDocCodeID	(string) The document's code returned by the Fiscal Authority upon comunication.
hasSourceDoc	(bool) Defines if the delivery was created from other document. Internally determined.
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.
unloadingStreetName	(string) The street name of the physical location where the goods are unloaded. The default is customer address street name.
loadingCityName	(string) The city of 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.
isManualSerie	(bool) Defines if the delivery type series is defined as manual. Internally determined.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
printedReportName	(string) Printed Report Name.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed

ItemType

1	Item
2	Service
3	SpecialSalesTaxes
4	Tax
5	Other

LogisticsProcess

1	Sales
2	Purchases