Skip to content
FRAGMENT
API Reference

Invoices

Invoice management operations

Create
invoices.create(InvoiceCreateParams**kwargs) -> InvoiceCreateResponse
POST/invoices
Create Batch Get
invoices.create_batch_get(InvoiceCreateBatchGetParams**kwargs) -> InvoiceCreateBatchGetResponse
POST/invoices/batch-get
List
invoices.list() -> InvoiceListResponse
GET/invoices
List History
invoices.list_history(strid) -> InvoiceListHistoryResponse
GET/invoices/{id}/history
Retrieve
invoices.retrieve(strid) -> InvoiceRetrieveResponse
GET/invoices/{id}
Search
invoices.search(InvoiceSearchParams**kwargs) -> InvoiceSearchResponse
POST/invoices/search
Update
invoices.update(strid, InvoiceUpdateParams**kwargs) -> InvoiceUpdateResponse
PATCH/invoices/{id}
ModelsExpand Collapse
class Invoice: …

Invoice object.

id: str

Unique invoice ID.

created: datetime

Timestamp when the invoice was created. Uses ISO 8601 format.

formatdate-time
Deprecatedstatus: Literal["active"]

Status of the invoice. Deprecated.

tags: List[Tag]

Tags for the invoice.

key: str

Tag key.

value: str

Tag value.

version: float

Current version of the invoice.

workspace_id: str

Workspace the invoice belongs to.

line_items: Optional[List[LineItem]]

Line items for the invoice.

id: str

FRAGMENT generated unique ID.

Deprecatedamount: str

Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.

currency_code: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
description: str

Description of the line item.

price: LineItemPrice

Price breakdown.

amount: str

Total amount as a string in the smallest currency unit, such as cents for USD.

quantity: int

Number of units.

unit_price: str

Unit price as a string in the smallest currency unit, such as cents for USD.

product_id: str

Unique identifier for the product.

tags: List[LineItemTag]

Tags for the line item.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the line item.

One of the following:
"payin"
"payout"
user_id: str

User-provided unique external ID.

modified: Optional[datetime]

Timestamp when the invoice was last modified. Uses ISO 8601 format.

formatdate-time
class InvoiceCreateResponse: …
data: Invoice

Invoice object.

id: str

Unique invoice ID.

created: datetime

Timestamp when the invoice was created. Uses ISO 8601 format.

formatdate-time
Deprecatedstatus: Literal["active"]

Status of the invoice. Deprecated.

tags: List[Tag]

Tags for the invoice.

key: str

Tag key.

value: str

Tag value.

version: float

Current version of the invoice.

workspace_id: str

Workspace the invoice belongs to.

line_items: Optional[List[LineItem]]

Line items for the invoice.

id: str

FRAGMENT generated unique ID.

Deprecatedamount: str

Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.

currency_code: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
description: str

Description of the line item.

price: LineItemPrice

Price breakdown.

amount: str

Total amount as a string in the smallest currency unit, such as cents for USD.

quantity: int

Number of units.

unit_price: str

Unit price as a string in the smallest currency unit, such as cents for USD.

product_id: str

Unique identifier for the product.

tags: List[LineItemTag]

Tags for the line item.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the line item.

One of the following:
"payin"
"payout"
user_id: str

User-provided unique external ID.

modified: Optional[datetime]

Timestamp when the invoice was last modified. Uses ISO 8601 format.

formatdate-time
class InvoiceCreateBatchGetResponse: …

Result of a batch invoice retrieval.

data: Data

Result of a batch invoice retrieval.

invoices: List[DataInvoice]

Invoices that were found, in request order.

balances: List[DataInvoiceBalance]

Invoice-level balances by currency.

currency: str

ISO 4217 or crypto currency code.

net: DataInvoiceBalanceNet

Net balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payins: DataInvoiceBalancePayins

Payins balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payouts: DataInvoiceBalancePayouts

Payouts balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payments: List[DataInvoicePayment]

Payments allocated to the invoice.

amount: str

Amount allocated as a string in the smallest currency unit, such as cents for USD.

