Skip to content

Proof payment document settings

Request

Using this endpoint, you can unlink an invoice from a proof of payment. After successfully unlinking the invoice, the price of the linked

invoice will be recalculated and increased by the price of the proof of payment.

Linking of the invoice to the proof of payment is not possible at this endpoint.

You can also close a proof of payment with this endpoint. You can open a proof of payment if it is not linked to any invoice.

Otherwise, a response code 409 is returned and the document cannot be closed.

Important note: If the document is closed, the invoice or proof of payment may have already been sent to the customer!

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired
Example:P--2015000170-1
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobject, non-emptyrequired
curl -i -X POST \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/proof-payments/P--2015000170-1/document-settings \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "unlink": false,
      "closed": false
    }
  }'

Responses

Created

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "proofPayments": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}