ROSE Developers - Web API Reference

Accounts Receivable | Receipt

The Receipts represents end point is used to record the settlement of the memos and invoices from your company.

Overview


URL api/{tenantKey}/{orgKey}/accountsReceivable/receipts
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 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 /accountsReceivable/receipts

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 /accountsReceivable/receipts?page={page}&pageSize={pageSize}

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 /accountsReceivable/receipts/{id}

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}

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 /accountsReceivable/receipts/{id}/print?template={template}

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/print

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 /accountsReceivable/receipts/{id}/printOriginal?template={template}

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:

GET /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal

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.

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

Response status codes:

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

Resource URL:

POST /accountsReceivable/receipts

PUT Operations

PUT Set Account Receipt

Updates the value of attribute 'Account' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/account

PUT Set AccountingPartyTaxId Receipt

Updates the value of attribute 'AccountingPartyTaxId' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyTaxId

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

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptLines/{lineId}/baseExchangeRate

PUT Set BeneficiaryParty ReceiptWTax

Updates the value of attribute 'BeneficiaryParty' 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 (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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptWTaxes/{lineId}/beneficiaryParty

PUT Set CashFlowItem Receipt

Updates the value of attribute 'CashFlowItem' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/cashFlowItem

PUT Set DimensionSet Receipt

Updates the value of attribute 'DimensionSet' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSet

PUT Set DimensionSetJson Receipt

Updates the value of attribute 'DimensionSetJson' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSetJson

PUT Set DimensionSetJson ReceiptLine

Updates the value of attribute 'DimensionSetJson' 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 (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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptLines/{lineId}/dimensionSetJson

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/emailTo

PUT Set FinancialAccount Receipt

Updates the value of attribute 'FinancialAccount' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/financialAccount

PUT Set HashControl Receipt

Updates the value of attribute 'HashControl' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/hashControl

PUT Set IBAN Receipt

Updates the value of attribute 'IBAN' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/iBAN

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive

PUT Set IsPrinted Receipt

Updates the value of attribute 'IsPrinted' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/isPrinted

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/isSeriesCommunicated

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/legalStamp

PUT Set Nature ReceiptLine

Updates the value of attribute 'Nature' 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 (enum AccountingNature) The request body should contain the new value for the attribute.
See AccountingNature.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptLines/{lineId}/nature

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/note

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/notification

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptLines/{lineId}/originalExchangeRate

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

PUT Set PaymentInstruction Receipt

Updates the value of attribute 'PaymentInstruction' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentInstruction

PUT Set PaymentMethod Receipt

Updates the value of attribute 'PaymentMethod' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentMethod

PUT Set PaymentReference Receipt

Updates the value of attribute 'PaymentReference' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentReference

PUT Set PrintedReportName Receipt

Updates the value of attribute 'PrintedReportName' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks

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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptLines/{lineId}/reportingExchangeRate

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:

PUT /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptLines/{lineId}/settledOriginalAmount

PUT Set Swift Receipt

Updates the value of attribute 'Swift' 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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/swift

PUT Set WithholdingTaxAmount Receipt

Updates the value of attribute 'WithholdingTaxAmount' 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 (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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/withholdingTaxAmount

PUT Set Custom Attribute Receipt

Updates the value of 'CustomAttribute' in 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.
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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/{customAttributeName}

PUT Set Custom Attribute ReceiptLine

Updates the value of 'CustomAttribute' in 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.
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 /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}/receiptLines/{lineId}/{customAttributeName}

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 /accountsReceivable/receipts/{id}

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:

DELETE /accountsReceivable/receipts/{companyKey}/{documentType}/{serie}/{seriesNumber}

Resources


ApiReceiptReceiptLinesResource

The following elements are required:

settledAmount (MoneyResource) 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.
See MoneyResource .
discount (MoneyResource) 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.
See MoneyResource .
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 (MoneyResource) It indicates the total amount of the original document in the receipt currency. Internally determined.
See MoneyResource .
openAmount (MoneyResource) 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.
See MoneyResource .
settled (bool) Indicates that the current line is selected to include on current receipt.
withholdingTaxAmount (MoneyResource) 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.
See MoneyResource .
openWithholdingTaxAmount (MoneyResource) 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.
See MoneyResource .
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.
nature (enum AccountingNature) The nature of the settled document.
See AccountingNature.
dimensionSetJson (string) Dimension Set Json.


ApiReceiptReceiptTaxesResource

The following elements are required:

taxableAmount (MoneyResource) The amount of revenue subject to tax. This taxable amount is calculated by subtracting the corresponding discounts and allowance charges to the gross value. Internally determined.
See MoneyResource .
taxAmount (MoneyResource) The receipt tax amount. Internally determined.
See MoneyResource .
sourceDoc (string) The original document to be settled. Internally determined.
percentage (decimal) The receipt tax rate. Internally determined.
openTaxAmount (MoneyResource) The receipt opened tax amount. Internally determined.
See MoneyResource .
openTaxableAmount (MoneyResource) The receipt opened taxable amount. Internally determined.
See MoneyResource .
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:

sourceDocId (Guid) The identifier of the original document to be settled. Internally determined.
isExempt (bool) Indicates the receipt tax schema is exempt. Internally determined.
sourceSchemaEntityId (Guid) The unique identifier of the schema entity from the originating document, possible values: Orders, Deliveries, GoodsReturns. 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 (MoneyResource) The receipt withholding tax taxable amount. Internally determined.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The receipt total amount for a withhold tax. Internally calculated.
See MoneyResource .
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 (MoneyResource) The receipt open amount for a withhold tax. Internally calculated.
See MoneyResource .
openTaxableAmount (MoneyResource) The receipt withholding open tax taxable amount. Internally determined.
See MoneyResource .
wTaxSummary (string) The receipt withholding tax summary. Internally determined.
withholdingTaxCode (string) The receipt withholding tax code. Internally determined.
beneficiaryParty (string) The party that benefits the WTax.
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:

sourceDocId (Guid) The identifier of the original document to be settled. Internally determined.
withholdingPosting (string) The receipt withholding posting. 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.
allowanceChargeAmount (MoneyResource) Total discount over goods and services. Internally calculated.
See MoneyResource .
grossValue (MoneyResource) Total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource .
payableAmount (MoneyResource) The receipt amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
wTaxTotal (MoneyResource) Total withholding tax value of goods and services. Internally calculated.
See MoneyResource .
taxTotal (MoneyResource) Total tax value of goods and services. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The receipt total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource .
withholdingTaxAmount (MoneyResource) Withholding Tax Amount.
See MoneyResource .
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.
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) 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. On a receipt either a cash drawer or a bank account must be used to define where to credit the value.
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.
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.
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.
account (string) The GL account to be used for the cash flow (petty cash or financial account).
dimensionSet (string) The dimension set. Infered from the dimensions of the petty cash or bank account.
paymentReference (string) The external payment reference.
dimensionSetJson (string) Dimension Set Json.
hashControl (string) Hash Control.
accountingPartyTaxId (string) Accounting Party Tax Id.
swift (string) Swift.
iBAN (string) IBAN.
paymentInstruction (string) Payment Instruction.
printedReportName (string) Indicates the report name used to print the document. Internally determined.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

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

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



ReceiptLineResource

The following elements are required:

settledAmount (MoneyResource) 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.
See MoneyResource .
discount (MoneyResource) 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.
See MoneyResource .
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 (MoneyResource) It indicates the total amount of the original document in the receipt currency. Internally determined.
See MoneyResource .
openAmount (MoneyResource) 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.
See MoneyResource .
settled (bool) Indicates that the current line is selected to include on current receipt.
withholdingTaxAmount (MoneyResource) 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.
See MoneyResource .
openWithholdingTaxAmount (MoneyResource) 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.
See MoneyResource .
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.
originalOpenAmount (MoneyResource) Original Open Amount.
See MoneyResource .

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.
discountAccount (string) The financial discount GL account assigned from the financial account determination.
customerAccount (string) The customer GL account.
chartOfAccount (string) The chart of accounts. Infered from the financial company setup.
nature (enum AccountingNature) The nature of the settled document.
See AccountingNature.
dimensionSet (string) The dimension set inherited from the supplier dimensions.
dimensionSetJson (string) Dimension Set Json.


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.
allowanceChargeAmount (MoneyResource) Total discount over goods and services. Internally calculated.
See MoneyResource .
grossValue (MoneyResource) Total value of goods and services before taxes or discounts. Internally calculated.
See MoneyResource .
payableAmount (MoneyResource) The receipt amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
wTaxTotal (MoneyResource) Total withholding tax value of goods and services. Internally calculated.
See MoneyResource .
taxTotal (MoneyResource) Total tax value of goods and services. Internally calculated.
See MoneyResource .
taxExclusiveAmount (MoneyResource) The receipt total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource .
journalNumber (int) The journal number assigned in accounting.
chartOfAccount (string) The chart of accounts. Infered from the financial company setup.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
withholdingTaxAmount (MoneyResource) Withholding Tax Amount.
See MoneyResource .
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) 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. On a receipt either a cash drawer or a bank account must be used to define where to credit the value.
(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.
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.
notification (string) The receipt notification configuration. Inferred from the receipt type.
(fk) Allowed value: the natural key of a record of type Notification.
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.
journalType (string) The journal type to be used when posting in accounting. Infered from the invoice type.
(fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
ledger (string) The ledger to be used when posting in accounting. The default value is the company's General Ledger.
(fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
account (string) The GL account to be used for the cash flow (petty cash or financial account).
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
dimensionSet (string) The dimension set. Infered from the dimensions of the petty cash or bank account.
(fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
accountingDocument (string) The accounting document that was assigned in accounting.
paymentReference (string) The external payment reference.
dimensionSetJson (string) Dimension Set Json.
hash (string) Hash.
hashControl (string) Hash Control.
aTQRCode (string) ATQR.
accountingPartyTaxId (string) Accounting Party Tax Id.
swift (string) Swift.
iBAN (string) IBAN.
paymentInstruction (string) Payment Instruction.
printedReportName (string) Indicates the report name used to print the document. Internally determined.
isReprinted (bool) Indicates if the document has been reprinted. Internally determined.
isSigned (bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.
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.
aTCUD (string) ATCUD:.


ReceiptTaxResource

The following elements are required:

taxableAmount (MoneyResource) The amount of revenue subject to tax. This taxable amount is calculated by subtracting the corresponding discounts and allowance charges to the gross value. Internally determined.
See MoneyResource .
taxAmount (MoneyResource) The receipt tax amount. Internally determined.
See MoneyResource .
sourceDoc (string) The original document to be settled. Internally determined.
percentage (decimal) The receipt tax rate. Internally determined.
openTaxAmount (MoneyResource) The receipt opened tax amount. Internally determined.
See MoneyResource .
openTaxableAmount (MoneyResource) The receipt opened taxable amount. Internally determined.
See MoneyResource .
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:

sourceDocId (Guid) The identifier of the original document to be settled. Internally determined.
isExempt (bool) Indicates the receipt tax schema is exempt. Internally determined.
sourceSchemaEntityId (Guid) The unique identifier of the schema entity from the originating document, possible values: Orders, Deliveries, GoodsReturns. 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 (MoneyResource) The receipt withholding tax taxable amount. Internally determined.
See MoneyResource .
withholdingTaxAmount (MoneyResource) The receipt total amount for a withhold tax. Internally calculated.
See MoneyResource .
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 (MoneyResource) The receipt open amount for a withhold tax. Internally calculated.
See MoneyResource .
openTaxableAmount (MoneyResource) The receipt withholding open tax taxable amount. Internally determined.
See MoneyResource .
wTaxSummary (string) The receipt withholding tax summary. Internally determined.
withholdingTaxCode (string) The receipt withholding tax code. Internally determined.
beneficiaryParty (string) The party that benefits the WTax.
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:

sourceDocId (Guid) The identifier of the original document to be settled. Internally determined.
withholdingPosting (string) The receipt withholding posting. 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.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AccountingNature

1 Debit
2 Credit


AccountingSchema

1 Accrual Acrrual Accounting Schema.
2 Cash


FinancialArea

1 AccountsReceivable
2 AccountsPayable
3 Accounting