currency: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
posted: datetime

Timestamp when the parent transaction was posted. Uses ISO 8601 format.

formatdate-time
transaction: DataInvoicePaymentTransaction

Transaction the payment is applied to.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[DataInvoicePaymentTransactionTag]

Tags from the parent transaction.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the payment.

One of the following:
"payin"
"payout"
user: DataInvoicePaymentUser

User associated with the payment.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

users: List[DataInvoiceUser]

Users involved in the invoice.

id: str

User-provided unique external ID.

balances: List[DataInvoiceUserBalance]

Per-currency balance breakdown for the user.

currency: str

ISO 4217 or crypto currency code.

net: DataInvoiceUserBalanceNet

Net balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payins: DataInvoiceUserBalancePayins

Payins balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payouts: DataInvoiceUserBalancePayouts

Payouts balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

external_id: str

User-provided unique ID.

not_found: List[str]

Ids from the request that did not match any invoice.

class InvoiceListResponse: …
data: List[Invoice]

List of invoices.

id: str

Unique invoice ID.

created: datetime

Timestamp when the invoice was created. Uses ISO 8601 format.

formatdate-time
Deprecatedstatus: Literal["active"]

Status of the invoice. Deprecated.

tags: List[Tag]

Tags for the invoice.

key: str

Tag key.

value: str

Tag value.

version: float

Current version of the invoice.

workspace_id: str

Workspace the invoice belongs to.

line_items: Optional[List[LineItem]]

Line items for the invoice.

id: str

FRAGMENT generated unique ID.

Deprecatedamount: str

Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.

currency_code: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
description: str

Description of the line item.

price: LineItemPrice

Price breakdown.

amount: str

Total amount as a string in the smallest currency unit, such as cents for USD.

quantity: int

Number of units.

unit_price: str

Unit price as a string in the smallest currency unit, such as cents for USD.

product_id: str

Unique identifier for the product.

tags: List[LineItemTag]

Tags for the line item.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the line item.

One of the following:
"payin"
"payout"
user_id: str

User-provided unique external ID.

modified: Optional[datetime]

Timestamp when the invoice was last modified. Uses ISO 8601 format.

formatdate-time
class InvoiceListHistoryResponse: …
data: List[Invoice]

Version history of the invoice.

id: str

Unique invoice ID.

created: datetime

Timestamp when the invoice was created. Uses ISO 8601 format.

formatdate-time
Deprecatedstatus: Literal["active"]

Status of the invoice. Deprecated.

tags: List[Tag]

Tags for the invoice.

key: str

Tag key.

value: str

Tag value.

version: float

Current version of the invoice.

workspace_id: str

Workspace the invoice belongs to.

line_items: Optional[List[LineItem]]

Line items for the invoice.

id: str

FRAGMENT generated unique ID.

Deprecatedamount: str

Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.

currency_code: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
description: str

Description of the line item.

price: LineItemPrice

Price breakdown.

amount: str

Total amount as a string in the smallest currency unit, such as cents for USD.

quantity: int

Number of units.

unit_price: str

Unit price as a string in the smallest currency unit, such as cents for USD.

product_id: str

Unique identifier for the product.

tags: List[LineItemTag]

Tags for the line item.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the line item.

One of the following:
"payin"
"payout"
user_id: str

User-provided unique external ID.

modified: Optional[datetime]

Timestamp when the invoice was last modified. Uses ISO 8601 format.

formatdate-time
class InvoiceRetrieveResponse: …
data: Data

Invoice with balance details.

balances: List[DataBalance]

Invoice-level balances by currency.

currency: str

ISO 4217 or crypto currency code.

net: DataBalanceNet

Net balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payins: DataBalancePayins

Payins balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payouts: DataBalancePayouts

Payouts balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payments: List[DataPayment]

Payments allocated to the invoice.

amount: str

Amount allocated as a string in the smallest currency unit, such as cents for USD.

currency: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
posted: datetime

Timestamp when the parent transaction was posted. Uses ISO 8601 format.

formatdate-time
transaction: DataPaymentTransaction

