Taxes | SAF-T Import

The SAFT Imports end point is used to record information from saft files, such as items, documents and customers.

Overview

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports

URL	api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiSAFTImportResource
ApiSAFTImportSAFTImportCustomersResource
ApiSAFTImportSAFTImportItemsResource
PartiesWithoutCustomersExtensions
SAFTImportCustomerResource
SAFTImportItemResource
SAFTImportResource
StandardSAFTImportResource
StandardSAFTImportSAFTImportCustomersResource
StandardSAFTImportSAFTImportItemsResource

All Enumerations

This service uses the following enumerations:

ItemType
SAFTImportStatus

GET Operations

GET SAFTImports

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports

GET /taxAuthorityPT/sAFTImports

GET SAFTImports (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 SAFTImportResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports?page={page}&pageSize={pageSize}

GET /taxAuthorityPT/sAFTImports?page={page}&pageSize={pageSize}

GET SAFTImport 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 SAFTImportResource.

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

GET /taxAuthorityPT/sAFTImports/{id}

GET SAFTImport by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
sAFTImportKey	(int) Number.

Response:

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

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}

GET /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}

GET Print SAFTImport 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}/taxAuthorityPT/sAFTImports/{id}/print?template={template}

GET /taxAuthorityPT/sAFTImports/{id}/print?template={template}

GET Print SAFTImport by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
sAFTImportKey	(int) Number.

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/print

GET /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/print

GET Original Print SAFTImportOriginal 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}/taxAuthorityPT/sAFTImports/{id}/printOriginal?template={template}

GET /taxAuthorityPT/sAFTImports/{id}/printOriginal?template={template}

GET Original Print SAFTImport by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
sAFTImportKey	(int) Number.

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/printOriginal

GET /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/printOriginal

GET Get SAFT Import Id By Request Id

This operation gets the saft import identifier from a request identifier.

The following elements are required:

requestId

(Guid) The Saft Request identifier.

Response:

When successful, the response body contains a unique identifier.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/getSAFTImportIdByRequestId/{requestId}

GET /taxAuthorityPT/sAFTImports/getSAFTImportIdByRequestId/{requestId}

GET Get Parties Without Customers Extensions

This endpoint will get all parties without the customer extensions used on the process of the saft import.

The following elements are required:

saftImportId

(Guid) The saft import identifier.

Response:

When successful, the response body contains a list of resources of type 'PartiesWithoutCustomersExtensions'. See PartiesWithoutCustomersExtensions.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/getPartiesWithoutCustomersExtensions/{saftImportId}

GET /taxAuthorityPT/sAFTImports/getPartiesWithoutCustomersExtensions/{saftImportId}

POST Operations

POST SAFTImports

Creates a new entity record.

The following elements are required:

sAFTImportResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports

POST /taxAuthorityPT/sAFTImports

POST SAF-T Import

Inserts a new 'SAFT Import Item' in the 'SAF-T Import'.

The following elements are required:

sAFTImportKey	(int) Number.
companyKey	(string) The company key.
value	(ApiSAFTImportSAFTImportItemsResource) The ApiSAFTImportSAFTImportItemsResource instance. See ApiSAFTImportSAFTImportItemsResource.

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems

POST /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems

POST SAF-T Import

Inserts a new 'SAFT Import Customer' in the 'SAF-T Import'.

The following elements are required:

sAFTImportKey	(int) Number.
companyKey	(string) The company key.
value	(ApiSAFTImportSAFTImportCustomersResource) The ApiSAFTImportSAFTImportCustomersResource instance. See ApiSAFTImportSAFTImportCustomersResource.

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers

POST /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers

POST Import Customers

Custom operation 'ImportCustomers'.

The following elements are required:

customer

(SAFTCustomer) Customer.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/importCustomers

POST /taxAuthorityPT/sAFTImports/importCustomers

POST Import Item

Custom operation 'ImportItem'.

The following elements are required:

item	(SAFTProduct) Item.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/importItem

POST /taxAuthorityPT/sAFTImports/importItem

POST Import Document

Custom operation 'ImportDocument'.

The following elements are required:

document

(SAFTDocument) Document.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/importDocument

POST /taxAuthorityPT/sAFTImports/importDocument

PUT Operations

PUT Set AccountID SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/accountID

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/accountID

PUT Set AddressBuildingNumber SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressBuildingNumber

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressBuildingNumber

PUT Set AddressCity SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressCity

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressCity

PUT Set AddressCountry SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressCountry

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressCountry

