Shipping | Delivery
The delivery entity is used to store information related with shipping of deliveries.
Overview
URL | api/{tenantKey}/{orgKey}/shipping/deliveries |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute Delivery
- PUT Set Custom Attribute DeliveryLine
- PUT Set IsActive Delivery
- PUT Set SeriesNumber Delivery
- PUT Set DocumentType Delivery
- PUT Set Note Delivery
- PUT Set Remarks Delivery
- PUT Set LoadingPoint Delivery
- PUT Set LoadingStreetName Delivery
- PUT Set LoadingBuildingNumber Delivery
- PUT Set LoadingPostalZone Delivery
- PUT Set LoadingCityName Delivery
- PUT Set LoadingPointAddress Delivery
- PUT Set LoadingDateTime Delivery
- PUT Set LoadingCountry Delivery
- PUT Set UnloadingPoint Delivery
- PUT Set UnloadingStreetName Delivery
- PUT Set UnloadingBuildingNumber Delivery
- PUT Set UnloadingPostalZone Delivery
- PUT Set UnloadingCityName Delivery
- PUT Set UnloadingPointAddress Delivery
- PUT Set UnloadingDateTime Delivery
- PUT Set VehiclePlateNumber Delivery
- PUT Set UnloadingCountry Delivery
- PUT Set NoteToRecipient Delivery
- PUT Set ATDocCodeID Delivery
- PUT Set IsATDocCodeIDEditable Delivery
- PUT Set IsGlobal Delivery
- PUT Set EndCustomer Delivery
- PUT Set UseCurrentDate Delivery
- PUT Set IsManualSerie Delivery
- PUT Set FiscalDocumentType Delivery
- PUT Set IsWsCommunicable Delivery
- PUT Set Notification Delivery
- PUT Set EmailTo Delivery
- PUT Set IsPurchasesReturn Delivery
- PUT Set DeliveryMode Delivery
- PUT Set IsEndCustomer Delivery
- PUT Set IsReturned Delivery
- PUT Set PrintedReportName Delivery
- PUT Set IsSeriesCommunicated Delivery
- PUT Set Description DeliveryLine
- PUT Set DeliveryDate DeliveryLine
- PUT Set ComplementaryDescription DeliveryLine
- PUT Set DimensionSet DeliveryLine
- PUT Set DimensionSetJson DeliveryLine
- PUT Set SourceOrder DeliveryLine
- PUT Set SourceOrderId DeliveryLine
- PUT Set SourceOrderLine DeliveryLine
- PUT Set SourceOrderLineId DeliveryLine
- PUT Set SourceOrderSchemaEntityId DeliveryLine
- PUT Set CommitmentReference DeliveryLine
- DELETE:
All Resources
This service uses the following resources:
- ApiDeliveryDocumentLinesResource
- ApiDeliveryResource
- DeliveryLineResource
- DeliveryResource
- DeliveryReturnOrder
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
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:
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:
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:
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:
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:
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:
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:
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:
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:
POST To Return Order
Custom operation 'ToReturnOrder'.
The following elements are required:
deliveryReturnOrder | (DeliveryReturnOrder) DeliveryReturnOrder. |
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:
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:
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:
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:
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:
PUT Set DeliveryMode Delivery
Updates the value of attribute 'DeliveryMode' 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:
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:
PUT Set DimensionSet DeliveryLine
Updates the value of attribute 'DimensionSet' 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:
PUT Set DimensionSetJson DeliveryLine
Updates the value of attribute 'DimensionSetJson' 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:
PUT Set DocumentType Delivery
Updates the value of attribute 'DocumentType' 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:
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:
PUT Set EndCustomer Delivery
Updates the value of attribute 'EndCustomer' 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:
PUT Set FiscalDocumentType Delivery
Updates the value of attribute 'FiscalDocumentType' 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:
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:
PUT Set IsATDocCodeIDEditable Delivery
Updates the value of attribute 'IsATDocCodeIDEditable' 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:
PUT Set IsEndCustomer Delivery
Updates the value of attribute 'IsEndCustomer' 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:
PUT Set IsGlobal Delivery
Updates the value of attribute 'IsGlobal' 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:
PUT Set IsManualSerie Delivery
Updates the value of attribute 'IsManualSerie' 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:
PUT Set IsPurchasesReturn Delivery
Updates the value of attribute 'IsPurchasesReturn' 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:
PUT Set IsReturned Delivery
Updates the value of attribute 'IsReturned' 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:
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:
PUT Set IsWsCommunicable Delivery
Updates the value of attribute 'IsWsCommunicable' 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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
PUT Set Notification Delivery
Updates the value of attribute 'Notification' 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:
PUT Set PrintedReportName Delivery
Updates the value of attribute 'PrintedReportName' 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:
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:
PUT Set SeriesNumber Delivery
Updates the value of attribute 'SeriesNumber' 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 | (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 Set SourceOrder DeliveryLine
Updates the value of attribute 'SourceOrder' 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:
PUT Set SourceOrderId DeliveryLine
Updates the value of attribute 'SourceOrderId' 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 | (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 Set SourceOrderLine DeliveryLine
Updates the value of attribute 'SourceOrderLine' 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 | (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 Set SourceOrderLineId DeliveryLine
Updates the value of attribute 'SourceOrderLineId' 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 | (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 Set SourceOrderSchemaEntityId DeliveryLine
Updates the value of attribute 'SourceOrderSchemaEntityId' 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 | (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 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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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 | (MoneyResource) 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.
See MoneyResource . |
deliveryDate | (DateTime) The delivery's line expected delivery date. |
taxTotal | (MoneyResource) The total's amount of taxes for this line. Internally calculated.
See MoneyResource . |
unit | (string) The delivery's line item sales unit. The default sales unit 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. |
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. |
dimensionSet | (string) The dimension set of the delivery line item. |
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. |
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. |
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. |
isWsCommunicable | (bool) The legal fiscal document type defined on the delivery type. Inferred from the delivery type. |
isPurchasesReturn | (bool) Internal flag that indicates if the delivery is a purchases return. |
isEndCustomer | (bool) Internal flag that indicates if the party is end customer. |
printDate | (DateTime) The date when the document was printed. |
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. |
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. |
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. |
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. |
notification | (string) The delivery's notification configuration. Inferred from the delivery type. |
emailTo | (string) The email(s) to send delivery notification. Inferred from the notification. |
priceList | (string) The price list of delivery. |
deliveryMode | (string) The delivery mode (ex: mail). |
isReturned | (bool) Internal flag that indicates if the document was returned. |
dimensionSet | (string) Dimension Set. |
dimensionSetJson | (string) Dimension Set Json. |
printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
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 | (MoneyResource) 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.
See MoneyResource . |
deliveryDate | (DateTime) The delivery's line expected delivery date. |
taxTotal | (MoneyResource) The total's amount of taxes for this line. Internally calculated.
See MoneyResource . |
allowanceChargeAmount | (MoneyResource) The total amount of taxes for this line. Internally calculated.
See MoneyResource . |
taxExclusiveAmount | (MoneyResource) The delivery's line net value. The line value after discounts, excluding taxes. Internally calculated.
See MoneyResource . |
grossValue | (MoneyResource) The delivery's line value before taxes or discounts. Internally calculated.
See MoneyResource . |
conversionFactor | (decimal) The delivery's line unit conversion factor. Internally determined. |
lineExtensionAmount | (MoneyResource) The delivery's line payable amount. The line value including taxes and discounts. Internally calculated.
See MoneyResource . |
unitCost | (MoneyResource) The delivery's line item cost by unit. Internally calculated.
See MoneyResource . |
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. 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 { |
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. |
dimensionSet | (string) The dimension set of the delivery line item. |
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. |
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 | (MoneyResource) The total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource . |
allowanceChargeAmount | (MoneyResource) The total discount over goods and services. Internally calculated.
See MoneyResource . |
taxExclusiveAmount | (MoneyResource) The delivery'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 delivery's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource . |
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) Set if the delivery was automatically 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. |
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. |
isPurchasesReturn | (bool) Internal flag that indicates if the delivery is a purchases return. |
isEndCustomer | (bool) Internal flag that indicates if the party is end customer. |
printDate | (DateTime) The date when the document was printed. |
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. |
emailTo | (string) The email(s) to send delivery 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 assigned in accounting. |
hasSourceDoc | (bool) Internal flag that indicates if the delivery has source doc. |
priceList | (string) The price list of delivery.
(fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service. |
deliveryMode | (string) The delivery mode (ex: mail).
(fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service. |
isReturned | (bool) Internal flag that indicates if the document was returned. |
dimensionSet | (string) 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. |
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. |
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. |
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. |
DeliveryReturnOrder
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. |