Subresources

Geschreven: 18 maart 2020

Sommige endpoints staan het toe om subresources van een bestaande resource aan te maken, te bewerken en/of te verwijderen. Een factuur (sales_invoice) heeft bijvoorbeeld factuurregels (invoice_lines) waarvoor dit geldt.

Voorbeeld: subresources toevoegen

In dit voorbeeld worden twee factuurregels aan een bestaande factuur toegevoegd. Bestaande factuurregels blijven ongemoeid.

// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}

{
  "sales_invoice": {
    "invoice_lines": [
      { "description": "Standaardwerk", "price_per_unit": "39.5", "quantity": "2" },
      { "description": "Maatwerk", "price_per_unit": "49.5", "quantity": "1" }
    ]
  }
}

Voorbeeld: subresources bewerken

In dit voorbeeld worden twee factuurregels van een bestaande factuur aangepast. Overige bestaande factuurregels blijven ongemoeid.

// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}

{
  "sales_invoice": {
    "invoice_lines": [
      { "id": 876544, "description": "Aangepaste omschrijving" },
      { "id": 987654, "quantity": "10" }
    ]
  }
}

Voorbeeld: subresources verwijderen

In dit voorbeeld worden twee factuurregels van een bestaande factuur verwijderd. Overige bestaande factuurregels blijven ongemoeid.

// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}

{
  "sales_invoice": {
    "invoice_lines": [
      { "id": 876543, "_destroy": true },
      { "id": 987653, "_destroy": true }
    ]
  }
}

Gecombineerd voorbeeld

In dit voorbeeld wordt één factuurregel toegevoegd, één factuurregel aangepast en één factuurregel verwijderd met één request. Overige bestaande factuurregels blijven ongemoeid.

// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}

{
  "sales_invoice": {
    "invoice_lines": [
      { "description": "Standaardwerk", "price_per_unit": "39.5", "quantity": "2" },
      { "id": 876544, "description": "Aangepaste omschrijving" },
      { "id": 876543, "_destroy": true }
    ]
  }
}