Skip to main content
PUT
/
api
/
invoices
/
{invoice_uid}
Update invoice
curl --request PUT \
  --url https://dev.exante.app/api/invoices/{invoice_uid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_party_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "document_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_blueprint_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoice_number": "<string>",
  "status": "<string>",
  "collection_method": "charge_automatically",
  "issue_date": "2023-11-07T05:31:56Z",
  "due_date": "2023-11-07T05:31:56Z",
  "paid_date": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "invoice_fields": {}
}
'
{
  "status": "success",
  "status_code": 200,
  "message": "Success",
  "data": {
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoice_number": "<string>",
    "invoice_type": "ACCOUNTS_PAYABLE",
    "status": "<string>",
    "collection_method": "charge_automatically",
    "issue_date": "2023-11-07T05:31:56Z",
    "due_date": "2023-11-07T05:31:56Z",
    "paid_date": "2023-11-07T05:31:56Z",
    "subtotal_cents": 123,
    "discount_cents": 123,
    "tax_cents": 123,
    "total": 123,
    "total_cents": 123,
    "pre_payment_credit_notes_cents": 123,
    "amount_due_cents": 123,
    "amount_paid_cents": 123,
    "amount_remaining_cents": 123,
    "overdue_days": 123,
    "currency": "<string>",
    "invoice_link": "<string>",
    "document_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoice_blueprint_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "target_party_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "age": 123,
    "has_comments": true,
    "line_items": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "context_type_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "context_type": "DISCOUNT",
        "context_name": "<string>",
        "currency": "<string>",
        "quantity": 123,
        "unit_price": 123,
        "line_total": 123
      }
    ],
    "invoice_fields": [
      {
        "key": "<string>",
        "value": {
          "type": "<string>",
          "original_type": "<string>",
          "value": "<unknown>"
        }
      }
    ],
    "parties": {
      "client": {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "address": "<string>",
        "billing_contact": {
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "party_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "title": "<string>",
          "email": "jsmith@example.com",
          "phone": "<string>"
        },
        "role": "<string>"
      },
      "service_provider": {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "address": "<string>",
        "billing_contact": {
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "party_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "title": "<string>",
          "email": "jsmith@example.com",
          "phone": "<string>"
        },
        "role": "<string>"
      }
    },
    "integrations": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entity_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "integration_name": "<string>",
        "integration_uid": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "integration_metadata": {}
      }
    ],
    "invoice_notes": {
      "invoice_memo": "<string>",
      "invoice_footer": "<string>"
    },
    "comments": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "text": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "last_modified_at": "2023-11-07T05:31:56Z",
        "resolved_by": 123,
        "resolved_at": "2023-11-07T05:31:56Z",
        "actor": {
          "id": 123,
          "fullname": "<string>",
          "avatar": "<string>",
          "email": "jsmith@example.com"
        }
      }
    ]
  }
}
Send only the fields you want to change. The backend syncs invoice changes to the configured external billing integration before committing the database transaction.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoice_uid
string<uuid>
required

Invoice UID

Body

application/json

Partial invoice update payload. Only provided fields are updated.

target_party_uid
string<uuid>
document_uid
string<uuid>
invoice_blueprint_uid
string<uuid>
invoice_number
string
status
string
collection_method
enum<string>
Available options:
charge_automatically,
send_invoice
issue_date
string<date-time>
due_date
string<date-time>
paid_date
string<date-time>
currency
string
Required string length: 3
invoice_fields
object

Response

Invoice updated

status
string
Example:

"success"

status_code
integer
Example:

200

message
string
Example:

"Success"

data
object