Update Invoice API

Modify invoice details including client information, company name, address, and tax ID for accounting purposes

Invoice Management

Update Invoice API

Update invoice details for accounting and record-keeping. Modify client information, company details, addresses, and tax IDs on existing invoices.

Invoice Editing

Update client and company details on any invoice.

Business Info

Add company name, address, and registration numbers.

Tax Compliance

Include tax IDs for proper accounting and compliance.


Endpoint Overview

MUTATION/graphql

Update invoice details including client company name, address, email, phone number, and tax ID. Returns the updated invoice with all fields.

Authentication:Bearer Token

Request Parameters

idInt!Required

The unique identifier of the invoice to update.

clientCompanyNameString

The name of the client's company for the invoice.

addressString

The billing address for the invoice.

emailString

The email address associated with the invoice.

phoneNumberString

The phone number for the invoice contact.

taxIdString

The tax identification number (VAT, EIN, etc.) for the invoice.

companyRegistrationNumberString

Company registration or incorporation number.


GraphQL Mutation

mutation updateInvoice($invoiceUpdate: InvoiceUpdate) {
  updateInvoice(invoiceUpdate: $invoiceUpdate) {
    id
    firstName
    lastName
    clientCompanyName
    address
    taxId
    email
    phoneNumber
    groupId
    amountForGroup
    multiLogin
    amountForMultiLogin
    totalAmount
    paymentMethod
    paymentDate
    invoiceDate
    updateDate
  }
}

Variables:

{
  "invoiceUpdate": {
    "id": 12345,
    "clientCompanyName": "Acme Corporation",
    "address": "123 Business Ave, Suite 100, San Francisco, CA 94102",
    "email": "billing@acme.com",
    "phoneNumber": "+1-555-123-4567",
    "taxId": "12-3456789",
    "companyRegistrationNumber": "C1234567"
  }
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
    "query": "mutation updateInvoice($invoiceUpdate: InvoiceUpdate) { updateInvoice(invoiceUpdate: $invoiceUpdate) { id clientCompanyName address taxId email phoneNumber totalAmount paymentMethod invoiceDate updateDate } }",
    "variables": {
      "invoiceUpdate": {
        "id": 12345,
        "clientCompanyName": "Acme Corporation",
        "address": "123 Business Ave, Suite 100",
        "email": "billing@acme.com",
        "phoneNumber": "+1-555-123-4567",
        "taxId": "12-3456789"
      }
    }
  }'

Response

Invoice Details

ID, dates, payment method, and total amount information.

Client Info

Name, company, address, email, phone, and tax ID.

Amount Breakdown

Group amount, multi-login amount, and total.

Timestamps

Invoice date, payment date, and last update date.

200Invoice Updated Successfully
{
  "data": {
    "updateInvoice": {
      "id": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "clientCompanyName": "Acme Corporation",
      "address": "123 Business Ave, Suite 100, San Francisco, CA 94102",
      "taxId": "12-3456789",
      "email": "billing@acme.com",
      "phoneNumber": "+1-555-123-4567",
      "groupId": "1",
      "amountForGroup": 99.00,
      "multiLogin": "5",
      "amountForMultiLogin": 25.00,
      "totalAmount": 124.00,
      "paymentMethod": "STRIPE",
      "paymentDate": "2025-01-15T10:30:00Z",
      "invoiceDate": "2025-01-15T10:30:00Z",
      "updateDate": "2025-01-15T14:45:00Z"
    }
  }
}
400Invoice Not Found
{
  "errors": [
    {
      "message": "Invoice not found",
      "path": ["updateInvoice"],
      "extensions": {
        "code": "INVOICE_NOT_FOUND"
      }
    }
  ],
  "data": null
}

Common Use Cases

Business Invoicing

Add company details for business expense reporting and reimbursement.

Tax Documentation

Include tax IDs for VAT reclaim or tax deduction purposes.

Contact Update

Change billing email or phone number for invoice delivery.

Address Correction

Fix or update billing address for accurate records.


Best Practices

Validate Tax IDs

Ensure tax IDs are in the correct format for the user's country before saving.

Complete Information

For business invoices, include company name, address, and tax ID for compliance.

Email After Update

After updating, use emailInvoicePDF to send the updated invoice.

Audit Trail

The updateDate field tracks when changes were made for auditing.



After Updating

After updating invoice details, use the Email Invoice PDF API to send the updated invoice to the client's email address.

Send Updated Invoices

After updating invoice details, send the PDF to your clients via email for their records.

Email Invoice PDF API