PUT Set AddressDetail SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressDetail

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressDetail

PUT Set AddressPostalCode SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressPostalCode

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressPostalCode

PUT Set AddressRegion SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressRegion

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressRegion

PUT Set AddressStreetName SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressStreetName

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/addressStreetName

PUT Set Cae SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/cae

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/cae

PUT Set Company SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/company

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/company

PUT Set CompanyName SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/companyName

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/companyName

PUT Set CustomerGroup SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/customerGroup

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/customerGroup

PUT Set CustomerID SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/customerID

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/customerID

PUT Set CustomersVerified SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/customersVerified

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/customersVerified

PUT Set CustomerTaxID SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/customerTaxID

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/customerTaxID

PUT Set Description SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/description

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/description

PUT Set DimensionSetJson SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/dimensionSetJson

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/dimensionSetJson

PUT Set DimensionSetJson SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/dimensionSetJson

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/dimensionSetJson

PUT Set DocumentsVerified SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/documentsVerified

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/documentsVerified

PUT Set Email SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/email

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/email

PUT Set EndDate SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/endDate

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/endDate

PUT Set ExistingNif SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/existingNif

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/existingNif

PUT Set Fax SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/fax

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/fax

PUT Set Filename SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/filename

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/filename

PUT Set FirstDocumentDate SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/firstDocumentDate

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/firstDocumentDate

PUT Set IsActive SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isActive

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isActive

PUT Set IsVerifyingCustomers SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isVerifyingCustomers

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isVerifyingCustomers

PUT Set IsVerifyingDocuments SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isVerifyingDocuments

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isVerifyingDocuments

PUT Set IsVerifyingItems SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isVerifyingItems

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/isVerifyingItems

PUT Set ItemAccountType SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemAccountType

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemAccountType

PUT Set ItemKey SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemKey

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemKey

PUT Set ItemsVerified SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/itemsVerified

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/itemsVerified

PUT Set ItemTaxSchema SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemTaxSchema

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemTaxSchema

PUT Set ItemType SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum ItemType) The request body should contain the new value for the attribute. See ItemType.

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemType

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemType

PUT Set ItemWithholdingTaxSchema SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemWithholdingTaxSchema

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/itemWithholdingTaxSchema

PUT Set LastDocumentDate SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/lastDocumentDate

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/lastDocumentDate

PUT Set Name SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/name

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/name

PUT Set OtherReceivable SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/otherReceivable

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/otherReceivable

PUT Set PartyAccountType SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/partyAccountType

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/partyAccountType

PUT Set PartyKey SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/partyKey

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/partyKey

PUT Set ProductCode SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productCode

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productCode

PUT Set ProductDescription SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productDescription

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productDescription

PUT Set ProductGroup SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productGroup

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productGroup

PUT Set ProductNumberCode SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productNumberCode

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productNumberCode

PUT Set ProductType SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productType

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/productType

PUT Set SAFTImportRequest SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportRequest

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportRequest

PUT Set SAFTImportStatus SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
companyKey	(string) The company key.
value	(enum SAFTImportStatus) The request body should contain the new value for the attribute. See SAFTImportStatus.

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportStatus

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportStatus

PUT Set SelfBillingIndicator SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/selfBillingIndicator

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/selfBillingIndicator

PUT Set StartDate SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/startDate

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/startDate

PUT Set TaxRegistrationNumber SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/taxRegistrationNumber

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/taxRegistrationNumber

PUT Set Telephone SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/telephone

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/telephone

PUT Set TotalCustomers SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalCustomers

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalCustomers

PUT Set TotalCustomersImported SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalCustomersImported

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalCustomersImported

PUT Set TotalDocuments SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalDocuments

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalDocuments

PUT Set TotalDocumentsImported SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalDocumentsImported

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalDocumentsImported

PUT Set TotalItems SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalItems

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalItems

PUT Set TotalItemsImported SAFTImport

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalItemsImported

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/totalItemsImported

PUT Set Unit SAFTImportItem

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/unit

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}/unit

PUT Set Website SAFTImportCustomer

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

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/website

PUT /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}/website

DELETE Operations

DELETE SAFT Import Item by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}

DELETE /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportItems/{lineId}

DELETE SAFT Import Customer by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

sAFTImportKey	(int) Number.
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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}

DELETE /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}/sAFTImportCustomers/{lineId}

DELETE SAFTImport 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}/taxAuthorityPT/sAFTImports/{id}

