API Key1

Approval Workflow Models5

Approval Workflows3

Bank accounts5

Bank Transactions5

Bill Payments3

Bills10

Books1

Books periods5

Cash Matching3

Charges5

Chart of Accounts7

Close Checklist4

Contract Documents3

Contract Items3

Contracts15

Credit Memos8

Customer Families8

Customer Payments2

Customers9

Draft Contract Documents3

Draft Contracts5

External Reference Types1

Feedback1

Fields6

Health1

Invoice Documents3

Invoice payments5

Invoices12

Journal Entries5

Journal Entry Documents2

Members1

Metadata1

Organizations1

Products6

Reimbursement Payments3

Reimbursements5

Reports7

Roles2

Subsidiaries2

Tax rates1

Vendor Credit Applications1

Vendor Credits5

Vendors5

Webhooks

Webhooks23

Invoices

Updates an invoice

Changed on Nov 3, 2026

IMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-an-invoice first to fetch the current record, then include ALL existing fields in your update request along with your changes. Exceptions that keep stored data when the field is omitted:

metadata: omit it to keep all existing metadata, or send only the keys you want to set or clear.
shipping_customer_id, billing_address_id, shipping_address_id: omit them to keep the invoice's current ship-to customer and addresses, or send null to clear them. This is for backward compatibility: integrations built before these fields existed won't clear them on every update.
email_selection: omit it to keep the invoice's current recipients.

put/invoices/{invoice_id}

Request

Base URL
https://api.rillet.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rillet/apis/rillet-accounting-api/docs/invoices/:invoice_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

invoice_idstring required

UUID of the invoice to be used in this operation.

Request body

Example request

{
  "items": [
    {
      "price": {
        "discount": {
          "amount_off": {
            "amount": "1.01",
            "currency": "USD"
          }
        },
        "amount_per_unit": {
          "amount": "1.01",
          "currency": "USD"
        }
      },
      "revenue": {
        "account_code": "11112"
      },
      "tax_rate": {
        "percentage": "0",
        "tax_amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "country": "US"
      }
    }
  ],
  "purchase_order_number": "1",
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ]
}

Response

idstring uuid required

subsidiary_idstring uuid required

invoice_numberstring required

customer_idstring uuid required

contract_idstring uuid

due_datestring date required

invoice_datestring date required

shipping_customer_idstring uuid nullable

The customer the invoice ships to. Equal to customer_id when shipping to the billing customer. Null when no ship-to customer is set.

payment_termsinteger required

purchase_order_numberstring

memostring

overdueboolean required

metadataobject

Invoice metadata values keyed by metadata definition key.

updated_atstring date-time required

ISO 8601 timestamp in UTC timezone (must end with 'Z')

sent_atstring date-time

ISO 8601 timestamp in UTC timezone (must end with 'Z') marking when the invoice was first sent to the customer from Rillet (either by a user action or by automation). Null if the invoice has never been sent from Rillet.

Example response

{
  "invoice_number": "INV01",
  "items": [
    {
      "description": "Description",
      "revenue": {
        "account_code": "11112"
      },
      "total_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "total_discount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "taxed_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "gross_rate": {
        "amount": "1.01",
        "currency": "USD"
      },
      "quantity": "1.0000",
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ]
    }
  ],
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "customer_address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "shipping_address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "net_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "amount_due": {
    "amount": "1.01",
    "currency": "USD"
  },
  "total": {
    "amount": "1.01",
    "currency": "USD"
  },
  "subtotal": {
    "amount": "1.01",
    "currency": "USD"
  },
  "total_discount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "purchase_order_number": "1",
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  },
  "taxed_amount": {
    "amount": "1.01",
    "currency": "USD"
  },
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ]
}

Changes

Nov 3, 2026c393d0102005 Revision changes
- breaking
  added to the ////// request property allOf list
- breaking
  the ////// request property type changed from object to no type
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became optional for the status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the // response's property type changed from number to string, and format from no format to number for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the request property ///////
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  added the new PROGRESS enum value to the /// response property for the response status
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ///////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new PROGRESS enum value to the request property ///////
- info
  added the new PROGRESS enum value to the request property ///////
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added to the response property allOf list for the response status
- info
  added to the response property allOf list for the response status
- info
  added the required property to the response with the status
- info
  added the success response with the status

Operation history