Accounts Receivable | Receipt

Service to manage entities of type 'Receipt'.

Overview

URL	api/{tenantKey}/{orgKey}/accountsReceivable/receipts
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Receipts
  • GET Receipts (paged)
  • GET Receipt by identifier
  • GET Receipt by key
  • GET Print Receipt by identifier
  • GET Print Receipt by key
  • GET Original Print ReceiptOriginal by identifier
  • GET Original Print Receipt by key
• POST:
  • POST Receipts
• PUT:
  • PUT Set IsActive Receipt
  • PUT Set Remarks Receipt
  • PUT Set Note Receipt
  • PUT Set NoteToRecipient Receipt
  • PUT Set AccountingSchema Receipt
  • PUT Set PartyAccountingSchema Receipt
  • PUT Set Notification Receipt
  • PUT Set EmailTo Receipt
  • PUT Set LegalStamp Receipt
  • PUT Set IsWsCommunicable Receipt
  • PUT Set IsSeriesCommunicated Receipt
  • PUT Set SettledOriginalAmount ReceiptLine
  • PUT Set BaseExchangeRate ReceiptLine
  • PUT Set ReportingExchangeRate ReceiptLine
  • PUT Set OriginalExchangeRate ReceiptLine
• DELETE:
  • DELETE Receipt by identifier
  • DELETE Receipt by key

All Resources

This service uses the following resources:

• ApiReceiptReceiptLinesResource
• ApiReceiptReceiptTaxesResource
• ApiReceiptReceiptWTaxesResource
• ApiReceiptReportingLinesResource
• ApiReceiptResource
• ReceiptLineResource
• ReceiptReportingLineResource
• ReceiptResource
• ReceiptTaxResource
• ReceiptWTaxResource

All Enumerations

This service uses the following enumerations:

• AccountingSchema
• FinancialArea
• Nature

GET Operations

