recurring invoices

GET /companies/{companySlug}/recurringInvoices/{recurringInvoiceId}

Changed on

Returns the recurring invoice with the specified id.

Request

  • Base URL
    https://api.fiken.no/api/v2
  • URL
    https://api.fiken.no/api/v2/companies/{companySlug}/recurringInvoices/{recurringInvoiceId}
  • Auth
    OAuth 2
    Authorization code: https://fiken.no/oauth/authorize
    Token URL: https://fiken.no/oauth/token

Response

OK

recurringInvoiceIdinteger

Recurring invoice (collection) ID.

createdDatestring date
descriptionstring

Optional description of the recurring invoice.

daysUntilDueDateinteger
activeboolean

True if at least one job in the collection is active (not paused).

invoiceDraftUuidstring uuid

UUID of the invoice draft the recurring invoice was created from.

Example response

{
  "recurringInvoiceId": 2888156,
  "createdDate": "2023-04-03",
  "daysUntilDueDate": 14,
  "jobs": [
    {
      "jobId": 2888157,
      "customerId": 7340852,
      "frequency": {
        "interval": 1,
        "intervalUnit": "MONTH"
      },
      "nextDate": "2018-05-03",
      "endDate": "2019-04-03",
      "lines": [
        {
          "net": 4500,
          "vat": 500,
          "vatType": "HIGH",
          "gross": 5000,
          "netInNok": 4500,
          "vatInNok": 500,
          "grossInNok": 5000,
          "vatInPercent": 25,
          "unitPrice": 4550,
          "quantity": 5,
          "discount": 25,
          "productId": 2888156,
          "productName": "Gardening Gloves VI2",
          "description": "Goatskin, with extra-long suede cuffs",
          "comment": "One size fits all",
          "incomeAccount": "3000"
        }
      ]
    }
  ]
}

Changes