Get Invoice | Coinflow

import requests
url = "https://api-sandbox.coinflow.cash/api/merchant/invoices/invoiceId"
headers = {"Authorization": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "string",
  "referenceId": "string",
  "merchantId": "string",
  "invoiceType": "Billing",
  "status": "Draft",
  "lineItems": [
    {
      "id": "string",
      "sourceType": "refund",
      "category": "Refund",
      "amount": {
        "cents": 1,
        "currency": "USD"
      },
      "sourceId": "string",
      "description": "string"
    }
  ],
  "amount": {
    "cents": 1,
    "currency": "USD"
  },
  "periodStart": "2024-01-15T09:30:00Z",
  "periodEnd": "2024-01-15T09:30:00Z",
  "dueDate": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "billingPeriod": "string",
  "issuedAt": "2024-01-15T09:30:00Z",
  "sentAt": "2024-01-15T09:30:00Z",
  "paidAt": "2024-01-15T09:30:00Z",
  "payment": {
    "method": "Checkout",
    "paymentId": "string",
    "transactionId": "string"
  },
  "notes": "string"
}

Get a specific invoice.

Authentication

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Path parameters

invoiceIdstringRequired

The invoice ID

Response

idstring

referenceIdstring

merchantIdstring

invoiceTypeenum

Type of invoice:

Billing: Monthly end-of-period billing invoice (one per merchant per billing period)
Ancillary: Ad-hoc/miscellaneous invoice for any charges

Type of invoice: - Billing: Monthly end-of-period billing invoice (one per merchant per billing period) - Ancillary: Ad-hoc/miscellaneous invoice for any charges

Allowed values:

statusenum

lineItemslist of objects

amountobject

periodStartdatetime

periodEnddatetime

dueDatedatetime

createdAtdatetime

updatedAtdatetime

billingPeriodstring or null

issuedAtdatetime or null

sentAtdatetime or null

paidAtdatetime or null

paymentobject or null

Payment info for a paid invoice (single payment only, no partials)

notesstring or null