Logistics | Delivery Type
The Delivery Type represents a purchases order with specific characteristics.
Overview
| URL | api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute DeliveryType
- PUT Set Custom Attribute DeliveryTypeSerie
- PUT Set IsActive DeliveryType
- PUT Set TypeKey DeliveryType
- PUT Set Company DeliveryType
- PUT Set Description DeliveryType
- PUT Set FiscalDocumentType DeliveryType
- PUT Set IsPortugueseCompany DeliveryType
- PUT Set IsInternal DeliveryType
- PUT Set ContactType DeliveryType
- PUT Set Notification DeliveryType
- PUT Set JournalType DeliveryType
- PUT Set DocumentNoteTitle DeliveryType
- PUT Set DocumentNote DeliveryType
- PUT Set DimensionCombination DeliveryType
- PUT Set CompanyHasDimensions DeliveryType
- PUT Set NumberOfCopies DeliveryTypeSerie
- PUT Set IsDefault DeliveryTypeSerie
- PUT Set IsManual DeliveryTypeSerie
- PUT Set IsExternal DeliveryTypeSerie
- PUT Set CommunicationType DeliveryTypeSerie
- PUT Set ATValidationCode DeliveryTypeSerie
- PUT Set ATManualCommunication DeliveryTypeSerie
- DELETE:
All Resources
This service uses the following resources:
- ApiDeliveryTypeDocumentTypeSeriesResource
- ApiDeliveryTypeResource
- DeliveryTypeResource
- DeliveryTypeSerieResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET DeliveryTypes
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See DeliveryTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes
GET /logisticsCore/deliveryTypes
GET DeliveryTypes (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 DeliveryTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes?page={page}&pageSize={pageSize}
GET /logisticsCore/deliveryTypes?page={page}&pageSize={pageSize}
GET DeliveryType 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 DeliveryTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{id}
GET /logisticsCore/deliveryTypes/{id}
GET DeliveryType by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the delivery type. |
Response:
| When successful, the response body contains the entity record. See DeliveryTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}
GET /logisticsCore/deliveryTypes/{companyKey}/{typeKey}
GET Print DeliveryType by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{id}/print?template={template}
GET /logisticsCore/deliveryTypes/{id}/print?template={template}
GET Print DeliveryType by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the delivery type. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/print
GET /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/print
GET Original Print DeliveryTypeOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{id}/printOriginal?template={template}
GET /logisticsCore/deliveryTypes/{id}/printOriginal?template={template}
GET Original Print DeliveryType by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the delivery type. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/printOriginal
GET /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/printOriginal
POST DeliveryTypes
Creates a new entity record.
The following elements are required:
| deliveryTypeResource | (ApiDeliveryTypeResource) The request body should contain the entity record that should be created. See ApiDeliveryTypeResource. |
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 ApiDeliveryTypeResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes
POST /logisticsCore/deliveryTypes
POST Delivery Type
Inserts a new 'Delivery Type Serie' in the 'Delivery Type'.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (ApiDeliveryTypeDocumentTypeSeriesResource) The ApiDeliveryTypeDocumentTypeSeriesResource instance. See ApiDeliveryTypeDocumentTypeSeriesResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries
POST /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries
PUT Set ATManualCommunication DeliveryTypeSerie
Updates the value of attribute 'ATManualCommunication' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication
PUT Set ATValidationCode DeliveryTypeSerie
Updates the value of attribute 'ATValidationCode' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode
PUT Set CommunicationType DeliveryTypeSerie
Updates the value of attribute 'CommunicationType' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (enum CommunicationType) The request body should contain the new value for the attribute. See CommunicationType. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/communicationType
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/communicationType
PUT Set Company DeliveryType
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/company
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/company
PUT Set CompanyHasDimensions DeliveryType
Updates the value of attribute 'CompanyHasDimensions' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/companyHasDimensions
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/companyHasDimensions
PUT Set ContactType DeliveryType
Updates the value of attribute 'ContactType' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/contactType
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/contactType
PUT Set Description DeliveryType
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/description
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/description
PUT Set DimensionCombination DeliveryType
Updates the value of attribute 'DimensionCombination' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/dimensionCombination
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/dimensionCombination
PUT Set DocumentNote DeliveryType
Updates the value of attribute 'DocumentNote' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentNote
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentNote
PUT Set DocumentNoteTitle DeliveryType
Updates the value of attribute 'DocumentNoteTitle' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentNoteTitle
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentNoteTitle
PUT Set FiscalDocumentType DeliveryType
Updates the value of attribute 'FiscalDocumentType' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/fiscalDocumentType
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/fiscalDocumentType
PUT Set IsActive DeliveryType
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/isActive
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/isActive
PUT Set IsDefault DeliveryTypeSerie
Updates the value of attribute 'IsDefault' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault
PUT Set IsExternal DeliveryTypeSerie
Updates the value of attribute 'IsExternal' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isExternal
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isExternal
PUT Set IsInternal DeliveryType
Updates the value of attribute 'IsInternal' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/isInternal
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/isInternal
PUT Set IsManual DeliveryTypeSerie
Updates the value of attribute 'IsManual' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isManual
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isManual
PUT Set IsPortugueseCompany DeliveryType
Updates the value of attribute 'IsPortugueseCompany' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/isPortugueseCompany
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/isPortugueseCompany
PUT Set JournalType DeliveryType
Updates the value of attribute 'JournalType' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/journalType
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/journalType
PUT Set Notification DeliveryType
Updates the value of attribute 'Notification' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/notification
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/notification
PUT Set NumberOfCopies DeliveryTypeSerie
Updates the value of attribute 'NumberOfCopies' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| 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:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies
PUT Set TypeKey DeliveryType
Updates the value of attribute 'TypeKey' in the specified entity record.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/typeKey
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/typeKey
PUT Set Custom Attribute DeliveryType
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the delivery type. |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/{customAttributeName}
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/{customAttributeName}
PUT Set Custom Attribute DeliveryTypeSerie
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the delivery type. |
| lineId | (string) The detail identifier. |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/{customAttributeName}
PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/{customAttributeName}
DELETE Delivery Type Serie by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| companyKey | (string) The company key. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}
DELETE /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}
DELETE DeliveryType by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{id}
DELETE /logisticsCore/deliveryTypes/{id}
DELETE DeliveryType by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| typeKey | (string) The key for the delivery type. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes/{companyKey}/{typeKey}
DELETE /logisticsCore/deliveryTypes/{companyKey}/{typeKey}
Resources
ApiDeliveryTypeDocumentTypeSeriesResource
The following elements are required:
| numberOfCopies | (int) The number of copies of the document to print. |
| isDefault | (bool) Indicates if this is the default serie for the document. |
| isManual | (bool) Indicates if the delivery type is serie is manual. |
| isExternal | (bool) Indicates if the delivery type is serie is external. |
| serie | (string) The serie for the delivery type serie. |
| communicationType | (enum CommunicationType) The communication type to comunicate the document to the tax authority.
See CommunicationType. |
| aTManualCommunication | (bool) Manual Communication. |
The following elements are optional:
| aTValidationCode | (string) Validation Code. |
ApiDeliveryTypeResource
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| company | (string) The delivery type's company. The company for the company type. The company code is the central organizational unit within the system. |
| isPortugueseCompany | (bool) Internal flag indicating if the delivery type company country is Portugal. |
| isInternal | (bool) System flag set for internal deliveries. |
| journalType | (string) The journal type to be used for the account posting. |
| companyHasDimensions | (bool) Flag to know if company has dimensions. |
The following elements are optional:
| description | (string) The description for the delivery type. |
| fiscalDocumentType | (string) The fiscal document type for the delivery type. |
| documentTypeSeries | (List of ApiDeliveryTypeDocumentTypeSeriesResource) The list of available series for this document type.
See ApiDeliveryTypeDocumentTypeSeriesResource. |
| contactType | (string) The contact type for the delivery type. |
| notification | (string) The notification for the delivery type. |
| documentNoteTitle | (string) The document note title. |
| documentNote | (string) The document note. |
| dimensionCombination | (string) The dimension combination. |
DeliveryTypeResource
The following elements are required:
| typeKey | (string) The key for the delivery type. |
| company | (string) The delivery type's company. The company for the company type. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| isPortugueseCompany | (bool) Internal flag indicating if the delivery type company country is Portugal. |
| isInternal | (bool) System flag set for internal deliveries. |
| journalType | (string) The journal type to be used for the account posting.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service. |
| companyHasDimensions | (bool) Flag to know if company has dimensions. |
The following elements are optional:
| description | (string) The description for the delivery type. |
| fiscalDocumentType | (string) The fiscal document type for the delivery type.
(fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service. |
| documentTypeSeries | (List of DeliveryTypeSerieResource) The list of available series for this document type.
See DeliveryTypeSerieResource. |
| contactType | (string) The contact type for the delivery type.
(fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service. |
| notification | (string) The notification for the delivery type.
(fk) Allowed value: the natural key of a record of type Notification. |
| documentNoteTitle | (string) The document note title. |
| documentNote | (string) The document note. |
| dimensionCombination | (string) The dimension combination.
(fk) Allowed value: the natural key of a record of type DimensionCombination. These records are accessibly through the DimensionCombinations service. |
DeliveryTypeSerieResource
The following elements are required:
| numberOfCopies | (int) The number of copies of the document to print. |
| isDefault | (bool) Indicates if this is the default serie for the document. |
| isManual | (bool) Indicates if the delivery type is serie is manual. |
| isExternal | (bool) Indicates if the delivery type is serie is external. |
| serie | (string) The serie for the delivery type serie. |
| communicationType | (enum CommunicationType) The communication type to comunicate the document to the tax authority.
See CommunicationType. |
| aTManualCommunication | (bool) Manual Communication. |
The following elements are optional:
| currentDate | (DateTime) The current date for the order delivery serie. |
| currentNumber | (int) The current delivery type serie number. |
| aTValidationCode | (string) Validation Code. |
| aTCommunicationDate | (DateTime) Communication Date. |
| aTCommunicationStatus | (enum ATCommunicationStatus) Communication Status.
See ATCommunicationStatus. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |