Invoices

Get an invoice.

Returns the requested invoice. Also accepts multiple comma-separated ids. Max 200 ids per request.Supports expense (bill of charges), purchase, purchase order, sales, sales order, self-assessed tax and travel invoices.

get/invoices/{invoiceId}

Request

  • Base URL: https://pts-api.procountor.com/api
  • URL: https://pts-api.procountor.com/api/invoices/{invoiceId}
  • Auth: HTTP bearer

Path parameters

invoiceIdstring multi required

ID of the invoice

Response

The invoice was successfully returned.

idinteger

Unique identifier of the invoice. Generated by Procountor and present in the object returned.

partnerIdinteger

Technical ID for the business partner. Used to link the invoice to a customer or supplier in the business partner register. If supplied, the company must have this partner ID in the corresponding register. This field is not editable in PUT /invoices endpoint.

type'SALES_INVOICE' | 'SALES_ORDER' | 'PURCHASE_INVOICE' | 'PURCHASE_ORDER' | 'TRAVEL_INVOICE' | 'BILL_OF_CHARGES' | 'PERIODIC_TAX_RETURN' required

Invoice type. Note that this affects validation requirements. PERIODIC_TAX_RETURN is supported only by GET /invoices endpoint. It's not supported by PUT and POST /invoices endpoints.

status'EMPTY' | 'UNFINISHED' | 'NOT_SENT' | 'SENT' | 'RECEIVED' | 'PAID' | 'PAYMENT_DENIED' | 'VERIFIED' | 'APPROVED' | 'INVALIDATED' | 'PAYMENT_QUEUED' | 'PARTLY_PAID' | 'PAYMENT_SENT_TO_BANK' | 'MARKED_PAID' | 'STARTED' | 'INVOICED' | 'OVERRIDDEN' | 'DELETED' | 'UNSAVED' | 'PAYMENT_TRANSACTION_REMOVED'

Invoice status. A new invoice created through the API will have its status set as UNFINISHED. Updating invoice is possible when its status is UNFINISHED. Updating expense claim, purchase, purchase order and travel invoice is possible when the status is UNFINISHED or RECEIVED. PUT /invoices endpoint is not able to change invoice status.

datestring date required

Invoice date. This is synonymous to billing date.

paymentDatestring date

Date of the latest payment transaction related to the invoice. Set automatically when payments are made and can't be modified directly.

discountPercentnumber required

Invoice discount percentage. Scale: 4.

orderReferencestring

Order reference of the invoice. This will be copied to the payment as message if no reference code is specified.

invoiceNumberinteger

Invoice number generated by Procountor. For custom invoice numbers, see the originalInvoiceNumber property.

vatStatusinteger

Invoice VAT status. Required for all invoices except travel invoices and expense claims.

originalInvoiceNumberstring

Invoice number from the biller in an external system.

deliveryStartDatestring date

First day of the delivery period.

deliveryEndDatestring date

Last day of the delivery period.

deliveryMethod'MAILING' | 'ONLINE' | 'COURIER' | 'VRCARGO' | 'BUS' | 'FREIGHT' | 'RETRIEVABLE' | 'OTHER'

Delivery method for the goods. SALES_INVOICE and SALES_ORDER do not support type OTHER.

deliveryInstructionsstring

Delivery instructions.

invoiceChannel'EMAIL' | 'MAIL' | 'ELECTRONIC_INVOICE' | 'EDIFACT' | 'PAPER_INVOICE' | 'NO_SENDING' required

Channel of distribution for the invoice. Values EDIFACT and PAPER_INVOICE are not allowed for POST /invoices and PUT /invoices endpoints.

penaltyPercentnumber

Penal interest rate. Scale: 2.

language'DANISH' | 'ENGLISH' | 'ESTONIAN' | 'FINNISH' | 'NORWEGIAN' | 'SWEDISH'

