Download the PASS-only canonical accounting export

GET

/invoices/{invoiceId}/export

curl --request GET \
  --url 'https://api.invogi.com/v1/invoices/example/export?format=json' \
  --header 'Authorization: Bearer <token>'

Returns Invogi’s stable, versioned canonical representation. Export is refused unless the invoice’s current decision is PASS.

Authorizations

• bearerAuth

Parameters

Path Parameters

invoiceId

required

string

Query Parameters

format

string

default: json

Allowed values: json csv

Responses

200

Downloadable canonical invoice

object

schema_version

required

string

Allowed value: invogi.canonical-invoice.v1

exported_at

required

string format: date-time

decision

required

string

Allowed value: PASS

invoice

required

object

key

additional properties

any

Example

{
  "schema_version": "invogi.canonical-invoice.v1",
  "decision": "PASS"
}

string

Headers

Content-Disposition

string

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

404

Resource not found

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

409

Conflicting idempotency key or resource processing state

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}