Jasmin Developers - Web API Reference

Purchases | Credit or Debit Note

Service to manage entities of type 'Memo'.

Overview


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

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

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

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

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

POST Credit or Debit Note

Inserts a new 'Memo Line' in the 'Credit or Debit Note'.

The following elements are required:

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

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.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /invoiceReceipt/memos/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines

POST Credit or Debit Note

Inserts a new 'Memo Tax' in the 'Credit or Debit Note'.

The following elements are required:

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

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.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /invoiceReceipt/memos/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes

POST Credit or Debit Note

Inserts a new 'Memo WTax' in the 'Credit or Debit Note'.

The following elements are required:

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

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.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /invoiceReceipt/memos/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes

PUT Operations

PUT Set AccountingAltAddress Memo

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

The following elements are required:

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

PUT Set AccountingPartyAddress Memo

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

The following elements are required:

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

PUT Set AltAddress Memo

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

The following elements are required:

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

PUT Set CommitmentReference MemoLine

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

The following elements are required:

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

PUT Set ComplementaryDescription MemoLine

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

The following elements are required:

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

PUT Set DeliveryTerm Memo

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

The following elements are required:

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

PUT Set Description MemoLine

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

The following elements are required:

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

PUT Set Discount Memo

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

The following elements are required:

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

PUT Set Discount1 MemoLine

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

The following elements are required:

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

PUT Set Discount2 MemoLine

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

The following elements are required:

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

PUT Set Discount3 MemoLine

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

The following elements are required:

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

PUT Set DueDate Memo

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

The following elements are required:

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

PUT Set IsActive Memo

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

The following elements are required:

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

PUT Set ItemTaxSchema MemoLine

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

The following elements are required:

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

PUT Set ItemWithholdingTaxSchema MemoLine

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

The following elements are required:

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

PUT Set MemoReason Memo

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

The following elements are required:

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

PUT Set Note Memo

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

The following elements are required:

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

PUT Set NoteToRecipient Memo

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

The following elements are required:

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

PUT Set PaymentMethod Memo

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

The following elements are required:

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

PUT Set PaymentTerm Memo

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

The following elements are required:

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

PUT Set PostingDate Memo

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

The following elements are required:

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

PUT Set Quantity MemoLine

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

The following elements are required:

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

PUT Set Remarks Memo

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

The following elements are required:

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

PUT Set RoundingTaxableAmount MemoTax

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

The following elements are required:

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

PUT Set RoundingTaxAmount MemoTax

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

The following elements are required:

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

PUT Set Unit MemoLine

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

The following elements are required:

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

PUT Set UnitPrice MemoLine

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

The following elements are required:

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

PUT Set Warehouse MemoLine

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

The following elements are required:

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

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

DELETE Operations

DELETE Memo Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /invoiceReceipt/memos/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}

DELETE Memo Tax by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /invoiceReceipt/memos/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}

DELETE Memo WTax by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /invoiceReceipt/memos/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes/{lineId}

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

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

Resources


ApiMemoDocumentLinesResource

The following elements are required:

description (string) The memo line item description. The default is defined on the purchases item.
quantity (decimal) The memo line item quantity. The default 1.
unitPrice (decimal) The memo line item unit price. The default price is loaded from purchases item prices when there is a match on the combination of price list, currency, tax included and unit.
unit (string) The memo line item purchases unit. The default purchases unit is defined on the purchases item.
itemTaxSchema (string) The memo 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 purchases item.
purchasesItem (string) The purchase item representing the good or service to be invoiced.

The following elements are optional:

discount1 (decimal) The memo line item discount 1 percetange. The default is 0.
discount2 (decimal) The memo line item discount 2 percentage. The default is 0. This discount is applied over the remaining value after discount 1 is applied.
discount3 (decimal) The memo line item discount 3 percentage. The default is 0. This discount is applied over the remaining value after discount 1 and 2 are applied.
complementaryDescription (string) The memo line item complementary description. The default is defined on the sales item.
warehouse (string) The memo line item warehouse. The default is defined on the materials item.
itemWithholdingTaxSchema (string) The memo 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 purchases item.
commitmentReference (string) Commitment Reference.


