ROSE Developers - Web API Reference

Sales | Memo

The Memos end point is used to record a commercial document from a sale return of goods or services or value amount correction. This document in Portugal will be communicated to AT.

Overview


URL api/{tenantKey}/{orgKey}/billing/memos
Methods Supported GET, POST, PUT, 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 Memos

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /billing/memos

GET Memos (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 MemoResource.

Response status codes:

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

Resource URL:

GET /billing/memos?page={page}&pageSize={pageSize}

GET Memo 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 MemoResource.

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 /billing/memos/{id}

GET Memo by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.

Response:

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

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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}

GET Print Memo 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 /billing/memos/{id}/print?template={template}

GET Print Memo by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/print

GET Original Print MemoOriginal 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 /billing/memos/{id}/printOriginal?template={template}

GET Original Print Memo by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/printOriginal

POST Operations

POST Memos

Creates a new entity record.

The following elements are required:

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

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiMemoResource.

Response status codes:

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

Resource URL:

POST /billing/memos

POST Generate Cius

Generate CIUS-PT document file.

The following elements are required:

memoId (Guid) The Invoice Identifier.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

POST /billing/memos/generateCius/{memoId}

PUT Operations

PUT Set AccountingSchema Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (enum AccountingSchema) The request body should contain the new value for the attribute.
See AccountingSchema.

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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/accountingSchema

PUT Set ChartOfAccount MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/chartOfAccount

PUT Set CommitmentReference MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/commitmentReference

PUT Set ComplementaryDescription MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/complementaryDescription

PUT Set CustomerAccount Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/customerAccount

PUT Set CustomsDeclaration Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/customsDeclaration

PUT Set DeliveryMode Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/deliveryMode

PUT Set DimensionSet Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/dimensionSet

PUT Set DimensionSet MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/dimensionSet

PUT Set DimensionSetJson Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/dimensionSetJson

PUT Set DimensionSetJson MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/dimensionSetJson

PUT Set DiscountAccount MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/discountAccount

PUT Set DocumentLineStatus MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum DocumentLineStatus) The request body should contain the new value for the attribute.
See DocumentLineStatus.

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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/documentLineStatus

PUT Set DueDate Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/dueDate

PUT Set EmailTo Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/emailTo

PUT Set FiscalDocumentType Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/fiscalDocumentType

PUT Set FiscalMemoReason Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/fiscalMemoReason

PUT Set IBAN Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/iBAN

PUT Set IsActive Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/isActive

PUT Set IsAgregatedDocument Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/isAgregatedDocument

PUT Set IsManualSerie Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/isManualSerie

PUT Set IsOneTimeCustomer Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/isOneTimeCustomer

PUT Set IsSeriesCommunicated Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/isSeriesCommunicated

PUT Set LogisticsPartyId Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/logisticsPartyId

PUT Set Nature Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (enum AccountingNature) The request body should contain the new value for the attribute.
See AccountingNature.

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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/nature

PUT Set NoteToRecipient Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/noteToRecipient

PUT Set Notification Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/notification

PUT Set OriginalTaxAmount Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/originalTaxAmount

PUT Set OriginalTaxExclusiveAmount Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/originalTaxExclusiveAmount

PUT Set PartyAccountingSchema Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (enum AccountingSchema) The request body should contain the new value for the attribute.
See AccountingSchema.

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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/partyAccountingSchema

PUT Set PaymentInstruction Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/paymentInstruction

PUT Set PrintDate Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/printDate

PUT Set PrintedReportName Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/printedReportName

PUT Set Remarks Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/remarks

PUT Set RoundingTaxableAmount MemoTax

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentTaxes/{lineId}/roundingTaxableAmount

PUT Set RoundingTaxAmount MemoTax

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentTaxes/{lineId}/roundingTaxAmount

PUT Set SalesAccount MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/salesAccount

PUT Set SalesChannel Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/salesChannel

PUT Set SourceOrder MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/sourceOrder

PUT Set SourceOrderId MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/sourceOrderId

PUT Set SourceOrderLine MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/sourceOrderLine

