Sales | Credit or Debit Note

Service to manage entities of type 'Memo'.

Overview

URL	api/{tenantKey}/{orgKey}/billing/memos
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Memos (odata)
  • GET Memo by identifier
  • GET Memo by key
  • GET Print Memo by identifier
  • GET Print Memo by identifier (asynchronously)
  • GET Print Memo by key
  • GET Print Memo by key (asynchronously)
  • GET Original Print Memo by identifier
  • GET Original Print Memo by identifier (asynchronously)
  • GET Original Print Memo by key
  • GET Original Print Memo by key (asynchronously)
• POST:
  • POST Memos
  • POST Communicate To Tax Authority
  • POST Generate Cius
• PUT:
  • PUT Set Custom Attribute Memo
  • PUT Set Custom Attribute MemoLine
  • PUT Set IsActive Memo
  • PUT Set Note Memo
  • PUT Set Remarks Memo
  • PUT Set NoteToRecipient Memo
  • PUT Set DueDate Memo
  • PUT Set Notification Memo
  • PUT Set EmailTo Memo
  • PUT Set CashInvoice Memo
  • PUT Set FinancialAccount Memo
  • PUT Set IsSeriesCommunicated Memo
  • PUT Set CustomerOrderId Memo
  • PUT Set CommitmentReference Memo
  • PUT Set ComplementaryDescription MemoLine
  • PUT Set DocumentLineStatus MemoLine
  • PUT Set CommitmentReference MemoLine
  • PUT Set CustomerOrderId MemoLine
  • PUT Set CustomerOrderLine MemoLine
• DELETE:
  • DELETE Memo by identifier
  • DELETE Memo by key

All Resources

This service uses the following resources:

• ApiMemoDocumentLinesResource
• ApiMemoDocumentTaxesResource
• ApiMemoPaymentMethodsResource
• ApiMemoResource
• MemoResource
• MoneyResource
• StandardMemosDocumentLinesResource
• StandardMemosResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AccountingSchema
• DocumentLineStatus
• DocumentStatus
• ItemType
• Nature

GET Operations

