receipts

receipts.find

Returns the receipts that meet the given conditions.

JS
CR.api('commerce.receipts.find', request, function(response) { … });
HTTP
POST /open2b/api/v3/commerce.receipts.find

request

{
  "conditions" : { // returns only the receipts …
    "ids" : [ "4722038952549247063", … ], // … with these identifiers - bigint(1…)
    "status" : "Open", // … with this status, can be "Open", "Sent", "Disputed", "Archived", "Cancelled" - string
    "fromNumber" : "7890", // … with a number greater or equal to this - string(1…32)
    "toNumber" : "8152", // … with a number lower ot equal to this - string(1…32)
    "fromCreationTime" : "2013-09-01 12:00:00", // … with creation time equal or next to this - datetime
    "toCreationTime" : "2013-12-31 23:59:59", // … with creation time equal or previous to this - datetime
    "fromUpdateTime" : "2013-05-01 12:00:00", // … with last update time equal or previous to this - datetime
    "toUpdateTime" : "2013-12-31 23:59:59", // … with last update time equal or next to this - datetime
    "fromIssueDate" : "2013-05-01 12:00:00", // … issue date equal or next to this - date
    "toIssueDate" : "2013-12-31 23:59:59", // … issue date equal or previous to this - date
    "customer" : 4907, // … of this customer (id) - int(1…)
    "address" : "Baker Street" // … with this phrase in the address - string(1…30)
  },
  "fields" : [ "number", "status", … ], // returns only these fields - string
  "order" : [ "number" ], // sort order of returned receipts, can contain "id", "-id", "number", "-number", "status", "-status",
                          // "creationTime", "-creationTime", "updateTime", "-updateTime", "issueDate", "-issueDate",
                          // "total", "-total", "taxedTotal", "-taxedTotal", "customerName" and "-customerName" - string
  "limit" : 10, // maximum number of receipts to return - int(1…100)
  "first" : 0 // index of the first receipt to return - int(0…)
}

response

{
  "status" : "ok",
  "receipts" : [ {
    "id" : "4722038952549247063", // identifier - bigint(1…)
    "number" : "2013/7496", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Sent", "Disputed", "Archived" or "Cancelled" - string
    "creationTime" : "2013-09-03 13:13:47", // creation time - datetime
    "updateTime" : "2013-09-03 16:08:11", // last update time - datetime
    "issueDate" : "2013-09-03", // issue date - date
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 4907, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp", // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem"  // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "taxArea" : 7, // tax area (id) used for tax calculations - int(1…)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…32)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "totalPrice" : 168.99, // total price (excluded taxes) - decimal[10,2]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "taxCode" : "VAT", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 112.66, // tax amount - decimal[10,2]
      "requests" : "…" // customer requests - string(0…255)
    }, … ],
    "prediscountSubtotal" : 69.54, // prediscount subtotal - decimal[10,2]
    "taxedPrediscountSubtotal" : 110.89, // prediscount subtotal, taxes included - decimal[10,2]
    "discountAmount" : 0.000, // discount amount - decimal[8,3](0…)
    "discountPercent" : 15.340, // discount percent - decimal[5,3](0…)
    "subtotal" : 69.54, // subtotal - decimal[10,2]
    "taxedSubtotal" : 110.89, // subtotal, taxes included - decimal[10,2]
    "shippingMethod" : { // shipping method (can be null)
      "id" : 14, // identifier - int(1…)
      "name" : "FedEx", // name - string(0…80)
      "cost" : 8.57, // cost - decimal[8,2](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 1.63 // amount of tax - decimal[8,2](0…)
    },
    "paymentMethod" : { // payment method (can be null)
      "id" : 3, // identifier - int(1…)
      "name" : "Credit Card", // name - string(0…80)
      "cost" : 1.20, // cost (fee) - decimal[8,2](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 0.23 // amount of tax - decimal[8,2](0…)
    },
    "taxAmount" : 31.25, // tax amount - decimal[10,2]
    "total" : 89.23, // total - decimal[10,2]
    "taxedTotal" : 120.48, // total, taxes included - decimal[10,2]
    "quantity" : 7.00, // total number of items quantity - decimal[10,2](0…)
    "weight" : 1.351, // total weight of items - decimal[8,3](0…)
    "customerName" : "Investigations Inc", // customer's name ( last and first name or company name ) - string(1…100)
    "billingAddress" : { // billing address
      "firstName" : "Sherlock", // first name - string(1…25)
      "lastName" : "Holmes", // last name - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(3…120)
    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name - string(1…100)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) - string(2)
    },
    "sellerAddress" : { // seller address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)
    },
    "terms" : "" // terms and conditions - string(0…65535)
  }, … ]
}

receipts.get

Returns a receipt given its identifier.

JS
CR.api('commerce.receipts.get', request, function(response) { … });
HTTP
POST /open2b/api/v3/commerce.receipts.get

