GET /v1/invoices/{id}/flow

GET

/v1/invoices/{id}/flow

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

• Production

Authorizations

• api_key
  invoice:read
• session

Parameters

Path Parameters

id

required

string format: uuid

Quote (devis) identifier.

Responses

200

The quote-to-cash flow.

Media type application/json

Response body of GET /v1/invoices/{id}/flow.

object

deposits

required

Deposit invoices (acompte) derived from this quote.

Array<object>

One numbered document in the flow, with how much of it is paid.

object

number

Document number, None while still a draft.

string | null

paid_cents

required

Sum of recorded payments against it (centimes).

integer format: int64

total_ttc_cents

required

Document total including VAT (centimes).

integer format: int64

final_invoice

One of:

null

null

object

Final invoice converted from this quote, None when not yet converted.

object

number

Document number, None while still a draft.

string | null

paid_cents

required

Sum of recorded payments against it (centimes).

integer format: int64

total_ttc_cents

required

Document total including VAT (centimes).

integer format: int64

flow_status

required

fully_paid/partially_paid/unpaid.

string

number

Quote number, None while still a draft.

string | null

paid_total_cents

required

Cash collected across the deposits and the final invoice (centimes).

integer format: int64

quote_total_cents

required

Quote total including VAT (centimes).

integer format: int64

remaining_cents

required

quote_total - paid_total, floored at 0 (centimes).

integer format: int64

Example ^generated

{
  "deposits": [
    {
      "number": "example",
      "paid_cents": 1,
      "total_ttc_cents": 1
    }
  ],
  "final_invoice": {
    "number": "example",
    "paid_cents": 1,
    "total_ttc_cents": 1
  },
  "flow_status": "example",
  "number": "example",
  "paid_total_cents": 1,
  "quote_total_cents": 1,
  "remaining_cents": 1
}

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, cross-org, or not a quote.

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"
}