Skip to main content
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": "testing@attention.please",
    "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
contractor
object
invoicePosition
object[]
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

Response

OK

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

data
object
result
enum<string>
default:OK
Available options:
OK
Example:

"OK"