GET Memos (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

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 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 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 record does not exist.

Resource URL:

GET Print Memo by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

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 Print Memo by key (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Original 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 record does not exist.

Resource URL:

GET Original Print Memo by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

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 Original Print Memo by key (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

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 Communicate To Tax Authority

Custom operation 'CommunicateToTaxAuthority'.

The following elements are required:

memoId

(Guid) MemoId.

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 a string.

Resource URL:

POST Generate Cius

Generate CIUS-PT document file.

The following elements are required:

memoId

(Guid) The Memo 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:

PUT Operations

PUT Set CashInvoice Memo

Updates the value of attribute 'CashInvoice' 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 Set CommitmentReference Memo

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.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set 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 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 Set CustomerOrderId Memo

Updates the value of attribute 'CustomerOrderId' 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 Set CustomerOrderId MemoLine

Updates the value of attribute 'CustomerOrderId' 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 Set CustomerOrderLine MemoLine

Updates the value of attribute 'CustomerOrderLine' 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 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 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 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 Set FinancialAccount Memo

Updates the value of attribute 'FinancialAccount' 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 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 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 Set Note Memo

Updates the value of attribute 'Note' 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 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 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 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 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 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:

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 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:

Resources

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.
salesItem	(string) The sales item representing the good or service for memo line.

The following elements are optional:

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.
sourceSchemaEntity	(string) The shema entity from originating document, possible values: Quotations.Sales, Orders.Sales, Deliveries.Shipping, Invoices.Billing, GoodsReturns.GoodsReceipt, Memos.Billing. If this field is not set, document integration validations will not be performed and SourceDoc field will be assumed as an external document.
sourceDoc	(string) The source document using the format {..} when the memo is transformed from another document.
sourceDocId	(Guid) The source document identifier when the memo is transformed from other source document.
sourceDocLine	(int) The source document's line number, when the memo was transformed.
sourceDocLineId	(Guid) The source document's line identifier, when the memo was transformed.
commitmentReference	(string) Commitment Ref.
customerOrderId	(string) Customer Order.
customerOrderLine	(string) Line.

ApiMemoDocumentTaxesResource

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.

ApiMemoPaymentMethodsResource

The following elements are required:

paymentMethod	(string) The payment method.
amount	(MoneyResource) The amount paid via the indicated payment method. See MoneyResource .
isMain	(bool) Indicates the main payment method. When a payment method is marked as 'main', it will overwrite the payment method in the document header and the paid amount of it will be calculated automatically.

The following elements are optional:

financialAccount

(string) The financial account.

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.
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.
memoReasonCustomDescription	(string) Reason Description.
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.
buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services).
issuesGoodsReturn	(bool) Indicates if the memo issues a goods return (used only for credit memos).
discountInValueAmount	(MoneyResource) Discount In Value. See MoneyResource .
cashInvoice	(bool) Cash Invoice.
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.
note	(string) The memo's note.
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.
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.
salesperson	(string) The sales person associated to the memo. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. 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 or the document's type series settings.
dueDate	(DateTime) Date in which the payment is due. In some countries it is also known as law date.
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.
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.
financialAccount	(string) Financial Account.
cashFlowItem	(string) Cash Flow Item.
checkDate	(DateTime) The payment's check date. Applicable only when the memo is cash invoice and the payment method is of type check.
checkBank	(string) The payment's check bank. Applicable only when the invoice is cash memo and the payment method is of type check.
checkBranch	(string) The payment's check bank branch. Applicable only when the memo is cash invoice and the payment method is of type check.
checkAccount	(string) The payment's check bank account. Applicable only when the memo is cash invoice and the payment method is of type check.
checkEndorsed	(bool) Defines if the payment check endsorded. Applicable only when the memo is cash invoice and the payment method is of type check. In some countries, the beneficiary can endorse the check, which allows him or her to specify a third party to whom it should be paid.
checkNumber	(string) The payment's check number. Applicable only when the memo is cash invoice and the payment method is of type check.
issuePlace	(string) The payment's check issue place. Applicable only when the memo is cash invoice and the payment method is of type check.
checkPayment	(bool) Determines if the used payment method is of type check. Applicable only when the memo is cash invoice and the payment method is of type check. Internally determined.
store	(string) The memo's store origin. The default value is defined in the document's type series settings.
deviceToken	(string) The device token. Required for integrations with devices, is used on device validations at document creation (otherwise it shoud not be set).
paymentMethods	(List of ApiMemoPaymentMethodsResource) The memo's payment methods. For cash invoice documents, it is possible to define more than one payment method. The payment method identified as 'main' (or the first one if there is no one identified as 'main') will override the payment method in the document header. See ApiMemoPaymentMethodsResource.
customerOrderId	(string) Customer Order.
commitmentReference	(string) Commitment Reference.

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.
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.
memoReasonCustomDescription	(string) Reason Description.
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.
buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services). (fk) Allowed value: the natural key of a record of type CustomerParty. These records are accessibly through the CustomerParties 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.
issuesGoodsReturn	(bool) Indicates if the memo issues a goods return (used only for credit memos).
discountInValueAmount	(MoneyResource) Discount In Value. See MoneyResource .
isLocked	(bool) Is Locked.
isCommunicated	(bool) Is Communicated.
cashInvoice	(bool) Cash Invoice.
isSeriesCommunicated	(bool) Is Series Communicated.
ignoreAssociatedSalesItems	(bool) Ignore Associated Sales Items.

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.
note	(string) The memo's note.
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.
salesperson	(string) The sales person associated to the memo. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type Salesperson. These records are accessibly through the Salespersons 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.
salesChannel	(string) The memo's sales channel origin. The default value is defined in the sales setup configuration or the document's type series 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.
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.
nature	(enum Nature) The memo's nature: credit or debit. Inferred from the memo type. See Nature.
isManualSerie	(bool) Is Manual Serie.
isOneTimeCustomer	(bool) Is One Time Customer.
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. These records are accessibly through the Notifications service.
emailTo	(string) The email(s) to send memo notification. Inferred from the notification.
printAllDiscounts	(string) Discount.
lockReason	(string) Lock Reason. (fk) Allowed value: the natural key of a record of type EntityLockReason. These records are accessibly through the EntityLockReasons service.
financialAccount	(string) Financial Account. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
cashFlowItem	(string) Cash Flow Item. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
checkDate	(DateTime) The payment's check date. Applicable only when the memo is cash invoice and the payment method is of type check.
checkBank	(string) The payment's check bank. Applicable only when the invoice is cash memo and the payment method is of type check.
checkBranch	(string) The payment's check bank branch. Applicable only when the memo is cash invoice and the payment method is of type check.
checkAccount	(string) The payment's check bank account. Applicable only when the memo is cash invoice and the payment method is of type check.
checkEndorsed	(bool) Defines if the payment check endsorded. Applicable only when the memo is cash invoice and the payment method is of type check. In some countries, the beneficiary can endorse the check, which allows him or her to specify a third party to whom it should be paid.
checkNumber	(string) The payment's check number. Applicable only when the memo is cash invoice and the payment method is of type check.
issuePlace	(string) The payment's check issue place. Applicable only when the memo is cash invoice and the payment method is of type check.
checkPayment	(bool) Determines if the used payment method is of type check. Applicable only when the memo is cash invoice and the payment method is of type check. Internally determined.
isCheckPayment	(bool) Is Check Payment.
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.
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.
store	(string) The memo's store origin. The default value is defined in the document's type series settings. (fk) Allowed value: the natural key of a record of type Store. These records are accessibly through the Stores service.
deviceToken	(string) The device token. Required for integrations with devices, is used on device validations at document creation (otherwise it shoud not be set).
isExclusiveForPOSDevice	(bool) Defines if the invoice type series is defined as ExclusiveForPOSDevice. Internally determined.
isCustomReasonAllowed	(bool) Is Custom Reason Allowed.
paymentMethods	(List of MemoPaymentMethodLineResource) The memo's payment methods. For cash invoice documents, it is possible to define more than one payment method. The payment method identified as 'main' (or the first one if there is no one identified as 'main') will override the payment method in the document header. See MemoPaymentMethodLineResource.
printAllPaymentMethods	(string) Payment Methods.
printedReportName	(string) Printed Report Name.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
partyHasWithholding	(bool) Party Has Withholding.
customerOrderId	(string) Customer Order.
commitmentReference	(string) Commitment Reference.

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.
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.
commitmentReference	(string) Commitment Ref.

StandardMemosResource

The following elements are required:

buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services).
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.
isWsCommunicable	(bool) Indicates if the memo is communicated via web service to fiscal authority. Inferred from the memo type serie.
issuesGoodsReturn	(bool) Indicates if the memo issues a goods return (used only for credit memos).
discountInValueAmount	(MoneyResource) Discount In Value. See MoneyResource .
isLocked	(bool) Is Locked.
isCommunicated	(bool) Is Communicated.
cashInvoice	(bool) Cash Invoice.
memoReasonCustomDescription	(string) Reason Description.
isSeriesCommunicated	(bool) Is Series Communicated.
allowanceChargeAmount	(MoneyResource) The total discount over goods and services. Internally calculated. See MoneyResource .
grossValue	(MoneyResource) The total value of goods and services before taxes or discounts. 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 .
totalLiability	(MoneyResource) The document's total liability. The payable amount without withholding taxes. Internally calculated. See MoneyResource .
wTaxTotal	(MoneyResource) The total's withholding tax value of goods and services. Internally calculated. See MoneyResource .

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.
fiscalDocumentType	(string) The legal fiscal document type defined on the memo type. Inferred from the memo type.
note	(string) The memo's note.
isPrinted	(bool) Indicates if the memo has been printed. Internally determined.
nature	(enum Nature) The memo's nature: credit or debit. Inferred from the memo type. See Nature.
lockReason	(string) Lock Reason.
isManualSerie	(bool) Is Manual Serie.
cashFlowItem	(string) Cash Flow Item.
checkDate	(DateTime) The payment's check date. Applicable only when the memo is cash invoice and the payment method is of type check.
checkNumber	(string) The payment's check number. Applicable only when the memo is cash invoice and the payment method is of type check.
financialAccount	(string) Financial Account.
isCheckPayment	(bool) Is Check Payment.
isExclusiveForPOSDevice	(bool) Defines if the invoice type series is defined as ExclusiveForPOSDevice. Internally determined.
isCustomReasonAllowed	(bool) Is Custom Reason Allowed.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
printedReportName	(string) Printed Report Name.
noteToRecipient	(string) The note to the memo's recipient.
partyHasWithholding	(bool) Party Has Withholding.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed

ItemType

1	Item
2	Service
3	SpecialSalesTaxes
4	Tax
5	Other

Nature

1	Debit
2	Credit