API - Sales Credit Memos

This is a fork of page page 30038 "APIV2 - Sales Credit Memos" from version 23.3.14876.15704. Added support for Extra Values.

Object Definition

Object Type	Page
Object ID	70314159
Object Name	QWESR API - Sales Credit Memos
Source Table	Sales Cr. Memo Entity Buffer

API Definition

APIPublisher	smartApps
APIGroup	spider
APIVersion	v1.0
EntitySetName	salesCreditMemos
EntityName	salesCreditMemo

Service Enabled Procedures

Name	Description
Cancel(WebServiceActionContext)	Cancels a already posted Credit Memo.
CancelAndSend(WebServiceActionContext)	Cancels and sends the current Credit Memo.
Post(WebServiceActionContext)	Posts the current Credit Memo.
PostAndSend(WebServiceActionContext)	Posts and sends the current Credit Memo to customer.
Release(WebServiceActionContext)	Releases the current Credit Memo.
Reopen(WebServiceActionContext)	Reopens the current Credit Memo.
Send(WebServiceActionContext)	Sends the current Credit Memo to the customer.

Events

Name	Description
OnAfterInsert(Record "Sales Cr. Memo Entity Buffer"; Record "Sales Header"; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer])	Raised after a record is inserted.
OnAfterModify(Record "Sales Cr. Memo Entity Buffer"; Record "Sales Header"; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer])	Raised after a record is modified.
OnGetPostedSalesCreditMemoExtraValues(Record "Sales Cr. Memo Entity Buffer"; Record "Sales Cr.Memo Header"; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text)	Raised after a record is read from the database. This event is raised if the Credit Memo is posted. Makes it possible to set the ExtraValues 1..10, to be returned to the client.
OnGetSalesCreditMemoExtraValues(Record "Sales Cr. Memo Entity Buffer"; Record "Sales Header"; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text)	Raised after a record is read from the database. This event is raised if the Sales Credit Memo is not posted. Makes it possible to set the ExtraValues 1..10, to be returned to the client.

Example

Read

Get a list of Sales Credit Memos.

GET businesscentralPrefix/companies({id})/salesCreditMemos?$schemaversion=2.0

Get a single Sales Credit Memo and it's lines.

GET businesscentralPrefix/companies({id})/salesCreditMemos({id})?$expand=salesCreditMemoLines&$schemaversion=2.0

Create

Create a new Sales Credit Memo and a Sales Credit Memo Line.

POST businesscentralPrefix/companies({id})/salesCreditMemos?$expand=salesCreditMemoLines&$schemaversion=2.0
Content-type: application/json
{
   "customerNumber": "10000",
   "salesCreditMemoLines": [
       {
           "lineType": "Item",
           "lineObjectNumber": "1896-S",
           "quantity": 5
   	    }
   ]
}

Controls

Type	Name	Data Type	Read-only
Field	id	Guid	Yes
Field	number	Code[20]	Yes
Field	externalDocumentNumber	Code[35]
Field	creditMemoDate	Date
Field	postingDate	Date
Field	dueDate	Date
Field	customerId	Guid
Field	customerNumber	Code[20]
Field	customerName	Text[100]	Yes
Field	billToName	Text[100]	Yes
Field	billToCustomerId	Guid
Field	billToCustomerNumber	Code[20]
Field	sellToAddressLine1	Text[100]
Field	sellToAddressLine2	Text[50]
Field	sellToCity	Text[30]
Field	sellToCountry	Code[10]
Field	sellToState	Text[30]
Field	sellToPostCode	Code[20]
Field	billToAddressLine1	Text[100]
Field	billToAddressLine2	Text[50]
Field	billToCity	Text[30]
Field	billToCountry	Code[10]
Field	billToState	Text[30]
Field	billToPostCode	Code[20]
Field	shortcutDimension1Code	Code[20]
Field	shortcutDimension2Code	Code[20]
Field	currencyId	Guid
Field	currencyCode	Text
Field	paymentTermsId	Guid
Field	shipmentMethodId	Guid
Field	salesperson	Code[20]
Field	pricesIncludeTax	Boolean	Yes
Sub page	dimensionSetLines
Sub page	salesCreditMemoLines
Sub page	pdfDocument		Yes
Field	discountAmount	Decimal
Field	discountAppliedBeforeTax	Boolean	Yes
Field	totalAmountExcludingTax	Decimal	Yes
Field	totalTaxAmount	Decimal	Yes
Field	totalAmountIncludingTax	Decimal	Yes
Field	status	Enum "Sales Cr. Memo Entity Buffer Status"	Yes
Field	lastModifiedDateTime	DateTime	Yes
Field	invoiceId	Guid
Field	invoiceNumber	Code[20]
Field	phoneNumber	Text[30]
Field	email	Text[80]
Field	customerReturnReasonId	Guid
Field	extraValue1	Text
Field	extraValue2	Text
Field	extraValue3	Text
Field	extraValue4	Text
Field	extraValue5	Text
Field	extraValue6	Text
Field	extraValue7	Text
Field	extraValue8	Text
Field	extraValue9	Text
Field	extraValue10	Text
Sub page	attachments
Sub page	documentAttachments

This documentation is generated from Spider v27.0