GET /v1/invoices/inbound/{id}

GET

/v1/invoices/inbound/{id}

curl --request GET \
  --url https://api.asap.cool/v1/invoices/inbound/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key
  invoice:read
• session

Parameters

Path Parameters

id

required

string format: uuid

Inbound record identifier.

Responses

200

The inbound invoice.

Media type application/json

Public projection of an [InboundRecord].

Light by design: the structured CII XML and the integrity digest are not surfaced; the readable PDF is referenced by its object-store key.

object

byte_size

Size in bytes of the stored object, when known.

integer | null format: int64

created_at

required

RFC3339 creation timestamp.

string

currency

Invoice currency code (BT-5), when parsed.

string | null

due_date

Payment due date as ISO YYYY-MM-DD (BT-9), when parsed.

string | null

id

required

Stable identifier.

string format: uuid

imported_at

RFC3339 import timestamp, when set.

string | null

invoice_number

Invoice number extracted from the CII (BT-1), when parsed.

string | null

issue_date

Issue date as ISO YYYY-MM-DD (BT-2), when parsed.

string | null

parse_status

required

CII parse outcome: 'parsed', 'parse_failed' or 'pending'.

string

pdf_storage_key

Object-store key of the readable PDF, when stored.

string | null

received_at

RFC3339 reception timestamp (as reported by the PA), when known.

string | null

seller_name

Seller name extracted from the CII (BT-27), when parsed.

string | null

sender_siren

SIREN of the sender, when provided.

string | null

total_ht

Total amount without VAT in cents (BT-109), when parsed.

integer | null format: int64

total_ttc

Grand total with VAT in cents (BT-112), when parsed.

integer | null format: int64

total_vat

Total VAT amount in cents (BT-110), when parsed.

integer | null format: int64

transmission_id

required

PA-assigned transmission id.

string

Example ^generated

{
  "byte_size": 1,
  "created_at": "example",
  "currency": "example",
  "due_date": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "imported_at": "example",
  "invoice_number": "example",
  "issue_date": "example",
  "parse_status": "example",
  "pdf_storage_key": "example",
  "received_at": "example",
  "seller_name": "example",
  "sender_siren": "example",
  "total_ht": 1,
  "total_ttc": 1,
  "total_vat": 1,
  "transmission_id": "example"
}

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing invoice:read scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

404

Not found or cross-org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}