request

{
  "id" : "4722038952549247063", // identifier (required) - bigint(1…)
  "fields" : [ "number", "status", … ]  // Fields to return - string
}

response

{
  "status" : "ok",
  "receipt" : { // (can be null)
    "id" : "4722038952549247063", // identifier - bigint(1…)
    "number" : "2013/7496", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Sent", "Disputed", "Archived" or "Cancelled" - string
    "creationTime" : "2013-09-03 13:13:47", // creation time - datetime
    "updateTime" : "2013-09-03 16:08:11", // last update time - datetime
    "issueDate" : "2013-09-03", // issue date - date
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 4907, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp", // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem"  // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "taxArea" : 7, // tax area (id) used for tax calculations - int(1…)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…32)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "totalPrice" : 168.99, // total price (excluded taxes) - decimal[10,2]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "taxCode" : "VAT", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 112.66, // tax amount - decimal[10,2]
      "requests" : "…" // customer requests - string(0…255)
    }, … ],
    "prediscountSubtotal" : 69.54, // prediscount subtotal - decimal[10,2]
    "taxedPrediscountSubtotal" : 110.89, // prediscount subtotal, taxes included - decimal[10,2]
    "discountAmount" : 0.000, // discount amount - decimal[8,3](0…)
    "discountPercent" : 15.340, // discount percent - decimal[5,3](0…)
    "subtotal" : 69.54, // subtotal - decimal[10,2]
    "taxedSubtotal" : 110.89, // subtotal, taxes included - decimal[10,2]
    "shippingMethod" : { // shipping method (can be null)
      "id" : 14, // identifier - int(1…)
      "name" : "FedEx", // name - string(0…80)
      "cost" : 8.57, // cost - decimal[8,2](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 1.63 // amount of tax - decimal[8,2](0…)
    },
    "paymentMethod" : { // payment method (can be null)
      "id" : 3, // identifier - int(1…)
      "name" : "Credit Card", // name - string(0…80)
      "cost" : 1.20, // cost (fee) - decimal[8,2](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 0.23 // amount of tax - decimal[8,2](0…)
    },
    "taxAmount" : 31.25, // tax amount - decimal[10,2]
    "total" : 89.23, // total - decimal[10,2]
    "taxedTotal" : 120.48, // total, taxes included - decimal[10,2]
    "quantity" : 7.00, // total number of items quantity - decimal[10,2](0…)
    "weight" : 1.351, // total weight of items - decimal[8,3](0…)
    "customerName" : "Investigations Inc", // customer's name ( last and first name or company name ) - string(1…100)
    "billingAddress" : { // billing address
      "firstName" : "Sherlock", // first name - string(1…25)
      "lastName" : "Holmes", // last name - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(3…120)
    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name - string(1…100)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) - string(2)
    },
    "sellerAddress" : { // seller address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)
    },
    "terms" : "" // terms and conditions - string(0…65535)
  }
}

receipts.count

Number of receipts that meet the given conditions.

JS
CR.api('commerce.receipts.count', request, function(response) { … });
HTTP
POST /open2b/api/v3/commerce.receipts.count

request

{
  "conditions" : { // counts the receipts …
    "ids" : [ "4722038952549247063", … ], // … with these identifiers - bigint(1…)
    "status" : "Open", // … with this status, can be "Open", "Sent", "Disputed", "Archived", "Cancelled" - string
    "fromNumber" : "7890", // … with a number greater or equal to this - string(1…32)
    "toNumber" : "8152", // … with a number lower ot equal to this - string(1…32)
    "fromCreationTime" : "2013-09-01 12:00:00", // … with creation time equal or next to this - datetime
    "toCreationTime" : "2013-12-31 23:59:59", // … with creation time equal or previous to this - datetime
    "fromUpdateTime" : "2013-05-01 12:00:00", // … with last update time equal or previous to this - datetime
    "toUpdateTime" : "2013-12-31 23:59:59", // … with last update time equal or next to this - datetime
    "fromIssueDate" : "2013-05-01 12:00:00", // … issue date equal or next to this - date
    "toIssueDate" : "2013-12-31 23:59:59", // … issue date equal or previous to this - date
    "customer" : 4907, // … of this customer (id) - int(1…)
    "address" : "Baker Street" // … with this phrase in the address - string(1…30)
  }
}

response

{
  "status" : "ok",
  "count" : 547 // number of receipts - int(0…)
}

receipts.create

Creates a new receipt.

JS
CR.api('commerce.receipts.create', request, function(response) { … });
HTTP
POST /open2b/api/v3/commerce.receipts.create

request

