Jasmin Developers - Web API Reference

Purchases | Expense

Service to manage entities of type 'Expense'.

Overview


URL api/{tenantKey}/{orgKey}/invoiceReceipt/expenses
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 Expenses (odata)

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

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/odata

GET Expense 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 ExpenseResource.

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{id}

GET Expense by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}

GET Print Expense by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{id}/print?template={template}

GET Print Expense by identifier (asynchronously)

Prints the specified entity record asynchronously.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

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

Response:

When successful, the response Location header contains an URL to download the printed file.

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{id}/printAsync?template={template}

GET Print Expense by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/print

GET Print Expense by key (asynchronously)

Prints the specified entity record asynchronously.

The following elements are required:

companyKey (string) The company key.
documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense 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 Location header contains an URL to download the printed file.

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/printAsync

GET Original Print Expense by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{id}/printOriginal?template={template}

GET Original Print Expense by identifier (asynchronously)

Prints the specified entity record asynchronously.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

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

Response:

When successful, the response Location header contains an URL to download the printed file.

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{id}/printOriginalAsync?template={template}

GET Original Print Expense by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal

GET Original Print Expense by key (asynchronously)

Prints the specified entity record asynchronously.

The following elements are required:

companyKey (string) The company key.
documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense 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 Location header contains an URL to download the printed file.

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginalAsync

GET Expense DocumentAttach.

Returns the value of attribute 'DocumentAttach' of the specified entity record.

The following elements are required:

id (string) The record identifier.
fileName (string) The file name.

Response:

When successful, the response is a stream with the image file.

Response status codes:

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

Resource URL:

GET /invoiceReceipt/expenses/{id}/documentAttach

POST Operations

POST Expenses

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /invoiceReceipt/expenses

POST Expense Line

Inserts a new 'Expense Line' in the 'Expense'.

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (ApiExpenseDocumentLinesResource) The ApiExpenseDocumentLinesResource instance.
See ApiExpenseDocumentLinesResource.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

PUT Operations

PUT Set Company Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/company

PUT Set Currency Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/currency

PUT Set Description ExpenseLine

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/description

PUT Set DocumentAttach Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentAttach

PUT Set DocumentDate Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentDate

PUT Set ExchangeRate Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRate

PUT Set ExchangeRateDate Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRateDate

PUT Set HasImage Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense 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 /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/hasImage

PUT Set HasInferredData Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense 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 /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/hasInferredData

PUT Set IsActive Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive

PUT Set ItemTaxSchema ExpenseLine

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/itemTaxSchema

PUT Set Note Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/note

PUT Set PaymentMethod Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentMethod

PUT Set PaymentTerm Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentTerm

PUT Set Remarks Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks

PUT Set SellerSupplierParty Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierParty

PUT Set SellerSupplierPartyName Expense

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyName

PUT Set UnitPrice ExpenseLine

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

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unitPrice

DELETE Operations

DELETE Expense Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
companyKey (string) The company key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

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

DELETE Expense by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /invoiceReceipt/expenses/{id}

DELETE Expense by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /invoiceReceipt/expenses/{companyKey}/{documentType}/{serie}/{seriesNumber}

Resources


ApiExpenseDocumentLinesResource

The following elements are required:

transactionAccount (string) The transaction's account.
description (string) The expense line's description.
unitPrice (MoneyResource) The unit price.
See MoneyResource .
itemTaxSchema (string) The item's tax schema.


ApiExpenseResource

The following elements are required:

company (string) The company's code is the central organizational unit within the system.
documentType (string) The document’s type.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
documentDate (DateTime) The document’s date.
sellerSupplierParty (string) The supplier.
currency (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
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.
cashInvoice (bool) Indicates whether the expense is a cash invoice or not. Defined internally and inferred from the expense type.
paymentMethod (string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party.
paymentTerm (string) The term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the supplier party.

The following elements are optional:

sellerSupplierPartyName (string) The supplier name.
documentAttach (string) The document’s attach.
exchangeRateDate (DateTime) The exchange’s rate date.
cashFlowItem (string) The 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. Used when the document is a cash invoice.
financialAccount (string) A financial account that represents either a cash drawer or a bank account and must be used to define where to debit 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. On an invoice either a cash drawer or a bank account must be used to define where to debit the value.
remarks (string) The remarks.
documentLines (List of ApiExpenseDocumentLinesResource) The document’s details.
See ApiExpenseDocumentLinesResource.
note (string) The note.
hasImage (bool) Defines if the expense document has attached an image. Internally determined.
hasInferredData (bool) Defines if the expense document has inferred data from the attached image. Internally determined.


ExpenseResource

The following elements are required:

company (string) The company's code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
documentType (string) The document’s type.
(fk) Allowed value: the natural key of a record of type ExpenseType.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the expense type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber (int) The sequential number internally determined that uniquely identifies the document within the expense type and serie. Part of the document natural key.
documentDate (DateTime) The document’s date.
sellerSupplierParty (string) The supplier.
(fk) Allowed value: the natural key of a record of type SupplierParty. These records are accessibly through the SupplierParties service.
currency (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
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.
taxExclusiveAmount (MoneyResource) The tax’s exclusive amount (Net).
See MoneyResource .
taxTotal (MoneyResource) The total's tax value of goods and services. Internally calculated.
See MoneyResource .
payableAmount (MoneyResource) The expense's amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource .
postingDate (DateTime) The date when the document is created.
grossValue (MoneyResource) The total value of goods and services before taxes or discounts.
See MoneyResource .
discount (decimal) The discount percentage. The default is defined on the supplier party.
allowanceChargeAmount (MoneyResource) The total’s discount over goods and services. Internally calculated.
See MoneyResource .
cashInvoice (bool) Indicates whether the expense is a cash invoice or not. Defined internally and inferred from the expense type.
wTaxTotal (MoneyResource) The total’s withholding tax value of goods and services. Internally calculated.
See MoneyResource .
paymentMethod (string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
paymentTerm (string) The term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
discountInValueAmount (MoneyResource) Discount In Value.
See MoneyResource .
isLocked (bool) Is Locked.

The following elements are optional:

sellerSupplierPartyName (string) The supplier name.
documentAttach (string) The document’s attach.
exchangeRateDate (DateTime) The exchange’s rate date.
cashFlowItem (string) The 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. Used when the document is a cash invoice.
(fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
financialAccount (string) A financial account that represents either a cash drawer or a bank account and must be used to define where to debit 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. On an invoice either a cash drawer or a bank account must be used to define where to debit the value.
(fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
remarks (string) The remarks.
documentLines (List of ExpenseLineResource) The document’s details.
See ExpenseLineResource.
taxIncluded (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the invoice series.
accountingPartyTaxId (string) The accounting’s party tax identifier.
isPrinted (bool) Indicates if the expense has been printed.
accountingParty (string) The accounting’s party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
documentStatus (enum DocumentStatus) The document’s status.
See DocumentStatus.
note (string) The note.
accountingSchema (enum AccountingSchema) The accounting’s schema.
See AccountingSchema.
partyAccountingSchema (enum AccountingSchema) The party’s accounting schema.
See AccountingSchema.
dueDate (DateTime) The due date. In some countries it is also known as law date.
hasImage (bool) Defines if the expense document has attached an image. Internally determined.
hasInferredData (bool) Defines if the expense document has inferred data from the attached image. 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.
isSaved (bool) Is Saved.
printedReportName (string) Printed Report Name.
isReprinted (bool) Is Reprinted.
isSigned (bool) Is Signed.


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.



Enumerations


AccountingSchema

1 Accrual Accrual Accounting Schema.
2 Cash


DocumentStatus

1 Open
2 Completed