Jasmin Developers - Web API Reference

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:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET InvoiceReceiptNotifications

Returns the list of all the entity records available.

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 /invoiceReceipt/invoiceReceiptNotifications

GET InvoiceReceiptNotifications (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 InvoiceReceiptNotificationResource.

Response status codes:

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

Resource URL:

GET /invoiceReceipt/invoiceReceiptNotifications?page={page}&pageSize={pageSize}

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 /invoiceReceipt/invoiceReceiptNotifications/{id}

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:

GET /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}

GET Print InvoiceReceiptNotification by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

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

GET Print InvoiceReceiptNotification by key

Prints the specified entity record.

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.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/print

GET Original Print InvoiceReceiptNotificationOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

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

GET Original Print InvoiceReceiptNotification by key

Prints the specified entity record.

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.

The following elements are optional:

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

Response:

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

Response status codes:

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

Resource URL:

GET /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/printOriginal

POST Operations

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 /invoiceReceipt/invoiceReceiptNotifications

POST Invoice Receipt Notification

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:

POST /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines

PUT Operations

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/accountingParty

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/accountingPartyAddress

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/accountingPartyName

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/accountingPartyTaxId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/commitmentReference

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/company

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/complementaryDescription

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/currency

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/currency

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/deliveryTerm

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/description

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/discount

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/discount1

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/discount2

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/discount3

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/discountInValueAmount

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/documentLineStatus

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/documentStatus

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/goodsReceiptNote

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/goodsReceiptNote

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/goodsReceiptNoteId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/goodsReceiptNoteId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/goodsReceiptNoteLine

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/goodsReceiptNoteLineId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/goodsReceiptNoteSchemaEntity

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationDate

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationKey

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceType

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/isActive

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/itemTaxSchema

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/loadingBuildingNumber

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/loadingCityName

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/loadingCountry

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/loadingPoint

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/loadingPointAddress

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/loadingPostalZone

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/loadingStreetName

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/memoType

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/partyTaxSchema

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/paymentMethod

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/paymentTerm

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/purchasesItem

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/quantity

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/sellerSupplierParty

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/sellerSupplierPartyAddress

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/sellerSupplierPartyName

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/sellerSupplierPartyTaxId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/sourceDoc

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/sourceDoc

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/sourceDocDate

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/sourceDocId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/sourceDocId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/sourceDocLine

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/sourceDocLineId

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/sourceDocNature

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/sourceSchemaEntity

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/taxIncluded

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/unit

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/unitPrice

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/unloadingBuildingNumber

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/unloadingCityName

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/unloadingCountry

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/unloadingPoint

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/unloadingPointAddress

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/unloadingPostalZone

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/unloadingStreetName

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:

PUT /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}/warehouse

DELETE Operations

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 /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}/invoiceReceiptNotificationLines/{lineId}

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 /invoiceReceipt/invoiceReceiptNotifications/{id}

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:

DELETE /invoiceReceipt/invoiceReceiptNotifications/{companyKey}/{invoiceReceiptNotificationKey}

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 (decimal) The purchase item unit price. Infered from the original document.
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 {..}. Infered from the invoice receipt notification.
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 {..}. The source document is usually the order (either standard or return). Internally determined.
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 {..}. Internally determined.
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.


InvoiceReceiptNotificationLineResource

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 (decimal) The purchase item unit price. Infered from the original document.
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.
itemType (enum ItemType) The purchases item type. Infered from the original document.
See ItemType.

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 {..}. Infered from the invoice receipt notification.
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.


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 {..}. The source document is usually the order (either standard or return). Internally determined.
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 {..}. Internally determined.
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.


Enumerations


DocumentLineStatus

1 Open
2 Completed


DocumentStatus

1 Open
2 Completed


ItemType

1 Item
2 Service
3 SpecialSalesTaxes
4 Tax
5 Other


OrderNature

1 StandardOrder
2 ReturnOrder