Language of the invoice. Required for sales invoices and sales orders, otherwise ignored.

invoiceTemplateIdinteger

SALES_INVOICE and SALES_ORDER only. ID of invoice template.

additionalInformationstring

Invoice notes containing additional information. Visible on the invoice. Use \n as line break.

vatCountry'AFGHANISTAN' | 'ALAND_ISLANDS' | 'ALBANIA' | 'ALGERIA' | 'AMERICAN_SAMOA' | 'ANDORRA' | 'ANGOLA' | 'ANGUILLA' | 'ANTARCTICA' | 'ANTIGUA_AND_BARBUDA' | 'ARGENTINA' | 'ARMENIA' | 'ARUBA' | 'ASCENSION_AND_TRISTAN_DA_CUNHA_SAINT_HELENA' | 'AUSTRALIA' | 'AUSTRIA' | 'AZERBAIJAN' | 'BAHAMAS' | 'BAHRAIN' | 'BANGLADESH' | 'BARBADOS' | 'BELARUS' | 'BELGIUM' | 'BELIZE' | 'BENIN' | 'BERMUDA' | 'BHUTAN' | 'BOLIVARIAN_REPUBLIC_OF_VENEZUELA' | 'BOSNIA_AND_HERZEGOVINA' | 'BOTSWANA' | 'BOUVET_ISLAND' | 'BRAZIL' | 'BRITISH_INDIAN_OCEAN_TERRITORY' | 'BRITISH_VIRGIN_ISLANDS' | 'BRUNEI_DARUSSALAM' | 'BULGARIA' | 'BURKINA_FASO' | 'BURUNDI' | 'CABO_VERDE' | 'CAMBODIA' | 'CAMEROON' | 'CANADA' | 'CAYMAN_ISLANDS' | 'CENTRAL_AFRICAN_REPUBLIC' | 'CHAD' | 'CHILE' | 'CHINA' | 'CHRISTMAS_ISLAND' | 'COCOS_KEELING_ISLANDS' | 'COLOMBIA' | 'COMOROS' | 'CONGO' | 'COOK_ISLANDS' | 'COSTA_RICA' | 'COTE_D_IVOIRE' | 'CROATIA' | 'CUBA' | 'CURACAO' | 'CYPRUS' | 'CZECH_REPUBLIC' | 'DEMOCRATIC_PEOPLE_S_REPUBLIC_OF_KOREA' | 'DENMARK' | 'DJIBOUTI' | 'DOMINICA' | 'DOMINICAN_REPUBLIC' | 'ECUADOR' | 'EGYPT' | 'EL_SALVADOR' | 'EQUATORIAL_GUINEA' | 'ERITREA' | 'ESTONIA' | 'ETHIOPIA' | 'FALKLAND_ISLANDS_MALVINAS' | 'FAROE_ISLANDS' | 'FEDERATED_STATES_OF_MICRONESIA' | 'FIJI' | 'FINLAND' | 'FRANCE' | 'FRENCH_GUIANA' | 'FRENCH_POLYNESIA' | 'FRENCH_SOUTHERN_TERRITORIES' | 'GABON' | 'GAMBIA' | 'GEORGIA' | 'GERMANY' | 'GHANA' | 'GIBRALTAR' | 'GREECE' | 'GREENLAND' | 'GRENADA' | 'GUADELOUPE' | 'GUAM' | 'GUATEMALA' | 'GUERNSEY' | 'GUINEA' | 'GUINEA_BISSAU' | 'GUYANA' | 'HAITI' | 'HEARD_ISLAND_AND_MCDONALD_ISLANDS' | 'HOLY_SEE_VATICAN_CITY_STATE' | 'HONDURAS' | 'HONG_KONG' | 'HUNGARY' | 'ICELAND' | 'INDIA' | 'INDONESIA' | 'IRAQ' | 'IRELAND' | 'ISLAMIC_REPUBLIC_OF_IRAN' | 'ISLE_OF_MAN' | 'ISRAEL' | 'ITALY' | 'JAMAICA' | 'JAPAN' | 'JERSEY' | 'JORDAN' | 'KAZAKHSTAN' | 'KENYA' | 'KIRIBATI' | 'KOSOVO_TEMPORARY' | 'KUWAIT' | 'KYRGYZSTAN' | 'LAO_PEOPLE_S_DEMOCRATIC_REPUBLIC' | 'LATVIA' | 'LEBANON' | 'LESOTHO' | 'LIBERIA' | 'LIBYA' | 'LIECHTENSTEIN' | 'LITHUANIA' | 'LUXEMBOURG' | 'MACAO' | 'MADAGASCAR' | 'MALAWI' | 'MALAYSIA' | 'MALDIVES' | 'MALI' | 'MALTA' | 'MARSHALL_ISLANDS' | 'MARTINIQUE' | 'MAURITANIA' | 'MAURITIUS' | 'MAYOTTE' | 'MEXICO' | 'MONACO' | 'MONGOLIA' | 'MONTENEGRO' | 'MONTSERRAT' | 'MOROCCO' | 'MOZAMBIQUE' | 'MYANMAR' | 'NAMIBIA' | 'NAURU' | 'NEPAL' | 'NETHERLANDS' | 'NEW_CALEDONIA' | 'NEW_ZEALAND' | 'NICARAGUA' | 'NIGER' | 'NIGERIA' | 'NIUE' | 'NORFOLK_ISLAND' | 'NORTHERN_IRELAND_TEMPORARY' | 'NORTHERN_MARIANA_ISLANDS' | 'NORWAY' | 'OMAN' | 'PAKISTAN' | 'PALAU' | 'PANAMA' | 'PAPUA_NEW_GUINEA' | 'PARAGUAY' | 'PERU' | 'PHILIPPINES' | 'PITCAIRN' | 'PLURINATIONAL_STATE_OF_BOLIVIA' | 'POLAND' | 'PORTUGAL' | 'PROVINCE_OF_CHINA_TAIWAN' | 'PUERTO_RICO' | 'QATAR' | 'REPUBLIC_OF_KOREA' | 'REPUBLIC_OF_MOLDOVA' | 'REUNION' | 'ROMANIA' | 'RUSSIAN_FEDERATION' | 'RWANDA' | 'SAINT_BARTHELEMY' | 'SAINT_KITTS_AND_NEVIS' | 'SAINT_LUCIA' | 'SAINT_MARTIN_FRENCH_PART' | 'SAINT_PIERRE_AND_MIQUELON' | 'SAINT_VINCENT_AND_THE_GRENADINES' | 'SAMOA' | 'SAN_MARINO' | 'SAO_TOME_AND_PRINCIPE' | 'SAUDI_ARABIA' | 'SENEGAL' | 'SERBIA' | 'SEYCHELLES' | 'SIERRA_LEONE' | 'SINGAPORE' | 'SINT_EUSTATIUS_AND_SABA_BONAIRE' | 'SINT_MAARTEN_DUTCH_PART' | 'SLOVAKIA' | 'SLOVENIA' | 'SOLOMON_ISLANDS' | 'SOMALIA' | 'SOUTH_AFRICA' | 'SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS' | 'SOUTH_SUDAN' | 'SPAIN' | 'SRI_LANKA' | 'STATE_OF_PALESTINE' | 'SUDAN' | 'SURINAME' | 'SVALBARD_AND_JAN_MAYEN' | 'SWAZILAND' | 'SWEDEN' | 'SWITZERLAND' | 'SYRIAN_ARAB_REPUBLIC' | 'TAJIKISTAN' | 'THAILAND' | 'THE_DEMOCRATIC_REPUBLIC_OF_THE_CONGO' | 'THE_FORMER_YUGOSLAV_REPUBLIC_OF_MACEDONIA' | 'TIMOR_LESTE' | 'TOGO' | 'TOKELAU' | 'TONGA' | 'TRINIDAD_AND_TOBAGO' | 'TUNISIA' | 'TURKEY' | 'TURKMENISTAN' | 'TURKS_AND_CAICOS_ISLANDS' | 'TUVALU' | 'UGANDA' | 'UKRAINE' | 'UNITED_ARAB_EMIRATES' | 'UNITED_KINGDOM_OF_GREAT_BRITAIN_AND_NORTHERN_IRELAND' | 'UNITED_REPUBLIC_OF_TANZANIA' | 'UNITED_STATES_MINOR_OUTLYING_ISLANDS' | 'UNITED_STATES_OF_AMERICA' | 'URUGUAY' | 'UZBEKISTAN' | 'U_S_VIRGIN_ISLANDS' | 'VANUATU' | 'VIET_NAM' | 'WALLIS_AND_FUTUNA' | 'WESTERN_SAHARA' | 'YEMEN' | 'ZAMBIA' | 'ZIMBABWE'

