Purchases | Invoice
The Invoices represents the commercial document with the purchased goods or services of the company.
Overview
| URL | api/{tenantKey}/{orgKey}/invoiceReceipt/invoices |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute Invoice
- PUT Set Custom Attribute InvoiceLine
- PUT Set IsActive Invoice
- PUT Set Company Invoice
- PUT Set SellerSupplierPartyName Invoice
- PUT Set SellerSupplierPartyTaxId Invoice
- PUT Set SellerSupplierPartyAddress Invoice
- PUT Set AccountingParty Invoice
- PUT Set AccountingPartyName Invoice
- PUT Set AccountingPartyTaxId Invoice
- PUT Set AccountingPartyAddress Invoice
- PUT Set LogisticsPartyId Invoice
- PUT Set AltAddress Invoice
- PUT Set DeliveryTerm Invoice
- PUT Set PaymentTerm Invoice
- PUT Set PaymentMethod Invoice
- PUT Set Currency Invoice
- PUT Set DocumentDate Invoice
- PUT Set Note Invoice
- PUT Set ExchangeRate Invoice
- PUT Set ExchangeRateDate Invoice
- PUT Set Discount Invoice
- PUT Set Remarks Invoice
- PUT Set PaymentAccountPostingId Invoice
- PUT Set NoteToRecipient Invoice
- PUT Set IsPaymentMethodCheck Invoice
- PUT Set LoadingPoint Invoice
- PUT Set LoadingPointAddress Invoice
- PUT Set LoadingDateTime Invoice
- PUT Set LoadingCountry Invoice
- PUT Set LoadingStreetName Invoice
- PUT Set LoadingBuildingNumber Invoice
- PUT Set LoadingPostalZone Invoice
- PUT Set LoadingCityName Invoice
- PUT Set VehiclePlateNumber Invoice
- PUT Set UnloadingPoint Invoice
- PUT Set UnloadingPointAddress Invoice
- PUT Set UnloadingDateTime Invoice
- PUT Set UnloadingCountry Invoice
- PUT Set UnloadingStreetName Invoice
- PUT Set UnloadingBuildingNumber Invoice
- PUT Set UnloadingPostalZone Invoice
- PUT Set UnloadingCityName Invoice
- PUT Set DueDate Invoice
- PUT Set AccountingAltAddress Invoice
- PUT Set AccountingSchema Invoice
- PUT Set PartyAccountingSchema Invoice
- PUT Set Notification Invoice
- PUT Set EmailTo Invoice
- PUT Set SupplierAccount Invoice
- PUT Set DimensionSet Invoice
- PUT Set DeliveryMode Invoice
- PUT Set PaymentReference Invoice
- PUT Set DimensionSetJson Invoice
- PUT Set CustomsDeclaration Invoice
- PUT Set Swift Invoice
- PUT Set IBAN Invoice
- PUT Set PaymentInstruction Invoice
- PUT Set PrintedReportName Invoice
- PUT Set ItemWithholdingTaxSchema InvoiceLine
- PUT Set ItemTaxSchema InvoiceLine
- PUT Set BaseUnit InvoiceLine
- PUT Set Unit InvoiceLine
- PUT Set Warehouse InvoiceLine
- PUT Set Description InvoiceLine
- PUT Set Quantity InvoiceLine
- PUT Set UnitPrice InvoiceLine
- PUT Set DeliveryDate InvoiceLine
- PUT Set Discount1 InvoiceLine
- PUT Set Discount2 InvoiceLine
- PUT Set Discount3 InvoiceLine
- PUT Set DocumentLineStatus InvoiceLine
- PUT Set UnitCost InvoiceLine
- PUT Set ComplementaryDescription InvoiceLine
- PUT Set DimensionSet InvoiceLine
- PUT Set PurchasesAccount InvoiceLine
- PUT Set DiscountAccount InvoiceLine
- PUT Set ChartOfAccount InvoiceLine
- PUT Set IsStockItem InvoiceLine
- PUT Set DimensionSetJson InvoiceLine
- PUT Set SourceOrder InvoiceLine
- PUT Set SourceOrderId InvoiceLine
- PUT Set SourceOrderLine InvoiceLine
- PUT Set SourceOrderLineId InvoiceLine
- PUT Set SourceOrderSchemaEntityId InvoiceLine
- PUT Set CommitmentReference InvoiceLine
- PUT Set RoundingTaxableAmount InvoiceTax
- PUT Set RoundingTaxAmount InvoiceTax
- DELETE:
All Resources
This service uses the following resources:
- ApiInvoiceDocumentLinesResource
- ApiInvoiceDocumentTaxesResource
- ApiInvoiceDocumentWTaxesResource
- ApiInvoiceResource
- InvoiceLineResource
- InvoiceResource
- InvoiceReturnOrder
- InvoiceTaxResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET Invoices
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See InvoiceResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices
GET /invoiceReceipt/invoices
GET Invoices (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 InvoiceResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices?page={page}&pageSize={pageSize}
GET /invoiceReceipt/invoices?page={page}&pageSize={pageSize}
GET Invoice 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 InvoiceResource. |
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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{id}
GET /invoiceReceipt/invoices/{id}
GET Invoice 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 invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
Response:
| When successful, the response body contains the entity record. See InvoiceResource. |
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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}
GET /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}
GET Print Invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{id}/print?template={template}
GET /invoiceReceipt/invoices/{id}/print?template={template}
GET Print Invoice by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/print
GET /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/print
GET Original Print InvoiceOriginal 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{id}/printOriginal?template={template}
GET /invoiceReceipt/invoices/{id}/printOriginal?template={template}
GET Original Print Invoice by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal
GET /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/printOriginal
POST Invoices
Creates a new entity record.
The following elements are required:
| invoiceResource | (ApiInvoiceResource) The request body should contain the entity record that should be created. See ApiInvoiceResource. |
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 ApiInvoiceResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices
POST /invoiceReceipt/invoices
POST Invoice
Inserts a new 'Invoice Line' in the 'Invoice'.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (ApiInvoiceDocumentLinesResource) The ApiInvoiceDocumentLinesResource instance. See ApiInvoiceDocumentLinesResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines
POST /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines
POST Invoice
Inserts a new 'Invoice Tax' in the 'Invoice'.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (ApiInvoiceDocumentTaxesResource) The ApiInvoiceDocumentTaxesResource instance. See ApiInvoiceDocumentTaxesResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes
POST /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes
POST Invoice
Inserts a new 'Invoice WTax' in the 'Invoice'.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (ApiInvoiceDocumentWTaxesResource) The ApiInvoiceDocumentWTaxesResource instance. See ApiInvoiceDocumentWTaxesResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes
POST /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes
POST To Return Order
The To Return Order end point is used to creat a return order based on a invoice.
The following elements are required:
| invoiceReturnOrder | (InvoiceReturnOrder) The invoice resource (company key + document key). |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/toReturnOrder
POST /invoiceReceipt/invoices/toReturnOrder
PUT Set AccountingAltAddress Invoice
Updates the value of attribute 'AccountingAltAddress' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingAltAddress
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingAltAddress
PUT Set AccountingParty Invoice
Updates the value of attribute 'AccountingParty' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingParty
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingParty
PUT Set AccountingPartyAddress Invoice
Updates the value of attribute 'AccountingPartyAddress' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyAddress
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyAddress
PUT Set AccountingPartyName Invoice
Updates the value of attribute 'AccountingPartyName' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyName
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyName
PUT Set AccountingPartyTaxId Invoice
Updates the value of attribute 'AccountingPartyTaxId' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyTaxId
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingPartyTaxId
PUT Set AccountingSchema Invoice
Updates the value of attribute 'AccountingSchema' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingSchema
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/accountingSchema
PUT Set AltAddress Invoice
Updates the value of attribute 'AltAddress' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/altAddress
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/altAddress
PUT Set BaseUnit InvoiceLine
Updates the value of attribute 'BaseUnit' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/baseUnit
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/baseUnit
PUT Set ChartOfAccount InvoiceLine
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/chartOfAccount
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/chartOfAccount
PUT Set CommitmentReference InvoiceLine
Updates the value of attribute 'CommitmentReference' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/commitmentReference
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/commitmentReference
PUT Set Company Invoice
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/company
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/company
PUT Set ComplementaryDescription InvoiceLine
Updates the value of attribute 'ComplementaryDescription' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/complementaryDescription
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/complementaryDescription
PUT Set Currency Invoice
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/currency
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/currency
PUT Set CustomsDeclaration Invoice
Updates the value of attribute 'CustomsDeclaration' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/customsDeclaration
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/customsDeclaration
PUT Set DeliveryDate InvoiceLine
Updates the value of attribute 'DeliveryDate' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/deliveryDate
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/deliveryDate
PUT Set DeliveryMode Invoice
Updates the value of attribute 'DeliveryMode' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryMode
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryMode
PUT Set DeliveryTerm Invoice
Updates the value of attribute 'DeliveryTerm' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryTerm
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/deliveryTerm
PUT Set Description InvoiceLine
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/description
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/description
PUT Set DimensionSet Invoice
Updates the value of attribute 'DimensionSet' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSet
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSet
PUT Set DimensionSet InvoiceLine
Updates the value of attribute 'DimensionSet' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSet
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSet
PUT Set DimensionSetJson Invoice
Updates the value of attribute 'DimensionSetJson' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSetJson
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/dimensionSetJson
PUT Set DimensionSetJson InvoiceLine
Updates the value of attribute 'DimensionSetJson' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/dimensionSetJson
PUT Set Discount Invoice
Updates the value of attribute 'Discount' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/discount
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/discount
PUT Set Discount1 InvoiceLine
Updates the value of attribute 'Discount1' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount1
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount1
PUT Set Discount2 InvoiceLine
Updates the value of attribute 'Discount2' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount2
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount2
PUT Set Discount3 InvoiceLine
Updates the value of attribute 'Discount3' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount3
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discount3
PUT Set DiscountAccount InvoiceLine
Updates the value of attribute 'DiscountAccount' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discountAccount
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/discountAccount
PUT Set DocumentDate Invoice
Updates the value of attribute 'DocumentDate' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (DateTime) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentDate
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentDate
PUT Set DocumentLineStatus InvoiceLine
Updates the value of attribute 'DocumentLineStatus' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (enum DocumentLineStatus) The request body should contain the new value for the attribute. See DocumentLineStatus. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/documentLineStatus
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/documentLineStatus
PUT Set DueDate Invoice
Updates the value of attribute 'DueDate' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (DateTime) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/dueDate
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/dueDate
PUT Set EmailTo Invoice
Updates the value of attribute 'EmailTo' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/emailTo
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/emailTo
PUT Set ExchangeRate Invoice
Updates the value of attribute 'ExchangeRate' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRate
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRate
PUT Set ExchangeRateDate Invoice
Updates the value of attribute 'ExchangeRateDate' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (DateTime) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRateDate
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/exchangeRateDate
PUT Set IBAN Invoice
Updates the value of attribute 'IBAN' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/iBAN
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/iBAN
PUT Set IsActive Invoice
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/isActive
PUT Set IsPaymentMethodCheck Invoice
Updates the value of attribute 'IsPaymentMethodCheck' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/isPaymentMethodCheck
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/isPaymentMethodCheck
PUT Set IsStockItem InvoiceLine
Updates the value of attribute 'IsStockItem' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/isStockItem
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/isStockItem
PUT Set ItemTaxSchema InvoiceLine
Updates the value of attribute 'ItemTaxSchema' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/itemTaxSchema
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/itemTaxSchema
PUT Set ItemWithholdingTaxSchema InvoiceLine
Updates the value of attribute 'ItemWithholdingTaxSchema' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/itemWithholdingTaxSchema
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/itemWithholdingTaxSchema
PUT Set LoadingBuildingNumber Invoice
Updates the value of attribute 'LoadingBuildingNumber' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingBuildingNumber
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingBuildingNumber
PUT Set LoadingCityName Invoice
Updates the value of attribute 'LoadingCityName' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCityName
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCityName
PUT Set LoadingCountry Invoice
Updates the value of attribute 'LoadingCountry' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCountry
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingCountry
PUT Set LoadingDateTime Invoice
Updates the value of attribute 'LoadingDateTime' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (DateTimeOffset) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingDateTime
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingDateTime
PUT Set LoadingPoint Invoice
Updates the value of attribute 'LoadingPoint' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPoint
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPoint
PUT Set LoadingPointAddress Invoice
Updates the value of attribute 'LoadingPointAddress' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPointAddress
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPointAddress
PUT Set LoadingPostalZone Invoice
Updates the value of attribute 'LoadingPostalZone' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPostalZone
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingPostalZone
PUT Set LoadingStreetName Invoice
Updates the value of attribute 'LoadingStreetName' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingStreetName
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/loadingStreetName
PUT Set LogisticsPartyId Invoice
Updates the value of attribute 'LogisticsPartyId' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (Guid) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/logisticsPartyId
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/logisticsPartyId
PUT Set Note Invoice
Updates the value of attribute 'Note' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/note
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/note
PUT Set NoteToRecipient Invoice
Updates the value of attribute 'NoteToRecipient' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/noteToRecipient
PUT Set Notification Invoice
Updates the value of attribute 'Notification' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/notification
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/notification
PUT Set PartyAccountingSchema Invoice
Updates the value of attribute 'PartyAccountingSchema' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/partyAccountingSchema
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/partyAccountingSchema
PUT Set PaymentAccountPostingId Invoice
Updates the value of attribute 'PaymentAccountPostingId' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (Guid) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentAccountPostingId
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentAccountPostingId
PUT Set PaymentInstruction Invoice
Updates the value of attribute 'PaymentInstruction' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentInstruction
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentInstruction
PUT Set PaymentMethod Invoice
Updates the value of attribute 'PaymentMethod' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentMethod
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentMethod
PUT Set PaymentReference Invoice
Updates the value of attribute 'PaymentReference' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentReference
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentReference
PUT Set PaymentTerm Invoice
Updates the value of attribute 'PaymentTerm' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentTerm
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/paymentTerm
PUT Set PrintedReportName Invoice
Updates the value of attribute 'PrintedReportName' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/printedReportName
PUT Set PurchasesAccount InvoiceLine
Updates the value of attribute 'PurchasesAccount' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/purchasesAccount
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/purchasesAccount
PUT Set Quantity InvoiceLine
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/quantity
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/quantity
PUT Set Remarks Invoice
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/remarks
PUT Set RoundingTaxableAmount InvoiceTax
Updates the value of attribute 'RoundingTaxableAmount' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}/roundingTaxableAmount
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}/roundingTaxableAmount
PUT Set RoundingTaxAmount InvoiceTax
Updates the value of attribute 'RoundingTaxAmount' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}/roundingTaxAmount
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}/roundingTaxAmount
PUT Set SellerSupplierPartyAddress Invoice
Updates the value of attribute 'SellerSupplierPartyAddress' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyAddress
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyAddress
PUT Set SellerSupplierPartyName Invoice
Updates the value of attribute 'SellerSupplierPartyName' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyName
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyName
PUT Set SellerSupplierPartyTaxId Invoice
Updates the value of attribute 'SellerSupplierPartyTaxId' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyTaxId
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/sellerSupplierPartyTaxId
PUT Set SourceOrder InvoiceLine
Updates the value of attribute 'SourceOrder' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrder
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrder
PUT Set SourceOrderId InvoiceLine
Updates the value of attribute 'SourceOrderId' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (Guid) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderId
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderId
PUT Set SourceOrderLine InvoiceLine
Updates the value of attribute 'SourceOrderLine' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (int) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLine
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLine
PUT Set SourceOrderLineId InvoiceLine
Updates the value of attribute 'SourceOrderLineId' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (Guid) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLineId
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderLineId
PUT Set SourceOrderSchemaEntityId InvoiceLine
Updates the value of attribute 'SourceOrderSchemaEntityId' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| lineId | (string) The detail identifier. |
| companyKey | (string) The company key. |
| value | (Guid) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderSchemaEntityId
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/sourceOrderSchemaEntityId
PUT Set SupplierAccount Invoice
Updates the value of attribute 'SupplierAccount' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/supplierAccount
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/supplierAccount
PUT Set Swift Invoice
Updates the value of attribute 'Swift' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/swift
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/swift
PUT Set Unit InvoiceLine
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unit
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unit
PUT Set UnitCost InvoiceLine
Updates the value of attribute 'UnitCost' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unitCost
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unitCost
PUT Set UnitPrice InvoiceLine
Updates the value of attribute 'UnitPrice' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unitPrice
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/unitPrice
PUT Set UnloadingBuildingNumber Invoice
Updates the value of attribute 'UnloadingBuildingNumber' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingBuildingNumber
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingBuildingNumber
PUT Set UnloadingCityName Invoice
Updates the value of attribute 'UnloadingCityName' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCityName
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCityName
PUT Set UnloadingCountry Invoice
Updates the value of attribute 'UnloadingCountry' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCountry
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingCountry
PUT Set UnloadingDateTime Invoice
Updates the value of attribute 'UnloadingDateTime' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| value | (DateTimeOffset) 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingDateTime
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingDateTime
PUT Set UnloadingPoint Invoice
Updates the value of attribute 'UnloadingPoint' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPoint
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPoint
PUT Set UnloadingPointAddress Invoice
Updates the value of attribute 'UnloadingPointAddress' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPointAddress
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPointAddress
PUT Set UnloadingPostalZone Invoice
Updates the value of attribute 'UnloadingPostalZone' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPostalZone
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingPostalZone
PUT Set UnloadingStreetName Invoice
Updates the value of attribute 'UnloadingStreetName' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingStreetName
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/unloadingStreetName
PUT Set VehiclePlateNumber Invoice
Updates the value of attribute 'VehiclePlateNumber' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/vehiclePlateNumber
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/vehiclePlateNumber
PUT Set Warehouse InvoiceLine
Updates the value of attribute 'Warehouse' in the specified entity record.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/warehouse
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/warehouse
PUT Set Custom Attribute Invoice
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/{customAttributeName}
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/{customAttributeName}
PUT Set Custom Attribute InvoiceLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}
PUT /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}/{customAttributeName}
DELETE Invoice Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}
DELETE /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentLines/{lineId}
DELETE Invoice Tax by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}
DELETE /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentTaxes/{lineId}
DELETE Invoice WTax by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| companyKey | (string) The company key. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes/{lineId}
DELETE /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}/documentWTaxes/{lineId}
DELETE Invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{id}
DELETE /invoiceReceipt/invoices/{id}
DELETE Invoice 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 invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice 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:
api/{tenantKey}/{orgKey}/invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}
DELETE /invoiceReceipt/invoices/{companyKey}/{documentType}/{serie}/{seriesNumber}
Resources
ApiInvoiceDocumentLinesResource
The following elements are required:
| purchasesItem | (string) The purchase item representing the good or service included on the invoice. |
| itemTaxSchema | (string) The invoice line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the purchases item. |
| unit | (string) The invoice line item purchases unit. The default purchases unit is defined on the purchases item. |
| description | (string) The invoice line item description. The default is defined on the purchases item. |
| quantity | (decimal) The invoice line item quantity. The default 1. |
| unitPrice | (MoneyResource) The invoice line item unit price. The default price is loaded from purchases item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource . |
| deliveryDate | (DateTime) The expected line item delivery date. The default is the document date. |
| documentLineStatus | (enum DocumentLineStatus) The document line status. The default is Open.
See DocumentLineStatus. |
| unitCost | (MoneyResource) The item current unit cost. Used only on inventory items, this value is infered from the material item depending on the warehouse used on this line.
See MoneyResource . |
| purchasesAccount | (string) The expenses GL account assigned from the account determination in the invoice tye. |
| chartOfAccount | (string) The chart of accounts infered from company financial setup. |
The following elements are optional:
| itemWithholdingTaxSchema | (string) The invoice line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the purchases item. |
| baseUnit | (string) The invoice line item base unit. The default unit is defined on the item. |
| warehouse | (string) The invoice line item warehouse. The default is defined on the materials item. |
| discount1 | (decimal) The memo line item discount 1 percetange. The default is 0. |
| discount2 | (decimal) The invoice line item discount 2 percentage. The default is 0. This discount is applied over the remaining value after discount 1 is applied. |
| discount3 | (decimal) The invoice line item discount 3 percentage. The default is 0. This discount is applied over the remaining value after discount 1 and 2 are applied. |
| complementaryDescription | (string) The invoice line item complementary description. The default is defined on the sales item. |
| dimensionSet | (string) The dimension set. Infered from the dimension combination in the invoice type. |
| discountAccount | (string) The commercial discount GL account received from the account determination in the invoice tye. |
| isStockItem | (bool) Value is true if PurchasesItem is declared on MaterialsItem. Internally determined. |
| dimensionSetJson | (string) Dimension Set Json. |
| sourceOrder | (string) The order that origin this line. |
| sourceOrderId | (Guid) The order id that origin this line. |
| sourceOrderLine | (int) The order line index that origin this line. |
| sourceOrderLineId | (Guid) The order line id that origin this line. |
| sourceOrderSchemaEntityId | (Guid) The order schema id that origin this line. |
| commitmentReference | (string) The state supplier commitment reference. |
ApiInvoiceDocumentTaxesResource
The following elements are required:
| roundingTaxableAmount | (MoneyResource) The rounding value of the invoice amount of revenue subject to tax.
See MoneyResource . |
| roundingTaxAmount | (MoneyResource) The rounding value of the invoice tax amount. Internally determined.
See MoneyResource . |
ApiInvoiceDocumentWTaxesResource
ApiInvoiceResource
The following elements are required:
| company | (string) The company where the invoice is posted. The company code is the central organizational unit within the system. |
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| sellerSupplierParty | (string) The supplier designated in the invoice as the party to whom the invoice is sell. It may or may not be the party from whom the goods or services are received. The default is defined on the party. |
| accountingParty | (string) The supplier designated in the invoice as the party to whom the memo should be sent. It may or may not be the party from whom the goods or services are received. The default is defined on the supplier party. |
| 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. |
| 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. |
| 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. |
| documentDate | (DateTime) The date when the document is issued. |
| exchangeRate | (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| postingDate | (DateTime) The date when the document is created. |
| discount | (decimal) The discount percentage. The default is defined on the supplier party. |
| loadingCountry | (string) The country of the physical location where the goods are loaded. The default is the supplier's address country. |
| unloadingCountry | (string) The country of the physical location where the goods are unloaded. The default is the company's address country. |
The following elements are optional:
| sellerSupplierPartyName | (string) The seller supplier party name. It is inferred from the seller supplier party. |
| sellerSupplierPartyTaxId | (string) The seller supplier party tax code. It is inferred from the seller supplier party. |
| sellerSupplierPartyAddress | (string) The seller supplier party address. It is inferred from the seller supplier party. |
| accountingPartyName | (string) The accounting party name. It is inferred from the accounting party. |
| accountingPartyTaxId | (string) The accounting party tax code. It is inferred from the accounting party. |
| accountingPartyAddress | (string) The accounting party address. It is inferred from the accounting party. |
| logisticsPartyId | (Guid) The party's unique identifier. It is inferred from the party. Internally setted. |
| altAddress | (string) The alternative party address key to be used on the invoice. The alternative addresses keys are defined on the party additional addresses. When defined overrides the party address and unloading address values. |
| 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) 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. |
| deliveryTerm | (string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the supplier party. |
| documentLines | (List of ApiInvoiceDocumentLinesResource) The invoice lines.
See ApiInvoiceDocumentLinesResource. |
| documentTaxes | (List of ApiInvoiceDocumentTaxesResource) The invoice taxes.
See ApiInvoiceDocumentTaxesResource. |
| note | (string) The invoice note. |
| exchangeRateDate | (DateTime) The exchange’s rate date. |
| remarks | (string) The invoice remarks. |
| paymentAccountPostingId | (Guid) The unique identifier of the account posting. |
| noteToRecipient | (string) Note to the invoice's recipient. |
| outgoingCheckLot | (string) The outgoint lot of the check used for this invoice document. Applicable only when the payment is cash payment and the payment method is of type check. |
| isPaymentMethodCheck | (bool) Determines if the used payment method is of type check. Applicable only when the payment is cash payment and the payment method is of type check. Internally determined. |
| loadingPoint | (string) The physical location where the goods are loaded. Defines the loading from the freight. The default is the supplier's address. |
| loadingPointAddress | (string) The physical location address where the goods are loaded. The default is the supplier's address. |
| loadingDateTime | (DateTimeOffset) The goods loading date and time from the loading physical location. The default is the invoice creation date and time. |
| loadingStreetName | (string) The street name of the physical location where the goods are loaded. The default is the supplier's address street name. |
| loadingBuildingNumber | (string) The building number of the physical location where the goods are loaded. The default is supplier address building number. |
| loadingPostalZone | (string) The postal zone of the physical location where the goods are loaded. The default is the supplier's address postal zone. |
| loadingCityName | (string) The city name of the physical location where the goods are loaded. The default is the supplier's address city name. |
| vehiclePlateNumber | (string) The vehicle plate used to transport the goods. |
| unloadingPoint | (string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is the company's physical location. |
| unloadingPointAddress | (string) The physical location address where the goods are unloaded. The default is the company's physical location address. |
| unloadingDateTime | (DateTimeOffset) The goods unloading date and time on the unloading physical location. |
| unloadingStreetName | (string) The street name of the physical location where the goods are unloaded. The default is the company's address street name. |
| unloadingBuildingNumber | (string) The building number of the physical location where the goods are unloaded. The default is the company's address building number. |
| unloadingPostalZone | (string) The postal zone of the physical location where the goods are unloaded. The default is the company's address postal zone. |
| unloadingCityName | (string) The city name of the physical location where the goods are unloaded. The default is the company's address city name. |
| dueDate | (DateTime) The due date. In some countries it is also known as law date. |
| accountingAltAddress | (string) The alternative accounting party address key to be used on the invoice. The alternative addresses keys are defined on the party additional addresses. When defined overrides the accounting party address and unloading address values. |
| accountingSchema | (enum AccountingSchema) The accounting organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema. |
| partyAccountingSchema | (enum AccountingSchema) The supplier accounting organization method. The supplier organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema. |
| notification | (string) The invoice notification configuration. Inferred from the invoice type. |
| emailTo | (string) The email(s) to send invoice notification. Inferred from the notification. |
| checkNumber | (int) The number of the check used for this invoice. Applicable only when the payment is cash payment and the payment method is of type check. |
| supplierAccount | (string) The supplier GL account. |
| dimensionSet | (string) The dimension set. Infered from the supplier. |
| chartOfAccount | (string) The chart of accounts. Infered from the financial company setup. |
| deliveryMode | (string) The invoice delivey mode. (ex: mail). |
| paymentReference | (string) The payment reference. |
| dimensionSetJson | (string) Dimension Set Json. |
| customsDeclaration | (string) The customs declaration. |
| swift | (string) The society for Worldwide Interbank Financial Telecommunication number. |
| iBAN | (string) The financial account's International Bank Account Number. |
| paymentInstruction | (string) The Payment authorization given by the party. |
| printedReportName | (string) Indicates the report name used to print the document. Internally determined. |
InvoiceLineResource
The following elements are required:
| purchasesItem | (string) The purchase item representing the good or service included on the invoice. |
| currency | (string) The money unit. Inferred from the invoice currency. |
| itemTaxSchema | (string) The invoice line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the purchases item. |
| partyTaxSchema | (string) The invoice supplier party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the supplier party. |
| unit | (string) The invoice line item purchases unit. The default purchases unit is defined on the purchases item. |
| description | (string) The invoice line item description. The default is defined on the purchases item. |
| quantity | (decimal) The invoice line item quantity. The default 1. |
| unitPrice | (MoneyResource) The invoice line item unit price. The default price is loaded from purchases item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource . |
| taxTotal | (MoneyResource) Total amount of taxes for this line. Internally calculated.
See MoneyResource . |
| deliveryDate | (DateTime) The expected line item delivery date. The default is the document date. |
| documentLineStatus | (enum DocumentLineStatus) The document line status. The default is Open.
See DocumentLineStatus. |
| allowanceChargeAmount | (MoneyResource) Total amount of taxes for this line. Internally calculated.
See MoneyResource . |
| taxExclusiveAmount | (MoneyResource) The invoice line net value. The line value after discounts, excluding taxes. Internally calculated.
See MoneyResource . |
| lineExtensionAmount | (MoneyResource) The invoice line payable amount. The line value including taxes and discounts. Internally calculated.
See MoneyResource . |
| unitCost | (MoneyResource) The item current unit cost. Used only on inventory items, this value is infered from the material item depending on the warehouse used on this line.
See MoneyResource . |
| grossValue | (MoneyResource) The invoice line value before taxes or discounts. Internally calculated.
See MoneyResource . |
| conversionFactor | (decimal) The conversion factor from the invoice line purchase unit to the purchase item base unit. In other words, the rate at which the item purchase's unit can be converter to the purchase item base unit. |
| itemType | (enum ItemType) The invoice line item type. Inferred from the puchase item type. Internally determined.
See ItemType. |
| purchasesAccount | (string) The expenses GL account assigned from the account determination in the invoice tye. |
| chartOfAccount | (string) The chart of accounts infered from company financial setup. |
| deliveryOnInvoice | (bool) The default delivery type when the orders are processed. |
The following elements are optional:
| itemWithholdingTaxSchema | (string) The invoice line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the purchases item. |
| partyWithholdingTaxSchema | (string) The invoice supplier party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the supplier party. |
| baseUnit | (string) The invoice line item base unit. The default unit is defined on the item. |
| warehouse | (string) The invoice line item warehouse. The default is defined on the materials item. |
| discount1 | (decimal) The memo line item discount 1 percetange. The default is 0. |
| discount2 | (decimal) The invoice line item discount 2 percentage. The default is 0. This discount is applied over the remaining value after discount 1 is applied. |
| discount3 | (decimal) The invoice line item discount 3 percentage. The default is 0. This discount is applied over the remaining value after discount 1 and 2 are applied. |
| inventoryAmount | (decimal) The value of stock represented by this line. Used only on inventory items, this value is internally calculated using the Unit Cost and quantity. |
| complementaryDescription | (string) The invoice line item complementary description. The default is defined on the sales item. |
| sourceSchemaEntity | (string) The schema's entity from originating document, possible values: Quotations, Orders, Deliveries, Invoices, GoodsReturns, Memos, DebitNotes. |
| sourceDoc | (string) The source document using the format { |
| sourceDocId | (Guid) The unique identifier of the source document, when the invoice was transformed. The source document is usually the order. Internally determined. |
| sourceDocLine | (int) The source document line number, when the invoice was transformed. Internally determined. |
| sourceDocLineId | (Guid) The source document line id, when the invoice was transformed. Internally determined. |
| invoiceReceiptNotificationId | (Guid) The invoice receipt notification unique identifier that originated the invoice line, when the invoice is transformed. Internally determined. |
| invoiceReceiptNotificationLineId | (Guid) The invoice receipt notification line id that originated the invoice line, when the invoice is transformed. Internally determined. |
| dimensionSet | (string) The dimension set. Infered from the dimension combination in the invoice type. |
| discountAccount | (string) The commercial discount GL account received from the account determination in the invoice tye. |
| isStockItem | (bool) Value is true if PurchasesItem is declared on MaterialsItem. Internally determined. |
| dimensionSetJson | (string) Dimension Set Json. |
| printAllDiscounts | (string) The line all discounts. |
| printTaxCodes | (string) The line tax codes. |
| sourceOrder | (string) The order that origin this line. |
| sourceOrderId | (Guid) The order id that origin this line. |
| sourceOrderLine | (int) The order line index that origin this line. |
| sourceOrderLineId | (Guid) The order line id that origin this line. |
| sourceOrderSchemaEntityId | (Guid) The order schema id that origin this line. |
| commitmentReference | (string) The state supplier commitment reference. |
InvoiceResource
The following elements are required:
| company | (string) The company where the invoice is posted. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| documentType | (string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice document type is defined in the purchases setup configuration setting.
(fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service. |
| serie | (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice document type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service. |
| seriesNumber | (int) The sequential number internally determined that uniquely identifies the +document within the invoice document type and serie. Part of the document natural key. |
| sellerSupplierParty | (string) The supplier designated in the invoice as the party to whom the invoice is sell. It may or may not be the party from whom the goods or services are received. The default is defined on the party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
| accountingParty | (string) The supplier designated in the invoice as the party to whom the memo should be sent. It may or may not be the party from whom the goods or services are received. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
| 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. |
| 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. |
| 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. |
| documentDate | (DateTime) The date when the document is issued. |
| exchangeRate | (decimal) The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency. |
| postingDate | (DateTime) The date when the document is created. |
| grossValue | (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 . |
| taxExclusiveAmount | (MoneyResource) The invoice total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated.
See MoneyResource . |
| taxTotal | (MoneyResource) The total's tax value of goods and services. Internally calculated.
See MoneyResource . |
| payableAmount | (MoneyResource) The invoice's amount. Total value of goods and services including taxes and discounts. Internally calculated.
See MoneyResource . |
| wTaxTotal | (MoneyResource) The total’s withholding tax value of goods and services. Internally calculated.
See MoneyResource . |
| totalLiability | (MoneyResource) The document's total liability. Internally calculated.
See MoneyResource . |
| cashInvoice | (bool) Indicates whether the invoice is a cash invoice or not. Defined internally and inferred from the invoice type. |
| documentStatus | (enum DocumentStatus) The document status. Internally determined.
See DocumentStatus. |
| isTransformed | (bool) Defines if the invoice was transformed from the other document. Internally determined. |
| loadingCountry | (string) The country of the physical location where the goods are loaded. The default is the supplier's address country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
| unloadingCountry | (string) The country of the physical location where the goods are unloaded. The default is the company's address country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
| journalNumber | (int) The journal number assigned in accounting. |
| roundingTaxableAmount | (MoneyResource) Rounding.
See MoneyResource . |
The following elements are optional:
| sellerSupplierPartyName | (string) The seller supplier party name. It is inferred from the seller supplier party. |
| sellerSupplierPartyTaxId | (string) The seller supplier party tax code. It is inferred from the seller supplier party. |
| sellerSupplierPartyAddress | (string) The seller supplier party address. It is inferred from the seller supplier party. |
| accountingPartyName | (string) The accounting party name. It is inferred from the accounting party. |
| accountingPartyTaxId | (string) The accounting party tax code. It is inferred from the accounting party. |
| accountingPartyAddress | (string) The accounting party address. It is inferred from the accounting party. |
| logisticsPartyId | (Guid) The party's unique identifier. It is inferred from the party. Internally setted. |
| altAddress | (string) The alternative party address key to be used on the invoice. The alternative addresses keys are defined on the party additional addresses. When defined overrides the party address and unloading address values.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service. |
| 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) 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. |
| deliveryTerm | (string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the supplier party.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service. |
| documentLines | (List of InvoiceLineResource) The invoice lines.
See InvoiceLineResource. |
| documentTaxes | (List of InvoiceTaxResource) The invoice taxes.
See InvoiceTaxResource. |
| note | (string) The invoice note. |
| exchangeRateDate | (DateTime) The exchange’s rate date. |
| remarks | (string) The invoice remarks. |
| isPrinted | (bool) Indicates if the invoice has been printed. Internally determined. |
| taxIncluded | (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the invoice series. |
| paymentAccountPostingId | (Guid) The unique identifier of the account posting. |
| noteToRecipient | (string) Note to the invoice's recipient. |
| outgoingCheckLot | (string) The outgoint lot of the check used for this invoice document. Applicable only when the payment is cash payment and the payment method is of type check.
(fk) Allowed value: the natural key of a record of type OutgoingCheckLot. These records are accessibly through the OutgoingCheckLots service. |
| 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. |
| isPaymentMethodCheck | (bool) Determines if the used payment method is of type check. Applicable only when the payment is cash payment and the payment method is of type check. Internally determined. |
| loadingPoint | (string) The physical location where the goods are loaded. Defines the loading from the freight. The default is the supplier's address. |
| loadingPointAddress | (string) The physical location address where the goods are loaded. The default is the supplier's address. |
| loadingDateTime | (DateTimeOffset) The goods loading date and time from the loading physical location. The default is the invoice creation date and time. |
| loadingStreetName | (string) The street name of the physical location where the goods are loaded. The default is the supplier's address street name. |
| loadingBuildingNumber | (string) The building number of the physical location where the goods are loaded. The default is supplier address building number. |
| loadingPostalZone | (string) The postal zone of the physical location where the goods are loaded. The default is the supplier's address postal zone. |
| loadingCityName | (string) The city name of the physical location where the goods are loaded. The default is the supplier's address city name. |
| vehiclePlateNumber | (string) The vehicle plate used to transport the goods. |
| unloadingPoint | (string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is the company's physical location. |
| unloadingPointAddress | (string) The physical location address where the goods are unloaded. The default is the company's physical location address. |
| unloadingDateTime | (DateTimeOffset) The goods unloading date and time on the unloading physical location. |
| unloadingStreetName | (string) The street name of the physical location where the goods are unloaded. The default is the company's address street name. |
| unloadingBuildingNumber | (string) The building number of the physical location where the goods are unloaded. The default is the company's address building number. |
| unloadingPostalZone | (string) The postal zone of the physical location where the goods are unloaded. The default is the company's address postal zone. |
| unloadingCityName | (string) The city name of the physical location where the goods are unloaded. The default is the company's address city name. |
| dueDate | (DateTime) The due date. In some countries it is also known as law date. |
| accountingAltAddress | (string) The alternative accounting party address key to be used on the invoice. The alternative addresses keys are defined on the party additional addresses. When defined overrides the accounting party address and unloading address values.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service. |
| accountingSchema | (enum AccountingSchema) The accounting organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema. |
| partyAccountingSchema | (enum AccountingSchema) The supplier accounting organization method. The supplier organication can follow the rules of "Cash Accounting" or "Accrual Accounting".
See AccountingSchema. |
| notification | (string) The invoice notification configuration. Inferred from the invoice type.
(fk) Allowed value: the natural key of a record of type Notification. |
| emailTo | (string) The email(s) to send invoice notification. Inferred from the notification. |
| checkNumber | (int) The number of the check used for this invoice. Applicable only when the payment is cash payment and the payment method is of type check. |
| supplierAccount | (string) The supplier GL 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 supplier.
(fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service. |
| 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. |
| 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. |
| accountingDocument | (string) The accounting document that was assigned in accounting. |
| deliveryMode | (string) The invoice delivey mode. (ex: mail).
(fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service. |
| paymentReference | (string) The payment reference. |
| dimensionSetJson | (string) Dimension Set Json. |
| customsDeclaration | (string) The customs declaration. |
| swift | (string) The society for Worldwide Interbank Financial Telecommunication number. |
| iBAN | (string) The financial account's International Bank Account Number. |
| paymentInstruction | (string) The Payment authorization given by the party. |
| 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. |
InvoiceReturnOrder
The following elements are required:
| company | (string) Company. |
| document | (string) The source document key. |
InvoiceTaxResource
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 invoice's tax amount. Internally determined.
See MoneyResource . |
| isExempt | (bool) Indicates whether the invoice tax schema is exempt. Internally determined. |
| roundingTaxableAmount | (MoneyResource) The rounding value of the invoice amount of revenue subject to tax.
See MoneyResource . |
| roundingTaxAmount | (MoneyResource) The rounding value of the invoice tax amount. Internally determined.
See MoneyResource . |
| totalTaxableAmount | (MoneyResource) The total amount of revenue subject to tax.
See MoneyResource . |
| totalTaxAmount | (MoneyResource) The total invoice tax amount. Internally determined.
See MoneyResource . |
| taxTypeCode | (string) Invoice tax type code. Internally determined. |
| currency | (string) Money unit. Inferred from the invoice currency. Internally determined. |
The following elements are optional:
| taxPercentage | (decimal) Invoice tax rate. Internally determined. |
| exemptionReasonCode | (string) Indicates the invoice tax schema exemption reason. Applicable only if the tax schema is exempt. 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.
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |