Ledger receipts

Get a ledger receipt.

Returns the requested ledger receipt. Also accepts multiple comma-separated ids. Max 200 ids per request.Supported ledger receipt types are journals, sales invoice ledger receipts, travel invoice ledger receipts, expense invoice ledger receipts, purchase ledger invoice receipts, VAT form ledger receipts, salary ledger receipts, employer contribution ledger receipts, purchase order ledger receipts, sales order ledger receipts, bank statement as a receipt ledger receipts, receipt for opening the accounts ledger receipts, reference payment ledger receipts, tracking period opening receipt ledger receipts, self-assessed tax ledger receipts and VAT summary ledger receipts.

get/ledgerreceipts/{receiptId}

Request

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

Path parameters

receiptIdstring multi required

Ledger receipt identifier

Response

Ledger receipt was successfully returned.

idinteger

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

type'JOURNAL' | 'PURCHASE_INVOICE' | 'SALES_INVOICE' | 'PERIODIC_TAX_RETURN' | 'TRAVEL_INVOICE' | 'BILL_OF_CHARGES' | 'VAT_FORM' | 'SALARY' | 'EMPLOYER_CONTRIBUTION' | 'PURCHASE_ORDER' | 'SALES_ORDER' | 'BANK_STATEMENT_AS_RECEIPT' | 'RECEIPT_FOR_OPENING_ACCOUNTS' | 'REFERENCE_PAYMENT' | 'TRACKING_PERIOD_OPENING_RECEIPT' | 'VAT_SUMMARY' required

Ledger receipt type. Use JOURNAL for creating ledger receipts (vouchers) containing ledger transactions without linkage to pre-existing resources. Other types are automatically generated by Procountor for holding accounting information for e.g. invoices. Types allowed for POST = JOURNAL. Types allowed for PUT = JOURNAL, SALES_INVOICE, PURCHASE_INVOICE, TRAVEL_INVOICE, BILL_OF_CHARGES Types allowed for GET listed below

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

Ledger receipt status. Status of a ledger receipt equals the status of the linked invoice. All ledger receipts are initially created with status UNFINISHED. For journals, possible statuses are UNFINISHED, APPROVED and INVALIDATED. Ledger receipt statuses cannot be directly modified through the API.

namestring required

Ledger receipt name.

receiptDatestring date required

Ledger receipt date. Must not be in a closed fiscal period. See GET /fiscalyears for a list of fiscal years.

vatType'PURCHASE' | 'SALES' required

Ledger receipt VAT type.

vatStatusinteger required

Ledger receipt VAT status. This can be overridden on transaction level. Use here the numeric parts of VAT status codes listed in "VAT defaults" in Procountor. For example, for VAT status code "vat_12", use value 12. The VAT status used must be enabled for the current receipt type (sales/purchase).

vatProcessing'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'

Ledger receipt VAT country. Only for JOURNAL types of ledger receipts. Requires a special right for foreign VATs. See Address.country in POST /invoices for a list of allowable values.

invoiceIdinteger

ID of the linked invoice. For sales and purchase invoice ledger receipts, this refers to the invoice the receipt holds accounting data for. For journal receipts, an invoice is automatically generated to store certain data fields. Use this ID in POST /attachments endpoint.

receiptNumberinteger

Number of the ledger receipt.

invoiceNotesstring

Invoice notes. Linked to Invoice.notes. Not visible on ledger receipt printouts. Use \n as line break. Max length 10000.

invoiceNumberinteger

Number of the linked invoice. Automatically generated by Procountor.

accountantsNotesstring

Notes made by the accountant. Visible on ledger receipt printouts.

transactionDescriptionstring

Transaction description. This is a summary description for any transactions belonging to the ledger receipt.

receiptValidity'EMPTY' | 'IMMEDIATELY' | 'OVER_3_YEARS' | 'SERVICE_PERIOD'

Receipt validity time.

periodStartDatestring date

Start date of the receipt period. If set, must precede the end date of the period.

periodEndDatestring date

End date of the receipt period. If this and the start date are set, this must be after the start date.

partnerIdinteger

Technical ID for the business partner. Link the related invoice to a customer or supplier in the business partner register. If supplied, the company must have this partner ID in the corresponding register.

partnerCodestring

Partner code. Identifier for the related company or person. May represent a business ID, national identification number (HETU in Finland) or an account number, depending on the receipt type.

versionstring date-time

Ledger receipt version timestamp. Automatically generated by Procountor and updated every time the receipt is modified. When using PUT /ledgerreceipts, it is required to include the latest version timestamp of the receipt to the request. This prevents conflicts if the receipt is being modified from several sources.

depreciation'EMPTY' | 'REDUCING_BALANCE_25_PERCENT' | 'REDUCING_BALANCE_4_PERCENT' | 'REDUCING_BALANCE_7_PERCENT' | 'STRAIGHT_LINE_DEPRECIATION_3_YEARS' | 'STRAIGHT_LINE_DEPRECIATION_5_YEARS'

Accounting depreciation method for the receipt.

vatDatestring date

VAT date to be used if payment based VAT is enabled

Example response

{
  "vatProcessing": "SWEDEN",
  "attachments": [
    {
      "name": "Picture.jpg"
    }
  ]
}

Changes

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