Skip to main content

Update ShipMyOrders Invoice Line Nominal Codes

PUT 

/api/shipmyorders/invoices/:invoice

Sets the nominal code on lines of a ShipMyOrders invoice. This is the only change it applies: invoice headers and line amounts are imported from the provider file and are not editable.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

The body is the full invoice and is validated as such:

  • invoice_number (string, required)
  • invoice_date (string, required)
  • total (number, required)
  • items (array) — for each line: id (integer — the line to update), date, reference, description (strings, required), amount, quantity, subtotal, tax, total (numbers, required), nominal_code_id (integer).

For each item, the line with that id on this invoice gets nominal_code_id; all other values are ignored. Lines are only booked to the ledger once every line has a nominal code.

Returns the invoice in the same shape as Get ShipMyOrders Invoice.

Requires the integrations.update permission.

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type