Sales Credit Memo
This service is to recieve posted sales credit memos from Business Central.
Service Endpoint
The base Endpoint is:
OutboundSalesCreditMemoIISWebService/OutboundSalesCreditMemoIISWebService
API Methods
Here are the available methods for the Sales Credit Memo Service:
- GetSalesCreditMemo
- GetSalesCreditMemoByDate
- GetSalesCreditMemoAsPDF
GetSalesCreditMemo
Sample Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:out="http://tempuri.org/OutboundSalesCreditMemoIISWebService/"
xmlns:x53="urn:microsoft-dynamics-nav/xmlports/x5371208">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/OutboundSalesCreditMemoIISWebService/OutboundSalesCreditMemoIISWebService/GetSalesCreditMemo</wsa:Action>
</soap:Header>
<soap:Body>
<out:GetSalesCreditMemo>
<out:outboundSalesCreditMemo/>
<out:fromDocNo>1</out:fromDocNo>
<out:customerNo>10000</out:customerNo>
<out:maxEntries>1</out:maxEntries>
<out:showDetails>false</out:showDetails>
</out:GetSalesCreditMemo>
</soap:Body>
</soap:Envelope>
Sample Response
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/OutboundSalesCreditMemoIISWebService/OutboundSalesCreditMemoIISWebService/GetSalesCreditMemoResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetSalesCreditMemoResponse xmlns="http://tempuri.org/OutboundSalesCreditMemoIISWebService/">
<outboundSalesCreditMemo>
<Sales_Credit_Memo xmlns="urn:microsoft-dynamics-nav/xmlports/x5371208">
<Amount>0</Amount>
<Total_Amount>0</Total_Amount>
<Invoice_Discount_Amount>0</Invoice_Discount_Amount>
<VAT_Amount>0</VAT_Amount>
<Amount_Incl_VAT>0</Amount_Incl_VAT>
<Header_General>
<Document_No>104001</Document_No>
<Document_Date>2017-01-15</Document_Date>
<Shipment_Method_Code/>
<Currency_Code/>
<External_Document_No/>
<Payment_Method_Code/>
</Header_General>
<Header_Sell_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Sell_To_Customer>
<Header_Bill_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Bill_To_Customer>
<Header_Ship_To_Customer>
<Code/>
<Name>Blaues Warenlager</Name>
<Name_2/>
<Address>Süd-Ost-Straße 3</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Ship_To_Customer>
</Sales_Credit_Memo>
</outboundSalesCreditMemo>
</GetSalesCreditMemoResponse>
</s:Body>
</s:Envelope>
GetSalesCreditMemoByDate
Sample Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:out="http://tempuri.org/OutboundSalesCreditMemoIISWebService/"
xmlns:x53="urn:microsoft-dynamics-nav/xmlports/x5371208">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/OutboundSalesCreditMemoIISWebService/OutboundSalesCreditMemoIISWebService/GetSalesCreditMemoByDate</wsa:Action>
</soap:Header>
<soap:Body>
<out:GetSalesCreditMemoByDate>
<out:outboundSalesCreditMemo/>
<out:fromDocNo>1</out:fromDocNo>
<out:customerNo>10000</out:customerNo>
<out:maxEntries>1</out:maxEntries>
<out:showDetails>true</out:showDetails>
<out:fromDate>2016-01-01</out:fromDate>
<out:toDate>2017-04-14</out:toDate>
</out:GetSalesCreditMemoByDate>
</soap:Body>
</soap:Envelope>
Sample Response
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/OutboundSalesCreditMemoIISWebService/OutboundSalesCreditMemoIISWebService/GetSalesCreditMemoByDateResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetSalesCreditMemoByDateResponse xmlns="http://tempuri.org/OutboundSalesCreditMemoIISWebService/">
<outboundSalesCreditMemo>
<Sales_Credit_Memo xmlns="urn:microsoft-dynamics-nav/xmlports/x5371208">
<Amount>382</Amount>
<Total_Amount>362.9</Total_Amount>
<Invoice_Discount_Amount>19.1</Invoice_Discount_Amount>
<VAT_Amount>68.95</VAT_Amount>
<Amount_Incl_VAT>431.85</Amount_Incl_VAT>
<Header_General>
<Document_No>104001</Document_No>
<Document_Date>2017-01-15</Document_Date>
<Shipment_Method_Code/>
<Currency_Code/>
<External_Document_No/>
<Payment_Method_Code/>
</Header_General>
<Header_Sell_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Sell_To_Customer>
<Header_Bill_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Bill_To_Customer>
<Header_Ship_To_Customer>
<Code/>
<Name>Blaues Warenlager</Name>
<Name_2/>
<Address>Süd-Ost-Straße 3</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Ship_To_Customer>
<Sales_CrMemo_Lines>
<Sales_CrMemo_Line>
<Line_No>10000</Line_No>
<Type>2</Type>
<No>1968-S</No>
<Variant_Code/>
<Description>MEXICO Bürostuhl, schwarz</Description>
<Description_2/>
<Quantity>2</Quantity>
<Unit_Of_Measure_Code>STÜCK</Unit_Of_Measure_Code>
<Line_Amount>362.90</Line_Amount>
<Line_Amount_Incl_VAT>431.85</Line_Amount_Incl_VAT>
<Shipment_Date>2017-01-15</Shipment_Date>
<Unit_Price>191.00</Unit_Price>
</Sales_CrMemo_Line>
</Sales_CrMemo_Lines>
</Sales_Credit_Memo>
</outboundSalesCreditMemo>
</GetSalesCreditMemoByDateResponse>
</s:Body>
</s:Envelope>
GetSalesCreditMemoAsPDF
Sample Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:out="http://tempuri.org/OutboundSalesCreditMemoIISWebService/">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/OutboundSalesCreditMemoIISWebService/OutboundSalesCreditMemoIISWebService/GetSalesCreditMemoAsPDF</wsa:Action>
</soap:Header>
<soap:Body>
<out:GetSalesCreditMemoAsPDF>
<!--Optional:-->
<out:documentNo>104001</out:documentNo>
<!--Optional:-->
<out:resultBase64String></out:resultBase64String>
</out:GetSalesCreditMemoAsPDF>
</soap:Body>
</soap:Envelope>
Sample Response
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/OutboundSalesCreditMemoIISWebService/OutboundSalesCreditMemoIISWebService/GetSalesCreditMemoAsPDFResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetSalesCreditMemoAsPDFResponse xmlns="http://tempuri.org/OutboundSalesCreditMemoIISWebService/">
<GetSalesCreditMemoAsPDFResult/>
<resultBase64String> BASE 64 encoded string </resultBase64String>
</GetSalesCreditMemoAsPDFResponse>
</s:Body>
</s:Envelope>
| Name |
Description |
Type |
max. Length |
Occurance |
| Amount |
Amount without invoice discount |
Decimal |
|
0..1 |
| Total_Amount |
Amount incl. invoice discount |
Decimal |
|
0..1 |
| Invoice_Discount_Amount |
Invoice discount amount |
Decimal |
|
0..1 |
| Total_VAT_Amount |
Total VAT amount |
Decimal |
|
0..1 |
| Amount_Incl_VAT |
Amount incl. VAT |
Decimal |
|
0..1 |
| Name |
Description |
Type |
max. Length |
Occurance |
| 🔑 Document No* |
Specifies the number of the Sales Credit Memo. Leave this empty when creating a new invoice. (Requieres auto incremented no. series in Business Central.) |
String |
20 |
1..1 |
| Document_Date |
Specifies the Document DateTime. Date is saved in NAV/Business Central only! |
DateTime |
|
0..1 |
| Shipment_Method_Code |
Specifies a default shipment method code for the order. Get a list of codes from the Master Data Service |
String |
50 |
0..1 |
| Currency_Code |
Specifies a default currency code for the invoice. Get a list of codes from the Master Data Service |
String |
10 |
0..1 |
| Shipping_Agent_Code |
Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service |
String |
10 |
0..1 |
| Shipping_Agent_Service_Code |
Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service |
String |
10 |
0..1 |
| Customer_Order_No |
Specifies the customer's order no. |
String |
20 |
0..1 |
| External_Document_No |
Specifies the external document no. This must be unique in NAV/Business Central. You'll receive an error when insert two orders with the same external document no. |
String |
35 |
0..1 |
| Payment_Method_Code |
Specifies a default payment method code for the invoice. Get a list of codes from the Master Data Service |
String |
10 |
0..1 |
| Prices_Incl_VAT |
Specifies the price to be incl. VAT |
Boolean |
|
0..1 |
| Name |
Description |
Type |
max. Length |
Occurance |
| Customer_No |
Specifies the number of the customer. |
String |
20 |
1..1 |
| Contact_No |
Specifies the number of the contact. |
String |
20 |
1..1 |
| Code |
Specifies the Ship-to Address Codes. |
String |
10 |
0..1 |
| Name |
Specifies the name. |
String |
50 |
0..1 |
| Name_2 |
Specifies the additional name. |
String |
50 |
0..1 |
| Address |
Specifies the address. i.E. 'Hauptstraße 12b' |
String |
50 |
1..1 |
| Address_2 |
Specifies the add. address information. |
String |
50 |
1..1 |
| City |
Specifies the city. |
String |
30 |
1..1 |
| Post_Code |
Specifies a code for the post code of the address. Get a list of codes from the Master Data Service |
String |
10 |
0..1 |
| Country_Region_Code |
Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service |
String |
10 |
0..1 |
| Name |
Description |
Type |
max. Length |
Occurance |
| 🔑 Line No* |
Specifies the pos. number. |
Decimal |
|
1..1 |
| Type |
Specifies the Type: "Item", "Resource", "G/L Account" |
String |
|
0..1 |
| No |
Specifies the No. i.E. Item No. "70000" |
String |
20 |
0..1 |
| Variant_Code |
Specifies the item variant code |
String |
10 |
0..1 |
| Description |
Specifies the Description. |
String |
50 |
0..1 |
| Description_2 |
Specifies the additional Description. |
String |
50 |
0..1 |
| Unit_Of_Measure_Code |
Specifies the sales unit of measure of the item. |
String |
10 |
0..1 |
| Quantity |
Specifies the quantity. |
Decimal |
|
1..1 |
| Line_Amount |
Specifies the lines amount |
Decimal |
|
0..1 |
| Line_Amount_Incl_VAT |
Specifies the lines amount incl. VAT. |
Decimal |
|
0..1 |
| Line_Discount_Percent |
Specifies the lines discount percentage. |
Decimal |
|
0..1 |
| Line_Discount_Amount |
Specifies the lines discount amount. |
Decimal |
|
0..1 |
| Shipment_Date |
Specifies the lines shipment date. |
DateTime |
|
0..1 |
| Unit_Price |
Specifies the lines unit price |
Decimal |
|
0..1 |