Country code describing which country's VAT standards are being used. Usage of foreign VAT settings must be agreed on separately with Procountor. Required if the company uses foreign VATs. Example value: SWEDEN. See Address.country in POST/PUT /invoices for a list of allowable values

ledgerReceiptIdinteger

ID of the ledger receipt linked to this invoice. A ledger receipt is linked to every invoice for holding its accounting information. For defining ledger accounts, dimensions or VAT status regarding the invoice, modify the ledger receipt. See PUT /ledgerreceipts for more info.

notesstring

Invoice notes (seller's/buyer's notes). Not visible on the invoice. Use \n as line break.

factoringContractIdinteger

SALES_INVOICE and SALES_ORDER only. ID for external financing agreement. The bankAccount.accountNumber specified must match the one used by the specified financing agreement. Financing agreements cannot be used with cash payments.

factoringTextstring

SALES_INVOICE and SALES_ORDER only. Additional notes about external financing agreement.

sumnumber

Only for invoice type PERIODIC_TAX_RETURN. Ignored for other types. Contains the total sum of invoice. POST and PUT operation cannot assign/modify value of this property.

orderNumberstring

Order number. Valid only in Finnish environments for SALES_INVOICE and PURCHASE_INVOICE.

agreementNumberstring

Agreement number. Valid only in Finnish environments for SALES_INVOICE and PURCHASE_INVOICE.