ApiMemoDocumentTaxesResource

The following elements are required:

roundingTaxableAmount (decimal) The memo rounding amount of revenue subject to tax. Internally determined.
roundingTaxAmount (decimal) The memo rounding tax amount. Internally determined.


ApiMemoDocumentWTaxesResource



ApiMemoResource

The following elements are required:

company (string) The company code is the central organizational unit within the system.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo document type is defined in the purchases setup configuration setting.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the memo document type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo document type and serie. Part of the document natural key.
accountingParty (string) The supplier designated in the invoice as the party to whom the invoice should be sent. It may or may not be the party from whom the goods or services are received. The default is defined on the supplier party.
sellerSupplierParty (string) The supplier designated in the invoice as the party to whom the memo is issued. It may or may not be the party from whom the goods or services are received. The default is defined on the supplier party.
paymentTerm (string) The 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 supplier party.
currency (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). 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 supplier party.
memoReason (string) The reason why the memo was created.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
postingDate (DateTime) The date when the document is created.
discount (decimal) The discount percentage. The default is defined on the supplier party.
documentDate (DateTime) The date when the document is issued.

The following elements are optional:

accountingPartyTaxId (string) The accounting party tax code. It is inferred from the accounting party.
accountingPartyName (string) The accounting party name. It is inferred from the accounting party.
accountingPartyAddress (string) The accounting party address. It is inferred from the accounting party.
sellerSupplierPartyTaxId (string) The seller supplier party tax code. It is inferred from the seller supplier party.
sellerSupplierPartyName (string) The seller supplier party name. It is inferred from the seller supplier party.
sellerSupplierPartyAddress (string) The seller supplier party address. It is inferred from the seller supplier party.
deliveryTerm (string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the supplier party.
paymentMethod (string) The 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 supplier party.
documentLines (List of ApiMemoDocumentLinesResource) The memo lines.
See ApiMemoDocumentLinesResource.
documentTaxes (List of ApiMemoDocumentTaxesResource) The memo taxes.
See ApiMemoDocumentTaxesResource.
note (string) The memo note.
exchangeRateDate (DateTime) The exchange rate creation date.
remarks (string) The memo remarks.
noteToRecipient (string) The note to the memo's recipient.
dueDate (DateTime) The date in which the memo is due. In some countries it is also known as law date.
altAddress (string) The alternative party address key to be used on the memo. The alternative addresses keys are defined on the party additional addresses. When defined overrides the party address and unloading address values.
accountingAltAddress (string) The alternative accounting party address key to be used on the memo. The alternative addresses keys are defined on the party additional addresses. When defined overrides the accounting party address and unloading address values.


MemoLineResource

The following elements are required:

description (string) The memo line item description. The default is defined on the purchases item.
quantity (decimal) The memo line item quantity. The default 1.
unitPrice (decimal) The memo line item unit price. The default price is loaded from purchases item prices when there is a match on the combination of price list, currency, tax included and unit.
taxTotal (decimal) The total amount of taxes for this line. Internally calculated.
allowanceChargeAmount (decimal) The total amount of taxes for this line. Internally calculated.
taxExclusiveAmount (decimal) The memo line net value. The line value after discounts, excluding taxes. Internally calculated.
lineExtensionAmount (decimal) The memo line payable amount. The line value including taxes and discounts. Internally calculated.
conversionFactor (decimal) The line convertion factor.
unitCost (decimal) The item current unit cost. Used only on inventory items, this value is infered from the material item depending on the warehouse used on this line.
grossValue (decimal) The memo line value before taxes or discounts. Internally calculated.
unit (string) The memo line item purchases unit. The default purchases unit is defined on the purchases item.
itemTaxSchema (string) The memo 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 purchases item.
partyTaxSchema (string) The memo supplier party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the supplier party.
currency (string) The money's unit. Inferred from the memo currency. Internally determined.
purchasesItem (string) The purchase item representing the good or service to be invoiced.
documentLineStatus (enum DocumentLineStatus) The document line status. The default is Open.
See DocumentLineStatus.
itemType (enum ItemType) The memo line item type. Inferred from the puchase item type. Internally determined.
See ItemType.

The following elements are optional:

deliveryDate (DateTime) The expected line item delivery date. The default is the document date.
inventoryAmount (decimal) The value of stock represented by this line. Used only on inventory items, this value is internally calculated using the Unit Cost and quantity.
discount1 (decimal) The memo line item discount 1 percetange. The default is 0.
discount2 (decimal) The memo line item discount 2 percentage. The default is 0. This discount is applied over the remaining value after discount 1 is applied.
discount3 (decimal) The memo line item discount 3 percentage. The default is 0. This discount is applied over the remaining value after discount 1 and 2 are applied.
returnQuantity (decimal) The memo line item return quantity.
complementaryDescription (string) The memo line item complementary description. The default is defined on the sales item.
warehouse (string) The memo line item warehouse. The default is defined on the materials item.
baseUnit (string) The memo line item base unit. The default unit is defined on the item.
partyWithholdingTaxSchema (string) The memo supplier 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 supplier party.
itemWithholdingTaxSchema (string) The memo 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 purchases item.
sourceSchemaEntity (string) The schema entity from originating document, possible values: Quotations, Orders, Deliveries, Invoices, GoodsReturns, Memos.
sourceDoc (string) Source document using the format {..} when the memo was transformed. The source document is usually the invoice. Internally determined.
sourceDocId (Guid) The unique identifier of the source document, when the memo was transformed. The source document is usually the invoice. Internally determined.
sourceDocLine (int) The source document line number, when the memo was transformed. Internally determined.
sourceDocLineId (Guid) The source document line id, when the memo was transformed. Internally determined.
delivery (string) The delivery that originated the memo line, when the memo is transformed. Internally determined.
deliveryId (Guid) The delivery unique identifier that originated the memo line, when the memo is transformed. Internally determined.
deliveryLine (int) The delivery line number that originated the memo line, when the memo is transformed. Internally determined.
deliveryLineId (Guid) The delivery line unique identifier that originated the memo line, when the memo is transformed. Internally determined.
invoiceReceiptNotificationId (Guid) The invoice receipt notification unique identifier that originated the memo line, when the memo is transformed. Internally determined.
invoiceReceiptNotificationLineId (Guid) The invoice receipt notification line uniqye identifier that originated the memo line, when the memo is transformed. Internally determined.
transactionAccount (string) The memo line item transaction account. Inferred from the sales item income account. Internally determined.
printTaxCodes (string) Print Tax Codes.
printAllDiscounts (string) Discount.
commitmentReference (string) Commitment Reference.


MemoResource

The following elements are required:

company (string) 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.
documentType (string) Defines the memo's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default memo document type is defined in the purchases setup configuration setting.
(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 document type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the memo document type and serie. Part of the document natural key.
accountingParty (string) The supplier designated in the invoice as the party to whom the invoice should be sent. It may or may not be the party from whom the goods or services are received. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
sellerSupplierParty (string) The supplier designated in the invoice as the party to whom the memo is issued. It may or may not be the party from whom the goods or services are received. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type SupplierParty. These records are accessibly through the SupplierParties service.
paymentTerm (string) The 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 supplier party.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
currency (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). 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 supplier party.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
memoReason (string) The reason why the memo was created.
(fk) Allowed value: the natural key of a record of type MemoReason. These records are accessibly through the MemoReasons service.
exchangeRate (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
postingDate (DateTime) The date when the document is created.
grossValue (decimal) The total value of goods and services before taxes or discounts. Internally calculated.
discount (decimal) The discount percentage. The default is defined on the supplier party.
allowanceChargeAmount (decimal) The total discount over goods and services. Internally calculated.
taxExclusiveAmount (decimal) The memo total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
taxTotal (decimal) The total tax value of goods and services. Internally calculated.
payableAmount (decimal) The memo amount. Total value of goods and services including taxes and discounts. Internally calculated.
wTaxTotal (decimal) The total withholding tax value of goods and services. Internally calculated.
totalLiability (decimal) The document total liability. Internally calculated.
documentStatus (enum DocumentStatus) The document status. Internally determined.
See DocumentStatus.
documentDate (DateTime) The date when the document is issued.
fromPicking (bool) Indicates if the memo was result of a picking process. Internally determined.
discountInValueAmount (decimal) Discount In Value.
isLocked (bool) Is Locked.

The following elements are optional:

accountingPartyTaxId (string) The accounting party tax code. It is inferred from the accounting party.
accountingPartyName (string) The accounting party name. It is inferred from the accounting party.
accountingPartyAddress (string) The accounting party address. It is inferred from the accounting party.
sellerSupplierPartyTaxId (string) The seller supplier party tax code. It is inferred from the seller supplier party.
sellerSupplierPartyName (string) The seller supplier party name. It is inferred from the seller supplier party.
sellerSupplierPartyAddress (string) The seller supplier party address. It is inferred from the seller supplier party.
deliveryTerm (string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
paymentMethod (string) The 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 supplier party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
documentLines (List of MemoLineResource) The memo lines.
See MemoLineResource.
documentTaxes (List of MemoTaxResource) The memo taxes.
See MemoTaxResource.
note (string) The memo note.
exchangeRateDate (DateTime) The exchange rate creation date.
remarks (string) The memo remarks.
isPrinted (bool) Indicates if the memo has been printed. Internally determined.
taxIncluded (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the invoice series.
noteToRecipient (string) The note to the memo's recipient.
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.
nature (enum Nature) The original document nature (Debit or Credit). Internally determined.
See Nature.
sourceSchemaEntity (string) The schema of the source document entity. Internally determined.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
sourceDoc (string) Source document using the format {..} when the memo was result of transformation. The source document is usually an invoice. Internally determined.
sourceDocId (Guid) The source document id, when the memo was result of a trasnformation. The source document is usually an invoice. Internally determined.
dueDate (DateTime) The date in which the memo is due. In some countries it is also known as law date.
altAddress (string) The alternative party address key to be used on the memo. The alternative addresses keys are defined on the party additional addresses. When defined overrides the 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.
accountingAltAddress (string) The alternative accounting party address key to be used on the memo. The alternative addresses keys are defined on the party additional addresses. When defined overrides the accounting 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.
accountingSchema (enum AccountingSchema) The accounting organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The supplier accounting organization method. The supplier organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema.
notification (string) The memo's notification configuration. Inferred from the invoice 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 the memo notification. Inferred from the notification.
lockReason (string) Lock Reason.
(fk) Allowed value: the natural key of a record of type EntityLockReason. These records are accessibly through the EntityLockReasons service.
printedReportName (string) Printed Report Name.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.


MemoTaxResource

The following elements are required:

taxableAmount (decimal) 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.
taxAmount (decimal) Memo tax amount. Internally determined.
isExempt (bool) Indicates whether the memo tax schema is exempt. Internally determined.
currency (string) The money's unit. Inferred from the memo currency. Internally determined.
taxTypeCode (string) Memo tax type code. Internally determined.
roundingTaxableAmount (decimal) The memo rounding amount of revenue subject to tax. Internally determined.
roundingTaxAmount (decimal) The memo rounding tax amount. Internally determined.
totalTaxableAmount (decimal) The memo total amount of revenue subject to tax. Internally determined.
totalTaxAmount (decimal) The memo total tax amount. Internally determined.

The following elements are optional:

taxPercentage (decimal) Memo tax rate percentage. Internally determined.
exemptionReasonCode (string) Indicates the memo tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.


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