AP Invoice Credit Memo (XML)
| Element | Parent | Required | Data Type | Description | Valid Values | Default |
|---|---|---|---|---|---|---|
| APInvoiceAndCreditMemo | ||||||
| Transaction | APInvoiceAndCreditMemo | |||||
| Properties | Transaction | |||||
| TransactionID | Transaction | No | VARCHAR(25) | The unique internal ID of the Transaction. | Next available number in the transaction class which is default retrieved from the Transaction Type. | |
| TransactionDate | Properties | Yes | DATETIME | The date of the transaction. | Any valid date. | |
| TransactionType | Properties | Yes | VARCHAR(20) | The type of transaction. Indicating whether it's a Credit memo or an invoice. | Invoice, credit memo. | |
| VendorID | Properties | Yes | VARCHAR(50) | The unique ID of the vendor. | All 'Active' AP Vendors. | |
| Document Number | Properties | Yes | VARCHAR(50) | The document number of the invoice or credit memo. | Must be unique by VendorID and Transaction Type. | |
| PurchaseOrderID | Properties | No | VARCHAR(50) | The Reference value of the transaction. This can be used to specify a purchase order number that is not setup in NorthScope for example. | NULL | |
| PaymentTerm | Properties | No | VARCHAR(20) | The payment term of the invoice or credit memo. | Vendor Payment Term | |
| Description | Properties | No | VARCHAR(60) | The description of the invoice or credit memo. | NULL | |
| GLDate | Properties | No | DATE | The GL Date of the invoice or credit memo. | Any valid date. | If not submitted, it defaults to the TransactionDate |
| DueDate | Properties | No | DATETIME | The due date of the invoice or credit memo. | If we have a a payment term available, we will calculate due date based on the due date days in the payment term. | |
| DiscountDate | Properties | No | DATETIME | The discount date of the invoice or credit memo. | If we have a payment term available, we will calculate the discount date days in the payment term. | |
| IsOnHold | Properties | No | VARCHAR(5) | Indicates whether or not the invoice or credit memo is on hold. | true, false. | FALSE |
| CurrencyID | Properties | No | VARCHAR(15) | The currency of the invoice or credit memo. If a value is supplied it must match the Vendor Currency. | Z-AUD, Z-C$, Z-NZD, Z-UK, Z-SGD, Z-SA, Z-US$, USD, CAD | Vendor currency, then Company Currency. |
| TransactionStatusName | Properties | No | VARCHAR(50) | The name of the status we want the transaction to be saved to. | New, Approved, Ready to Post. | New. |
| CompanyID | Properties | Yes | VARCHAR(10) | This is the ID of the company that you are sending data for. This company ID should match the entry in the database table name ERPx_MFDataEntityCompany for the Company ID column. | ||
| AttributeList | Transaction | |||||
| Attribute | AttributeList | |||||
| AttributeID | Attribute | No | VARCHAR(25) | The unique ID of the attribute in NorthScope. | Must be a valid Attribute that is visible to the transaction type (either a credit memo/invoice). | |
| Value | Attribute | No | VARCHAR(200) | The value of the attribute. | For DateTime type attributes, the value must be in the following format to display correctly on the transaction: 'YYYY-MM-DD HH:MM:00' For example, 2022-06-21 12:15:00 will be displayed on the transaction as 06/20/2022 12:15PM if the users date preference format is set to MM/DD/YYYY. | |
| TransactionLineList | Transaction | |||||
| TransactionLine | TransactionLineList | |||||
| POLineSK | TransactionLine | No | BIGINT | The unique key value that is assigned to the line item on the linked Purchase Order record. | Must be a valid line item on an open Purchase Order record. | |
| ItemID | TransactionLine | Yes | VARCHAR(50) | The ID of the Item for the corresponding line. | Must be a valid active Item that is configured in the system. | |
| POLineNumber | TransactionLine | No | BIGINT | The Line number of the corresponding item on the linked Purchase Order record. | ||
| LineDescription | TransactionLine | Yes | VARCHAR(200) | Description of the line item. | ||
| Quantity | TransactionLine | Yes | NUMERIC(18,5) | The quantity on the line item. Must be bigger than or equal to 0. | If 0.00 the transaction Status must be New. | |
QuantityUOMID | TransactionLine | Yes | VARCHAR(10) | The unit of measure for the line item. | Must be valid UOM for the company (kg, gr, lbs, etc.) | |
| Price | TransactionLine | Yes | NUMERIC(18,5) | The price of the line item. Must be bigger than or equal to 0. | ||
| AccountNumber | TransactionLine | No | VARCHAR(75) | The account number of the line item. When blank or empty, it will default to the Vendor Account. | Vendor Purchase Account | |
| ToDistributionAccountType | TransactionLine | No | VARCHAR(25) | The type of the distribution account. When this is present, ToDistributionAccount should also be filled in. | Employee, AP Vendor, Project. | NULL |
| ToDistributionAccount | TransactionLine | No | VARCHAR(100) | The unique ID of the distribution account. When the Distribution Account Type Employee, we expect the name of an employee here, when AP Vendor, the name of the Vendor, and when Project, the name of the project. | Must be a valid value |
Example XML
<APInvoiceAndCreditMemo>
<Transaction TransactionID="">
<Properties>
<TransactionID>INV1000</TransactionID>
<TransactionDate>4/22/2019</TransactionDate>
<TransactionType>Invoice</TransactionType>
<VendorID>MYVENDORIF</VendorID>
<DocumentNumber>AE23456</DocumentNumber>
<PurchaseOrderID>25-1485</PurchaseOrderID>
<PaymentTerm>Net 30</PaymentTerm>
<Description>Supplies</Description>
<GLDate>4/22/2019</GLDate>
<DueDate>5/22/2019</DueDate>
<DiscountDate/>
<IsOnHold>false</IsOnHold>
<CurrencyID>USD</CurrencyID>
<TransactionStatusName>Ready to Post</TransactionStatusName>
<CompanyID>XYZ</CompanyID>
</Properties>
<AttributeList>
<Attribute>
<AttributeID>Subject to Use Tax</AttributeID>
<Value>Yes</Value>
</Attribute>
</AttributeList>
<TransactionLineList>
<TransactionLine>
<POLineSK>1234</POLineSK>
<ItemID>10010</ItemID>
<POLineNumber>20</POLineNumber>
<LineDescription>Case Printer Paper</LineDescription>
<Quantity>2.00</Quantity>
<Price>50.25</Price>
<AccountNumber>10-5980-20</AccountNumber>
<ToDistributionAccount>John Johnson</ToDistributionAccount>
<ToDistributionAccountType>AP Vendor</ToDistributionAccountType>
</TransactionLine>
<TransactionLine>
<POLineSK>1235</POLineSK>
<ItemID>10011</ItemID>
<POLineNumber>30</POLineNumber>
<LineDescription>Printer Ink</LineDescription>
<Quantity>25.00</Quantity>
<Price>15.75</Price>
<AccountNumber>10-5980-30</AccountNumber>
<ToDistributionAccount>David Williams</ToDistributionAccount>
<ToDistributionAccountType>AP Vendor</ToDistributionAccountType>
</TransactionLine>
</TransactionLineList>
</Transaction>
</APInvoiceAndCreditMemo>