Billwerk+ is now Frisbii
API Reference
Frisbii WebsiteHelp CenterTry for freeBook a demo
Start typing to search…

Create or update billing address

put https://api.reepay.com/v1/invoice//billing_address
Log in to see full request history

Create or update invoice billing address

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.

Error code HTTP codeDescription
31404Invoice not found
Path Params
string
required

Invoice id or handle

Body Params
string

Company name

string

Company vat number

string

Attention

string

Address line 1

string

Address line 2

string

City

string

Country in ISO 3166-1 alpha-2

string

Email

string

Phone number

string

First name

string

Last name

string

Postal code

string

State or province. Should be in country subdivision code defined in ISO 3166-2.

Responses

Response body
object
string
required
length ≥ 1

Invoice id assigned by Frisbii

string
required
length ≥ 1

Per account unique handle. Provided at on-demand invoice/charge creation or set to inv-<invoice_number> for automatically created subscription invoices

string
required
length ≥ 1

Customer handle

string

Subscription handle, will be null for a one-time customer invoice

string

Subscription plan handle for the plan used to automatically create the invoice or the case that an on-demand subscription invoice has been created that should include a plan order line

string
required
length ≥ 1

The invoice state one of the following: created, pending, dunning, settled, cancelled, authorized, failed

created pending dunning settled authorized cancelled failed

boolean

For asynchronous payment methods, e.g. MobilePay subscriptions, this flag indicates that an invoice transaction is in state processing and is awaiting result.

string
required
length ≥ 1

The type of invoice: s - subscription recurring, so - subscription one-time, soi - subscription one-time instant, co - customer one-time, ch - charge

s so soi co ch

int32
required
≥ 0

The invoice amount including VAT

int32
≥ 1

Sequential invoice number. Only present for subscription and customer invoices.

string
required

Invoice currency in ISO 4217 three letter alpha code

date-time
required

When is the invoice due, in ISO-8601 extended offset date-time format.

date-time

When the invoice failed, in ISO-8601 extended offset date-time format.

date-time

When the invoice settled, in ISO-8601 extended offset date-time format.

date-time

When the invoice was cancelled, in ISO-8601 extended offset date-time format.

date-time

When the invoice was authorized, if the invoice went through an authorize and settle flow, in ISO-8601 extended offset date-time format.

credits
array of objects
required

Credits applied to invoice

credits*
object
string
required
length ≥ 1

Credit handle

int32
required
≥ 0

The credit amount transferred to invoice

date-time
required

Date when credit was transferred to invoice. In ISO-8601 extended offset date-time format.

string
required
length ≥ 1

Text describing the credit.

date-time
required

When the invoice was created, in ISO-8601 extended offset date-time format.

int32

Subscription plan version

string

Dunning plan handle

int32
required
≥ 0

The potential discount amount deducted from the invoice amount including VAT

int32
required
≥ 0

The invoice original amount including VAT, may differ from amount if adjustments have been applied for the invoice

int32
required

The invoice vat amount calculated as rounded summed fractional vats for each orderline

int32
required

The invoice amount without vat

int32
required

Settled amount

int32
required

Refunded amount

int32

Authorized amount

int32

Credited amount

int32

The subscription period this invoice is for

string

Optional reference to recurring payment method created in conjunction with charging

order_lines
array of objects
required

Order lines for invoice sorted by descending timestamp

order_lines*
object
string
required
length ≥ 1

Per account unique order line id

string
required
length ≥ 1

Order line text

int32
required

Order line total amount including vat

float
required

Order line vat percent

int32
required
≥ 1

Order line quantity

string
required

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

date-time
required

Timestamp from order line origin, in ISO-8601 extended offset date-time format.

int32

Order line amount after potential discount has been deducted

int32
required

Order line total vat amount

int32
required

Order line total amount without vat

int32
required

Order line unit amount including vat

int32
required

Order line unit vat amount

int32
required

Order line unit amount without vat

boolean
required

Whether the amount was defined including VAT. E.g. plan amount defined including VAT.

string

Tax rule applied for order line indicates who is liable to account for the VAT.

reverse_charge intra_community_digital_service

string

Handle for additional cost, credit, plan or subscription discount in the case one of those are the origin

date-time

The start of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

date-time

The end of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

int32

The discount percentage for discount order lines that has a percentage discount

string

For discount order lines a reference to the order line for which the order line is a discount

