Skip to content
FRAGMENT
API Reference

Invoices

Invoice management operations

Create
client.invoices.create(InvoiceCreateParams { invoice_id, line_items, tags } body, RequestOptionsoptions?): InvoiceCreateResponse { data }
POST/invoices
Create Batch Get
client.invoices.createBatchGet(InvoiceCreateBatchGetParams { ids } body, RequestOptionsoptions?): InvoiceCreateBatchGetResponse { data }
POST/invoices/batch-get
List
client.invoices.list(RequestOptionsoptions?): InvoiceListResponse { data }
GET/invoices
List History
client.invoices.listHistory(stringid, RequestOptionsoptions?): InvoiceListHistoryResponse { data }
GET/invoices/{id}/history
Retrieve
client.invoices.retrieve(stringid, RequestOptionsoptions?): InvoiceRetrieveResponse { data }
GET/invoices/{id}
Search
client.invoices.search(InvoiceSearchParams { filter, page_info } body, RequestOptionsoptions?): InvoiceSearchResponse { data }
POST/invoices/search
Update
client.invoices.update(stringid, InvoiceUpdateParams { current_invoice_version, line_items, tags } body, RequestOptionsoptions?): InvoiceUpdateResponse { data }
PATCH/invoices/{id}
ModelsExpand Collapse
Invoice { id, created, status, 5 more }

Invoice object.

id: string

Unique invoice ID.

created: string

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

formatdate-time
Deprecatedstatus: "active"

Status of the invoice. Deprecated.

tags: Array<Tag>

Tags for the invoice.

key: string

Tag key.

value: string

Tag value.

version: number

Current version of the invoice.

workspace_id: string

Workspace the invoice belongs to.

line_items?: Array<LineItem>

Line items for the invoice.

id: string

FRAGMENT generated unique ID.

Deprecatedamount: string

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

currency_code: "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: string

Description of the line item.

price: Price { amount, quantity, unit_price }

Price breakdown.

amount: string

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

quantity: number

Number of units.

unit_price: string

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

product_id: string

Unique identifier for the product.

tags: Array<Tag>

Tags for the line item.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the line item.

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

User-provided unique external ID.

modified?: string

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

formatdate-time
InvoiceCreateResponse { data }
data: Invoice { id, created, status, 5 more }

Invoice object.

id: string

Unique invoice ID.

created: string

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

formatdate-time
Deprecatedstatus: "active"

Status of the invoice. Deprecated.

tags: Array<Tag>

Tags for the invoice.

key: string

Tag key.

value: string

Tag value.

version: number

Current version of the invoice.

workspace_id: string

Workspace the invoice belongs to.

line_items?: Array<LineItem>

Line items for the invoice.

id: string

FRAGMENT generated unique ID.

Deprecatedamount: string

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

currency_code: "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: string

Description of the line item.

price: Price { amount, quantity, unit_price }

Price breakdown.

amount: string

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

quantity: number

Number of units.

unit_price: string

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

product_id: string

Unique identifier for the product.

tags: Array<Tag>

Tags for the line item.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the line item.

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

User-provided unique external ID.

modified?: string

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

formatdate-time
InvoiceCreateBatchGetResponse { data }

Result of a batch invoice retrieval.

data: Data { invoices, not_found }

Result of a batch invoice retrieval.

invoices: Array<Invoice>

Invoices that were found, in request order.

balances: Array<Balance>

Invoice-level balances by currency.

currency: string

ISO 4217 or crypto currency code.

net: Net { actual, expected, remaining }

Net balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payins: Payins { actual, expected, remaining }

Payins balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payouts: Payouts { actual, expected, remaining }

Payouts balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payments: Array<Payment>

Payments allocated to the invoice.

amount: string

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

currency: "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: string

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

formatdate-time
transaction: Transaction { id, external_id, tags }

Transaction the payment is applied to.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: Array<Tag>

Tags from the parent transaction.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the payment.

One of the following:
"payin"
"payout"
user: User { id, external_id }

User associated with the payment.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

users: Array<User>

Users involved in the invoice.

id: string

User-provided unique external ID.

balances: Array<Balance>

Per-currency balance breakdown for the user.

currency: string

ISO 4217 or crypto currency code.

net: Net { actual, expected, remaining }

Net balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payins: Payins { actual, expected, remaining }

Payins balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payouts: Payouts { actual, expected, remaining }

Payouts balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

external_id: string

User-provided unique ID.

not_found: Array<string>

Ids from the request that did not match any invoice.

InvoiceListResponse { data }
data: Array<Invoice { id, created, status, 5 more } >

List of invoices.

id: string

Unique invoice ID.

created: string

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

formatdate-time
Deprecatedstatus: "active"

Status of the invoice. Deprecated.

tags: Array<Tag>

Tags for the invoice.

key: string

Tag key.

value: string

Tag value.

version: number

Current version of the invoice.

workspace_id: string

Workspace the invoice belongs to.

line_items?: Array<LineItem>

Line items for the invoice.

id: string

FRAGMENT generated unique ID.

