ROSE Developers - Web API Reference

Taxes | SAFT Sales Import Setup

Service to manage entities of type 'SAFTSalesImportSetup'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET SAFTSalesImportSetups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxAuthorityPT/sAFTSalesImportSetups

GET SAFTSalesImportSetups (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 SAFTSalesImportSetupResource.

Response status codes:

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

Resource URL:

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

GET SAFTSalesImportSetup 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 SAFTSalesImportSetupResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /taxAuthorityPT/sAFTSalesImportSetups/{id}

GET SAFTSalesImportSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

company (string) Company.

Response:

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

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /taxAuthorityPT/sAFTSalesImportSetups/{company}

GET Print SAFTSalesImportSetup by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

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

GET Print SAFTSalesImportSetup by key

Prints the specified entity record.

The following elements are required:

company (string) Company.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /taxAuthorityPT/sAFTSalesImportSetups/{company}/print

GET Original Print SAFTSalesImportSetupOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

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

GET Original Print SAFTSalesImportSetup by key

Prints the specified entity record.

The following elements are required:

company (string) Company.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /taxAuthorityPT/sAFTSalesImportSetups/{company}/printOriginal

POST Operations

POST SAFT Sales Import Setup

Inserts a new 'SAFTSI Document Type' in the 'SAFT Sales Import Setup'.

The following elements are required:

company (string) Company.
value (ApiSAFTSalesImportSetupSAFTSIDocumentTypesResource) The ApiSAFTSalesImportSetupSAFTSIDocumentTypesResource instance.
See ApiSAFTSalesImportSetupSAFTSIDocumentTypesResource.

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:

POST /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIDocumentTypes

POST SAFT Sales Import Setup

Inserts a new 'SAFTSI Product Tax' in the 'SAFT Sales Import Setup'.

The following elements are required:

company (string) Company.
value (ApiSAFTSalesImportSetupSAFTSIProductTaxesResource) The ApiSAFTSalesImportSetupSAFTSIProductTaxesResource instance.
See ApiSAFTSalesImportSetupSAFTSIProductTaxesResource.

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:

POST /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProductTaxes

POST SAFT Sales Import Setup

Inserts a new 'SAFTSI Customer' in the 'SAFT Sales Import Setup'.

The following elements are required:

company (string) Company.
value (ApiSAFTSalesImportSetupSAFTSICustomersResource) The ApiSAFTSalesImportSetupSAFTSICustomersResource instance.
See ApiSAFTSalesImportSetupSAFTSICustomersResource.

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:

POST /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers

POST SAFT Sales Import Setup

Inserts a new 'SAFTSI Product' in the 'SAFT Sales Import Setup'.

The following elements are required:

company (string) Company.
value (ApiSAFTSalesImportSetupSAFTSIProductsResource) The ApiSAFTSalesImportSetupSAFTSIProductsResource instance.
See ApiSAFTSalesImportSetupSAFTSIProductsResource.

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:

POST /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts

POST SAFT Sales Import Setup

Inserts a new 'SAFTSI Withholding' in the 'SAFT Sales Import Setup'.

The following elements are required:

company (string) Company.
value (ApiSAFTSalesImportSetupSAFTSIWithholdingsResource) The ApiSAFTSalesImportSetupSAFTSIWithholdingsResource instance.
See ApiSAFTSalesImportSetupSAFTSIWithholdingsResource.

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:

POST /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIWithholdings

PUT Operations

PUT Set ChartOfAccount SAFTSIWithholding

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIWithholdings/{lineId}/chartOfAccount

PUT Set Company SAFTSalesImportSetup

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

The following elements are required:

company (string) Company.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/company

PUT Set Country SAFTSICustomer

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers/{lineId}/country

PUT Set CustomerGLAccount SAFTSICustomer

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers/{lineId}/customerGLAccount

PUT Set CustomerGroup SAFTSICustomer

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers/{lineId}/customerGroup

PUT Set CustomerTaxID SAFTSICustomer

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers/{lineId}/customerTaxID

PUT Set DefaultCountry SAFTSalesImportSetup

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

The following elements are required:

company (string) Company.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/defaultCountry

PUT Set DimensionAllocationJson SAFTSIDocumentType

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIDocumentTypes/{lineId}/dimensionAllocationJson

PUT Set EUMember SAFTSICustomer

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers/{lineId}/eUMember

PUT Set FinancialGLAccount SAFTSIDocumentType

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIDocumentTypes/{lineId}/financialGLAccount

PUT Set GLAccount SAFTSIWithholding

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIWithholdings/{lineId}/gLAccount

PUT Set GroupByOneTimeCustomer SAFTSalesImportSetup

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

The following elements are required:

company (string) Company.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/groupByOneTimeCustomer

PUT Set HandleWithholdingTaxes SAFTSalesImportSetup

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

The following elements are required:

company (string) Company.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/handleWithholdingTaxes

PUT Set IsActive SAFTSalesImportSetup

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

The following elements are required:

company (string) Company.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/isActive

PUT Set ItemWithholdingTaxSchema SAFTSIWithholding

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIWithholdings/{lineId}/itemWithholdingTaxSchema

PUT Set JournalType SAFTSIDocumentType

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIDocumentTypes/{lineId}/journalType

PUT Set MemoReason SAFTSIDocumentType

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIDocumentTypes/{lineId}/memoReason

PUT Set PartyAccountType SAFTSICustomer

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers/{lineId}/partyAccountType

PUT Set PartyKeyOnCreation SAFTSalesImportSetup

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

The following elements are required:

company (string) Company.
value (enum PartyCreationKey) The request body should contain the new value for the attribute.
See PartyCreationKey.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/partyKeyOnCreation

PUT Set PartyTaxSchema SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/partyTaxSchema

PUT Set ProductCodeDescription SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/productCodeDescription

PUT Set ProductGroup SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/productGroup

PUT Set ReturnGLAccount SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/returnGLAccount

PUT Set SAFTProductType SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (enum SAFTProductType) The request body should contain the new value for the attribute.
See SAFTProductType.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/sAFTProductType

PUT Set SAFTProductType SAFTSIProductTax

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (enum SAFTProductType) The request body should contain the new value for the attribute.
See SAFTProductType.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProductTaxes/{lineId}/sAFTProductType

PUT Set SalesGLAccount SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/salesGLAccount

PUT Set TaxClass SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/taxClass

PUT Set TaxClass SAFTSIProductTax

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProductTaxes/{lineId}/taxClass

PUT Set TaxRegionalArea SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/taxRegionalArea

PUT Set TaxRegionalArea SAFTSIProductTax

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProductTaxes/{lineId}/taxRegionalArea

PUT Set TaxSubClass SAFTSIProduct

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}/taxSubClass

