Create/update invoice

curl --request POST \
  --url https://api.altera.co/sales/invoice \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelType": "INVOICE",
  "override": false,
  "basicInformation": {
    "invoiceId": 2069,
    "invoiceType": "SALES",
    "invoiceFormat": "%N/%M/%Y",
    "saleDate": "2022-10-11T00:00:00.000Z",
    "issueDate": "2022-10-11T00:00:00.000Z",
    "isReceipt": false,
    "relatedInvoicesIds": [],
    "priceTypeId": "NET"
  },
  "contractor": {
    "contractorRegion": "POLAND",
    "country": "PL",
    "contractorType": "COMPANY",
    "contractorName": "Test działania",
    "street": "Testowa",
    "houseNumber": "10",
    "flatNumber": "10",
    "city": "Bydgoszcz",
    "postCode": "62-156",
    "defaultCurrency": "PLN",
    "taxIdentificationNumber": "1589651654",
    "email": "[email protected]",
    "areaNumber": "+58",
    "phoneNumber": "518 961 516"
  },
  "invoicePosition": [
    {
      "productPosition": 0,
      "productName": "A",
      "positionType": "PRODUCT",
      "productCategory": "Health",
      "quantity": 10,
      "unit": "szt.",
      "priceType": null,
      "unitNetPrice": 150,
      "unitGrossPrice": 184.5,
      "vat": "23%",
      "pkwiu": "",
      "discount": "0",
      "deductions": false,
      "netPrice": "1500",
      "grossPrice": "1845",
      "invoiceProductId": 179
    }
  ],
  "additionalDetails": "",
  "correctionReason": "",
  "payments": {
    "isPaid": false,
    "paymentMethod": "TRANSFER",
    "dueDate": "2022-10-25T00:00:00.000Z",
    "bankAccountNumber": "10 1010 1062 5565 1561 5615 1516",
    "isSplitPayment": false
  },
  "projects": []
}
'

{
  "result": "OK",
  "data": {
    "invoiceId": 12413
  }
}

POST

sales

invoice

Create/update invoice

curl --request POST \
  --url https://api.altera.co/sales/invoice \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modelType": "INVOICE",
  "override": false,
  "basicInformation": {
    "invoiceId": 2069,
    "invoiceType": "SALES",
    "invoiceFormat": "%N/%M/%Y",
    "saleDate": "2022-10-11T00:00:00.000Z",
    "issueDate": "2022-10-11T00:00:00.000Z",
    "isReceipt": false,
    "relatedInvoicesIds": [],
    "priceTypeId": "NET"
  },
  "contractor": {
    "contractorRegion": "POLAND",
    "country": "PL",
    "contractorType": "COMPANY",
    "contractorName": "Test działania",
    "street": "Testowa",
    "houseNumber": "10",
    "flatNumber": "10",
    "city": "Bydgoszcz",
    "postCode": "62-156",
    "defaultCurrency": "PLN",
    "taxIdentificationNumber": "1589651654",
    "email": "[email protected]",
    "areaNumber": "+58",
    "phoneNumber": "518 961 516"
  },
  "invoicePosition": [
    {
      "productPosition": 0,
      "productName": "A",
      "positionType": "PRODUCT",
      "productCategory": "Health",
      "quantity": 10,
      "unit": "szt.",
      "priceType": null,
      "unitNetPrice": 150,
      "unitGrossPrice": 184.5,
      "vat": "23%",
      "pkwiu": "",
      "discount": "0",
      "deductions": false,
      "netPrice": "1500",
      "grossPrice": "1845",
      "invoiceProductId": 179
    }
  ],
  "additionalDetails": "",
  "correctionReason": "",
  "payments": {
    "isPaid": false,
    "paymentMethod": "TRANSFER",
    "dueDate": "2022-10-25T00:00:00.000Z",
    "bankAccountNumber": "10 1010 1062 5565 1561 5615 1516",
    "isSplitPayment": false
  },
  "projects": []
}
'

{
  "result": "OK",
  "data": {
    "invoiceId": 12413
  }
}

Authorizations

Authorization

string

header

required

OpenApi Key created within Altera.app for a certain company

