Logistics | Delivery Type

Service to manage entities of type 'DeliveryType'.

Overview

api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes

URL	api/{tenantKey}/{orgKey}/logisticsCore/deliveryTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST DeliveryTypes
- POST Delivery Type Serie
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiDeliveryTypeDocumentTypeSeriesResource
ApiDeliveryTypeResource
DeliveryTypeResource

All Enumerations

This service uses the following enumerations:

CommunicationType

GET Operations

GET DeliveryTypes (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

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/odata

GET /logisticsCore/deliveryTypes/odata

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}

POST Operations

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.

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 Serie

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.

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 Operations

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 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 ExcludeFromBilling DeliveryType

Updates the value of attribute 'ExcludeFromBilling' 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}/excludeFromBilling

PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/excludeFromBilling

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 Led DeliveryTypeSerie

Updates the value of attribute 'Led' 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}/led

PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/led

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 PrintWithoutATCode DeliveryType

Updates the value of attribute 'PrintWithoutATCode' 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}/printWithoutATCode

PUT /logisticsCore/deliveryTypes/{companyKey}/{typeKey}/printWithoutATCode

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

DELETE Operations

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:

led	(string) Place of issue of the document. It is required for electronic communication of the document to the Cape Verde tax authority.
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.
isInternal	(bool) Is Internal.
excludeFromBilling	(bool) Exclude From Billing.
printWithoutATCode	(bool) Print Without AT Code.

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.

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) Is Internal.
excludeFromBilling	(bool) Exclude From Billing.
printWithoutATCode	(bool) Print Without AT Code.

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. These records are accessibly through the Notifications service.

Enumerations

CommunicationType

1	WebService
2	SAFT
3	NoCommunication
4	Manual