Update Invoice | Coperniq API

const url = 'https://api.coperniq.io/v1/invoices/1';
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "invoiceNumber": 1,
  "status": "DRAFT",
  "amount": 1.1,
  "amountPaid": 1.1,
  "calculationMethod": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "description": "string",
  "basedOnId": 1,
  "basedOnUid": 1,
  "dueDate": "2024-01-15T09:30:00Z",
  "issueDate": "2024-01-15T09:30:00Z",
  "isArchived": true,
  "sharedWithPortal": true,
  "percentage": 1.1,
  "baseAmount": 1.1,
  "account": {
    "id": 1,
    "title": "string"
  },
  "record": {
    "id": 1,
    "uid": 1,
    "title": "string"
  },
  "lineItems": [
    {
      "id": 1,
      "catalogItemId": 1,
      "quantity": 1,
      "unitCost": 1.1,
      "unitPrice": 1.1,
      "description": "string",
      "catalogItem": {
        "id": 1,
        "name": "string",
        "manufacturer": "string",
        "sku": "string",
        "type": "PRODUCT"
      }
    }
  ]
}

Update an existing invoice. Supports partial updates.

Updatable fields:

lineItems: Array of line items if calculationMethod is “LINE_ITEMS”
sections: Grouped line items if calculationMethod is “LINE_ITEMS”
percentage: Percentage if calculationMethod is “PERCENTAGE”
issueDate: ISO 8601 datetime string
dueDate: ISO 8601 datetime string
description: Invoice description
status: Invoice status — one of DRAFT, SENT, DECLINED, PAID, PARTIALLY_PAID, OVERDUE. Only valid transitions from the invoice’s current status are accepted (e.g. DECLINED is reachable from DRAFT, SENT, OVERDUE, or PARTIALLY_PAID); an invalid transition is rejected with a 400.
isActive: Set to false to archive the invoice, or true to unarchive it. Applied independently of any other fields present in the same request.

calculationMethod cannot be changed after creation and is rejected if included.

Update an existing invoice. Supports partial updates. Updatable fields: - `lineItems`: Array of line items if calculationMethod is "LINE_ITEMS" - `sections`: Grouped line items if calculationMethod is "LINE_ITEMS" - `percentage`: Percentage if calculationMethod is "PERCENTAGE" - `issueDate`: ISO 8601 datetime string - `dueDate`: ISO 8601 datetime string - `description`: Invoice description - `status`: Invoice status — one of `DRAFT`, `SENT`, `DECLINED`, `PAID`, `PARTIALLY_PAID`, `OVERDUE`. Only valid transitions from the invoice's current status are accepted (e.g. `DECLINED` is reachable from `DRAFT`, `SENT`, `OVERDUE`, or `PARTIALLY_PAID`); an invalid transition is rejected with a 400. - `isActive`: Set to `false` to archive the invoice, or `true` to unarchive it. Applied independently of any other fields present in the same request. `calculationMethod` cannot be changed after creation and is rejected if included.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

invoice_idintegerRequired

Invoice identifier

Request

This endpoint expects an object.

statusenumOptional

Invoice status

lineItemslist of objectsOptional

Flat array of line items (LINE_ITEMS only). May be combined with sections (a catalogItemId may appear only once across both).

sectionslist of objectsOptional

Grouped line items with named sections (LINE_ITEMS only). May be combined with lineItems (ungrouped items).

percentagedoubleOptional>=0

Percentage (PERCENTAGE invoices only). Cannot be combined with lineItems or sections.

issueDatestringOptionalformat: "date-time"

Issue date (ISO 8601 datetime string)

dueDatestringOptionalformat: "date-time"

Due date (ISO 8601 datetime string)

descriptionstring or nullOptional

Invoice description

isActivebooleanOptional

Set to false to archive the invoice, or true to unarchive it. Applied independently of any other fields present in the same request.

Response

Invoice updated successfully

idinteger

Invoice identifier

invoiceNumberinteger

Unique invoice number

statusenum

Invoice status

amountdouble

Total invoice amount

amountPaiddouble

Amount paid

calculationMethodstring

Calculation method (e.g., LINE_ITEMS)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

descriptionstring or nullOptional

Invoice description

basedOnIdinteger or nullOptional

ID of the record this invoice is based on

basedOnUidinteger or nullOptional

UID of the record this invoice is based on

dueDatestringOptionalformat: "date-time"

Due date

issueDatestring or nullOptionalformat: "date-time"

Issue date when the invoice has been issued

isArchivedbooleanOptional

Whether the invoice is archived

sharedWithPortalbooleanOptional

Whether the invoice is shared with portal

percentagedouble or nullOptional

Percentage if applicable

baseAmountdouble or nullOptional

Base amount if applicable

accountobject or nullOptional

recordobject or nullOptional

lineItemslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

Update an existing invoice. Supports partial updates.

Updatable fields:

lineItems: Array of line items if calculationMethod is “LINE_ITEMS”
sections: Grouped line items if calculationMethod is “LINE_ITEMS”
percentage: Percentage if calculationMethod is “PERCENTAGE”
issueDate: ISO 8601 datetime string
dueDate: ISO 8601 datetime string
description: Invoice description
status: Invoice status — one of DRAFT, SENT, DECLINED, PAID, PARTIALLY_PAID, OVERDUE. Only valid transitions from the invoice’s current status are accepted (e.g. DECLINED is reachable from DRAFT, SENT, OVERDUE, or PARTIALLY_PAID); an invalid transition is rejected with a 400.
isActive: Set to false to archive the invoice, or true to unarchive it. Applied independently of any other fields present in the same request.

calculationMethod cannot be changed after creation and is rejected if included.