Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Bills

Updates a bill

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-a-bill first to fetch the current record, then include ALL existing fields in your update request along with your changes.

put/bills/{bill_id}

Path parameters

bill_idstring required

UUID of the bill to be used in this operation.

Request body

vendor_idstring uuid required
expense_numberstring required
bill_datestring date required
due_datestring date required
impact_datestring date

Example request

{
  "expense_number": "B123",
  "items": [
    {
      "description": "API Bill",
      "account_code": "11112",
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "tax_rate": {
        "tax_amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "country": "US"
      }
    }
  ],
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ],
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  }
}

Response

OK

vendor_idstring uuid required
expense_numberstring required
bill_datestring date required
due_datestring date required
impact_datestring date
subsidiary_idstring uuid
idstring uuid required
status'UNPAID' | 'PAID' | 'PARTIALLY_PAID' | 'CREDITED' | 'PARTIALLY_CREDITED' | 'APPLIED' required
updated_atstring date-time required

Timestamp when the bill was last modified

Example response

{
  "expense_number": "B123",
  "items": [
    {
      "description": "API Bill",
      "account_code": "11112",
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "tax_rate": {
        "tax_amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "country": "US"
      }
    }
  ],
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ],
  "exchange_rate": {
    "base": "USD",
    "target": "USD"
  }
}