additional_costs
array of strings
required

Additional cost handles for any additional costs added to this invoice

additional_costs*
transactions
array of objects
required

Invoice transactions, ascending order and limited to 100 transactions

transactions*
object
string
required
length ≥ 1

Transaction id assigned by Frisbii

string
required
length ≥ 1

State of the transaction, one of the following: pending, processing, authorized, settled, refunded, failed, cancelled

pending processing authorized settled refunded failed cancelled

string
required
length ≥ 1

Invoice handle

string
required
length ≥ 1

Transaction type, one of the following: settle, refund, authorization

settle refund authorization

int32
required
≥ 0

The transaction amount

string

Currency in ISO 4217 three letter alpha code

date-time

When the transaction was settled, in ISO-8601 extended offset date-time format.

date-time

When the transaction was authorized, in ISO-8601 extended offset date-time format.

date-time

When the transaction failed, in ISO-8601 extended offset date-time format.

date-time

When the transaction was refunded, in ISO-8601 extended offset date-time format.

date-time
required

Date when the transaction was created. In ISO-8601 extended offset date-time format.

string
required

Payment type for transaction, either: card, mpo, mobilepay, vipps, vipps_epayment, vipps_recurring, swish, viabill, anyday, manual, applepay, googlepay, paypal, klarna_pay_now, klarna_pay_later, klarna_slice_it, klarna_direct_bank_transfer, klarna_direct_debit, resurs, mobilepay_subscriptions, emv_token, bancomatpay, bcmc, blik, pp_blik_oc, giropay, ideal, p24, sepa, trustly, eps, estonia_banks, latvia_banks, lithuania_banks, mb_way, multibanco, mybank, payconiq, paysafecard, paysera, postfinance, satispay, twint, wechatpay, santander, verkkopankki, offline_cash, offline_bank_transfer, or offline_other

card mpo mobilepay vipps vipps_epayment vipps_recurring swish viabill anyday manual applepay googlepay paypal klarna_pay_now klarna_pay_later klarna_slice_it klarna_direct_bank_transfer klarna_direct_debit resurs ideal p24 bancomatpay blik giropay sepa verkkopankki mobilepay_subscriptions emv_token bcmc pp_blik_oc trustly eps estonia_banks latvia_banks lithuania_banks mb_way multibanco mybank payconiq paysafecard paysera postfinance satispay twint wechatpay santander offline_cash offline_bank_transfer offline_other

string

Reference to payment method in case of a MIT transaction

card_transaction
object

Specifics in case of GooglePay transaction

mpo_transaction
object

Specifics in case of GooglePay transaction

vipps_transaction
object

Specifics in case of GooglePay transaction

applepay_transaction
object

Specifics in case of GooglePay transaction

googlepay_transaction
object

Specifics in case of GooglePay transaction

manual_transaction
object

Specifics in case of manual transaction

viabill_transaction
object

Specifics in case of ViaBill transaction

anyday_transaction
object

Specifics in case of Anyday transaction

santander_transaction
object

Specifics in case of Santander transaction

resurs_transaction
object

Specifics in case of Resurs Bank transaction

klarna_transaction
object

Specifics in case of Klarna transaction

swish_transaction
object

Specifics in case of Swish transaction

paypal_transaction
object

Specifics in case of PayPal transaction

bancomatpay_transaction
object

Specifics in case of Bancomat Pay transaction

bancontact_transaction
object

Specifics in case of Bancontact transaction

blik_transaction
object

Specifics in case of BLIK transaction

giropay_transaction
object

Specifics in case of Giropay transaction

ideal_transaction
object

Specifics in case of IDEAL transaction

p24_transaction
object

Specifics in case of P24 transaction

sepa_transaction
object

Specifics in case of SEPA transaction

trustly_transaction
object

Specifics in case of Trustly transaction

verkkopankki_transaction
object

Specifics in case of Verkkopankki transaction

eps_transaction
object

Specifics in case of Eps transaction

estonia_banks_transaction
object

Specifics in case of Estonia Banks transaction

latvia_banks_transaction
object

Specifics in case of Latvia Banks transaction

lithuania_banks_transaction
object

Specifics in case of Lithuania Banks transaction

mbway_transaction
object

Specifics in case of MB Way transaction

multibanco_transaction
object

Specifics in case of Multibanco transaction

mybank_transaction
object

Specifics in case of MyBank transaction

payconiq_transaction
object