GET Receipts

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET Receipts (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 ReceiptResource.

Response status codes:

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

Resource URL:

GET Receipt 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 ReceiptResource.

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 Receipt 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 receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt document type and serie. Part of the document natural key.

Response:

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

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 Receipt by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

GET Print Receipt by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Original Print ReceiptOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

GET Original Print Receipt by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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:

POST Operations

POST Receipts

Creates a new entity record.

The following elements are required:

receiptResource

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

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 ApiReceiptResource.

Response status codes:

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

Resource URL:

PUT Operations

PUT Set AccountingSchema Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt document type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set BaseExchangeRate ReceiptLine

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set EmailTo Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set IsActive Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set IsSeriesCommunicated Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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.

Resource URL:

PUT Set IsWsCommunicable Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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.

Resource URL:

PUT Set LegalStamp Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set Note Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set NoteToRecipient Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set Notification Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set OriginalExchangeRate ReceiptLine

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set PartyAccountingSchema Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt document type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set Remarks Receipt

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set ReportingExchangeRate ReceiptLine

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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 Set SettledOriginalAmount ReceiptLine

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

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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:

DELETE Operations

DELETE Receipt 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 Receipt 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 receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt 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:

Resources

ApiReceiptReceiptLinesResource

The following elements are required:

settledAmount	(decimal) It indicates the amount (in the receipt curreny) that is settled by this receipt. This amount is deducted to the original open amount. One original document document can be partially settled over multiple receipts.
discount	(decimal) It indicates the discount amount (in the receipt curreny) that is settled by this receipt. This discount amount is deducted to the setteled amount. One original document document can be partially settled over multiple receipts.
dueDate	(DateTime) The due date of the original document to be settled. Internally determined.
issueDate	(DateTime) The issue date original document to be settled. Internally determined.
amount	(decimal) It indicates the total amount of the original document in the receipt currency. Internally determined.
openAmount	(decimal) It indicates the current open amount of the original document in the receipt currency. One original document document can be partially settled over multiple receipts. Internally determined.
settled	(bool) Indicates that the current line is selected to include on current receipt.
withholdingTaxAmount	(decimal) It indicates the withholding tax amount (in the receipt curreny) that is settled by this receipt. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount.
openWithholdingTaxAmount	(decimal) It indicates the open withholding tax amount (in the receipt curreny) that is settled by this receipt. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount. Internally determined.
nature	(enum Nature) The original document nature (Debit or Credit). Internally determined. See Nature.
currency	(string) 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 customer party.
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 currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
settledOriginalAmount	(decimal) It indicates the amount (in the original document currency) that is settled by this receipt. This amount is deducted to the original open amount. One original document document can be partially settled over multiple receipts. Internally determined.
baseExchangeRate	(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.
reportingExchangeRate	(decimal) The price of the document's currency expressed in the organization reporting currency. In other words, the rate at which the document's currency can be exchanged for the organization reporting currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
originalExchangeRate	(decimal) The original price of the document's currency expressed in the receipt's currency. In other words, the rate at which the document's original currency can be exchanged for the receipt's currency. Internally infered.

The following elements are optional:

sourceDoc	(string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined.
currencyKey	(string) The key of the money unit used on this receipt. Internaly determined.
sourceDocId	(Guid) The identifier of the original document to be settled. Internally determined.
accountPosting	(string) The accounting posting of the original documents. Internally determined.
financialArea	(enum FinancialArea) The receipt document financial area (Accounts Receivable or Accounts Payable). Internally determined. See FinancialArea.
paymentMethod	(string) 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.
sourceSchemaEntity	(string) The schema of the source document entity. Internally determined.
exchangeRateDate	(DateTime) The exchange rate creation date.

ApiReceiptReceiptTaxesResource

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) The receipt tax amount. Internally determined.
sourceDoc	(string) The original document to be settled. Internally determined.
percentage	(decimal) The receipt tax rate. Internally determined.
openTaxAmount	(decimal) The receipt opened tax amount. Internally determined.
sourceDocId	(Guid) The identifier of the original document to be settled. Internally determined.
openTaxableAmount	(decimal) The receipt opened taxable amount. Internally determined.
sourceSchemaEntityId	(Guid) The unique identifier of the schema entity from the originating document, possible values: Orders, Deliveries, GoodsReturns. Internally determined.
taxSummary	(string) The receipt tax summary. Internally determined.
taxTypeCode	(string) The receipt tax type code. Internally determined.
currency	(string) Money unit. Inferred from the receipt currency. Internally determined.
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 currency. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

isExempt	(bool) Indicates the receipt tax schema is exempt. Internally determined.
taxPosting	(string) The receipt tax posting. Internally determined.
exemptionReasonCode	(string) Indicates the receipt tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.
exchangeRateDate	(DateTime) The exchange rate creation date.

ApiReceiptReceiptWTaxesResource

The following elements are required:

taxableAmount	(decimal) The receipt withholding tax taxable amount. Internally determined.
withholdingTaxAmount	(decimal) The receipt total amount for a withhold tax. Internally calculated.
ignore	(bool) If receipt's value is 0. Withholding tax should be ignored.
sourceDoc	(string) The original document to be settled. Internally determined.
percentage	(decimal) The receipt withholding tax code rate percentage. Internally determined.
openWithholdingTaxAmount	(decimal) The receipt open amount for a withhold tax. Internally calculated.
sourceDocId	(Guid) The identifier of the original document to be settled. Internally determined.
openTaxableAmount	(decimal) The receipt withholding open tax taxable amount. Internally determined.
wTaxSummary	(string) The receipt withholding tax summary. Internally determined.
withholdingTaxCode	(string) The receipt withholding tax code. Internally determined.
currency	(string) Money unit. Inferred from the receipt currency. Internally determined.
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 currency. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

withholdingPosting	(string) The receipt withholding posting. Internally determined.
beneficiaryParty	(string) The receipt beneficiary party. Internally determined.
wTaxPosting	(string) The receipt withholding tax posting. Internally determined.
sourceSchemaEntity	(string) The schema of the source document entity. Internally determined.
exchangeRateDate	(DateTime) The exchange rate creation date.

ApiReceiptReportingLinesResource

The following elements are optional:

sourceDoc	(string) The original document to be settled. Internally determined from the receipt line.
issueDate	(DateTime) The issue date original document to be settled. Internally determined from the receipt line.
dueDate	(DateTime) The due date of the original document to be settled. Internally determined from the receipt line.
currencyKey	(string) The key of the money unit used on this receipt. Internally determined from the receipt line.
amount	(decimal) It indicates the total amount of the original document in the receipt currency. Internally determined from the receipt line.
openAmount	(decimal) It indicates the current open amount of the original document in the receipt currency. Internally determined from the receipt line.
settledAmount	(decimal) It indicates the amount (in the receipt curreny) that is settled by this receipt. Internally determined from the receipt line.
discount	(decimal) It indicates the discount amount (in the receipt curreny) that is settled by this receipt. Internally determined from the receipt line.
withholdingTaxAmount	(decimal) It indicates the withholding tax amount (in the receipt curreny) that is settled by this receipt. Internally determined from the receipt line.
taxableAmount	(decimal) The receipt line 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.
percentage	(decimal) The receipt line tax rate. Internally determined.
taxAmount	(decimal) The receipt line tax amount. Internally determined.
taxTypeCode	(string) The receipt line tax type code. Internally determined.

ApiReceiptResource

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial 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 receipt document type.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt document type and serie. Part of the document natural key.
accountingParty	(string) The customer designated in the receipt as the party to whom the receipt should be sent. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party.
company	(string) The company code is the central organizational unit within the system.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created.
currency	(string) 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 customer party.
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.
checkEndorsed	(bool) 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. The name of that third party (in case the payment method used is check).
allowanceChargeAmount	(decimal) Total discount over goods and services. Internally calculated.
grossValue	(decimal) Total value of goods and services before taxes or discounts. Internally calculated.
payableAmount	(decimal) The receipt amount. Total value of goods and services including taxes and discounts. Internally calculated.
wTaxTotal	(decimal) Total withholding tax value of goods and services. Internally calculated.
taxTotal	(decimal) Total tax value of goods and services. Internally calculated.
taxExclusiveAmount	(decimal) The receipt total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
isWsCommunicable	(bool) Indicates if the receipt is communicated via web service to fiscal authority. Inferred from tax comfiguration.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

receiptLines	(List of ApiReceiptReceiptLinesResource) The receipt lines. See ApiReceiptReceiptLinesResource.
receiptTaxes	(List of ApiReceiptReceiptTaxesResource) The receipt taxes. See ApiReceiptReceiptTaxesResource.
receiptWTaxes	(List of ApiReceiptReceiptWTaxesResource) The receipt withholding taxes. See ApiReceiptReceiptWTaxesResource.
reportingLines	(List of ApiReceiptReportingLinesResource) The receipt reporting taxes lines. See ApiReceiptReportingLinesResource.
remarks	(string) The receipt remarks.
note	(string) The receipt note.
partyAddress	(string) The customer address. It is inferred from the customer party.
noteToRecipient	(string) Note to the receipt recipient.
accountingSchemaLegalStamp	(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.
paymentMethodStamp	(string) Sentence to be printed on the Receipt, regarding the Payment Methods.
financialAccount	(string) A financial account that represents either a cash drawer or a bank account and must be used to define where to credit the value. A bank account is an account that exists in a financial institution. The financial institution holds someone's money, resulting in a positive balance. It can also be a credit or loans account in which the bank lends money, resulting in a negative balance or debit. Unlike a brokerage account, which allows the investor to buy and sell stocks, a bank account is used for savings. The types of bank accounts include savings accounts and current accounts.
cashFlowItem	(string) Incoming and outgoing cash flow caused by the main business activities. The component of the cash flow operations shows how much money is generated by a company's products or services. Generally, the changes made to the cash, banks, accounts receivables and accounts payable affects operational cash. The classification of each of these operations' types is made by using cash flows.
exchangeRateDate	(DateTime) The exchange rate creation date.
checkDate	(DateTime) The date of the check (in case the payment method used is check).
checkBank	(string) The date of the bank that issued the check (in case the payment method used is check).
checkBranch	(string) The branch of the bank that issued the check (in case the payment method used is check).
checkAccount	(string) The branch of the bank that issued the check (in case the payment method used is check).
checkNumber	(string) The number of the check used for the payment (in case the payment method used is check).
issuePlace	(string) The place where the check was issued (in case the payment method is check).
paymentMethod	(string) 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.
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 customer accounting organization method. The customer organication can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
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.
notification	(string) The receipt notification configuration. Inferred from the receipt type.
emailTo	(string) The email(s) to send receipt notification. Inferred from the notification.
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.

ReceiptLineResource

The following elements are required:

settledAmount	(decimal) It indicates the amount (in the receipt curreny) that is settled by this receipt. This amount is deducted to the original open amount. One original document document can be partially settled over multiple receipts.
discount	(decimal) It indicates the discount amount (in the receipt curreny) that is settled by this receipt. This discount amount is deducted to the setteled amount. One original document document can be partially settled over multiple receipts.
dueDate	(DateTime) The due date of the original document to be settled. Internally determined.
issueDate	(DateTime) The issue date original document to be settled. Internally determined.
amount	(decimal) It indicates the total amount of the original document in the receipt currency. Internally determined.
openAmount	(decimal) It indicates the current open amount of the original document in the receipt currency. One original document document can be partially settled over multiple receipts. Internally determined.
settled	(bool) Indicates that the current line is selected to include on current receipt.
withholdingTaxAmount	(decimal) It indicates the withholding tax amount (in the receipt curreny) that is settled by this receipt. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount.
openWithholdingTaxAmount	(decimal) It indicates the open withholding tax amount (in the receipt curreny) that is settled by this receipt. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount. Internally determined.
nature	(enum Nature) The original document nature (Debit or Credit). Internally determined. See Nature.
currency	(string) 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 customer party.
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 currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
settledOriginalAmount	(decimal) It indicates the amount (in the original document currency) that is settled by this receipt. This amount is deducted to the original open amount. One original document document can be partially settled over multiple receipts. Internally determined.
baseExchangeRate	(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.
reportingExchangeRate	(decimal) The price of the document's currency expressed in the organization reporting currency. In other words, the rate at which the document's currency can be exchanged for the organization reporting currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
originalExchangeRate	(decimal) The original price of the document's currency expressed in the receipt's currency. In other words, the rate at which the document's original currency can be exchanged for the receipt's currency. Internally infered.

The following elements are optional:

sourceDoc	(string) The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined.
currencyKey	(string) The key of the money unit used on this receipt. Internaly determined.
sourceDocId	(Guid) The identifier of the original document to be settled. Internally determined.
accountPosting	(string) The accounting posting of the original documents. Internally determined.
financialArea	(enum FinancialArea) The receipt document financial area (Accounts Receivable or Accounts Payable). Internally determined. See FinancialArea.
paymentMethod	(string) 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.
sourceSchemaEntity	(string) The schema of the source document entity. Internally determined.
exchangeRateDate	(DateTime) The exchange rate creation date.

ReceiptReportingLineResource

The following elements are optional:

sourceDoc	(string) The original document to be settled. Internally determined from the receipt line.
issueDate	(DateTime) The issue date original document to be settled. Internally determined from the receipt line.
dueDate	(DateTime) The due date of the original document to be settled. Internally determined from the receipt line.
currencyKey	(string) The key of the money unit used on this receipt. Internally determined from the receipt line.
amount	(decimal) It indicates the total amount of the original document in the receipt currency. Internally determined from the receipt line.
openAmount	(decimal) It indicates the current open amount of the original document in the receipt currency. Internally determined from the receipt line.
settledAmount	(decimal) It indicates the amount (in the receipt curreny) that is settled by this receipt. Internally determined from the receipt line.
discount	(decimal) It indicates the discount amount (in the receipt curreny) that is settled by this receipt. Internally determined from the receipt line.
withholdingTaxAmount	(decimal) It indicates the withholding tax amount (in the receipt curreny) that is settled by this receipt. Internally determined from the receipt line.
taxableAmount	(decimal) The receipt line 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.
percentage	(decimal) The receipt line tax rate. Internally determined.
taxAmount	(decimal) The receipt line tax amount. Internally determined.
taxTypeCode	(string) The receipt line tax type code. Internally determined.

ReceiptResource

The following elements are required:

documentType	(string) Defines the receipt's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default receipt type is defined in the financial setup configuration setting. (fk) Allowed value: the natural key of a record of type ReceiptType. These records are accessibly through the ReceiptTypes service.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the receipt document type. (fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber	(int) Sequential number internally determined that uniquely identifies the document within the receipt document type and serie. Part of the document natural key.
accountingParty	(string) The customer designated in the receipt as the party to whom the receipt should be sent. 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.
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.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created.
currency	(string) 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 customer party. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies 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.
checkEndorsed	(bool) 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. The name of that third party (in case the payment method used is check).
isPaymentMethodCheck	(bool) Indicates if the payment method used is check. Internally determined. Defined at the payment method.
allowanceChargeAmount	(decimal) Total discount over goods and services. Internally calculated.
grossValue	(decimal) Total value of goods and services before taxes or discounts. Internally calculated.
payableAmount	(decimal) The receipt amount. Total value of goods and services including taxes and discounts. Internally calculated.
wTaxTotal	(decimal) Total withholding tax value of goods and services. Internally calculated.
taxTotal	(decimal) Total tax value of goods and services. Internally calculated.
taxExclusiveAmount	(decimal) The receipt total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
isLocked	(bool) Is Locked.
isWsCommunicable	(bool) Indicates if the receipt is communicated via web service to fiscal authority. Inferred from tax comfiguration.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

receiptLines	(List of ReceiptLineResource) The receipt lines. See ReceiptLineResource.
receiptTaxes	(List of ReceiptTaxResource) The receipt taxes. See ReceiptTaxResource.
receiptWTaxes	(List of ReceiptWTaxResource) The receipt withholding taxes. See ReceiptWTaxResource.
reportingLines	(List of ReceiptReportingLineResource) The receipt reporting taxes lines. See ReceiptReportingLineResource.
remarks	(string) The receipt remarks.
note	(string) The receipt note.
partyAddress	(string) The customer address. It is inferred from the customer party.
isPrinted	(bool) Indicates if the receipt has been printed. Internally determined.
noteToRecipient	(string) Note to the receipt recipient.
accountingSchemaLegalStamp	(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.
paymentMethodStamp	(string) Sentence to be printed on the Receipt, regarding the Payment Methods.
financialAccount	(string) A financial account that represents either a cash drawer or a bank account and must be used to define where to credit the value. A bank account is an account that exists in a financial institution. The financial institution holds someone's money, resulting in a positive balance. It can also be a credit or loans account in which the bank lends money, resulting in a negative balance or debit. Unlike a brokerage account, which allows the investor to buy and sell stocks, a bank account is used for savings. The types of bank accounts include savings accounts and current accounts. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
cashFlowItem	(string) Incoming and outgoing cash flow caused by the main business activities. The component of the cash flow operations shows how much money is generated by a company's products or services. Generally, the changes made to the cash, banks, accounts receivables and accounts payable affects operational cash. The classification of each of these operations' types is made by using cash flows. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
exchangeRateDate	(DateTime) The exchange rate creation date.
checkDate	(DateTime) The date of the check (in case the payment method used is check).
checkBank	(string) The date of the bank that issued the check (in case the payment method used is check).
checkBranch	(string) The branch of the bank that issued the check (in case the payment method used is check).
checkAccount	(string) The branch of the bank that issued the check (in case the payment method used is check).
checkNumber	(string) The number of the check used for the payment (in case the payment method used is check).
issuePlace	(string) The place where the check was issued (in case the payment method is check).
paymentMethod	(string) 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.
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 customer accounting organization method. The customer organication can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
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.
notification	(string) The receipt notification configuration. Inferred from the receipt 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 receipt notification. Inferred from the notification.
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.
lockReason	(string) Lock Reason. (fk) Allowed value: the natural key of a record of type EntityLockReason. These records are accessibly through the EntityLockReasons service.
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.
aTCUD	(string) ATCUD.
aTQRCode	(string) QR Code.
printedReportName	(string) Printed Report Name.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
fiscalDocumentType	(string) Fiscal Document Type. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.

ReceiptTaxResource

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) The receipt tax amount. Internally determined.
sourceDoc	(string) The original document to be settled. Internally determined.
percentage	(decimal) The receipt tax rate. Internally determined.
openTaxAmount	(decimal) The receipt opened tax amount. Internally determined.
sourceDocId	(Guid) The identifier of the original document to be settled. Internally determined.
openTaxableAmount	(decimal) The receipt opened taxable amount. Internally determined.
sourceSchemaEntityId	(Guid) The unique identifier of the schema entity from the originating document, possible values: Orders, Deliveries, GoodsReturns. Internally determined.
taxSummary	(string) The receipt tax summary. Internally determined.
taxTypeCode	(string) The receipt tax type code. Internally determined.
currency	(string) Money unit. Inferred from the receipt currency. Internally determined.
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 currency. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

isExempt	(bool) Indicates the receipt tax schema is exempt. Internally determined.
taxPosting	(string) The receipt tax posting. Internally determined.
exemptionReasonCode	(string) Indicates the receipt tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.
exchangeRateDate	(DateTime) The exchange rate creation date.

ReceiptWTaxResource

The following elements are required:

taxableAmount	(decimal) The receipt withholding tax taxable amount. Internally determined.
withholdingTaxAmount	(decimal) The receipt total amount for a withhold tax. Internally calculated.
ignore	(bool) If receipt's value is 0. Withholding tax should be ignored.
sourceDoc	(string) The original document to be settled. Internally determined.
percentage	(decimal) The receipt withholding tax code rate percentage. Internally determined.
openWithholdingTaxAmount	(decimal) The receipt open amount for a withhold tax. Internally calculated.
sourceDocId	(Guid) The identifier of the original document to be settled. Internally determined.
openTaxableAmount	(decimal) The receipt withholding open tax taxable amount. Internally determined.
wTaxSummary	(string) The receipt withholding tax summary. Internally determined.
withholdingTaxCode	(string) The receipt withholding tax code. Internally determined.
currency	(string) Money unit. Inferred from the receipt currency. Internally determined.
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 currency. The default is inferred using the defined exchange rates on the system for the document date and currency.

The following elements are optional:

withholdingPosting	(string) The receipt withholding posting. Internally determined.
beneficiaryParty	(string) The receipt beneficiary party. Internally determined.
wTaxPosting	(string) The receipt withholding tax posting. Internally determined.
sourceSchemaEntity	(string) The schema of the source document entity. Internally determined.
exchangeRateDate	(DateTime) The exchange rate creation date.

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash

FinancialArea

1	AccountsReceivable
2	AccountsPayable

Nature

1	Debit
2	Credit