Transaction the payment is applied to.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[DataPaymentTransactionTag]

Tags from the parent transaction.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the payment.

One of the following:
"payin"
"payout"
user: DataPaymentUser

User associated with the payment.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

users: List[DataUser]

Users involved in the invoice.

id: str

User-provided unique external ID.

balances: List[DataUserBalance]

Per-currency balance breakdown for the user.

currency: str

ISO 4217 or crypto currency code.

net: DataUserBalanceNet

Net balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payins: DataUserBalancePayins

Payins balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payouts: DataUserBalancePayouts

Payouts balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

external_id: str

User-provided unique ID.

class InvoiceSearchResponse: …

Search results for invoices.

data: Data

Search results for invoices.

invoices: List[DataInvoice]

Invoices matching the search criteria.

balances: List[DataInvoiceBalance]

Invoice-level balances by currency.

currency: str

ISO 4217 or crypto currency code.

net: DataInvoiceBalanceNet

Net balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payins: DataInvoiceBalancePayins

Payins balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payouts: DataInvoiceBalancePayouts

Payouts balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payments: List[DataInvoicePayment]

Payments allocated to the invoice.

amount: str

Amount allocated as a string in the smallest currency unit, such as cents for USD.

currency: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
posted: datetime

Timestamp when the parent transaction was posted. Uses ISO 8601 format.

formatdate-time
transaction: DataInvoicePaymentTransaction

Transaction the payment is applied to.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[DataInvoicePaymentTransactionTag]

Tags from the parent transaction.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the payment.

One of the following:
"payin"
"payout"
user: DataInvoicePaymentUser

User associated with the payment.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

users: List[DataInvoiceUser]

Users involved in the invoice.

id: str

User-provided unique external ID.

balances: List[DataInvoiceUserBalance]

Per-currency balance breakdown for the user.

currency: str

ISO 4217 or crypto currency code.

net: DataInvoiceUserBalanceNet

Net balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payins: DataInvoiceUserBalancePayins

Payins balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

payouts: DataInvoiceUserBalancePayouts

Payouts balance breakdown.

actual: str

Actual amount as a string in the smallest currency unit, such as cents for USD.

expected: str

Expected amount as a string in the smallest currency unit, such as cents for USD.

remaining: str

Remaining amount as a string in the smallest currency unit, such as cents for USD.

external_id: str

User-provided unique ID.

page_info: DataPageInfo

Pagination cursors.

next_cursor: Optional[str]

Cursor to fetch the next page of results.

class InvoiceUpdateResponse: …
data: Invoice

Invoice object.

id: str

Unique invoice ID.

created: datetime

Timestamp when the invoice was created. Uses ISO 8601 format.

formatdate-time
Deprecatedstatus: Literal["active"]

Status of the invoice. Deprecated.

tags: List[Tag]

Tags for the invoice.

key: str

Tag key.

value: str

Tag value.

version: float

Current version of the invoice.

workspace_id: str

Workspace the invoice belongs to.

line_items: Optional[List[LineItem]]

Line items for the invoice.

id: str

FRAGMENT generated unique ID.

Deprecatedamount: str

Total amount as a string in the smallest currency unit, such as cents for USD. Deprecated, use price.amount instead.

currency_code: Literal["ADA", "BTC", "DAI", 176 more]

ISO 4217 or crypto currency code.

One of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
description: str

Description of the line item.

price: LineItemPrice

Price breakdown.

amount: str

Total amount as a string in the smallest currency unit, such as cents for USD.

quantity: int

Number of units.

unit_price: str

Unit price as a string in the smallest currency unit, such as cents for USD.

product_id: str

Unique identifier for the product.

tags: List[LineItemTag]

Tags for the line item.

key: str

Tag key.

value: str

Tag value.

type: Literal["payin", "payout"]

Type of the line item.

One of the following:
"payin"
"payout"
user_id: str

User-provided unique external ID.

modified: Optional[datetime]

Timestamp when the invoice was last modified. Uses ISO 8601 format.

formatdate-time