DELETE /taxAuthorityPT/sAFTImports/{id}

DELETE SAFTImport by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
sAFTImportKey	(int) Number.

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}/taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}

DELETE /taxAuthorityPT/sAFTImports/{companyKey}/{sAFTImportKey}

Resources

ApiSAFTImportResource

The following elements are required:

taxRegistrationNumber	(string) Tax Registration Number.
sAFTImportStatus	(enum SAFTImportStatus) Status. See SAFTImportStatus.
sAFTImportRequest	(string) SAFT Import Request.
company	(string) Company.

The following elements are optional:

filename	(string) Filename.
firstDocumentDate	(DateTime) First Document Date.
lastDocumentDate	(DateTime) Last Document Date.
totalDocuments	(int) Total Documents.
totalCustomers	(int) Total Customers.
totalItems	(int) Total Items.
totalDocumentsImported	(int) Total Documents Imported.
totalCustomersImported	(int) Total Customers Imported.
totalItemsImported	(int) Total Items Imported.
sAFTImportItems	(List of ApiSAFTImportSAFTImportItemsResource) SAFT Import Items. See ApiSAFTImportSAFTImportItemsResource.
sAFTImportCustomers	(List of ApiSAFTImportSAFTImportCustomersResource) SAFT Import Customers. See ApiSAFTImportSAFTImportCustomersResource.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
isVerifyingCustomers	(bool) Is Verifying Customers.
customersVerified	(string) Customers Verified.
isVerifyingItems	(bool) Is Verifying Items.
itemsVerified	(string) Items Verified.
isVerifyingDocuments	(bool) Is Verifying Documents.
documentsVerified	(string) Documents Verified.

ApiSAFTImportSAFTImportCustomersResource

The following elements are required:

customerGroup	(string) Customer Group.
partyAccountType	(string) Party Account Type.
selfBillingIndicator	(int) Self Billing Indicator.
existingNif	(bool) Existing Nif.

The following elements are optional:

partyKey	(string) Party.
name	(string) Name.
customerID	(string) Customer ID.
accountID	(string) Account ID.
customerTaxID	(string) Customer Tax ID.
companyName	(string) Company Name.
telephone	(string) Telephone.
email	(string) Email.
website	(string) Website.
otherReceivable	(bool) Other Receivable.
addressBuildingNumber	(string) Address Building Number.
addressStreetName	(string) Address Street Name.
addressDetail	(string) Address Detail.
addressCity	(string) Address City.
addressPostalCode	(string) Address Postal.
addressRegion	(string) Address Region.
addressCountry	(string) Address Country.
fax	(string) Fax.
cae	(string) Cae.
dimensionSetJson	(string) The party dimension set configuration.

ApiSAFTImportSAFTImportItemsResource

The following elements are required:

itemKey	(string) Item.
itemAccountType	(string) Item Account Type.
itemTaxSchema	(string) Item Tax Schema.

The following elements are optional:

productCode	(string) Product.
productType	(string) Product Type.
productDescription	(string) Product Description.
productGroup	(string) Product Group.
productNumberCode	(string) Product Number.
description	(string) Description.
itemType	(enum ItemType) Item Type. See ItemType.
unit	(string) Unit.
itemWithholdingTaxSchema	(string) Item Withholding Tax Schema.
dimensionSetJson	(string) The item dimension set configuration.

PartiesWithoutCustomersExtensions

The following elements are required:

partyKey

(string) The key of the party.

The following elements are optional:

customerGroupId	(Guid) The customer group identifier of the saft import customer.
baseEntityId	(Guid) The base entity identifier of the party.
customerTaxId	(string) The customer tax id.
otherReceivable	(bool) if the party is customer or Other Receivable.

SAFTImportCustomerResource

The following elements are required:

customerGroup	(string) Customer Group.
partyAccountType	(string) Party Account Type.
selfBillingIndicator	(int) Self Billing Indicator.
existingNif	(bool) Existing Nif.

The following elements are optional:

partyKey	(string) Party.
name	(string) Name.
customerID	(string) Customer ID.
accountID	(string) Account ID.
customerTaxID	(string) Customer Tax ID.
companyName	(string) Company Name.
telephone	(string) Telephone.
email	(string) Email.
website	(string) Website.
otherReceivable	(bool) Other Receivable.
addressBuildingNumber	(string) Address Building Number.
addressStreetName	(string) Address Street Name.
addressDetail	(string) Address Detail.
addressCity	(string) Address City.
addressPostalCode	(string) Address Postal.
addressRegion	(string) Address Region.
addressCountry	(string) Address Country.
fax	(string) Fax.
cae	(string) Cae.
dimensionSetJson	(string) The party dimension set configuration.