PUT Set SourceOrderLineId MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/sourceOrderLineId

PUT Set SourceOrderSchemaEntityId MemoLine

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/sourceOrderSchemaEntityId

PUT Set Swift Memo

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/swift

PUT Set TotalTaxableAmount MemoTax

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentTaxes/{lineId}/totalTaxableAmount

PUT Set TotalTaxAmount MemoTax

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

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
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 /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentTaxes/{lineId}/totalTaxAmount

PUT Set Custom Attribute Memo

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/{customAttributeName}

PUT Set Custom Attribute MemoLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey (string) The company key.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
lineId (string) The detail identifier.
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}/documentLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Memo 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 /billing/memos/{id}

DELETE Memo by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /billing/memos/{companyKey}/{seriesNumber}/{documentType}/{serie}

Resources


ApiMemoDocumentLinesDocumentLineTaxesResource

The following elements are required:

roundingTaxableAmount (MoneyResource) Round Taxable Amount.
See MoneyResource .
roundingTaxAmount (MoneyResource) Round Tax Amount.
See MoneyResource .


ApiMemoDocumentLinesResource

The following elements are required:

description (string) The memo's line item description. The default is defined on the sales item.
quantity (decimal) The memo's line item quantity. The default 1.
unitPrice (MoneyResource) The memo's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource .
unit (string) The memo's line item sales unit. The default sales unit is defined on the sales item.
itemTaxSchema (string) The memo's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
partyTaxSchema (string) The memo's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
salesItem (string) The sales item representing the good or service for memo line.
salesAccount (string) The expense/revenue GL account assigned from the account determination in the invoice tye.
chartOfAccount (string) The chart of accounts infered from company financial setup.

The following elements are optional:

documentLineTaxes (List of ApiMemoDocumentLinesDocumentLineTaxesResource) The memo's line taxes.
See ApiMemoDocumentLinesDocumentLineTaxesResource.
discount1 (decimal) The line item's discount 1 percentage. The default is 0.
discount2 (decimal) The line item's discount 2 percentage. The default is 0.
discount3 (decimal) The line item's discount 3 percentage. The default is 0.
complementaryDescription (string) The memo's line item complementary description. The default is defined on the sales item.
warehouse (string) The memo's line item warehouse. The default is defined on the materials item.
itemWithholdingTaxSchema (string) The memo's line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the sales item.
documentLineStatus (enum DocumentLineStatus) The document's line status. The default is Open.
See DocumentLineStatus.
dimensionSet (string) The dimension set. Infered from the dimension combination in the invoice type.
discountAccount (string) The commercial discount GL account assigned from the account determination in the invoice tye.
dimensionSetJson (string) Dimension Set Json.
reference (string) In this property will be the document number associated with this memo.
sourceOrder (string) The order that origin this line.
sourceOrderId (Guid) The order id that origin this line.
sourceOrderLine (int) The order line index that origin this line.
sourceOrderLineId (Guid) The order line id that origin this line.
sourceOrderSchemaEntityId (Guid) The order schema id that origin this line.
commitmentReference (string) The state supplier commitment reference.


ApiMemoDocumentTaxesResource

The following elements are required:

roundingTaxableAmount (MoneyResource) The rounding value of the invoice amount of revenue subject to tax.
See MoneyResource .
roundingTaxAmount (MoneyResource) The rounding value of the invoice tax amount. Internally determined.
See MoneyResource .
totalTaxableAmount (MoneyResource) The total amount of revenue subject to tax.
See MoneyResource .
totalTaxAmount (MoneyResource) The total invoice tax amount. Internally determined.
See MoneyResource .

The following elements are optional:

customExemptionReasonCode (string) Indicates the memo tax schema custom exemption reason. Applicable only if the tax schema is exempt. Internally determined.


