Reference

Endpoint Retrieve an Invoice

Name

get_single_invoice

Description

Retrieves the invoice with the given Id. [API reference]

Related Tables

Invoices

Parameters

Parameter	Required	Options
Name: Id Label: Invoice Id Returns an invoice for the Invoice Id.	YES

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length
Id	`DT_WSTR`	`nvarchar(255)`	255
Object	`DT_WSTR`	`nvarchar(100)`	100
AccountCountry	`DT_WSTR`	`nvarchar(100)`	100
AccountName	`DT_WSTR`	`nvarchar(1020)`	1020
AccountTaxId	`DT_WSTR`	`nvarchar(1020)`	1020
AmountDue	`DT_I8`	`bigint`
AmountPaid	`DT_I8`	`bigint`
AmountRemaining	`DT_I8`	`bigint`
ApplicationFeeAmount	`DT_I8`	`bigint`
AttemptCount	`DT_I8`	`bigint`
Attempted	`DT_BOOL`	`bit`
AutoAdvance	`DT_BOOL`	`bit`
BillingReason	`DT_WSTR`	`nvarchar(1020)`	1020
Charge	`DT_WSTR`	`nvarchar(255)`	255
CollectionMethod	`DT_WSTR`	`nvarchar(1020)`	1020
Created	`DT_DBTIMESTAMP`	`datetime`
Currency	`DT_WSTR`	`nvarchar(100)`	100
CustomFields	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerId	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressCity	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressCountry	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressLine1	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressLine2	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressPostalCode	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerAddressState	`DT_WSTR`	`nvarchar(1020)`	1020
CustomerEmail	`DT_WSTR`	`nvarchar(100)`	100
CustomerName	`DT_WSTR`	`nvarchar(100)`	100
CustomerPhone	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressCity	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressCountry	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressLine1	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressLine2	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressPostalCode	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingAddressState	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingName	`DT_WSTR`	`nvarchar(100)`	100
CustomerShippingPhone	`DT_WSTR`	`nvarchar(100)`	100
TaxExempt	`DT_WSTR`	`nvarchar(100)`	100
TaxIDs	`DT_WSTR`	`nvarchar(1020)`	1020
DefaultPaymentMethod	`DT_WSTR`	`nvarchar(1020)`	1020
DefaultSource	`DT_WSTR`	`nvarchar(1020)`	1020
DefaultTaxRates	`DT_WSTR`	`nvarchar(1000)`	1000
Description	`DT_WSTR`	`nvarchar(1020)`	1020
Discount	`DT_WSTR`	`nvarchar(1020)`	1020
Discounts	`DT_WSTR`	`nvarchar(100)`	100
DueDate	`DT_DBTIMESTAMP`	`datetime`
EndingBalance	`DT_I8`	`bigint`
Footer	`DT_WSTR`	`nvarchar(1020)`	1020
HostedInvoiceURL	`DT_WSTR`	`nvarchar(1020)`	1020
InvoicePDF	`DT_WSTR`	`nvarchar(1020)`	1020
LastFinalizationError	`DT_WSTR`	`nvarchar(1020)`	1020
LinesObject	`DT_WSTR`	`nvarchar(100)`	100
LinesData	`DT_NTEXT`	`nvarchar(MAX)`
LinesHasMore	`DT_BOOL`	`bit`
LinesTotalCount	`DT_I8`	`bigint`
LinesUrl	`DT_WSTR`	`nvarchar(1020)`	1020
LiveMode	`DT_BOOL`	`bit`
NextPaymentAttempt	`DT_DBTIMESTAMP`	`datetime`
Number	`DT_WSTR`	`nvarchar(1020)`	1020
Paid	`DT_BOOL`	`bit`
PaymentIntent	`DT_WSTR`	`nvarchar(1020)`	1020
PeriodEnd	`DT_DBTIMESTAMP`	`datetime`
PeriodStart	`DT_DBTIMESTAMP`	`datetime`
PostPaymentCreditNotesAmount	`DT_I8`	`bigint`
PrepaymentCreditNotesAmount	`DT_I8`	`bigint`
ReceiptNumber	`DT_WSTR`	`nvarchar(255)`	255
StartingBalance	`DT_I8`	`bigint`
StatementDesctiption	`DT_WSTR`	`nvarchar(1020)`	1020
Status	`DT_WSTR`	`nvarchar(100)`	100
StatusTransitionsFinalizedAt	`DT_DBTIMESTAMP`	`datetime`
StatusTransitionsMarkedUncollectibleAt	`DT_DBTIMESTAMP`	`datetime`
StatusTransitionsPaidAt	`DT_DBTIMESTAMP`	`datetime`
StatusTransitionsVoidedAt	`DT_DBTIMESTAMP`	`datetime`
SubscriptionId	`DT_WSTR`	`nvarchar(1020)`	1020
Subtotal	`DT_I8`	`bigint`
Tax	`DT_I8`	`bigint`
Total	`DT_I8`	`bigint`
TotalDiscountAmounts	`DT_WSTR`	`nvarchar(100)`	100
TotalTaxAmounts	`DT_WSTR`	`nvarchar(100)`	100
TransferData	`DT_WSTR`	`nvarchar(1020)`	1020
WebhooksDeliveredAt	`DT_DBTIMESTAMP`	`datetime`

If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Description
Id	`DT_WSTR`	`nvarchar(4000)`	4000

Required columns that you need to supply are bolded.

Examples

SSIS

Use Stripe Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Invoices table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Stripe

This connector support read/write operations for Stripe APIs

Stripe

Invoices

Required Parameters
Invoice Id	Fill-in the parameter...
Optional Parameters
ContineOn404Error	True

SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Invoices table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to retrieve an invoice:

API Destination - Stripe

This connector support read/write operations for Stripe APIs

Stripe

Invoices

Lookup

Required Parameters
Invoice Id	Fill-in the parameter...
Optional Parameters
ContineOn404Error	True

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get an Invoice

Read an invoice

SELECT * FROM Invoices
WHERE Id = 'abc'

get_single_invoice endpoint belongs to Invoices table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get an Invoice

Read an invoice

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Invoices
WHERE Id = ''abc''';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

get_single_invoice endpoint belongs to Invoices table(s), and can therefore be used via those table(s).