GET
/
expenses
List available expenses
curl --request GET \
  --url https://api.altera.co/expenses \
  --header 'Authorization: <api-key>'
{
  "result": "OK",
  "data": {
    "expenses": [
      {
        "modelType": "PROCESSED_EXPENSE",
        "readOnly": false,
        "basicInformation": {
          "invoiceId": 18,
          "invoiceType": "SALES",
          "invoiceNumber": "2/1/2022",
          "year": 2022,
          "month": 6,
          "invoiceNumberInPeriod": 2,
          "statusId": "SENT",
          "isReceipt": false,
          "isRelated": false,
          "netPrice": 8500,
          "grossPrice": 10455,
          "currency": "PLN",
          "exchangeRate": 1,
          "vatPLN": 1955,
          "issueDate": "2022-06-16T00:00:00.000Z",
          "saleDate": "2022-06-27T00:00:00.000Z",
          "uploadDate": "2022-03-24T14:26:17.000Z",
          "relatedInvoicesIds": [],
          "priceTypeId": "NET",
          "paymentGenerationStatus": "ACCEPTED"
        },
        "contractor": {
          "contractorName": "Altera sp. z o.o.",
          "contractorId": 25,
          "taxIdentificationNumber": "7010978165",
          "country": "PL",
          "contractorType": "COMPANY",
          "contractorRegion": "POLAND",
          "defaultCurrency": "PLN",
          "city": "Bydgoszcz",
          "street": "ul. Grunwaldzka",
          "houseNumber": "4",
          "postCode": "85-236"
        },
        "buyer": {
          "taxIdentificationNumber": "9671391067",
          "contractorName": "ITKO Łukasz Kowalski"
        },
        "seller": {
          "contractorName": "Altera sp. z o.o.",
          "contractorId": 25,
          "taxIdentificationNumber": "7010978165",
          "country": "PL",
          "contractorType": "COMPANY",
          "contractorRegion": "POLAND",
          "defaultCurrency": "PLN",
          "city": "Bydgoszcz",
          "street": "ul. Grunwaldzka",
          "houseNumber": "4",
          "postCode": "85-236"
        },
        "payments": {
          "paymentMethod": "TRANSFER",
          "dueDate": "2022-07-11T00:00:00.000Z",
          "isSplitPayment": false,
          "isPaid": false,
          "bankAccountNumber": "PL78114020040000360280396856"
        },
        "invoicePosition": [],
        "costCenterPerItem": false,
        "additionalDetails": "Usługi księgowe Koszty ogólne",
        "accounting": {
          "accountingDate": "2022-09-16T00:00:00.000Z",
          "receiptDate": "2022-09-23T00:00:00.000Z",
          "vatProcedures": [],
          "registrationPlate": "",
          "isSubjectToVat": false,
          "activeVat": false,
          "bufferOnly": false
        }
      }
    ],
    "pagesAmount": "1",
    "sumGross": "10455.000",
    "sumNet": "8500.00"
  }
}

Authorizations

​
Authorization
string
header
required

OpenApi Key created within Altera.app for a certain company

Query Parameters

​
documentsPerPage
enum<string>
default:20

Defines the amount of invoices polled per page

Available options:
10,
20,
50,
100
​
pageNumber
string

Defines the page we want to poll

​
sortBy
enum<string>
Available options:
INVOICE_NUMBER,
ISSUE_DATE,
SALE_DATE,
DUE_DATE,
AMOUNT_GROSS,
CONTRACTOR_NAME
Example:

"ISSUE_DATE"

​
order
enum<string>
Available options:
ASC,
DESC
Example:

"DESC"

​
searchPhrase
string

Freetext search over concatenated fields InvoiceNumber, ContractorName, ContractorTIN and ContractorCity

​
contractorName
string
​
invoiceType
any[]
Example:

"INTERIM"

​
paymentStatus
enum<string>
Available options:
PAID,
UNPAID,
OVERDUE
Example:

"OVERDUE"

Response

200 - application/json

OK

The response is of type object.