ApiMemoResource

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
documentDate (DateTime) The date when the memo is issued.
postingDate (DateTime) The date when the memo is created.
note (string) The memo's note.
buyerCustomerPartyName (string) The customer's name. It is inferred from the customer party.
accountingParty (string) The customer designated in the memo as the party to whom the memo should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party.
exchangeRate (decimal) The rate that translates the values in the document from the document currency to company base currency. By default the system uses the exchange rates table at the document date.
discount (decimal) The discount's percentage. The default is defined on the customer party.
memoReason (string) The typified memo's reason. For example price error or missing stock.
currency (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party.
paymentTerm (string) The memo's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
company (string) The memo's company. The company code is the central organizational unit within the system.
customerAccount (string) The customer GL account.
printDate (DateTime) The date when the document was printed.
buyerCustomerParty (string) The customer party. Party that the memo is for.
isAgregatedDocument (bool) Defines if the invoice has agregated document. Used by saft import.
isSeriesCommunicated (bool) Is Series Communicated.

The following elements are optional:

documentLines (List of ApiMemoDocumentLinesResource) The memo's lines.
See ApiMemoDocumentLinesResource.
documentTaxes (List of ApiMemoDocumentTaxesResource) The memo's taxes.
See ApiMemoDocumentTaxesResource.
buyerCustomerPartyTaxId (string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the customer party.
buyerCustomerPartyAddress (string) The customer's address. It is inferred from the customer party.
accountingPartyName (string) The accounting's party name. It is inferred from the accounting party.
accountingPartyTaxId (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
accountingPartyAddress (string) The accounting's customer address. It is inferred from the accounting party.
exchangeRateDate (DateTime) The exchange rate's creation date.
remarks (string) The memo's remarks.
hash (string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
hashControl (string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
manualNumber (int) The memo's manual serie number. Applicable only when the memo type series is defined as manual.
manualDate (DateTime) The memo's manual serie number. Applicable only when the memo type series is defined as manual.
manualSerie (string) The memo's manual date. Applicable only when the memo type series is defined as manual.
noteToRecipient (string) The note to the memo's recipient.
economicActivityClassification (string) The memo's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
paymentMethod (string) The memo's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
deliveryTerm (string) The memo's delivery term. The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
altAddress (string) The alternative customer's address key to be used on the memo. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values.
salesChannel (string) The memo's sales channel origin. The default value is defined in the sales setup configuration settings.
dueDate (DateTime) Date in which the payment is due. In some countries it is also known as law date.
isManualSerie (bool) Is the series for copy of manual memo(s) (internal).
isOneTimeCustomer (bool) Is the party one-time ony customer (Internal).
fiscalDocumentType (string) The legal fiscal document type defined on the memo type. Inferred from the memo type.
accountingAltAddress (string) The alternative accounting's party address key to be used on the memo. The alternative addresses keys are defined on the accounting party addresses. When defined overrides the accounting party address values.
accountingSchema (enum AccountingSchema) The accounting's organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The customer accounting's organization method. The customer organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
notification (string) The memo's notification configuration. Inferred from the memo type.
emailTo (string) The email(s) to send memo notification. Inferred from the notification.
dimensionSet (string) The dimension set. Infered from the customer.
fiscalMemoReason (string) The fiscal reason for the memo assigned to the memo reason.
nature (enum AccountingNature) The nature of the memo.
See AccountingNature.
deliveryMode (string) The delivery mode. (ex: mail).
dimensionSetJson (string) Dimension Set Json.
customsDeclaration (string) The customs declaration.
salesperson (string) The sales person. The seller of the invoice.
logisticsPartyId (Guid) The party's unique identifier. It is inferred from the party. Internally setted.
swift (string) The society for Worldwide Interbank Financial Telecommunication number.
iBAN (string) The financial account's International Bank Account Number.
paymentInstruction (string) The Payment authorization given by the party.
originalTaxExclusiveAmount (decimal) [Non persisted] The memo's original total net value. Total value of goods and services after discounts, excluding taxes. Only applicable to external memos import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
originalTaxAmount (decimal) [Non persisted] The memo's original total tax value of goods and services. Only applicable to external memos import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
printedReportName (string) Indicates the report name used to print the document. Internally determined.


MemoLineResource

The following elements are required:

description (string) The memo's line item description. The default is defined on the sales item.
quantity (decimal) The memo's line item quantity. The default 1.
unitPrice (MoneyResource) The memo's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource .
taxTotal (MoneyResource) The total amount of taxes for this line. Internally calculated.
See MoneyResource .
allowanceChargeAmount (MoneyResource) The memo's line total discount. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The memo's line net value. The line value after discounts, excluding taxes. Internally calculated.
See MoneyResource .
lineExtensionAmount (MoneyResource) The memo's line payable amount. The line value including taxes and discounts. Internally calculated.
See MoneyResource .
grossValue (MoneyResource) The memo's line value before taxes or discounts. Internally calculated.
See MoneyResource .
unit (string) The memo's line item sales unit. The default sales unit is defined on the sales item.
itemTaxSchema (string) The memo's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
partyTaxSchema (string) The memo's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
salesItem (string) The sales item representing the good or service for memo line.
currency (string) The money's unit. Inferred from the memo currency.
itemType (enum ItemType) The memo's line item type. Inferred from the sales item type. Internally determined.
See ItemType.
salesAccount (string) The expense/revenue GL account assigned from the account determination in the invoice tye.
chartOfAccount (string) The chart of accounts infered from company financial setup.
deliveryOnInvoice (bool) The default delivery type when the orders are processed.

The following elements are optional:

documentLineTaxes (List of MemoLineTaxResource) The memo's line taxes.
See MemoLineTaxResource.
discount1 (decimal) The line item's discount 1 percentage. The default is 0.
discount2 (decimal) The line item's discount 2 percentage. The default is 0.
discount3 (decimal) The line item's discount 3 percentage. The default is 0.
complementaryDescription (string) The memo's line item complementary description. The default is defined on the sales item.
warehouse (string) The memo's line item warehouse. The default is defined on the materials item.
partyWithholdingTaxSchema (string) The memo's customer party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
itemWithholdingTaxSchema (string) The memo's line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the sales item.
documentLineStatus (enum DocumentLineStatus) The document's line status. The default is Open.
See DocumentLineStatus.
sourceSchemaEntity (string) The shema entity from originating document, possible values: Quotations, Orders, Deliveries, Invoices, GoodsReturns, Memos.
sourceDoc (string) The source document using the format {..} when the memo is transformed from another document. Internally determined.
sourceDocId (Guid) The source document identifier when the memo is transformed from other source document. Internally determined.
sourceDocLine (int) The source document's line number, when the memo was transformed. Internally determined.
sourceDocLineId (Guid) The source document's line identifier, when the memo was transformed. Internally determined.
billingRequestId (Guid) The billing request identifier that originated the memo line, when the memo is transformed. Internally determined.
billingRequestLineId (Guid) The billing request line identifier that originated the memo line, when the memo is transformed. Internally determined.
dimensionSet (string) The dimension set. Infered from the dimension combination in the invoice type.
discountAccount (string) The commercial discount GL account assigned from the account determination in the invoice tye.
dimensionSetJson (string) Dimension Set Json.
printAllDiscounts (string) Discount.
printTaxCodes (string) Print Tax Codes.
reference (string) In this property will be the document number associated with this memo.
sourceOrder (string) The order that origin this line.
sourceOrderId (Guid) The order id that origin this line.
sourceOrderLine (int) The order line index that origin this line.
sourceOrderLineId (Guid) The order line id that origin this line.
sourceOrderSchemaEntityId (Guid) The order schema id that origin this line.
commitmentReference (string) The state supplier commitment reference.


MemoLineTaxResource

The following elements are required:

isExempt (bool) Indicates whether the memo line tax schema is exempt. Internally determined.
taxableAmount (MoneyResource) The memo's line revenue amount subject to tax. This taxable amount is calculated by subtracting the corresponding discounts and allowance charges to the gross value. Internally determined.
See MoneyResource .
taxPercentage (decimal) The memo's line tax rate percentage. Internally determined.
taxAmount (MoneyResource) The memo's line tax amount. Internally determined.
See MoneyResource .
currency (string) The money's unit. Inferred from the memo currency. Internally determined.
taxTypeCode (string) The memo's line tax type code. Internally determined.
roundingTaxableAmount (MoneyResource) Round Taxable Amount.
See MoneyResource .
roundingTaxAmount (MoneyResource) Round Tax Amount.
See MoneyResource .

The following elements are optional:

exemptionReasonCode (string) Indicates the memo line tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.


MemoResource

The following elements are required:

seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
(fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
documentDate (DateTime) The date when the memo is issued.
postingDate (DateTime) The date when the memo is created.
note (string) The memo's note.
buyerCustomerPartyName (string) The customer's name. It is inferred from the customer party.
accountingParty (string) The customer designated in the memo as the party to whom the memo should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
exchangeRate (decimal) The rate that translates the values in the document from the document currency to company base currency. By default the system uses the exchange rates table at the document date.
discount (decimal) The discount's percentage. The default is defined on the customer party.
grossValue (MoneyResource) The total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource .
allowanceChargeAmount (MoneyResource) The total discount over goods and services. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The memo's total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource .
taxTotal (MoneyResource) The total's tax value of goods and services. Internally calculated.
See MoneyResource .
payableAmount (MoneyResource) The memo's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
wTaxTotal (MoneyResource) The total's withholding tax value of goods and services. Internally calculated.
See MoneyResource .
totalLiability (MoneyResource) The document's total liability. The payable amount without withholding taxes. Internally calculated.
See MoneyResource .
memoReason (string) The typified memo's reason. For example price error or missing stock.
(fk) Allowed value: the natural key of a record of type MemoReason. These records are accessibly through the MemoReasons service.
currency (string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
paymentTerm (string) The memo's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
company (string) The memo's company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
fromPicking (bool) Is from transformed from picking. Internal flag.
isExternal (bool) Defines if the memo type series is defined as external. Internally determined.
isManual (bool) Defines if the memo type series is defined as manual. Internally determined.
isWsCommunicable (bool) Indicates if the memo is communicated via web service to fiscal authority. Inferred from the memo type serie.
customerAccount (string) The customer GL account.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
journalNumber (int) The journal number assigned in accounting.
issuesGoodsReturn (bool) True if document issues goods return.
printDate (DateTime) The date when the document was printed.
buyerCustomerParty (string) The customer party. Party that the memo is for.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
isAgregatedDocument (bool) Defines if the invoice has agregated document. Used by saft import.
roundingTaxableAmount (MoneyResource) Rounding.
See MoneyResource .
isSeriesCommunicated (bool) Is Series Communicated.

The following elements are optional:

documentLines (List of MemoLineResource) The memo's lines.
See MemoLineResource.
documentTaxes (List of MemoTaxResource) The memo's taxes.
See MemoTaxResource.
taxIncluded (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the memo series.
buyerCustomerPartyTaxId (string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the customer party.
buyerCustomerPartyAddress (string) The customer's address. It is inferred from the customer party.
accountingPartyName (string) The accounting's party name. It is inferred from the accounting party.
accountingPartyTaxId (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
accountingPartyAddress (string) The accounting's customer address. It is inferred from the accounting party.
exchangeRateDate (DateTime) The exchange rate's creation date.
remarks (string) The memo's remarks.
hash (string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
hashControl (string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
manualNumber (int) The memo's manual serie number. Applicable only when the memo type series is defined as manual.
legalStamp (string) In some countries, the documents issued by a company have to contain mandatory remarks, clearly visible in printing, which may vary according to the document. These texts are printed under the signature terms. Internally determined.
isPrinted (bool) Indicates if the memo has been printed. Internally determined.
manualDate (DateTime) The memo's manual serie number. Applicable only when the memo type series is defined as manual.
manualSerie (string) The memo's manual date. Applicable only when the memo type series is defined as manual.
noteToRecipient (string) The note to the memo's recipient.
economicActivityClassification (string) The memo's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
(fk) Allowed value: the natural key of a record of type EconomicActivityClassification. These records are accessibly through the EconomicActivityClassifications service.
paymentMethod (string) The memo's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
deliveryTerm (string) The memo's delivery term. The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
documentStatus (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus.
altAddress (string) The alternative customer's address key to be used on the memo. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
sourceDoc (string) The source document using the format {..} when the memo is transformed from other source document. Internally determined.
sourceDocId (Guid) The source document's identifier when the memo is transformed from other source document. Internally determined.
sourceSchemaEntity (string) The schema entity from originating document, possible values: Orders, Deliveries, GoodsReturns. Applicable only when there is source doc defined.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
salesChannel (string) The memo's sales channel origin. The default value is defined in the sales setup configuration settings.
(fk) Allowed value: the natural key of a record of type SalesChannel. These records are accessibly through the SalesChannels service.
dueDate (DateTime) Date in which the payment is due. In some countries it is also known as law date.
isManualSerie (bool) Is the series for copy of manual memo(s) (internal).
isOneTimeCustomer (bool) Is the party one-time ony customer (Internal).
fiscalDocumentType (string) The legal fiscal document type defined on the memo type. Inferred from the memo type.
(fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
accountingAltAddress (string) The alternative accounting's party address key to be used on the memo. The alternative addresses keys are defined on the accounting party addresses. When defined overrides the accounting party address values.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
accountingSchema (enum AccountingSchema) The accounting's organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The customer accounting's organization method. The customer organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
notification (string) The memo's notification configuration. Inferred from the memo type.
(fk) Allowed value: the natural key of a record of type Notification.
emailTo (string) The email(s) to send memo notification. Inferred from the notification.
chartOfAccount (string) The chart of accounts. Infered from the financial company setup.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
dimensionSet (string) The dimension set. Infered from the customer.
(fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
journalType (string) The journal type to be used when posting in accounting. Infered from the invoice type.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
fiscalMemoReason (string) The fiscal reason for the memo assigned to the memo reason.
(fk) Allowed value: the natural key of a record of type FiscalMemoReason. These records are accessibly through the FiscalMemoReasons service.
nature (enum AccountingNature) The nature of the memo.
See AccountingNature.
accountingDocument (string) The accounting document that was assigned in accounting.
deliveryMode (string) The delivery mode. (ex: mail).
(fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
dimensionSetJson (string) Dimension Set Json.
customsDeclaration (string) The customs declaration.
salesperson (string) The sales person. The seller of the invoice.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
logisticsPartyId (Guid) The party's unique identifier. It is inferred from the party. Internally setted.
aTQRCode (string) Unique fiscal document bidimensional QR code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
swift (string) The society for Worldwide Interbank Financial Telecommunication number.
iBAN (string) The financial account's International Bank Account Number.
paymentInstruction (string) The Payment authorization given by the party.
originalTaxExclusiveAmount (decimal) [Non persisted] The memo's original total net value. Total value of goods and services after discounts, excluding taxes. Only applicable to external memos import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
originalTaxAmount (decimal) [Non persisted] The memo's original total tax value of goods and services. Only applicable to external memos import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
printedReportName (string) Indicates the report name used to print the document. Internally determined.
isReprinted (bool) Indicates if the document has been reprinted. Internally determined.
isSigned (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.
aTCUD (string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.


MemoTaxResource

The following elements are required:

taxableAmount (MoneyResource) The amount of revenue subject to tax. This taxable amount is calculated by subtracting the corresponding discounts and allowance charges to the gross value. Internally determined.
See MoneyResource .
taxAmount (MoneyResource) The memo's tax amount. Internally determined.
See MoneyResource .
isExempt (bool) Indicates whether the memo tax schema is exempt. Internally determined.
roundingTaxableAmount (MoneyResource) The rounding value of the invoice amount of revenue subject to tax.
See MoneyResource .
roundingTaxAmount (MoneyResource) The rounding value of the invoice tax amount. Internally determined.
See MoneyResource .
totalTaxableAmount (MoneyResource) The total amount of revenue subject to tax.
See MoneyResource .
totalTaxAmount (MoneyResource) The total invoice tax amount. Internally determined.
See MoneyResource .
taxTypeCode (string) The memo's tax type code. Internally determined.
currency (string) The money's unit. Inferred from the memo currency. Internally determined.

The following elements are optional:

taxPercentage (decimal) The memo's tax rate percentage. Internally determined.
exemptionReasonCode (string) Indicates the memo tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.
customExemptionReasonCode (string) Indicates the memo tax schema custom exemption reason. Applicable only if the tax schema is exempt. Internally determined.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



StandardMemosDocumentLinesResource

The following elements are required:

unit (string) The memo's line item sales unit. The default sales unit is defined on the sales item.
unitPrice (MoneyResource) The memo's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource .
salesItem (string) The sales item representing the good or service for memo line.
quantity (decimal) The memo's line item quantity. The default 1.
lineExtensionAmount (MoneyResource) The memo's line payable amount. The line value including taxes and discounts. Internally calculated.
See MoneyResource .
itemTaxSchema (string) The memo's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
description (string) The memo's line item description. The default is defined on the sales item.
itemType (enum ItemType) The memo's line item type. Inferred from the sales item type. Internally determined.
See ItemType.

The following elements are optional:

warehouse (string) The memo's line item warehouse. The default is defined on the materials item.
discount1 (decimal) The line item's discount 1 percentage. The default is 0.
sourceDoc (string) The source document using the format {..} when the memo is transformed from another document. Internally determined.
itemWithholdingTaxSchema (string) The memo's line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the sales item.
reference (string) In this property will be the document number associated with this memo.


StandardMemosResource

The following elements are required:

documentDate (DateTime) The date when the memo is issued.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo type is defined in the sales setup configuration settings.
payableAmount (MoneyResource) The memo's payable amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
paymentTerm (string) The memo's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo type and serie. Part of the document natural key.
memoReason (string) The typified memo's reason. For example price error or missing stock.
company (string) The memo's company. The company code is the central organizational unit within the system.
fromPicking (bool) Is from transformed from picking. Internal flag.
discount (decimal) The discount's percentage. The default is defined on the customer party.
note (string) The memo's note.
isWsCommunicable (bool) Indicates if the memo is communicated via web service to fiscal authority. Inferred from the memo type serie.
buyerCustomerParty (string) The customer party. Party that the memo is for.
isSeriesCommunicated (bool) Is Series Communicated.

The following elements are optional:

paymentMethod (string) The memo's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
documentLines (List of StandardMemosDocumentLinesResource) The memo's lines.
See StandardMemosDocumentLinesResource.
altAddress (string) The alternative customer's address key to be used on the memo. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values.
sourceDoc (string) The source document using the format {..} when the memo is transformed from other source document. Internally determined.
sourceDocId (Guid) The source document's identifier when the memo is transformed from other source document. Internally determined.
fiscalDocumentType (string) The legal fiscal document type defined on the memo type. Inferred from the memo type.
isPrinted (bool) Indicates if the memo has been printed. Internally determined.
nature (enum AccountingNature) The nature of the memo.
See AccountingNature.
dueDate (DateTime) Date in which the payment is due. In some countries it is also known as law date.
isManualSerie (bool) Is the series for copy of manual memo(s) (internal).
printedReportName (string) Indicates the report name used to print the document. Internally determined.
aTCUD (string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
isReprinted (bool) Indicates if the document has been reprinted. Internally determined.
isSigned (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AccountingNature

1 Debit
2 Credit


AccountingSchema

1 Accrual Acrrual Accounting Schema.
2 Cash


DocumentLineStatus

1 Open
2 Completed


DocumentStatus

1 Open
2 Completed
3 Processing


ItemType

1 Item
2 Service