> ## Documentation Index > Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Amend an invoice > Adds, changes or removes invoice lines and returns the invoice. Amends the invoice's lines. Each entry of `invoice.lines` names an `op`: `add` with the new line under `value`, `change` with the line's `id` as `charge_item_uuid` and the new price or quantity, or `remove` with the line's `id` as `charge_item_uuid`. Each amendment raises the invoice's `version` by one. The body is optional. > [!NOTE] > > The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload. ## OpenAPI ````yaml POST /invoices/{invoice_id}/amend openapi: 3.1.0 info: title: Exsited API version: v4 servers: - url: https://{host}/api/v4 variables: host: default: your-api-host.example.com description: Your Exsited API host name, without https://. security: - bearerAuth: [] tags: - name: Authentication - name: Accounts - name: Account emails - name: Account groups - name: Communications - name: Communication profiles - name: Orders - name: Quote orders - name: Express - name: Usages - name: Sales reps - name: Gift certificates - name: Invoices - name: Pro-forma invoices - name: Payments - name: Refunds - name: Credit notes - name: Credit note applications - name: Reconciliations - name: Items - name: Inventory adjustments - name: Units of measurement - name: Zones - name: Shipping packages - name: Shipping rules - name: Fulfillment profiles - name: Fulfillment terms - name: Item fulfillments - name: Item receipts - name: Bookings - name: Rental assets - name: Return merchandise authorisations - name: Purchase orders - name: Purchase invoices - name: Purchase payments - name: Purchase refunds - name: Purchase credit notes - name: Purchase credit note applications - name: Purchase express - name: Return vendor authorizations - name: ABA files - name: Receive terms - name: Labours - name: Tasks - name: Timesheets - name: Milestones - name: Employees - name: Departments - name: Designations - name: Teams - name: Time periods - name: Workflows - name: Workflow settings - name: Events - name: Custom events - name: System events - name: Approvals - name: Approval profiles - name: Approval user groups - name: Alerts - name: Alert responsibility settings - name: Alert responsibilities - name: Action scripts - name: Note groups - name: Note attachments - name: Instance settings - name: Accounting codes - name: Additional codes - name: Billing periods - name: Charging periods - name: Pricing periods - name: Invoice terms - name: Days of the month - name: Countries - name: Salutations - name: Document templates - name: Email templates - name: Roles - name: Operators - name: Operator groups - name: User settings - name: Custom attributes - name: Custom components - name: Custom features - name: Custom fields - name: Custom forms - name: Attribute attachments - name: Portal - name: Integration connections - name: External databases - name: Reports - name: Applications - name: Organisation - name: Child organisations - name: Webhooks paths: /invoices/{invoice_id}/amend: post: tags: - Invoices summary: Amend an invoice description: >- Amends the invoice's lines. Each entry of `invoice.lines` names an `op`: `add` with the new line under `value`, `change` with the line's `id` as `charge_item_uuid` and the new price or quantity, or `remove` with the line's `id` as `charge_item_uuid`. Each amendment raises the invoice's `version` by one. The body is optional. operationId: invoices_amend_invoice parameters: - name: invoice_id in: path required: true description: The invoice's `id`, such as `INV-0001`. Not its `uuid`. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: invoice: type: object properties: lines: type: array items: type: object properties: op: type: string enum: - add - change - remove value: type: object description: 'For `add`: the new line.' properties: item_id: type: string item_price: type: number item_quantity: type: number charge_item_uuid: type: string description: >- For `change` and `remove`: the `id` of the invoice line. item_price: type: number description: For `change`. item_order_quantity: type: number description: For `change`. example: invoice: lines: - op: add value: item_id: ITEM-0001 item_price: 3 item_quantity: 1 responses: '200': description: The amended invoice, under `invoice`. content: application/json: schema: $ref: '#/components/schemas/InvoiceResponse' x-codeSamples: - lang: bash label: cURL source: |- curl -X POST "$EXSITED_BASE_URL/api/v4/invoices/INV-0001/amend" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "invoice": { "lines": [ { "op": "add", "value": { "item_id": "ITEM-0001", "item_price": 3, "item_quantity": 1 } } ] } }' - lang: python label: Python source: | from exsited import build_client client = build_client() response = client.invoices.amend_invoice( "INV-0001", { "invoice": { "lines": [ { "op": "add", "value": { "item_id": "ITEM-0001", "item_price": 3, "item_quantity": 1, }, } ] } }, ) print(response.data) - lang: javascript label: JavaScript source: | import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.invoices.amendInvoice('INV-0001', { invoice: {lines: [{op: 'add', value: {item_id: 'ITEM-0001', item_price: 3, item_quantity: 1}}]}, }); console.log(response.data); - lang: php label: PHP source: | use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->invoices->amendInvoice('INV-0001', [ 'invoice' => [ 'lines' => [ [ 'op' => 'add', 'value' => ['item_id' => 'ITEM-0001', 'item_price' => 3, 'item_quantity' => 1], ], ], ], ]); print_r($response->data); - lang: java label: Java source: > import com.exsited.client.ApiResponse; import com.exsited.client.ClientRegistry; import com.exsited.client.ExsitedClient; import com.exsited.resources.invoices.invoices_dto.InvoicesDto.Invoice; import java.util.List; import java.util.Map; ExsitedClient client = ClientRegistry.buildClient(); ApiResponse response = client.invoices().amendInvoice( "INV-0001", Map.of( "invoice", Map.of( "lines", List.of( Map.of( "op", "add", "value", Map.of( "item_id", "ITEM-0001", "item_price", 3, "item_quantity", 1)))))); System.out.println(response.getMap()); - lang: csharp label: .NET source: | using Exsited.Client; await using var client = ExsitedClient.BuildClient(); var response = await client.Invoices.AmendInvoiceAsync( "INV-0001", new Dictionary { ["invoice"] = new Dictionary { ["lines"] = new List { new Dictionary { ["op"] = "add", ["value"] = new Dictionary { ["item_id"] = "ITEM-0001", ["item_price"] = 3, ["item_quantity"] = 1, }, }, }, }, }); Console.WriteLine(response.Json); - lang: dart label: Dart source: | import 'package:exsited/exsited.dart'; final client = buildClient(); final response = await client.invoices.amendInvoice('INV-0001', { 'invoice': { 'lines': [ { 'op': 'add', 'value': { 'item_id': 'ITEM-0001', 'item_price': 3, 'item_quantity': 1, }, }, ], }, }); print(response.map); - lang: go label: Go source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Invoices().AmendInvoice(context.Background(), \"INV-0001\", map[string]any{\n\t\"invoice\": map[string]any{\n\t\t\"lines\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"op\": \"add\",\n\t\t\t\t\"value\": map[string]any{\n\t\t\t\t\t\"item_id\": \"ITEM-0001\",\n\t\t\t\t\t\"item_price\": 3,\n\t\t\t\t\t\"item_quantity\": 1,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: schemas: InvoiceResponse: type: object properties: invoice: $ref: '#/components/schemas/Invoice' Invoice: type: object properties: id: type: string uuid: type: string version: type: integer status: type: string type: type: string origin: type: string payment_status: type: string account_id: type: string account_name: type: string order_id: type: string customer_purchase_order_id: type: string invoice_note: type: string issue_date: type: string due_date: type: string alternate_issue_date: type: string alternate_due_date: type: string billing_start_date: type: string billing_end_date: type: string alternate_billing_start_date: type: string alternate_billing_end_date: type: string subtotal: type: string tax: type: string tax_total: type: string total: type: string due: type: string paid: type: string discount_amount: type: number shipping_cost: type: string credit_applied: type: string credit_issued: type: string payment_applied: type: string outstanding: type: string price_tax_inclusive: type: boolean recurring_rate_count: type: string usage_rate_count: type: string currency: $ref: '#/components/schemas/InvoiceCurrency' custom_form: $ref: '#/components/schemas/InvoiceCustomForm' kpis: $ref: '#/components/schemas/InvoiceKpis' last_payment: $ref: '#/components/schemas/InvoiceLastPayment' created_on: type: string created_by: $ref: '#/components/schemas/InvoiceCreatedBy' last_updated_on: type: string last_updated_by: $ref: '#/components/schemas/InvoiceLastUpdatedBy' lines: type: array items: $ref: '#/components/schemas/InvoiceLine' description: >- Returned by Retrieve an invoice and by the invoice writes. A listing entry and Retrieve an invoice's information leave it out. custom_attributes: type: array items: $ref: '#/components/schemas/InvoiceCustomAttribute' custom_objects: type: array items: {} activity_logs: type: array items: $ref: '#/components/schemas/InvoiceActivityLog' notes: type: array items: $ref: '#/components/schemas/InvoiceNote' item_fulfillments: type: array items: $ref: '#/components/schemas/InvoiceItemFulfillment' return_merchandise_authorisations: type: array items: {} account: $ref: '#/components/schemas/InvoiceAccount' object: type: string order: $ref: '#/components/schemas/InvoiceOrder' InvoiceCurrency: type: object properties: code: type: string href: type: string id: type: string name: type: string object: type: string InvoiceCustomForm: type: object properties: object: type: string id: type: string name: type: string href: type: string InvoiceKpis: type: object properties: credit_applied: type: string credit_issued: type: string payment_applied: type: string last_payment_date: type: string last_amended_on: type: string last_cancelled_on: type: string last_reactivated_on: type: string deleted_on: type: string voided_on: type: string outstanding: type: - string - integer overdue: type: - integer - string InvoiceLastPayment: type: object properties: uuid: type: string id: type: string date: type: string amount: type: string created_on: type: string InvoiceCreatedBy: type: object properties: name: type: string object: type: string InvoiceLastUpdatedBy: type: object properties: name: type: string object: type: string InvoiceLine: type: object properties: object: type: string id: type: string version: type: integer item: $ref: '#/components/schemas/InvoiceLineItem' description: A reference to the item, with `object`, `id`, `name` and `href`. item_id: type: string item_uuid: type: string item_name: type: string item_uom: type: string item_warehouse: type: string item_serial_or_batch_number: type: string item_order_quantity: type: integer item_charge_type: type: string item_custom_attributes: type: array items: {} pricing_snapshot_price: type: number pricing_snapshot_uuid: type: string charging_start_date: type: string charging_end_date: type: string alternate_charging_start_date: type: string alternate_charging_end_date: type: string subtotal: type: string total: type: string tax: $ref: '#/components/schemas/InvoiceLineTax' accounting_code: $ref: '#/components/schemas/InvoiceAccountingCode' InvoiceCustomAttribute: type: object properties: name: type: string value: {} InvoiceActivityLog: type: object properties: activity: type: string InvoiceNote: type: object properties: object: type: string id: type: string href: type: string content: type: string version: type: integer invoice: $ref: '#/components/schemas/InvoiceNoteDetail' group: {} user: {} attachments: type: array items: $ref: '#/components/schemas/InvoiceNoteAttachment' watchers: type: array items: $ref: '#/components/schemas/InvoiceNoteWatcher' description: The people watching the note. created_on: type: string created_by: $ref: '#/components/schemas/InvoiceNoteCreatedBy' last_updated_on: {} last_updated_by: {} InvoiceItemFulfillment: type: object properties: uuid: type: string id: type: string version: type: string invoice_id: type: string order_id: type: string date: type: string status: type: string note: type: string tracking_number: type: string created_on: type: string created_by: type: string last_updated_on: type: string last_updated_by: type: string fulfillments: type: array items: {} InvoiceAccount: type: object properties: object: type: string id: type: string name: type: string href: type: string InvoiceOrder: type: object properties: object: type: string id: type: string name: type: string href: type: string InvoiceLineItem: type: object properties: object: type: string id: type: string name: type: string href: type: string InvoiceLineTax: type: object properties: object: type: string id: type: string name: type: string rate: type: number amount: type: string href: type: string InvoiceAccountingCode: type: object properties: sales_revenue: type: string InvoiceNoteDetail: type: object properties: href: type: string id: type: string object: type: string InvoiceNoteAttachment: type: object properties: uuid: type: string filename: type: string content_type: type: string size: type: integer href: type: string InvoiceNoteWatcher: type: object properties: email: type: string name: type: string type: type: string InvoiceNoteCreatedBy: type: object properties: name: type: string object: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: >- An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew it for you. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.