Taxes | SAF-T Import Document
The SAFT Import Documentss end point is used to record information abount documents from saft files.
Overview
URL | api/{tenantKey}/{orgKey}/taxAuthorityPT/sAFTImportDocuments |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET SAFTImportDocuments
- GET SAFTImportDocuments (paged)
- GET SAFTImportDocument by identifier
- GET SAFTImportDocument by key
- GET Print SAFTImportDocument by identifier
- GET Print SAFTImportDocument by key
- GET Original Print SAFTImportDocumentOriginal by identifier
- GET Original Print SAFTImportDocument by key
- GET Get Documents Summary
- GET Get Saft Import Documents By Document No
- POST:
-
PUT:
- PUT Set IsActive SAFTImportDocument
- PUT Set DocumentNo SAFTImportDocument
- PUT Set DocumentStatus SAFTImportDocument
- PUT Set SAFTImport SAFTImportDocument
- PUT Set DocumentDate SAFTImportDocument
- PUT Set DocumentType SAFTImportDocument
- PUT Set CustomerID SAFTImportDocument
- PUT Set Hash SAFTImportDocument
- PUT Set HashControl SAFTImportDocument
- PUT Set TaxPayable SAFTImportDocument
- PUT Set NetTotal SAFTImportDocument
- PUT Set GrossTotal SAFTImportDocument
- PUT Set Company SAFTImportDocument
- PUT Set IntegrationSchemaEntity SAFTImportDocument
- PUT Set IntegrationDocID SAFTImportDocument
- PUT Set ShipToAddressBuildingNumber SAFTImportDocument
- PUT Set ShipToAddressStreetName SAFTImportDocument
- PUT Set ShipToAddressDetail SAFTImportDocument
- PUT Set ShipToCity SAFTImportDocument
- PUT Set ShipToAddressPostalCode SAFTImportDocument
- PUT Set ShipToAddressRegion SAFTImportDocument
- PUT Set ShipToAddressCountry SAFTImportDocument
- PUT Set ShipFromAddressBuildingNumber SAFTImportDocument
- PUT Set ShipFromAddressStreetName SAFTImportDocument
- PUT Set ShipFromAddressDetail SAFTImportDocument
- PUT Set ShipFromCity SAFTImportDocument
- PUT Set ShipFromAddressPostalCode SAFTImportDocument
- PUT Set ShipFromAddressRegion SAFTImportDocument
- PUT Set ShipFromAddressCountry SAFTImportDocument
- PUT Set DocumentStatusDate SAFTImportDocument
- PUT Set MarkedAsDeleted SAFTImportDocument
- PUT Set ProductCode SAFTImportDocumentLine
- PUT Set Quantity SAFTImportDocumentLine
- PUT Set UnitOfMeasure SAFTImportDocumentLine
- PUT Set UnitPrice SAFTImportDocumentLine
- PUT Set TaxPointDate SAFTImportDocumentLine
- PUT Set Description SAFTImportDocumentLine
- PUT Set CreditAmount SAFTImportDocumentLine
- PUT Set DebitAmount SAFTImportDocumentLine
- PUT Set SettlementAmount SAFTImportDocumentLine
- DELETE:
All Resources
This service uses the following resources:
GET SAFTImportDocuments
Returns the list of all the entity records available.
Response:
When successful, the response body contains the list of records available. See SAFTImportDocumentResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET SAFTImportDocuments (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 SAFTImportDocumentResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET SAFTImportDocument 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 SAFTImportDocumentResource. |
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 SAFTImportDocument by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
Response:
When successful, the response body contains the entity record. See SAFTImportDocumentResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Print SAFTImportDocument by identifier
Prints the specified entity record.
The following elements are required:
id | (string) The record identifier. |
The following elements are optional:
template | (string) The report template that should be used. This is a query string parameter. |
Response:
When successful, the response body contains a stream with the printed file. |
Response status codes:
200 | OK. The operation was completed successfully. |
404 | NotFound. The specified resord does not exist. |
Resource URL:
GET Print SAFTImportDocument by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
The following elements are optional:
template | (string) The report template that should be used. This is a query string parameter. |
Response:
When successful, the response body contains a stream with the printed file. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Original Print SAFTImportDocumentOriginal by identifier
Prints the specified entity record.
The following elements are required:
id | (string) The record identifier. |
The following elements are optional:
template | (string) The report template that should be used. This is a query string parameter. |
Response:
When successful, the response body contains a stream with the printed file. |
Response status codes:
200 | OK. The operation was completed successfully. |
404 | NotFound. The specified resord does not exist. |
Resource URL:
GET Original Print SAFTImportDocument by key
Prints the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
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 Get Documents Summary
This operation gets the summary information of documents available to be imported.
The following elements are required:
sAFTImportRequestId | (Guid) The saft import request identifier. |
pageSize | (int) The page size. |
pageIndex | (int) The page index. |
Response:
When successful, the response body contains a list of resources of type 'SaftImportDocumentSummary'. See SaftImportDocumentSummary. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Saft Import Documents By Document No
This operation gets the summary information of documents imported from SAFT for the given document number.
The following elements are required:
documentNo | (string) The saft document number. |
companyId | (Guid) The company identifier. |
Response:
When successful, the response body contains a list of resources of type 'SAFTImportDocumentResource'. See SAFTImportDocumentResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST SAFTImportDocuments
Creates a new entity record.
The following elements are required:
sAFTImportDocumentResource | (ApiSAFTImportDocumentResource) The request body should contain the entity record that should be created. See ApiSAFTImportDocumentResource. |
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 ApiSAFTImportDocumentResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST SAFT Import Document
Inserts a new 'SAFT Import Document Line' in the 'SAFT Import Document'.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (ApiSAFTImportDocumentSAFTImportDocumentLinesResource) The ApiSAFTImportDocumentSAFTImportDocumentLinesResource instance. See ApiSAFTImportDocumentSAFTImportDocumentLinesResource. |
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:
PUT Set Company SAFTImportDocument
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CreditAmount SAFTImportDocumentLine
Updates the value of attribute 'CreditAmount' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CustomerID SAFTImportDocument
Updates the value of attribute 'CustomerID' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DebitAmount SAFTImportDocumentLine
Updates the value of attribute 'DebitAmount' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description SAFTImportDocumentLine
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DocumentDate SAFTImportDocument
Updates the value of attribute 'DocumentDate' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DocumentNo SAFTImportDocument
Updates the value of attribute 'DocumentNo' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DocumentStatus SAFTImportDocument
Updates the value of attribute 'DocumentStatus' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DocumentStatusDate SAFTImportDocument
Updates the value of attribute 'DocumentStatusDate' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (DateTimeOffset) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DocumentType SAFTImportDocument
Updates the value of attribute 'DocumentType' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set GrossTotal SAFTImportDocument
Updates the value of attribute 'GrossTotal' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Hash SAFTImportDocument
Updates the value of attribute 'Hash' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set HashControl SAFTImportDocument
Updates the value of attribute 'HashControl' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IntegrationDocID SAFTImportDocument
Updates the value of attribute 'IntegrationDocID' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (Guid) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IntegrationSchemaEntity SAFTImportDocument
Updates the value of attribute 'IntegrationSchemaEntity' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive SAFTImportDocument
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set MarkedAsDeleted SAFTImportDocument
Updates the value of attribute 'MarkedAsDeleted' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set NetTotal SAFTImportDocument
Updates the value of attribute 'NetTotal' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ProductCode SAFTImportDocumentLine
Updates the value of attribute 'ProductCode' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Quantity SAFTImportDocumentLine
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SAFTImport SAFTImportDocument
Updates the value of attribute 'SAFTImport' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SettlementAmount SAFTImportDocumentLine
Updates the value of attribute 'SettlementAmount' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipFromAddressBuildingNumber SAFTImportDocument
Updates the value of attribute 'ShipFromAddressBuildingNumber' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipFromAddressCountry SAFTImportDocument
Updates the value of attribute 'ShipFromAddressCountry' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipFromAddressDetail SAFTImportDocument
Updates the value of attribute 'ShipFromAddressDetail' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipFromAddressPostalCode SAFTImportDocument
Updates the value of attribute 'ShipFromAddressPostalCode' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipFromAddressRegion SAFTImportDocument
Updates the value of attribute 'ShipFromAddressRegion' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipFromAddressStreetName SAFTImportDocument
Updates the value of attribute 'ShipFromAddressStreetName' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipFromCity SAFTImportDocument
Updates the value of attribute 'ShipFromCity' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipToAddressBuildingNumber SAFTImportDocument
Updates the value of attribute 'ShipToAddressBuildingNumber' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipToAddressCountry SAFTImportDocument
Updates the value of attribute 'ShipToAddressCountry' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipToAddressDetail SAFTImportDocument
Updates the value of attribute 'ShipToAddressDetail' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipToAddressPostalCode SAFTImportDocument
Updates the value of attribute 'ShipToAddressPostalCode' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipToAddressRegion SAFTImportDocument
Updates the value of attribute 'ShipToAddressRegion' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipToAddressStreetName SAFTImportDocument
Updates the value of attribute 'ShipToAddressStreetName' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ShipToCity SAFTImportDocument
Updates the value of attribute 'ShipToCity' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TaxPayable SAFTImportDocument
Updates the value of attribute 'TaxPayable' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TaxPointDate SAFTImportDocumentLine
Updates the value of attribute 'TaxPointDate' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (DateTime) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnitOfMeasure SAFTImportDocumentLine
Updates the value of attribute 'UnitOfMeasure' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnitPrice SAFTImportDocumentLine
Updates the value of attribute 'UnitPrice' in the specified entity record.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) 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:
DELETE SAFT Import Document Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
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:
DELETE SAFTImportDocument by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE SAFTImportDocument by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiSAFTImportDocumentResource
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
company | (string) Company. |
markedAsDeleted | (bool) Marked As Deleted. |
The following elements are optional:
documentDate | (string) Document Date. |
documentType | (string) Document Type. |
customerID | (string) Customer ID. |
sAFTImportDocumentLines | (List of ApiSAFTImportDocumentSAFTImportDocumentLinesResource) SAFT Import Document Lines.
See ApiSAFTImportDocumentSAFTImportDocumentLinesResource. |
hash | (string) Hash. |
hashControl | (string) Hash Control. |
taxPayable | (decimal) Tax Payable. |
netTotal | (decimal) Net Total. |
grossTotal | (decimal) Gross Total. |
integrationSchemaEntity | (string) Schema Entity (Integration). |
integrationDocID | (Guid) Integration Doc ID. |
shipToAddressBuildingNumber | (string) Ship To Address Building Number. |
shipToAddressStreetName | (string) Ship To Address Street Name. |
shipToAddressDetail | (string) Ship To Address Detail. |
shipToCity | (string) Ship To City. |
shipToAddressPostalCode | (string) Ship To Address Postal. |
shipToAddressRegion | (string) Ship To Address Region. |
shipToAddressCountry | (string) Ship To Address Country. |
shipFromAddressBuildingNumber | (string) Ship From Address Building Number. |
shipFromAddressStreetName | (string) Ship From Address Street Name. |
shipFromAddressDetail | (string) Ship From Address Detail. |
shipFromCity | (string) Ship From City. |
shipFromAddressPostalCode | (string) Ship From Address Postal. |
shipFromAddressRegion | (string) Ship From Address Region. |
shipFromAddressCountry | (string) Ship From Address Country. |
documentStatusDate | (DateTimeOffset) Document Status Date. |
ApiSAFTImportDocumentSAFTImportDocumentLinesResource
The following elements are optional:
productCode | (string) Product. |
quantity | (decimal) Quantity. |
unitOfMeasure | (string) Unit Of Measure. |
unitPrice | (decimal) Unit Price. |
taxPointDate | (DateTime) Tax Point Date. |
description | (string) Description. |
creditAmount | (decimal) Credit Amount. |
debitAmount | (decimal) Debit Amount. |
sAFTImportDocumentLineTaxes | (List of ApiSAFTImportDocumentSAFTImportDocumentLinesSAFTImportDocumentLineTaxesResource) SAFT Import Document Line Taxes.
See ApiSAFTImportDocumentSAFTImportDocumentLinesSAFTImportDocumentLineTaxesResource. |
settlementAmount | (decimal) Settlement Amount. |
ApiSAFTImportDocumentSAFTImportDocumentLinesSAFTImportDocumentLineTaxesResource
The following elements are optional:
taxType | (string) Tax Type. |
taxCountryRegion | (string) Tax Country Region. |
taxCode | (string) Tax. |
taxPercentage | (decimal) Tax Percentage. |
SAFTImportDocumentLineResource
The following elements are optional:
productCode | (string) Product. |
quantity | (decimal) Quantity. |
unitOfMeasure | (string) Unit Of Measure. |
unitPrice | (decimal) Unit Price. |
taxPointDate | (DateTime) Tax Point Date. |
description | (string) Description. |
creditAmount | (decimal) Credit Amount. |
debitAmount | (decimal) Debit Amount. |
sAFTImportDocumentLineTaxes | (List of SAFTImportDocumentLineTaxResource) SAFT Import Document Line Taxes.
See SAFTImportDocumentLineTaxResource. |
settlementAmount | (decimal) Settlement Amount. |
SAFTImportDocumentLineTaxResource
The following elements are optional:
taxType | (string) Tax Type. |
taxCountryRegion | (string) Tax Country Region. |
taxCode | (string) Tax. |
taxPercentage | (decimal) Tax Percentage. |
SAFTImportDocumentResource
The following elements are required:
documentNo | (string) Document No. |
documentStatus | (string) Document Status. |
sAFTImport | (string) SAFT Import. |
company | (string) Company. |
markedAsDeleted | (bool) Marked As Deleted. |
The following elements are optional:
documentDate | (string) Document Date. |
documentType | (string) Document Type. |
customerID | (string) Customer ID. |
sAFTImportDocumentLines | (List of SAFTImportDocumentLineResource) SAFT Import Document Lines.
See SAFTImportDocumentLineResource. |
hash | (string) Hash. |
hashControl | (string) Hash Control. |
taxPayable | (decimal) Tax Payable. |
netTotal | (decimal) Net Total. |
grossTotal | (decimal) Gross Total. |
integrationSchemaEntity | (string) Schema Entity (Integration). |
integrationDocID | (Guid) Integration Doc ID. |
shipToAddressBuildingNumber | (string) Ship To Address Building Number. |
shipToAddressStreetName | (string) Ship To Address Street Name. |
shipToAddressDetail | (string) Ship To Address Detail. |
shipToCity | (string) Ship To City. |
shipToAddressPostalCode | (string) Ship To Address Postal. |
shipToAddressRegion | (string) Ship To Address Region. |
shipToAddressCountry | (string) Ship To Address Country. |
shipFromAddressBuildingNumber | (string) Ship From Address Building Number. |
shipFromAddressStreetName | (string) Ship From Address Street Name. |
shipFromAddressDetail | (string) Ship From Address Detail. |
shipFromCity | (string) Ship From City. |
shipFromAddressPostalCode | (string) Ship From Address Postal. |
shipFromAddressRegion | (string) Ship From Address Region. |
shipFromAddressCountry | (string) Ship From Address Country. |
documentStatusDate | (DateTimeOffset) Document Status Date. |
SaftImportDocumentSummary
The following elements are optional:
documentDate | (string) The Document date. |
customerKey | (string) The Customer. |
documentNumber | (string) The Document Number. |
netTotal | (decimal) The Net Total Amount. |
taxPayable | (decimal) The Tax Payable Amount. |
grossTotal | (decimal) The Gross Total Amount. |
status | (string) The Invoice Status. |
currencyCode | (string) The ISO code for the currency of the document. |