Invoice link proforma invoices

Request

Linking proforma invoices to invoice. Proforma invoices must be related to the order, must be in same currency as the order, must be valid and cannot be linked to another invoice. Multiple proforma invoices are allowed to link to the invoice. This endpoint has several sections, which are only sent when requested in the include parameter (see Requested sections).

Value	Section
`surchargeParameters`	Item surcharge parameters

Security

shoptetAccessToken or shoptetPrivateApiToken

Path

codestringrequired

Code of the invoice

Example:2018000053

Query

includestring

Sections to include

Example:include=surchargeParameters

Headers

Content-Typestringrequired

Default:"application/json"

Bodyapplication/json

dataobjectrequired

curl -i -X PATCH \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/invoices/2018000053/link-proforma-invoice?include=surchargeParameters' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "proformaInvoiceCodes": [
        "2024249998"
      ]
    }
  }'

Responses

OK

Bodyapplication/json

dataobjectrequired

errorsArray of objects or null(Errors)required

metadataobject(Metadata)required

Response

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