Purchases | Invoice Receipt Notification
Service to manage entities of type 'InvoiceReceiptNotification'.
Overview
URL | api/{tenantKey}/{orgKey}/invoiceReceipt/invoiceReceiptNotifications |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive InvoiceReceiptNotification
- PUT Set InvoiceReceiptNotificationKey InvoiceReceiptNotification
- PUT Set Company InvoiceReceiptNotification
- PUT Set Currency InvoiceReceiptNotification
- PUT Set InvoiceType InvoiceReceiptNotification
- PUT Set MemoType InvoiceReceiptNotification
- PUT Set DeliveryTerm InvoiceReceiptNotification
- PUT Set SellerSupplierParty InvoiceReceiptNotification
- PUT Set SellerSupplierPartyName InvoiceReceiptNotification
- PUT Set SellerSupplierPartyTaxId InvoiceReceiptNotification
- PUT Set SellerSupplierPartyAddress InvoiceReceiptNotification
- PUT Set AccountingParty InvoiceReceiptNotification
- PUT Set AccountingPartyName InvoiceReceiptNotification
- PUT Set AccountingPartyTaxId InvoiceReceiptNotification
- PUT Set AccountingPartyAddress InvoiceReceiptNotification
- PUT Set Discount InvoiceReceiptNotification
- PUT Set PaymentMethod InvoiceReceiptNotification
- PUT Set PaymentTerm InvoiceReceiptNotification
- PUT Set TaxIncluded InvoiceReceiptNotification
- PUT Set DocumentStatus InvoiceReceiptNotification
- PUT Set InvoiceReceiptNotificationDate InvoiceReceiptNotification
- PUT Set LoadingPoint InvoiceReceiptNotification
- PUT Set LoadingPointAddress InvoiceReceiptNotification
- PUT Set LoadingStreetName InvoiceReceiptNotification
- PUT Set LoadingBuildingNumber InvoiceReceiptNotification
- PUT Set LoadingPostalZone InvoiceReceiptNotification
- PUT Set LoadingCityName InvoiceReceiptNotification
- PUT Set LoadingCountry InvoiceReceiptNotification
- PUT Set UnloadingPoint InvoiceReceiptNotification
- PUT Set UnloadingPointAddress InvoiceReceiptNotification
- PUT Set UnloadingStreetName InvoiceReceiptNotification
- PUT Set UnloadingBuildingNumber InvoiceReceiptNotification
- PUT Set UnloadingPostalZone InvoiceReceiptNotification
- PUT Set UnloadingCityName InvoiceReceiptNotification
- PUT Set UnloadingCountry InvoiceReceiptNotification
- PUT Set SourceDoc InvoiceReceiptNotification
- PUT Set SourceDocId InvoiceReceiptNotification
- PUT Set SourceDocDate InvoiceReceiptNotification
- PUT Set GoodsReceiptNote InvoiceReceiptNotification
- PUT Set GoodsReceiptNoteId InvoiceReceiptNotification
- PUT Set DiscountInValueAmount InvoiceReceiptNotification
- PUT Set PurchasesItem InvoiceReceiptNotificationLine
- PUT Set Description InvoiceReceiptNotificationLine
- PUT Set ComplementaryDescription InvoiceReceiptNotificationLine
- PUT Set Quantity InvoiceReceiptNotificationLine
- PUT Set UnitPrice InvoiceReceiptNotificationLine
- PUT Set Unit InvoiceReceiptNotificationLine
- PUT Set Discount1 InvoiceReceiptNotificationLine
- PUT Set Discount2 InvoiceReceiptNotificationLine
- PUT Set Discount3 InvoiceReceiptNotificationLine
- PUT Set Warehouse InvoiceReceiptNotificationLine
- PUT Set PartyTaxSchema InvoiceReceiptNotificationLine
- PUT Set ItemTaxSchema InvoiceReceiptNotificationLine
- PUT Set Currency InvoiceReceiptNotificationLine
- PUT Set DocumentLineStatus InvoiceReceiptNotificationLine
- PUT Set SourceSchemaEntity InvoiceReceiptNotificationLine
- PUT Set SourceDocId InvoiceReceiptNotificationLine
- PUT Set SourceDoc InvoiceReceiptNotificationLine
- PUT Set SourceDocLine InvoiceReceiptNotificationLine
- PUT Set SourceDocLineId InvoiceReceiptNotificationLine
- PUT Set SourceDocNature InvoiceReceiptNotificationLine
- PUT Set GoodsReceiptNoteSchemaEntity InvoiceReceiptNotificationLine
- PUT Set GoodsReceiptNote InvoiceReceiptNotificationLine
- PUT Set GoodsReceiptNoteId InvoiceReceiptNotificationLine
- PUT Set GoodsReceiptNoteLine InvoiceReceiptNotificationLine
- PUT Set GoodsReceiptNoteLineId InvoiceReceiptNotificationLine
- PUT Set CommitmentReference InvoiceReceiptNotificationLine
- DELETE:
All Resources
This service uses the following resources:
- ApiInvoiceReceiptNotificationInvoiceReceiptNotificationLinesResource
- ApiInvoiceReceiptNotificationResource
- InvoiceReceiptNotificationResource
- MoneyResource
All Enumerations
This service uses the following enumerations:
GET InvoiceReceiptNotifications (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See InvoiceReceiptNotificationResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET InvoiceReceiptNotification 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 InvoiceReceiptNotificationResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET InvoiceReceiptNotification by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
Response:
When successful, the response body contains the entity record. See InvoiceReceiptNotificationResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST InvoiceReceiptNotifications
Creates a new entity record.
The following elements are required:
invoiceReceiptNotificationResource | (ApiInvoiceReceiptNotificationResource) The request body should contain the entity record that should be created. See ApiInvoiceReceiptNotificationResource. |
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 ApiInvoiceReceiptNotificationResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Invoice Receipt Notif. Line
Inserts a new 'Invoice Receipt Notif. Line' in the 'Invoice Receipt Notification'.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (ApiInvoiceReceiptNotificationInvoiceReceiptNotificationLinesResource) The ApiInvoiceReceiptNotificationInvoiceReceiptNotificationLinesResource instance. See ApiInvoiceReceiptNotificationInvoiceReceiptNotificationLinesResource. |
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:
PUT Set AccountingParty InvoiceReceiptNotification
Updates the value of attribute 'AccountingParty' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AccountingPartyAddress InvoiceReceiptNotification
Updates the value of attribute 'AccountingPartyAddress' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AccountingPartyName InvoiceReceiptNotification
Updates the value of attribute 'AccountingPartyName' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AccountingPartyTaxId InvoiceReceiptNotification
Updates the value of attribute 'AccountingPartyTaxId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CommitmentReference InvoiceReceiptNotificationLine
Updates the value of attribute 'CommitmentReference' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Company InvoiceReceiptNotification
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ComplementaryDescription InvoiceReceiptNotificationLine
Updates the value of attribute 'ComplementaryDescription' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Currency InvoiceReceiptNotification
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Currency InvoiceReceiptNotificationLine
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DeliveryTerm InvoiceReceiptNotification
Updates the value of attribute 'DeliveryTerm' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description InvoiceReceiptNotificationLine
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Discount InvoiceReceiptNotification
Updates the value of attribute 'Discount' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Discount1 InvoiceReceiptNotificationLine
Updates the value of attribute 'Discount1' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Discount2 InvoiceReceiptNotificationLine
Updates the value of attribute 'Discount2' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Discount3 InvoiceReceiptNotificationLine
Updates the value of attribute 'Discount3' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DiscountInValueAmount InvoiceReceiptNotification
Updates the value of attribute 'DiscountInValueAmount' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DocumentLineStatus InvoiceReceiptNotificationLine
Updates the value of attribute 'DocumentLineStatus' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set DocumentStatus InvoiceReceiptNotification
Updates the value of attribute 'DocumentStatus' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (enum DocumentStatus) The request body should contain the new value for the attribute. See DocumentStatus. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set GoodsReceiptNote InvoiceReceiptNotification
Updates the value of attribute 'GoodsReceiptNote' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set GoodsReceiptNote InvoiceReceiptNotificationLine
Updates the value of attribute 'GoodsReceiptNote' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set GoodsReceiptNoteId InvoiceReceiptNotification
Updates the value of attribute 'GoodsReceiptNoteId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set GoodsReceiptNoteId InvoiceReceiptNotificationLine
Updates the value of attribute 'GoodsReceiptNoteId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set GoodsReceiptNoteLine InvoiceReceiptNotificationLine
Updates the value of attribute 'GoodsReceiptNoteLine' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set GoodsReceiptNoteLineId InvoiceReceiptNotificationLine
Updates the value of attribute 'GoodsReceiptNoteLineId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set GoodsReceiptNoteSchemaEntity InvoiceReceiptNotificationLine
Updates the value of attribute 'GoodsReceiptNoteSchemaEntity' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set InvoiceReceiptNotificationDate InvoiceReceiptNotification
Updates the value of attribute 'InvoiceReceiptNotificationDate' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (DateTime) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set InvoiceReceiptNotificationKey InvoiceReceiptNotification
Updates the value of attribute 'InvoiceReceiptNotificationKey' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
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:
PUT Set InvoiceType InvoiceReceiptNotification
Updates the value of attribute 'InvoiceType' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive InvoiceReceiptNotification
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set ItemTaxSchema InvoiceReceiptNotificationLine
Updates the value of attribute 'ItemTaxSchema' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LoadingBuildingNumber InvoiceReceiptNotification
Updates the value of attribute 'LoadingBuildingNumber' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LoadingCityName InvoiceReceiptNotification
Updates the value of attribute 'LoadingCityName' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LoadingCountry InvoiceReceiptNotification
Updates the value of attribute 'LoadingCountry' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LoadingPoint InvoiceReceiptNotification
Updates the value of attribute 'LoadingPoint' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LoadingPointAddress InvoiceReceiptNotification
Updates the value of attribute 'LoadingPointAddress' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LoadingPostalZone InvoiceReceiptNotification
Updates the value of attribute 'LoadingPostalZone' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LoadingStreetName InvoiceReceiptNotification
Updates the value of attribute 'LoadingStreetName' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MemoType InvoiceReceiptNotification
Updates the value of attribute 'MemoType' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PartyTaxSchema InvoiceReceiptNotificationLine
Updates the value of attribute 'PartyTaxSchema' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PaymentMethod InvoiceReceiptNotification
Updates the value of attribute 'PaymentMethod' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PaymentTerm InvoiceReceiptNotification
Updates the value of attribute 'PaymentTerm' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PurchasesItem InvoiceReceiptNotificationLine
Updates the value of attribute 'PurchasesItem' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Quantity InvoiceReceiptNotificationLine
Updates the value of attribute 'Quantity' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SellerSupplierParty InvoiceReceiptNotification
Updates the value of attribute 'SellerSupplierParty' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SellerSupplierPartyAddress InvoiceReceiptNotification
Updates the value of attribute 'SellerSupplierPartyAddress' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SellerSupplierPartyName InvoiceReceiptNotification
Updates the value of attribute 'SellerSupplierPartyName' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SellerSupplierPartyTaxId InvoiceReceiptNotification
Updates the value of attribute 'SellerSupplierPartyTaxId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SourceDoc InvoiceReceiptNotification
Updates the value of attribute 'SourceDoc' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SourceDoc InvoiceReceiptNotificationLine
Updates the value of attribute 'SourceDoc' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SourceDocDate InvoiceReceiptNotification
Updates the value of attribute 'SourceDocDate' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set SourceDocId InvoiceReceiptNotification
Updates the value of attribute 'SourceDocId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set SourceDocId InvoiceReceiptNotificationLine
Updates the value of attribute 'SourceDocId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set SourceDocLine InvoiceReceiptNotificationLine
Updates the value of attribute 'SourceDocLine' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set SourceDocLineId InvoiceReceiptNotificationLine
Updates the value of attribute 'SourceDocLineId' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
PUT Set SourceDocNature InvoiceReceiptNotificationLine
Updates the value of attribute 'SourceDocNature' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (enum OrderNature) The request body should contain the new value for the attribute. See OrderNature. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SourceSchemaEntity InvoiceReceiptNotificationLine
Updates the value of attribute 'SourceSchemaEntity' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TaxIncluded InvoiceReceiptNotification
Updates the value of attribute 'TaxIncluded' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Unit InvoiceReceiptNotificationLine
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnitPrice InvoiceReceiptNotificationLine
Updates the value of attribute 'UnitPrice' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnloadingBuildingNumber InvoiceReceiptNotification
Updates the value of attribute 'UnloadingBuildingNumber' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnloadingCityName InvoiceReceiptNotification
Updates the value of attribute 'UnloadingCityName' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnloadingCountry InvoiceReceiptNotification
Updates the value of attribute 'UnloadingCountry' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnloadingPoint InvoiceReceiptNotification
Updates the value of attribute 'UnloadingPoint' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnloadingPointAddress InvoiceReceiptNotification
Updates the value of attribute 'UnloadingPointAddress' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnloadingPostalZone InvoiceReceiptNotification
Updates the value of attribute 'UnloadingPostalZone' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnloadingStreetName InvoiceReceiptNotification
Updates the value of attribute 'UnloadingStreetName' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Warehouse InvoiceReceiptNotificationLine
Updates the value of attribute 'Warehouse' in the specified entity record.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. 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:
DELETE Invoice Receipt Notif. Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
companyKey | (string) The company key. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE InvoiceReceiptNotification by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE InvoiceReceiptNotification by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiInvoiceReceiptNotificationInvoiceReceiptNotificationLinesResource
The following elements are required:
purchasesItem | (string) The purchase item representing the good or service included on the document. Infered from the original document. |
unitPrice | (MoneyResource) The purchase item unit price. Infered from the original document.
See MoneyResource . |
unit | (string) The purchase item unit. Infered from the original document. |
partyTaxSchema | (string) The supplier party tax schema. The tax schema identifies the group of taxes a party is liable for. Infered from the original document. |
itemTaxSchema | (string) The purchase item tax schema. The tax schema identifies the group of taxes a item is liable for. |
currency | (string) Money unit. |
The following elements are optional:
description | (string) The purchase item description. Infered from the original document. |
complementaryDescription | (string) The purchase item complementary description. Infered from the original document. |
quantity | (decimal) The purchase item quantity. Infered from the original document. |
discount1 | (decimal) The purchase item discount 1 percetange. Infered from the original document. |
discount2 | (decimal) The purchase item discount 2 percetange. Infered from the original document. |
discount3 | (decimal) The purchase item discount 3 percetange. Infered from the original document. |
warehouse | (string) The purchase item whare house. Infered from the original document. |
documentLineStatus | (enum DocumentLineStatus) The document’s line status.
See DocumentLineStatus. |
sourceSchemaEntity | (string) The schema entity from originating document. Internally determined. |
sourceDocId | (Guid) The unique identitifer of the source document. Infered from the invoice receipt notification. |
sourceDoc | (string) The source document using the format { |
sourceDocLine | (int) The source document line number. Internally determined. |
sourceDocLineId | (Guid) The unique identifier of the source document line. Internally determined. |
sourceDocNature | (enum OrderNature) The nature of the source document. Infered from the original document.
See OrderNature. |
goodsReceiptNoteSchemaEntity | (string) Infered from the original document. |
goodsReceiptNote | (string) The goods receipt notification that originated this invoice receipt notification line. Internally determined. |
goodsReceiptNoteId | (Guid) The unique identifier of the goods receipt notification that originated this invoice receipt notification line. Internally determined. |
goodsReceiptNoteLine | (int) The line number of the goods receipt notification line that originated this invoice receipt notification line. Internally determined. |
goodsReceiptNoteLineId | (Guid) The unique identifier of the goods receipt notification line that originated this invoice receipt notification line. Internally determined. |
commitmentReference | (string) Commitment Reference. |
ApiInvoiceReceiptNotificationResource
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
company | (string) The company code is the central organizational unit within the system. Infered from the original document. |
currency | (string) The money unit used. Infered from the original delivery. |
sellerSupplierParty | (string) The supplier designated in the memo as the party to whom the memo is sell to. Infered from the original document. |
accountingParty | (string) The supplier designated in the invoice as the party to whom the invoice should be sent. Infered from the original document. |
paymentMethod | (string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the supplier party. |
paymentTerm | (string) The term specifying the manner in which a trade will be done. Infered from the original document. |
invoiceReceiptNotificationDate | (DateTime) The date of then invoice receipt notification document. |
The following elements are optional:
invoiceType | (string) Defines the invoice document type. Depends on the order document type (value is set only if is not a return order). Internally determinated. |
memoType | (string) Defines the memo document type. Depends on the order document type (value is set only if is a return order). Internally determinated. |
deliveryTerm | (string) The conditions in a sales or transportation contract that specify the means of transportation. Infered from the original document. |
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 supplier party. |
accountingPartyTaxId | (string) The accounting party tax code. It is inferred from the accounting supplier party. |
accountingPartyAddress | (string) The accounting party tax address. It is inferred from the accounting supplier party. |
discount | (decimal) The discount percentage. Infered from the original document. |
taxIncluded | (bool) Indicates whether the unit prices have taxes included or not. Infered from the source document. |
documentStatus | (enum DocumentStatus) The document status. Internally determined.
See DocumentStatus. |
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. |
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. |
loadingCountry | (string) The country of the physical location where the goods are loaded. The default is the supplier's address country. |
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. |
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. |
unloadingCountry | (string) The country of the physical location where the goods are unloaded. The default is the company's address country. |
sourceDoc | (string) The source document using the format { |
sourceDocId | (Guid) The unique identitifer of the source document. Internally determined. |
sourceDocDate | (DateTimeOffset) The source document date. Internally determined. |
goodsReceiptNote | (string) The goods receipt note document using the format { |
goodsReceiptNoteId | (Guid) The unique identifier of the goods receipt note document. Internally determined. |
invoiceReceiptNotificationLines | (List of ApiInvoiceReceiptNotificationInvoiceReceiptNotificationLinesResource) The invoice receipt notification lines.
See ApiInvoiceReceiptNotificationInvoiceReceiptNotificationLinesResource. |
discountInValueAmount | (decimal) The discount in value. Infered from the original document. |
InvoiceReceiptNotificationResource
The following elements are required:
invoiceReceiptNotificationKey | (int) The sequential number internally determined that uniquely identifies the invoice invoice receipt notification. The document natural key. |
company | (string) The company code is the central organizational unit within the system. Infered from the original document.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
currency | (string) The money unit used. Infered from the original delivery.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
sellerSupplierParty | (string) The supplier designated in the memo as the party to whom the memo is sell to. Infered from the original document.
(fk) Allowed value: the natural key of a record of type SupplierParty. These records are accessibly through the SupplierParties service. |
accountingParty | (string) The supplier designated in the invoice as the party to whom the invoice should be sent. Infered from the original document.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties 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. |
paymentTerm | (string) The term specifying the manner in which a trade will be done. Infered from the original document.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service. |
invoiceReceiptNotificationDate | (DateTime) The date of then invoice receipt notification document. |
The following elements are optional:
invoiceType | (string) Defines the invoice document type. Depends on the order document type (value is set only if is not a return order). Internally determinated.
(fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service. |
memoType | (string) Defines the memo document type. Depends on the order document type (value is set only if is a return order). Internally determinated.
(fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service. |
deliveryTerm | (string) The conditions in a sales or transportation contract that specify the means of transportation. Infered from the original document.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service. |
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 supplier party. |
accountingPartyTaxId | (string) The accounting party tax code. It is inferred from the accounting supplier party. |
accountingPartyAddress | (string) The accounting party tax address. It is inferred from the accounting supplier party. |
discount | (decimal) The discount percentage. Infered from the original document. |
taxIncluded | (bool) Indicates whether the unit prices have taxes included or not. Infered from the source document. |
documentStatus | (enum DocumentStatus) The document status. Internally determined.
See DocumentStatus. |
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. |
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. |
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. |
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. |
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. |
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. |
sourceDoc | (string) The source document using the format { |
sourceDocId | (Guid) The unique identitifer of the source document. Internally determined. |
sourceDocDate | (DateTimeOffset) The source document date. Internally determined. |
goodsReceiptNote | (string) The goods receipt note document using the format { |
goodsReceiptNoteId | (Guid) The unique identifier of the goods receipt note document. Internally determined. |
invoiceReceiptNotificationLines | (List of InvoiceReceiptNotificationLineResource) The invoice receipt notification lines.
See InvoiceReceiptNotificationLineResource. |
discountInValueAmount | (decimal) The discount in value. Infered from the original document. |
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.