The Invoice JSON object defines an invoice in the Dsco system.
- Make sure you're familiar with JSON before continuing.
- The JSON objects are defined using Orderly. Optional attrs end with a "?" all others are required.
- isodate fields use one of these ISO 8601 format: 2014-01-01T10:30:00.000+01:00, 2014-01-01T10:30:00.000+0100, 2014-01-01T10:30:00.000Z
- Dsco reserves the right to add new attributes at any time so Partners should ensure their validators won't break should this happen
Definition
Object { string dscoInvoiceId?; # DSCO's unique ID for the invoice string invoiceId; # The supplier-provided unique ID for the invoice string poNumber; # The associated order's PO Number double totalAmount; # The total amount of the invoice isodate invoiceDate?; # The date of the invoice string currencyCode?; # The currency code of the currency used in the invoice double lineItemsSubtotal?; # The subtotal of the line items double subtotalExcludingLineItems?; # The subtotal excluding line items int numberOfLineItems?; # The number of line items double handlingAmount?; # The handling amount double freightAmount?; # The freight amount double salesTaxAmount?; # The sales tax amount string buyerId?; # The buyer ID string sellerId?; # The seller ID string sellerInvoiceNumber?; # The seller's invoice number string supplierOrderNumber?; # The supplier's order number string consumerOrderNumber?; # The consumer's order number string externalBatchId?; # The ID of the batch this invoice is part of array{ref InvoiceCharge} charges?; # The charges of the invoice ref InvoiceTerms terms?; # The invoice's terms ref InvoiceShipFromTo shipFrom?; # The from address information ref InvoiceShipFromTo shipTo?; # The to address information ref InvoiceShipInfo ship?; # The shipping information array{ref InvoiceLineItem} lineItems?; # The line items of the invoice double dscoExpectedOrdeTotalAmount?; # Subtotal of the associated order (SUM(cost * qty) for all order line-items) double dscoExpectedOrderTotalDifference?; # totalAmount - expectedOrderTotalAmount int dscoOrderId?; # The associated order's Dsco order ID string dscoStatus[created]?; # The status of the invoice; today this value is not used int dscoRetailerId?; # The associated retailers Dsco's retailer ID int dscoSupplierId?; # The associated supplier's Dsco's supplier ID string dscoTradingPartnerId?; # Dsco's trading partner ID string dscoTradingPartnerName?; # Dsco's trading partner name isodate dscoCreateDate?; # Dsco's order creation date isodate dscoLastUpdate?; # Dsco's last update to order string dscoRetailerName?; # Added in V2 string dscoSupplierName?; # Added in V2 string requestedWarehouseCode?; #Added in V2 - supplier-provided string requestedWarehouseRetailerCode?; #Added in V2 - retailer code for # supplier's warehouse string requestedWarehouseDscoId?; # Added in V2 - Dsco ID of supplier's # warehouse };
Example
{ "dscoInvoiceId": "asfs92342klsdfsf", "invoiceId": "88823242", "poNumber": "abcdefygsa", "totalAmount": 28.21, "dscoExpectedOrderTotalAmount": 28.21, "dscoExpectedOrderTotalDifference": 0, "dscoOrderId": 234242, "dscoStatus": "created", "dscoRetailerId": 98221, "dscoSupplierId": 96251, "dscoCreateDate": "2014-01-01T10:30:00+01:00", "dscoLastUpdate": "2014-01-01T10:30:00+01:00" }
Comments
Please sign in to leave a comment.