Proforma invoices

Managing proforma invoices in the e-shop.

The code (code) is the proforma invoice identifier. Although this is usually a number, it is necessary to take into account that this might also include letters, a dash, etc.

Operations

Proforma invoice from order creation

Request

Creating proforma invoice from existing order.

Security

shoptetAccessToken or shoptetPrivateApiToken

Path

codestringrequired

Code of order

Example:2018000053

Query

suppressExistenceCheckboolean

suppress checking of existing proforma invoices per order (allows multiple proforma invoices per order)

Default:false

Example:suppressExistenceCheck=true

Headers

Content-Typestringrequired

Default:"application/json"

Bodyapplication/json

dataobjectrequired

curl -i -X POST \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api_orders_2018000053_proforma-invoice.yaml?suppressExistenceCheck=true' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "proformaInvoiceCode": "2021000021",
      "varSymbol": 2021000021,
      "creationTime": "2018-05-29T09:02:27+0200",
      "dueDate": "2017-04-04",
      "constSymbol": "0308",
      "specSymbol": 201323134,
      "billingMethodId": 1
    }
  }'

Responses

Created

Bodyapplication/json

dataobjectrequired

errorsArray of objects or null(Errors)required

metadataobject(Metadata)required

Response

{
  "data": {
    "proformaInvoice": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}