Specifics in case of Payconiq transaction

paysafecard_transaction
object

Specifics in case of Paysafecard transaction

paysera_transaction
object

Specifics in case of Paysera transaction

postfinance_transaction
object

Specifics in case of PostFinance transaction

satispay_transaction
object

Specifics in case of Satispay transaction

twint_transaction
object

Specifics in case of Twint transaction

wechatpay_transaction
object

Specifics in case of WeChat Pay transaction

mps_transaction
object

Specifics in case of MobilePay Subscriptions transaction

vipps_epayment_transaction
object

Specifics in case of Vipps ePayments transaction

vipps_recurring_transaction
object

Specifics in case of Vipps Recurring transaction

offline_transaction
object

Specifics in case of Offline transaction

string

Payment context describing if the transaction is customer or merchant initiated, one of the following values: cit, mit, cit_cof

string

Accounting invoice number if this transaction belongs to an accounting invoice

int64

Customer debtor id if this transaction belongs to an accounting invoice

string

Customer handle if this transaction belongs to an accounting invoice

date-time

When dunning for the invoice was started, in ISO-8601 extended offset date-time format.

int32

Number of dunning events for invoice (number of reminders sent)

date-time

When dunning for the invoice expired, in ISO-8601 extended offset date-time format.

date-time

The start of billing period if the invoice is for a specific billing period, in ISO-8601 extended offset date-time format.

date-time

The end of billing period if the invoice is for a specific billing period, in ISO-8601 extended offset date-time format.

boolean

Whether this is a customer one-time invoice that will be settled later

string

The payment method to use for a later settle of a one-time customer invoice

billing_address
object

Optional billing address

string

Company name

string

Company vat number

string

Attention

string

Address line 1

string

Address line 2

string

City

string

Country in ISO 3166-1 alpha-2

string

Email

string

Phone number

string

First name

string

Last name

string

Postal code

string

State or province. Should be in country subdivision code defined in ISO 3166-2.

shipping_address
object

Optional shipping address

string

Company name

string

Company vat number

string

Attention

string

Address line 1

string

Address line 2

string

City

string

Country in ISO 3166-1 alpha-2

string

Email

string

Phone number

string

First name

string

Last name

string

Postal code

string

State or province. Should be in country subdivision code defined in ISO 3166-2.

string

Invoice accounting number

int64

Customer debtor id

string

Url to invoice pdf

date-time

When the accounting invoice was created. An accounting invoice is created when a non-charging invoice is created with the state pending or the invoice moved from state created. Timestamp in ISO-8601 extended offset date-time format.

credit_notes
array of objects

Invoice credit notes

credit_notes
object
string
required
length ≥ 1

Credit note id

string
required

Invoice credited by this note

string

Refund transaction id if credit note has an associated refund

string

Credit reference if the credit note relates to a subscription credit

int32
required

Credit note amount

date-time
required

Creation date for note, in ISO-8601 extended offset date-time format.

string
required

Credit note currency in ISO 4217 three letter alpha code

string
required
length ≥ 1

Customer handle

string

Subscription handle, will be null for a one-time customer invoice

int32
required

Credit note vat amount calculated as rounded summed fractional vats for each credit note lines

int32

Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines

credit_note_lines
array of objects
required

Credit note lines

credit_note_lines*
object
int32
required
≥ 1

Credit note line total amount

string
required
length ≥ 1

Credit note line text

string

Order line description

int32
required
≥ 1

Credit note line quantity

float

Vat for this credit note line

date-time

Creation date for this credit note line, in ISO-8601 extended offset date-time format.

string

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

string

Reference to invoice orderline this credit note line relates to

int32

Credit note line total amount including VAT

int32

Credit note line total amount excluding VAT

int32

Credit note line unit amount

int32

Credit note line vat amount

int32

Credit note line unit amount excluding VAT

boolean

Whether the total and units are including VAT.

date-time

The start of billing period in ISO-8601 extended offset date-time format.

date-time

The end of billing period in ISO-8601 extended offset date-time format.

string

Credit note accounting number

int64

Customer debtor id

string

Url to credit note pdf

date-time

When the credit note was created. A credit note is created when a non-charging invoice is cancelled or refunded. Timestamp in ISO-8601 extended offset date-time format.

Updated about 13 hours ago

Did this page help you?
Language
Credentials
:

Updated about 13 hours ago

Did this page help you?