billing-debug 0.23.67

  • Contact: N/A
  • License: N/A

Resources

channel_debug_transaction

Operations

Method and Path Description
POST /channel/:channel_id/billing/debug/transactions

debug_order

Operations

Method and Path Description
POST /internal/billing/debug/order

debug_order_transaction

Operations

Method and Path Description
POST /internal/billing/debug/order/transactions

internal_debug_transaction

Operations

Method and Path Description
POST /internal/billing/debug/transactions

organization_debug_transaction

Operations

Method and Path Description
POST /:organization/billing/debug/transactions

task

Operations

Method and Path Description
GET /internal/billing/debug/tasks

Headers

No headers

Imports

https://app.apibuilder.io/flow/billing-internal/latest/service.json
https://app.apibuilder.io/flow/billing/latest/service.json
https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/error/latest/service.json
https://app.apibuilder.io/flow/experience/latest/service.json
https://app.apibuilder.io/flow/order-price/latest/service.json

Enums

debug_accounting_transaction_type

Name Value Description
fulfillment fulfillment

Interfaces

debug_transaction

Field Type Required? Default Description Annotations
debug debug_transaction_details No -

queue debug_transaction_queued No -

If applicable, describes what we are waiting for to process this transaction

Models

channel_debug_transaction

Example Json: Minimal | Full

Interfaces: debug_transaction

Field Type Required? Default Description Annotations
debug debug_transaction_details No -

queue debug_transaction_queued No -

If applicable, describes what we are waiting for to process this transaction

debug_accounting_transaction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
type debug_accounting_transaction_type Yes -

type_id string Yes -

transaction_id string Yes -

debug_details

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
labels [debug_label] Yes -

captures [debug_payment_transaction_summary] Yes -

refunds [debug_payment_transaction_summary] Yes -

allocation io.flow.experience.v0.models.allocation_v2:0.18.89 Yes -

debug_fulfillment_delta

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
posted_transactions_net decimal Yes -

fulfillments_net decimal Yes -

delta_amount decimal Yes -

delta_percent decimal Yes -

debug_label

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
carrier_id string Yes -

carrier_tracking_number string Yes -

label_tracking_summary_id string No -

label_id string No -

transactions [debug_label_transaction_summary] No -

debug_label_transaction_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

type string Yes -

debug_order

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
organization_id string Yes -

number string Yes -

prices [io.flow.order.price.v0.models.order_price_detail:0.18.89] Yes -

total io.flow.common.v0.models.money_with_base:0.18.89 Yes -

identifiers map[string] No -

submitted_at date-time-iso8601 No -

debug_order_transaction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
order debug_order Yes -

debug debug_details Yes -

transactions [io.flow.billing.v0.models.transaction:0.18.89] Yes -

reporting reporting_details Yes -

debug_order_transaction_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
order_id string No -

organization_id string No -

If specified, specify order_number also

order_number string No -

If specified, specify organization_id also

transaction_id string No -

capture_id string No -

refund_id string No -

order_identifier debug_order_transaction_form_order_identifier No -

authorization_id string No -

posting_proof_id string No -

label_tracking_summary_id string No -

shipping_notification_id string No -

external_fulfillment_proof_id string No -

order_cancellation_id string No -

debug_order_transaction_form_order_identifier

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
key string No -

value string No -

debug_payment_transaction_summary

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

type string Yes -

processing_transaction_id string No -

queue_errors [string] No -

ignore_reason string No -

debug_transaction_details

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
transaction io.flow.billing.v0.models.transaction:0.18.89 Yes -

status debug_transaction_details_status Yes -

payout io.flow.billing.v0.models.pending_payout_transaction_reason:0.18.89 No -

fx debug_transaction_fx No -

debug_transaction_details_status

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
status io.flow.billing.internal.v0.enums.billing_transaction_status:0.23.67 Yes -

description string Yes -

Additional information related to the status of this transaction

debug_transaction_fx

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
timestamp date-time-iso8601 No -

The timestamp that we used to look up the market FX rates in effect.

market [debug_transaction_fx_rate] Yes -

The FX rates, if any, used for processing this transaction

order_effective_rate debug_transaction_fx_rate No -

The effective rate of the order is the base total / local total

transaction_effective_rate debug_transaction_fx_rate No -

The effective rate of the payment transaction is the base total / local total

debug_transaction_fx_rate

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
base string Yes -

The base currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies

target string Yes -

The target currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies

value decimal Yes -

The actual conversion rate from the base currency to target currency including any applicable margins.

debug_transaction_queued

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
id string Yes -

reasons [string] Yes -

internal_debug_transaction

Example Json: Minimal | Full

Interfaces: debug_transaction

Field Type Required? Default Description Annotations
debug debug_transaction_details No -

queue debug_transaction_queued No -

If applicable, describes what we are waiting for to process this transaction

organization_debug_transaction

Example Json: Minimal | Full

Interfaces: debug_transaction

Field Type Required? Default Description Annotations
debug debug_transaction_details No -

queue debug_transaction_queued No -

If applicable, describes what we are waiting for to process this transaction

reporting_details

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
accounting_transactions [object] No -

fulfillments [object] No -

fulfillment_delta debug_fulfillment_delta No -

sales_records [object] No -

refund_records [object] No -

task

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
type string Yes -

type_id string Yes -

The actual record id

source_type string No -

source_id string No -

environment io.flow.common.v0.enums.environment:0.18.89 Yes -

created_at date-time-iso8601 Yes -

num_attempts integer Yes 0

next_attempt_at date-time-iso8601 Yes -

errors [string] No -

stacktrace string No -

snooze_id string No -

Unions

No unions

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].