*API field name refers to field names for XML, JSON, and CSV field names.
| EDI Field | Logicbroker/API Field | Description | Requirement |
|---|---|---|---|
|
N/A |
Identifier.SourceKey |
Identifier that will come from the source system; typically this will match the PartnerPO. |
Read Only |
|
N/A |
Identifier.LogicbrokerKey |
ID to identify the document in the logicbroker system. |
Read Only |
|
N/A |
Identifier.LinkKey |
Used to link the document to the original source document. For example, It is best to supply the Order's linkkey when posting a shipment. This will make sure the order shipped quanitites are updated on the original order and all statuses are updated appropriateley. |
Optional |
|
N/A |
SenderCompanyId |
Logicbroker Internal Company ID to specify what company is sending the document. |
Required |
|
N/A |
ReceiverCompanyId |
Logicbroker Internal Company ID to specify what company is to receive the document. |
Required |
|
BIG01 |
InvoiceDate |
Date of the invoice. |
Required |
|
BIG02 |
InvoiceNumber |
Number to identify the unique invoice document. |
Required |
|
N/A |
DocumentDate |
Read Only |
|
|
BIG03 |
OrderDate |
Date on the Purchase Order |
Optional - will be pulled from original order if not provided |
|
BIG04 |
PartnerPO |
This will be the purchase order number, this will be the main Key to link all your documents. This should match the order. |
Required |
|
CUR02 (SE) |
Currency |
Currency code to identify all values on the invoice. If no value is provided "USD" will be assumed. |
Optional |
|
SAC05 (C*G821) |
HandlingAmount |
Shipping and handling total to be charged on the invoice, this is part of the invoice total. |
Optional |
|
TDS02 |
InvoiceTotal |
Invoice total includes, full amount to be paid including line totals, shipping, taxes and discounts. Will be automatically calculated if no value is provided. |
Required |
|
REF02 (CO) |
OrderNumber |
Contains the end customer's order number, this will be used on the packing slip. |
Optional |
|
REF02 (IA) |
VendorNumber |
This is the internal vendor number provided to the supplier from the merchant. If available it is always recommended to send. |
Optional |
|
N9:MSG01 (L1*Notes) |
Note |
This will include any important internal messages or notes on the invoice. |
Optional |
|
SAC05 (A*C310) |
Discounts.DiscountAmount |
Will include the total discount, and will be used to calculate the invoice total. |
Optional |
|
ITD03 |
Discounts.DiscountPercent |
Discount percent will be used as part of the payment terms. It will be used with the discount due date and discount days due. |
Optional - will be pulled from original order if not provided |
|
SAC05 (C*H850) |
Taxes.TaxAmount |
This will be the an tax amount used to calculate the invoice total amount. |
Optional |
|
ITD04 |
PaymentTerm.DiscountDueDate |
Discount due date when discount will be applied. |
Optional - will be pulled from original order if not provided |
|
ITD05 |
PaymentTerm.DiscountInNumberOfDays |
Discount days due when discount will be applied. |
Optional - will be pulled from original order if not provided |
|
N/A |
PaymentTerm.EffectiveDate |
Date when the Payment terms begin. |
Optional |
|
ITD06 |
PaymentTerm.DueDate |
Date in which the invoice is due, before additional charges are accrued. |
Optional - will be pulled from original order if not provided |
|
ITD07 |
PaymentTerm.PayInNumberOfDays |
Number of days in which the invoice is due, before additional charges are accrued. |
Optional - will be pulled from original order if not provided |
|
ITD08 |
PaymentTerm.AvailableDiscount |
The total amount of discount available if the terms are met. |
Optional |
|
ITD12 |
PaymentTerm.TermsDescription |
Description of the payment terms. This will be a free form description. |
Optional |
|
N102 (RI) |
RemitToAddress.CompanyName |
Remit to address is only required if you do not have a business rule setup to default your remit to address. |
Required |
|
N201 (RI) |
RemitToAddress.FirstName |
Optional |
|
|
N202 (RI) |
RemitToAddress.LastName |
Optional |
|
|
N301 (RI) |
RemitToAddress.Address1 |
Required |
|
|
N302 (RI) |
RemitToAddress.Address2 |
Optional |
|
|
N401 (RI) |
RemitToAddress.City |
Required |
|
|
N402 (RI) |
RemitToAddress.State |
Required |
|
|
N404 (RI) |
RemitToAddress.Country |
Required |
|
|
N403 (RI) |
RemitToAddress.Zip |
Required |
|
|
N104 (RI*92) |
RemitToAddress.AddressCode |
Optional |
|
|
N1:PER06 (TE) |
RemitToAddress.Phone |
Optional |
|
|
N1:PER04 (EM) |
RemitToAddress.Email |
Optional |
|
|
SAC05 (A*ZZZZ) |
ExtendedAttribute.Allowance - ZZZ |
Used to indicate an additional detailed allowance. The Code as shown in the example ZZZ will correspond to what type of allowance. See specific partner details for the applicable codes. These will be deducted automatically in the invoice total calculation. |
Optional |
|
SAC05 (C*ZZZZ) |
ExtendedAttribute.Charge - ZZZ |
Used to indicate an additional detailed charge. The Code as shown in the example ZZZ will correspond to what type of charge. See specific partner details for the applicable codes. These will be added automatically in the invoice total calculation. |
Optional |
|
IT101 |
InvoiceLine.LineNumber |
Line Number from the Order. If not provided this will be taked from the order automatically. |
Required |
|
IT104 |
InvoiceLine.Price |
Unit cost that the merchant is being billed for that line. |
Required |
|
IT105 |
InvoiceLine.PriceCode |
Used to indicate the price level for the product. See specific partner details for applicable codes. |
Optional |
|
IT102 |
InvoiceLine.Quantity |
Contains the quantity of items to be invoiced. |
Required |
|
IT103 |
InvoiceLine.QuantityUOM |
Unit of Measure for the quantity invoiced. See partner's details for specifics. |
Required |
|
IT1:CTP03 (RTL) |
InvoiceLine.MSRP |
Optional |
|
|
IT1:PID05 (08) |
InvoiceLine.Description |
Standard short description or name of the product. |
Optional |
|
IT109 (IN) |
InvoiceLine.ItemIdentifier.PartnerSKU |
The Item identifier that is internal to the purchaser/merchant. |
Conditional - if received on an order this value should be returned |
|
IT107 (VN) |
InvoiceLine.ItemIdentifier.SupplierSKU |
The Item Identifier that is used by the supplier or the person fulfilling the product. This will always contain a value. |
Required |
|
IT110 (UP) |
InvoiceLine.ItemIdentifier.UPC |
Typically the U.P.C Consumer Package code will be provided; however additional standardized codes can be provided here as well. See specific partner instructions for details. |
Conditional - if received on an order this value should be returned |
|
N/A |
InvoiceLine.ItemIdentifier.ManufacturerSKU |
Manufacturer's ID for the product. |
Conditional - if received on an order this value should be returned |
|
IT1:SAC05 (C*H850) |
InvoiceLine.Taxes.TaxAmount |
Item Level Tax amount |
Optional |
History:
3/14/2019 - Original specification added