Sign in

v1

latestOpenAPI 3.0.0© Billie GmbH, 20202026-07-24143643.6 KB
Captures

Get Invoice

Purpose:

Retrieves full information about a capture.

Preconditions:

  • captureId: The unique identifier of the capture

Success:

  • Response Code: HTTP 200
get/invoices/{captureId}

Path parameters

captureIdstring uuid required
Example:12345667-890a-bcde-f123-34567890abcd

The unique identifier of the capture

Response

Invoice Response

uuidstring uuid
invoice_numberstring nullable

Customer facing merchant defined invoice number which must be unique.

durationnumber

The defined time allowed for payment. Measured in days.

payout_amountnumber float

The amount that will be paid out to the merchant.

outstanding_amountnumber float

The remaining amount that has to be paid by the debtor still.

fee_amountnumber float

The fee amount per invoice paid by the merchant to Billie.

fee_ratenumber float

The fee rate is the percentage that the merchant pays to Billie.

created_atstring date

The date and time when the invoice was created.

due_datestring date

The date when this invoice is due to be paid back.

statestring

The state of the invoice.

selected_payment_method'bank_transfer' | 'direct_debit' nullable

Example response

{
  "uuid": "12345667-890a-bcde-f123-34567890abcd",
  "amount": {
    "gross": 260.27,
    "net": 200.12,
    "tax": 60.15
  },
  "created_at": "2019-03-20",
  "due_date": "2019-03-20",
  "state": "created",
  "selected_payment_method": "bank_transfer",
  "payment_methods": [
    {
      "type": "bank_transfer",
      "data": {
        "mandate_execution_date": "2019-01-20 14:00:00"
      }
    }
  ]
}