Body

application/json

override

boolean

default:false

Defines whether we wish to override split payments warning, in Machine-machine integrations should be set to true

basicInformation

object

Show child attributes

basicInformation.invoiceType

enum<string>

required

The type of invoice we wish to create

Available options:

SALES,

PRO_FORMA,

INTERIM,

INTERIM_FINAL,

CORRECTION

Example:

"SALES"

basicInformation.invoiceFormat

string

required

Defines the Invoice numbering format that will be used; Altera providesa set of pre-defined formats right after company creation. They can be reviewed in the UI

Example:

"%N/%M/%Y"

basicInformation.saleDate

string

required

basicInformation.issueDate

string

required

basicInformation.priceTypeId

enum<string>

default:NET

required

Available options:

NET,

GROSS

Example:

"NET"

basicInformation.invoiceId

integer

Invoice identificator, used for updating documents

basicInformation.isReceipt

boolean

Defines whether we are creating an invoice to an already issued receipt

Optional array of invoiceIds that should be related to the document we are creating; Rule of thumb if you wish to work with relatedInvoices (CORRECTION, INTERIM_FINAL) it is best to start from th pre-populated object retrieved via GET /sales/invoice with parameter related in use

basicInformation.statusId

enum<string>

default:DRAFT

Available options:

DRAFT,

ISSUED

Example:

"ISSUED"

contractor

object

Show child attributes

contractor.contractorRegion

enum<string>

Available options:

EU,

OUTSIDE_OF_EU,

POLAND

Example:

"POLAND"

contractor.country

string

ISO 3166-1 alfa-2 two letter country code

Maximum string length: 2

Example:

"PL"

contractor.contractorType

enum<string>

Available options:

COMPANY,

PRIVATE_PERSON

Example:

"COMPANY"

contractor.contractorName

string

contractor.street

string

contractor.houseNumber

string

contractor.flatNumber

string

contractor.city

string

contractor.postCode

string

contractor.defaultCurrency

string

contractor.taxIdentificationNumber

string

Maximum string length: 45

contractor.email

string

Comma delimited list of contractor e-mails

Maximum string length: 200

contractor.areaNumber

string

Maximum string length: 5

contractor.phoneNumber

string

Maximum string length: 45

invoicePosition

object[]

Show child attributes

invoicePosition.productPosition

integer

Zero based position number in invoice

Example:

0

invoicePosition.productName

string

Maximum string length: 200

invoicePosition.positionType

enum<string>

Available options:

PRODUCT,

SERVICE

Example:

"SERVICE"

invoicePosition.productCategory

string

Allows grouping of similar products

Example:

"Personalized"

invoicePosition.quantity

number

Example:

14

invoicePosition.unit

string

Example:

"pcs."

invoicePosition.unitNetPrice

number

Defines the net price per item

Example:

100

invoicePosition.unitGrossPrice

number

Defines the gross price per item

Example:

123

invoicePosition.vat

enum<string>

Defines the vat rate used for this product

Available options:

23%,

8%,

5%,

0%,

np,

zw

Example:

"23%"

invoicePosition.pkwiu

string

invoicePosition.discount

string

Defines % discount on given product

Example:

"10%"

invoicePosition.invoiceProductId

integer

additionalDetails

string

Describes extra information that we wish to present on the invoice

correctionReason

string

Additional information regarding the reason behing correcting your invoice

payments

object

Show child attributes

payments.isPaid

boolean

payments.paymentMethod

enum<string>

Available options:

TRANSFER,

CASH,

CARD

Example:

"TRANSFER"

payments.dueDate

string

payments.bankAccountNumber

string

Defines the bank account no. we wish to receive funds to

payments.isSplitPayment

boolean

Response

Regular format of success response in Altera API Retrieved information will always be stored in the 'data' node

data

object

Show child attributes

data.invoiceId

number

Example:

12413

result

enum<string>

default:OK

Available options:

OK

Example:

"OK"

Get invoice data Mark Invoice as paid

⌘I

OpenAPI Documentation

Sales

Data export

Expenses

Configuration

Create/update invoice

Authorizations

Body

Response