Sign in

v1

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

Create Invoice

Purpose:

Captures against an order. This can be done against part of the authorised order amount (partial capture) or its entire amount (full capture).

For partial captures, please submit each as a separate request specifying the amount until the full amount of the associated Order is reached.

Preconditions:

  • id: The unique identifier of the order
  • Order with id has a sufficient unshipped amount (not lower than the amount provided to be captured).
  • Invoice Number present as external_code
  • Invoice present and reachable for download at invoice_url

Success:

  • Response Code: HTTP 201
  • Response body: 'uuid` -> unique identifier of the capture

Attention:

  • Only one order id can be provided per request.
  • Don’t submit a negative amount value.
  • The referenced order will change its state to shipped if the full amount is captured and partially_shipped for a capture amount lower then the order amount.
  • Capturing an order that is already partially shipped with an amount equal to the remaining amount will change the state of the order from partially_shipped to shipped.
post/invoices

Request body

ordersUUID[] required

Include all the order ids that you want to create an invoice for (currently only one order is supported).

external_codestring required
invoice_urlstring required

Example request

{
  "orders": [
    "12345667-890a-bcde-f123-34567890abcd"
  ],
  "amount": {
    "gross": 260.27,
    "net": 200.12,
    "tax": 60.15
  }
}

Response

Invoice successfully created

uuidstring uuid required

Example response

{
  "uuid": "12345667-890a-bcde-f123-34567890abcd"
}