Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Invoice

Change invoice settings

To update settings, first perform a GET request to /v1/workspaces/{workspaceId}/invoices/settings to retrieve the object's current state. Next, modify only the specific fields you wish to change while leaving the rest of the structure intact. Finally, send that modified payload back to the server using a PUT request to overwrite and update the resource.

Important: You must echo back the full payload returned by the initial GET request; Because PUT replaces the entire resource, any omitted fields will be overwritten with default values or cleared entirely.

put/v1/workspaces/{workspaceId}/invoices/settings

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Request body

Example request

{
  "defaults": {
    "companyId": "34a687e29ae1f428e7ebe101",
    "dueDays": 2,
    "itemTypeId": "78a687e29ae1f428e7ebe303",
    "notes": "This is a sample note for this invoice.",
    "subject": "January salary",
    "tax2Percent": 5,
    "taxPercent": 5,
    "taxType": "COMPOUND"
  },
  "labels": {
    "amount": "AMOUNT",
    "billFrom": "BILL FROM",
    "billTo": "BILL TO",
    "description": "DESCRIPTION",
    "discount": "DISCOUNT",
    "dueDate": "DUE DATE",
    "issueDate": "ISSUE DATE",
    "itemType": "ITEM TYPE",
    "notes": "NOTES",
    "paid": "PAID",
    "quantity": "QUANTITY",
    "subtotal": "SUBTOTAL",
    "tax": "TAX",
    "tax2": "TAX2",
    "total": "AMOUNT",
    "totalAmountDue": "TOTAL AMOUNT DUE",
    "unitPrice": "UNIT PRICE"
  }
}

Response

OK