FIfiken
recurring invoices

GET /companies/{companySlug}/recurringInvoices

Changed on

Returns all recurring invoices for the given company.

Request

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

Query parameters

pageinteger

Returns the number of the page to return. Valid page values are integers from 0 to the total number of pages. Default value is 0.

pageSizeinteger

Defines the number of entries to return on each page. Maximum number of results that can be returned at one time are 100. Default value is 25.

customerIdinteger

Returns only recurring invoices with a job for the specified customer.

activeboolean

When set, returns only recurring invoices that have at least one active (true) or no active (false) job.

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