SAFTImportItemResource

The following elements are required:

itemKey	(string) Item.
itemAccountType	(string) Item Account Type.
itemTaxSchema	(string) Item Tax Schema.

The following elements are optional:

productCode	(string) Product.
productType	(string) Product Type.
productDescription	(string) Product Description.
productGroup	(string) Product Group.
productNumberCode	(string) Product Number.
description	(string) Description.
itemType	(enum ItemType) Item Type. See ItemType.
unit	(string) Unit.
itemWithholdingTaxSchema	(string) Item Withholding Tax Schema.
dimensionSetJson	(string) The item dimension set configuration.

SAFTImportResource

The following elements are required:

sAFTImportKey	(int) Number.
taxRegistrationNumber	(string) Tax Registration Number.
sAFTImportStatus	(enum SAFTImportStatus) Status. See SAFTImportStatus.
sAFTImportRequest	(string) SAFT Import Request. (fk) Allowed value: the natural key of a record of type SAFTImportRequest. These records are accessibly through the SAFTImportRequests service.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

filename	(string) Filename.
firstDocumentDate	(DateTime) First Document Date.
lastDocumentDate	(DateTime) Last Document Date.
totalDocuments	(int) Total Documents.
totalCustomers	(int) Total Customers.
totalItems	(int) Total Items.
totalDocumentsImported	(int) Total Documents Imported.
totalCustomersImported	(int) Total Customers Imported.
totalItemsImported	(int) Total Items Imported.
sAFTImportItems	(List of SAFTImportItemResource) SAFT Import Items. See SAFTImportItemResource.
sAFTImportCustomers	(List of SAFTImportCustomerResource) SAFT Import Customers. See SAFTImportCustomerResource.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.
isVerifyingCustomers	(bool) Is Verifying Customers.
customersVerified	(string) Customers Verified.
isVerifyingItems	(bool) Is Verifying Items.
itemsVerified	(string) Items Verified.
isVerifyingDocuments	(bool) Is Verifying Documents.
documentsVerified	(string) Documents Verified.

StandardSAFTImportResource

The following elements are required:

sAFTImportKey	(int) Number.
company	(string) Company.
sAFTImportRequest	(string) SAFT Import Request.

The following elements are optional:

sAFTImportCustomers	(List of StandardSAFTImportSAFTImportCustomersResource) SAFT Import Customers. See StandardSAFTImportSAFTImportCustomersResource.
customersVerified	(string) Customers Verified.
documentsVerified	(string) Documents Verified.
isVerifyingCustomers	(bool) Is Verifying Customers.
isVerifyingDocuments	(bool) Is Verifying Documents.
isVerifyingItems	(bool) Is Verifying Items.
itemsVerified	(string) Items Verified.
sAFTImportItems	(List of StandardSAFTImportSAFTImportItemsResource) SAFT Import Items. See StandardSAFTImportSAFTImportItemsResource.
totalCustomers	(int) Total Customers.
totalCustomersImported	(int) Total Customers Imported.
totalDocuments	(int) Total Documents.
totalDocumentsImported	(int) Total Documents Imported.
totalItems	(int) Total Items.
totalItemsImported	(int) Total Items Imported.

StandardSAFTImportSAFTImportCustomersResource

The following elements are required:

customerGroup	(string) Customer Group.
partyAccountType	(string) Party Account Type.
existingNif	(bool) Existing Nif.

The following elements are optional:

customerID	(string) Customer ID.
customerTaxID	(string) Customer Tax ID.
dimensionSetJson	(string) The party dimension set configuration.
name	(string) Name.
otherReceivable	(bool) Other Receivable.

StandardSAFTImportSAFTImportItemsResource

The following elements are required:

itemAccountType	(string) Item Account Type.
itemKey	(string) Item.
itemTaxSchema	(string) Item Tax Schema.

The following elements are optional:

description	(string) Description.
dimensionSetJson	(string) The item dimension set configuration.
itemType	(enum ItemType) Item Type. See ItemType.
itemWithholdingTaxSchema	(string) Item Withholding Tax Schema.
unit	(string) Unit.

Enumerations

ItemType

1	Item
2	Service

SAFTImportStatus

1	Processing
2	AccountingSucceeded
3	AccountingPartiallySucceeded
4	AccountingFailed
5	Deleted
6	DeletedPartially