accountingCodestring

Accounting code. Valid only in Finnish environments for SALES_INVOICE and PURCHASE_INVOICE.

deliverySitestring

Delivery site. Valid only in Finnish environments for SALES_INVOICE and PURCHASE_INVOICE.

tenderReferencestring

Tender reference. Valid only in Finnish environments for SALES_INVOICE and PURCHASE_INVOICE.

buyerReferenceIdentifierstring

Buyer reference. Valid only in Finnish environments for SALES_INVOICE and PURCHASE_INVOICE.

sellerReferenceIdentifierstring

Seller reference. Valid only in Finnish environments for SALES_INVOICE and PURCHASE_INVOICE.

versionstring date-time

Invoice version. This field is required in the PUT /invoices/{invoiceId} endpoint.

creatorIdinteger

Invoice owner's user ID.

isOfferboolean

It marks invoice as an offer. It is applicable only to SALES_ORDER type of invoices.

Example response

{
  "status": "UNFINISHED",
  "counterParty": {
    "counterPartyAddress": {
      "country": "SWEDEN"
    }
  },
  "billingAddress": {
    "country": "SWEDEN"
  },
  "deliveryAddress": {
    "country": "SWEDEN"
  },
  "paymentInfo": {
    "currency": "EUR",
    "bankReferenceCode": "26013"
  },
  "vatCountry": "SWEDEN",
  "attachments": [
    {
      "name": "Picture.jpg"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.