Items uit het domein “purchases” stellen aankoopdocumenten voor.  Aankoopdocumenten worden via Peppol ontvangen, kunnen via e-mail worden verzonden of kunnen manueel worden opgeladen.


URL opbouw

  • Alle aankoopdocumenten: GET /api/v1/purchases
  • Specifiek aankoopdocument: GET /api/v1/purchases/{purchase_id}


Velden

VeldnaamTypeOmschrijvingVoorbeeld
purchase_id
intUniek ID van de aankoopfactuur13
uritextURL naar de aankoopfactuur/api/v1/purchases/13
supplier_id int Unieke ID van de leverancier11 
supplier_uri textURL naar de leverancier/api/v1/suppliers/11
supplier_nametextNaam van de leverancier.Mobile Vikings NV
state textStatus van de aankoopfactuur. Mogelijke waarden: pending, accepted, overdue, rejected, payment_scheduled, paidpending
date dateFactuurdatum van de aankoopfactuur. Formaat YYYY-MM-DD.2024-09-04
due_date dateDatum waarop betaling verschuldigd is. Formaat YYYY-MM-DD.2024-10-04
currency textDe valuta van de aankoopfactuur . Dit moet een 3-lettercode zijn. Standaard 'EUR' als niet gespecificeerd.EUR
total_without_tax floatTotaalbedrag van de aankoopfactuur exclusief btw.500
total_with_tax floatTotaalbedrag van de aankoopfactuur inclusief btw.
605
file_available textGeeft aan of het UBL-bestand beschikbaar is om te downloaden . Kan 'yes' of 'no' zijn.
yes
has_attachments textGeeft aan of er extra bijlagen zijn voor de aankoopfactuur . Kan 'yes' of 'no' zijn.yes
created dateDatum waarop de aankoopfactuur is toegevoegd. Formaat YYYY-MM-DD.2024-08-30
references listReferenties van de aankoopfactuur. 3 types referenties beschikbaar: peppol, transmission, purchase_order, structured_message
-
tags listLijst van tags die aan de aankoopfactuur zijn gekoppeld.
-


Voorbeeld in JSON:

{
  "purchase_id": 104,
  "uri": "https://.../api/v1/purchases/104",
  "supplier_id": 72,
  "supplier_uri": "https://.../api/v1/suppliers/72",
  "supplier_name": "Telenet BV",
  "state": "pending",
  "number": "00390002",
  "date": "2024-11-07",
  "due_date": "2024-12-07",
  "currency": "EUR",
  "total_without_tax": 2500,
  "total_with_tax": 3025,
  "file_available": "yes",
  "has_attachments": "yes",
  "created": "2024-11-12",
  "references": [
    {
      "type": "peppol",
      "value": "cb7ec06a-4180-4f19-94fc-c4c711346fe4"
    },
    {
      "type": "transmission",
      "value": "c038dbdc1-26ed-41bf-9ebf-37g3c4ceaa58"
    },
    {
      "type": "purchase_order",
      "value": "PO-987654"
    }
  ],
  "tags": [
    {
      "name": "accountant"
    }
  ]
}



  Meer info over de API? Lees onderstaande nuttige artikels