{
  "receipt" : { // receipt to create (required)
    "number" : "2013/7496", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Sent", "Disputed", "Archived" or "Cancelled" - string
    "creationTime" : "2013-09-02 12:00:00", // creation time, if empty it takes the current time - datetime
    "issueDate" : "2013-09-03", // issue date - date
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 4907, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp", // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem" // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…32)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "requests" : "…" // customer requests - string(0…255)
    }, … ],
    "discountAmount" : 0.000, // discount amount - decimal[8,3](0…)
    "discountPercent" : 5.200, // discount percent - decimal[5,3](0…)
    "shippingMethod" : 3, // shipping method (id) (can be null) - int(1…)
    "paymentMethod" : 8, // payment method (id) (can be null) - int(1…)
    "billingAddress" : { // billing address (required)
      "firstName" : "Sherlock", // first name (required) - string(1…25)
      "lastName" : "Holmes", // last name (required) - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city  (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) (required) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address (required) - string(3…120)
    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name (required) - string(1…100)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) (required) - string(2)
    },
    "sellerAddress" : { // seller address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)
    },
    "terms" : "" // terms and conditions - string(0…65535)
  }
}

response

{
  "status" : "ok",
  "id" : "4722038952549247063" // identifier of the new receipt - bigint(1…)
}

Errors

Field Type Description
number AlreadyExist Number <number> already exists
creationTime MissingCombination 'creationTime' is required if 'number' is provided
creationTime InvalidValue Creation time '<creationTime>' is in the future
creationTime InvalidValue Creation time '<creationTime>' is greater than the creation time of the next receipt
locale NotFound Locale '<locale>' does not exist
customer NotFound Customer <customer> does not exist
country InvalidValue No tax areas for country '<country>'
taxClass NotFound Tax class <taxClass> does not exist
shippingMethod MissingCombination Shipping method is required because the payment method is on delivery
shippingMethod InvalidValue Shipping method <shippingMethod> is not suitable for this receipt
paymentMethod InvalidValue Payment method <paymentMethod> is not suitable for this receipt
paymentMethod InvalidValue Payment method <paymentMethod> and shipping method <shippingMethod> are not compatible

Notes

  • Per le precedenti ricevute da importare, tutti i number e creationTime devono essere coerenti.
  • Non indicare rounding se si vuole utilizzare l'impostazione globale.
  • Non indicare taxArea se si vuole che venga determinata automaticamente in base agli indirizzi di fatturazione e spedizione.

receipts.update

Updates a receipt. Any fields left out of the request will remain unchanged.

JS
CR.api('commerce.receipts.update', request, function(response) { … });
HTTP
POST /open2b/api/v3/commerce.receipts.update

request

{
  "id" : "4722038952549247063", // identifier of the receipt to update (required) - bigint(1…)
  "receipt" : { // receipt's fields to update (required)
    "number" : "2013/7496", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Sent", "Disputed", "Archived" or "Cancelled" - string
    "creationTime" : "2013-09-02 12:00:00", // creation time - datetime
    "issueDate" : "2013-09-03", // issue date - date
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 4907, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp", // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem" // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…32)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "requests" : "…" // customer requests - string(0…255)
    }, … ],
    "discountAmount" : 0.000, // discount amount - decimal[8,3](0…)
    "discountPercent" : 5.200, // discount percent - decimal[5,3](0…)
    "shippingMethod" : 5, // shipping method (id) (can be null) - int(1…)
    "paymentMethod" : 3, // payment method (id) (can be null) - int(1…)
    "billingAddress" : { // billing address
      "firstName" : "Sherlock", // first name (required) - string(1…25)
      "lastName" : "Holmes", // last name (required) - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city  (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) (required) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address (required) - string(3…120)
    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name (required) - string(1…100)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) (required) - string(2)
    },
    "sellingAddress" : { // selling address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)
    },
    "terms" : "" // terms and conditions - string(0…65535)
  }
}

response

{
  "status" : "ok"
}

Errors

Field Type Description
number NotFound Number <number> does not exist
customer NotFound Customer <customer> does not exist
taxClass NotFound Tax class <taxClass> does not exist
country InvalidValue No tax areas for country '<country>'
shippingMethod NotFound Shipping method <shippingMethod> does not exist
shippingMethod InvalidValue Shipping method <shippingMethod> is not suitable for this receipt
shippingMethod MissingCombination 'shippingMethod' is required because the payment method is on delivery
paymentMethod NotFound Payment method <paymentMethod> does not exist
paymentMethod InvalidValue Payment method <paymentMethod> is not suitable for this receipt
paymentMethod InvalidValue Payment method <paymentMethod> and shipping method <shippingMethod> are not compatible

receipts.delete

Deletes one or more receipts.

JS
CR.api('commerce.receipts.delete', request, function(response) { … });
HTTP
POST /open2b/api/v3/commerce.receipts.delete

request

{
  "ids" : [ "4722038952549247063", … ]  // identifiers of the receipts to delete (required) - bigint(1…)
}

response

{
  "status" : "ok"
}