Deprecatedamount: string

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

currency_code: "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: string

Description of the line item.

price: Price { amount, quantity, unit_price }

Price breakdown.

amount: string

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

quantity: number

Number of units.

unit_price: string

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

product_id: string

Unique identifier for the product.

tags: Array<Tag>

Tags for the line item.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the line item.

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

User-provided unique external ID.

modified?: string

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

formatdate-time
InvoiceListHistoryResponse { data }
data: Array<Invoice { id, created, status, 5 more } >

Version history of the invoice.

id: string

Unique invoice ID.

created: string

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

formatdate-time
Deprecatedstatus: "active"

Status of the invoice. Deprecated.

tags: Array<Tag>

Tags for the invoice.

key: string

Tag key.

value: string

Tag value.

version: number

Current version of the invoice.

workspace_id: string

Workspace the invoice belongs to.

line_items?: Array<LineItem>

Line items for the invoice.

id: string

FRAGMENT generated unique ID.

Deprecatedamount: string

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

currency_code: "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: string

Description of the line item.

price: Price { amount, quantity, unit_price }

Price breakdown.

amount: string

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

quantity: number

Number of units.

unit_price: string

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

product_id: string

Unique identifier for the product.

tags: Array<Tag>

Tags for the line item.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the line item.

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

User-provided unique external ID.

modified?: string

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

formatdate-time
InvoiceRetrieveResponse { data }
data: Data { balances, payments, users }

Invoice with balance details.

balances: Array<Balance>

Invoice-level balances by currency.

currency: string

ISO 4217 or crypto currency code.

net: Net { actual, expected, remaining }

Net balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payins: Payins { actual, expected, remaining }

Payins balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payouts: Payouts { actual, expected, remaining }

Payouts balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payments: Array<Payment>

Payments allocated to the invoice.

amount: string

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

currency: "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: string

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

formatdate-time
transaction: Transaction { id, external_id, tags }

Transaction the payment is applied to.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: Array<Tag>

Tags from the parent transaction.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the payment.

One of the following:
"payin"
"payout"
user: User { id, external_id }

User associated with the payment.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

users: Array<User>

Users involved in the invoice.

id: string

User-provided unique external ID.

balances: Array<Balance>

Per-currency balance breakdown for the user.

currency: string

ISO 4217 or crypto currency code.

net: Net { actual, expected, remaining }

Net balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payins: Payins { actual, expected, remaining }

Payins balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payouts: Payouts { actual, expected, remaining }

Payouts balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

external_id: string

User-provided unique ID.

InvoiceSearchResponse { data }

Search results for invoices.

data: Data { invoices, page_info }

Search results for invoices.

invoices: Array<Invoice>

Invoices matching the search criteria.

balances: Array<Balance>

Invoice-level balances by currency.

currency: string

ISO 4217 or crypto currency code.

net: Net { actual, expected, remaining }

Net balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payins: Payins { actual, expected, remaining }

Payins balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payouts: Payouts { actual, expected, remaining }

Payouts balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payments: Array<Payment>

Payments allocated to the invoice.

amount: string

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

currency: "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: string

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

formatdate-time
transaction: Transaction { id, external_id, tags }

Transaction the payment is applied to.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: Array<Tag>

Tags from the parent transaction.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the payment.

One of the following:
"payin"
"payout"
user: User { id, external_id }

User associated with the payment.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

users: Array<User>

Users involved in the invoice.

id: string

User-provided unique external ID.

balances: Array<Balance>

Per-currency balance breakdown for the user.

currency: string

ISO 4217 or crypto currency code.

net: Net { actual, expected, remaining }

Net balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payins: Payins { actual, expected, remaining }

Payins balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

payouts: Payouts { actual, expected, remaining }

Payouts balance breakdown.

actual: string

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

expected: string

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

remaining: string

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

external_id: string

User-provided unique ID.

page_info: PageInfo { next_cursor }

Pagination cursors.

next_cursor?: string

Cursor to fetch the next page of results.

InvoiceUpdateResponse { data }
data: Invoice { id, created, status, 5 more }

Invoice object.

id: string

Unique invoice ID.

created: string

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

formatdate-time
Deprecatedstatus: "active"

Status of the invoice. Deprecated.

tags: Array<Tag>

Tags for the invoice.

key: string

Tag key.

value: string

Tag value.

version: number

Current version of the invoice.

workspace_id: string

Workspace the invoice belongs to.

line_items?: Array<LineItem>

Line items for the invoice.

id: string

FRAGMENT generated unique ID.

Deprecatedamount: string

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

currency_code: "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: string

Description of the line item.

price: Price { amount, quantity, unit_price }

Price breakdown.

amount: string

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

quantity: number

Number of units.

unit_price: string

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

product_id: string

Unique identifier for the product.

tags: Array<Tag>

Tags for the line item.

key: string

Tag key.

value: string

Tag value.

type: "payin" | "payout"

Type of the line item.

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

User-provided unique external ID.

modified?: string

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

formatdate-time