PUT Set TaxSubClass SAFTSIProductTax

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProductTaxes/{lineId}/taxSubClass

PUT Set TaxTypeCode SAFTSIProductTax

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProductTaxes/{lineId}/taxTypeCode

PUT Set ToImport SAFTSIDocumentType

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

The following elements are required:

company (string) Company.
lineId (string) The detail identifier.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIDocumentTypes/{lineId}/toImport

DELETE Operations

DELETE SAFTSI Document Type by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company (string) Company.
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:

DELETE /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIDocumentTypes/{lineId}

DELETE SAFTSI Product Tax by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company (string) Company.
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:

DELETE /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProductTaxes/{lineId}

DELETE SAFTSI Customer by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company (string) Company.
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:

DELETE /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSICustomers/{lineId}

DELETE SAFTSI Product by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company (string) Company.
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:

DELETE /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIProducts/{lineId}

DELETE SAFTSI Withholding by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

company (string) Company.
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:

DELETE /taxAuthorityPT/sAFTSalesImportSetups/{company}/sAFTSIWithholdings/{lineId}

Resources


ApiSAFTSalesImportSetupResource

The following elements are required:

company (string) Company.
groupByOneTimeCustomer (bool) Group By One Time Customer.
partyKeyOnCreation (enum PartyCreationKey) Party Key.
See PartyCreationKey.
handleWithholdingTaxes (bool) Handle Withholding Taxes.

The following elements are optional:

sAFTSIDocumentTypes (List of ApiSAFTSalesImportSetupSAFTSIDocumentTypesResource) Document Types.
See ApiSAFTSalesImportSetupSAFTSIDocumentTypesResource.
sAFTSIProductTaxes (List of ApiSAFTSalesImportSetupSAFTSIProductTaxesResource) Taxes.
See ApiSAFTSalesImportSetupSAFTSIProductTaxesResource.
sAFTSICustomers (List of ApiSAFTSalesImportSetupSAFTSICustomersResource) Customers.
See ApiSAFTSalesImportSetupSAFTSICustomersResource.
sAFTSIProducts (List of ApiSAFTSalesImportSetupSAFTSIProductsResource) Products.
See ApiSAFTSalesImportSetupSAFTSIProductsResource.
sAFTSIWithholdings (List of ApiSAFTSalesImportSetupSAFTSIWithholdingsResource) Withholdings.
See ApiSAFTSalesImportSetupSAFTSIWithholdingsResource.
defaultCountry (string) Default Country.


ApiSAFTSalesImportSetupSAFTSICustomersResource

The following elements are required:

customerGLAccount (string) Customer GL Account.
eUMember (bool) EU Member.

The following elements are optional:

country (string) Country.
customerTaxID (string) Customer Tax ID.
partyAccountType (string) Party Account Type.
customerGroup (string) Customer Group.


ApiSAFTSalesImportSetupSAFTSIDocumentTypesResource

The following elements are required:

toImport (bool) To Import.

The following elements are optional:

journalType (string) Journal Type.
financialGLAccount (string) Financial GL Account.
memoReason (string) Memo Reason.
dimensionAllocationJson (string) The json representation of the dimension allocation.


ApiSAFTSalesImportSetupSAFTSIProductsResource

The following elements are required:

salesGLAccount (string) Sales GL Account.
returnGLAccount (string) Return GL Account.

The following elements are optional:

sAFTProductType (enum SAFTProductType) Product Type.
See SAFTProductType.
partyTaxSchema (string) Party Tax Schema.
taxClass (string) Tax Class.
taxSubClass (string) Tax Subclass.
taxRegionalArea (string) Tax Regional Area.
productGroup (string) Product Group.
productCodeDescription (string) Product Code/Description.


ApiSAFTSalesImportSetupSAFTSIProductTaxesResource

The following elements are required:

taxTypeCode (string) Tax Type.

The following elements are optional:

sAFTProductType (enum SAFTProductType) Product Type.
See SAFTProductType.
taxClass (string) Tax Class.
taxSubClass (string) Tax Subclass.
taxRegionalArea (string) Tax Regional Area.


ApiSAFTSalesImportSetupSAFTSIWithholdingsResource

The following elements are required:

gLAccount (string) GL Account.
itemWithholdingTaxSchema (string) Item Withholding Tax Schema.
chartOfAccount (string) Chart Of Account.


SAFTSalesImportSetupResource

The following elements are required:

company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
groupByOneTimeCustomer (bool) Group By One Time Customer.
partyKeyOnCreation (enum PartyCreationKey) Party Key.
See PartyCreationKey.
chartOfAccount (string) Chart Of Account.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
handleWithholdingTaxes (bool) Handle Withholding Taxes.

The following elements are optional:

sAFTSIDocumentTypes (List of SAFTSIDocumentTypeResource) Document Types.
See SAFTSIDocumentTypeResource.
sAFTSIProductTaxes (List of SAFTSIProductTaxResource) Taxes.
See SAFTSIProductTaxResource.
sAFTSICustomers (List of SAFTSICustomerResource) Customers.
See SAFTSICustomerResource.
sAFTSIProducts (List of SAFTSIProductResource) Products.
See SAFTSIProductResource.
sAFTSIWithholdings (List of SAFTSIWithholdingResource) Withholdings.
See SAFTSIWithholdingResource.
defaultCountry (string) Default Country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.


SAFTSICustomerResource

The following elements are required:

customerGLAccount (string) Customer GL Account.
eUMember (bool) EU Member.

The following elements are optional:

country (string) Country.
customerTaxID (string) Customer Tax ID.
partyAccountType (string) Party Account Type.
customerGroup (string) Customer Group.
chartOfAccount (string) Chart Of Account.


SAFTSIDocumentTypeResource

The following elements are required:

fiscalDocumentType (string) Fiscal Document Type.
toImport (bool) To Import.

The following elements are optional:

journalType (string) Journal Type.
financialGLAccount (string) Financial GL Account.
memoReason (string) Memo Reason.
dimensionAllocationJson (string) The json representation of the dimension allocation.
chartOfAccount (string) Chart Of Account.


SAFTSIProductResource

The following elements are required:

salesGLAccount (string) Sales GL Account.
returnGLAccount (string) Return GL Account.

The following elements are optional:

sAFTProductType (enum SAFTProductType) Product Type.
See SAFTProductType.
partyTaxSchema (string) Party Tax Schema.
taxClass (string) Tax Class.
taxSubClass (string) Tax Subclass.
taxRegionalArea (string) Tax Regional Area.
chartOfAccount (string) Chart Of Account.
productGroup (string) Product Group.
productCodeDescription (string) Product Code/Description.


SAFTSIProductTaxResource

The following elements are required:

taxTypeCode (string) Tax Type.

The following elements are optional:

sAFTProductType (enum SAFTProductType) Product Type.
See SAFTProductType.
taxClass (string) Tax Class.
taxSubClass (string) Tax Subclass.
taxRegionalArea (string) Tax Regional Area.


SAFTSIWithholdingResource

The following elements are required:

gLAccount (string) GL Account.
itemWithholdingTaxSchema (string) Item Withholding Tax Schema.
chartOfAccount (string) Chart Of Account.


Enumerations


PartyCreationKey

1 CompanyTaxID The company tax id.
2 Autonumber The autonumber.


SAFTProductType

1 Product
2 Service
3 Other
4 SpecialTax
5 Tax