Get repayment documents

note

The id in this example is a placeholder — use a real one from repaymentRequests.

Use repaymentRequest query to retrieve the documents of a repayment request: fiscalDocument is the credit note of the return, and shipping.proforma and shipping.labels work like on order shippings, one label (waybill) per parcel. The url values are temporary signed download links: fetch the file when you need it instead of storing the URL.

OMS can also notify your integration when the credit note is issued: see the AccountingCreditDocument / issued webhook event.

Request

query repaymentDocuments {
  repaymentRequest(id: "567") {
    id
    number
    status
    fiscalDocument {
      id
      number
      url
      createdAt
      fileName
    }
    shipping {
      id
      proforma {
        id
        number
        url
        createdAt
        fileName
      }
      labels {
        id
        number
        url
        createdAt
        fileName
      }
    }
  }
}

Open in playground

Response

{
  "data": {
    "repaymentRequest": {
      "id": "567",
      "number": "RR-2026-0001",
      "status": "refunded",
      "fiscalDocument": {
        "id": "910",
        "number": "RF-2026-001",
        "url": "https://documents.example.test/repayment-fiscal-document.pdf",
        "createdAt": "2026-02-14T09:00:00.000Z",
        "fileName": "RF-2026-001.pdf"
      },
      "shipping": {
        "id": "790",
        "proforma": {
          "id": "911",
          "number": "RPRO-2026-001",
          "url": "https://documents.example.test/return-proforma.pdf",
          "createdAt": "2026-02-14T09:05:00.000Z",
          "fileName": "RPRO-2026-001.pdf"
        },
        "labels": [
          {
            "id": "912",
            "number": "RLBL-2026-001",
            "url": "https://documents.example.test/return-label.pdf",
            "createdAt": "2026-02-14T09:10:00.000Z",
            "fileName": "RLBL-2026-001.pdf"
          }
        ]
      }
    }
  },
  "extensions": {
    "queryComplexity": 24,
    "bucketBalance": 9976,
    "bucketRestoreRate": 100
  }
}

Relevant permissions

The operations in this page require the following permissions on the API credentials — they are configured for you by Calicantus.

• repayment_request:query:repayment_request
• repayment_request:read
• repayment_shipping:read
• accounting_document:read
• accounting_proforma:read
• shipping_label:read