Sage 50 US Customer Credit Memo XML
The Import Customer Credit Memos task allows you to create new customer credit memos in Sage 50 US. We recommend that the ExternalId field be populated by the unique id of the customer from the external system, Zynk uses this field to track credit memos already imported to prevent duplicates being created in Sage.
Tasks
XML
Any Sage fields not documented below are not supported with our exports, if there are additional fields you need contact us at [email protected].
Complete import file for creating a sales orders:-
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomerCreditMemo>
<CustomerCreditMemo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExternalId>123</ExternalId>
<ReferenceNumber>CCM4001</ReferenceNumber>
<Date>2015-03-15T00:00:00</Date>
<AccountReference>11000-00</AccountReference>
<TermsDescription>2% 10, Net 30 Days</TermsDescription>
<InternalNote />
<DiscountAmount>1.2000000000000000000</DiscountAmount>
<CustomerReference>SNOWDEN</CustomerReference>
<SalesRepresentativeReference>SPRICHARD</SalesRepresentativeReference>
<AmountDue>0.0000000000000000000</AmountDue>
<CustomerNote />
<CustomerPurchaseOrderNumber>213456</CustomerPurchaseOrderNumber>
<DateDue>2015-03-18T00:00:00</DateDue>
<DiscountDate>2015-03-16T00:00:00</DiscountDate>
<FreightAccountReference>57500-00</FreightAccountReference>
<FreightAmount>0</FreightAmount>
<PrintCustomerNoteAfterLineItems>false</PrintCustomerNoteAfterLineItems>
<ReturnAuthorization />
<SalesTaxAmount>0.0000000000000000000</SalesTaxAmount>
<SalesTaxCodeReference>GAGWINN</SalesTaxCodeReference>
<StatementNote />
<CustomerCreditMemoInvoiceLines>
<CustomerCreditMemoInvoiceLine>
<AccountReference>40000-LS</AccountReference>
<Description>Lawn and Turf Care Service</Description>
<InventoryItemReference>FERT-16160</InventoryItemReference>
<InvoiceReference>10209</InvoiceReference>
<Quantity>1</Quantity>
<UnitPrice>9.99</UnitPrice>
</CustomerCreditMemoInvoiceLine>
</CustomerCreditMemoInvoiceLines>
<CustomerCreditMemoSalesLines />
</CustomerCreditMemo>
</ArrayOfCustomerCreditMemo>
Specifying The Customer Record
When importing credit memos, you must specify the customer record to create the credit memo against. This is done by providing the customer reference in the XML, as shown in the example below.
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomerCreditMemo>
<CustomerCreditMemo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CustomerReference>SNOWDEN</CustomerReference>
</CustomerCreditMemo>
</ArrayOfCustomerCreditMemo>
In each of the following sections most of the XML has been omitted to make the samples easier to read. The sections have been broken up into the various sections of the credit memo record as viewed within Sage 50 US.
Main Credit Memo Fields
The below will let you specify the main fields required for a credit memo record.
Sage Field | XML Field | Example | Field Type | Field Length | Input |
---|---|---|---|---|---|
N/A | ExternalId | 123 | string | 255 | Optional |
Customer ID | CustomerReference | SNOWDEN | string | 20 | Required, must exist in Sage as a customer |
Credit date | Date | 2015-03-15T00:00:00 | datetime | - | Optional, defaults to day of import |
Due date | DateDue | 2015-04-15T00:00:00 | datetime | - | Optional |
Credit No.* | ReferenceNumber | CCM4001 | string | - | Optional |
Customer PO | CustomerPurchaseOrderNumber | 213456 | string | 20 | Optional |
Sales rep* | SalesRepresentativeReference | SPRICHARD | string | 20 | Optional |
Return authorization | ReturnAuthorization | Yes | string | - | Optional |
Terms | TermsDescription | Net 30 Days | string | - | Optional |
Sales tax* | SalesTaxCodeReference | GAGWINN | string | 8 | Optional |
Freight | FreightAmount | 1.00 | decimal | - | Optional |
A/R account* | AccountReference | 11000-00 | string | 15 | Optional |
N/A | DiscountAmount | 1.00 | decimal | 15 | Optional |
N/A | DiscountDate | 2015-03-16T00:00:00 | string | 15 | Optional |
Customer Note | CustomerNote | Leave by the door | string | 2000 | Optional |
Print* | PrintCustomerNoteAfterLineItems | false | bool | - | Optional |
Internal Note | InternalNote | Leave by the door | string | 2000 | Optional |
Statement Note | StatementNote | Leave by the door | string | 160 | Optional |
- Credit No.* - if provided, the value must be unique. If left blank the next available number from Sage will be used
- Sales rep* - can only be what you have setup in Sage under Maintain Employees & Sales Reps.
- Sales Tax* - can only be what you have setup in Sage under Maintain -> Sales Taxes
- A/R account* - can only be what you have setup in Sage under Maintain Chart of Accounts.
- Print* - set to false to use print Before Line Items, set to true to use print After Line Items
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomerCreditMemo>
<CustomerCreditMemo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ExternalId>123</ExternalId>
<CustomerReference>SNOWDEN</CustomerReference>
<Date>2015-03-15T00:00:00</Date>
<DateDue>2015-04-15T00:00:00</DateDue>
<ReferenceNumber>CCM4001</ReferenceNumber>
<CustomerPurchaseOrderNumber>213456</CustomerPurchaseOrderNumber>
<SalesRepresentativeReference>SPRICHARD</SalesRepresentativeReference>
<ReturnAuthorization>Yes</ReturnAuthorization>
<TermsDescription>Net 30 Days</TermsDescription>
<SalesTaxCodeReference>GAGWINN</SalesTaxCodeReference>
<FreightAmount>1.00</FreightAmount>
<AccountReference>11000-00</AccountReference>
<DiscountAmount>1.00</DiscountAmount>
<DiscountDate>2015-03-16T00:00:00</DiscountDate>
<CustomerNote>Leave by the door</CustomerNote>
<PrintCustomerNoteAfterLineItems>false</PrintCustomerNoteAfterLineItems>
<InternalNote>Leave by the door<InternalNote>
<StatementNote>Leave by the door</StatementNote>
</CustomerCreditMemo>
</ArrayOfCustomerCreditMemo>
Apply To Invoice Line Fields
The below will let you specify the invoice item line fields required for a credit memo. You can provide multiple CustomerCreditMemoInvoiceLine entries in the CustomerCreditMemoInvoiceLines node.
Sage Field | XML Field | Example | Field Type | Field Length | Input |
---|---|---|---|---|---|
Invoice | InvoiceReference | 10209 | string | 20 | Required, unless InventoryItemReference is blank |
Item | InventoryItemReference | FERT-16160 | string | 20 | Optional |
Quantity | Quantity | 1 | decimal | - | Optional |
Description | Description | Lawn and Turf Care Service | string | 30 | Optional |
Unit Price | UnitPrice | 9.99 | decimal | - | Optional, must be 0 if Quantity is 0 |
Job* | JobReference | SHARP | string | 20 | Optional |
GL Account* | AccountReference | 40000-LS | string | 15 | Optional |
- Job* - can only be what you have setup in Sage under Maintain Jobs.
- GL Account* - can only be what you have setup in Sage under Maintain Chart of Accounts.
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomerCreditMemo>
<CustomerCreditMemo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CustomerCreditMemoInvoiceLines>
<CustomerCreditMemoInvoiceLine>
<InvoiceReference>10209</InvoiceReference>
<InventoryItemReference>FERT-16160</InventoryItemReference>
<Quantity>1</Quantity>
<Description>Lawn and Turf Care Service</Description>
<UnitPrice>9.99</UnitPrice>
<JobReference>SHARP</JobReference>
<AccountReference>40000-LS</AccountReference>
</CustomerCreditMemoInvoiceLine>
</CustomerCreditMemoInvoiceLines>
</CustomerCreditMemo>
</ArrayOfCustomerCreditMemo>
Apply To Sales Line Fields
The below will let you specify the sales item line fields required for a credit memo. You can provide multiple CustomerCreditMemoSalesLine entries in the CustomerCreditMemoSalesLines node.
Sage Field | XML Field | Example | Field Type | Field Length | Input |
---|---|---|---|---|---|
Quantity | Quantity | 1 | decimal | - | Optional |
Item | InventoryItemReference | FERT-16160 | string | 20 | Optional |
Description | Description | Lawn and Turf Care Service | string | 30 | Optional |
Unit Price | UnitPrice | 9.99 | decimal | - | Optional, must be 0 if Quantity is 0 |
Tax | SalesTaxType | 1 | int | - | Optional |
Job* | JobReference | SHARP | string | 20 | Optional |
GL Account* | AccountReference | 40000-LS | string | 15 | Optional |
- Job* - can only be what you have setup in Sage under Maintain Jobs.
- GL Account* - can only be what you have setup in Sage under Maintain Chart of Accounts.
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomerCreditMemo>
<CustomerCreditMemo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CustomerCreditMemoSalesLines>
<CustomerCreditMemoSalesLine>
<Quantity>1</Quantity>
<InventoryItemReference>FERT-16160</InventoryItemReference>
<Description>Lawn and Turf Care Service</Description>
<UnitPrice>9.99</UnitPrice>
<SalesTaxType>1</SalesTaxType>
<JobReference>SHARP</JobReference>
<AccountReference>40000-LS</AccountReference>
</CustomerCreditMemoSalesLine>
</CustomerCreditMemoSalesLines>
</CustomerCreditMemo>
</ArrayOfCustomerCreditMemo>