--- title: "DEPRECATED. Get Purchase invoice data as JSON" method: GET path: "/purchase_invoices/{guid}" tags: ["PurchaseInvoices"] --- # DEPRECATED. Get Purchase invoice data as JSON `GET /purchase_invoices/{guid}` DEPRECATED. Use the /api/v2/received_documents endpoint. Get a specific PurchaseInvoice, in JSON format. ## Path parameters - `guid` string, uuid, required ## Query parameters - `pmv` string - `version` string ## Response `200` Success - PurchaseInvoice - `external_user_id` string — Deprecated. Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created. - `external_key` string — Deprecated. Used for accountants. The id you specified for the organization. - `document` string — DEPRECATED. Use the new atatchments array. - `invoice_type` 'invoice' | 'creditnote' | 'correctioninvoice' — The type of invoice. - `vat_reverse_charge` boolean — DEPRECATED - This is now part of each invoice line. - `amount_including_vat` number — DEPRECATED - Use amount_including_tax. - `allowance_charge` number — DEPRECATED - Use the allowance_charges array. - `payment_means` object — DEPRECATED - Use the new payment_means_array array. - `iban` string — The IBAN to which to transfer. - `id` string — An id to mention in the transfer. - `accounting` PurchaseInvoiceAccountingDetails - `code` string — The the code of the general ledger account. - `name` string — A textual description of the code. - `list` string — The name of the list for the code, e.g. "RGS". - `list_version` string — The version of the list for the code, e.g. "1.1". - `payment_means_payment_id` string — DEPRECATED - use the payment_id property in the payment_means_array - `guid` string, uuid — The GUID of the invoice - `legal_entity_id` integer — The id of the LegalEntity the invoice was received for. - `system_generated_primary_image` boolean — Whether or not the document image (PDF) was generated by Storecove. If true, it means the invoice was received without any attachments and Storecove generated one for you. If false, the invoice will contain at least one attachment, which was received from the invoice sender. - `document_type` 'invoice' — The type of document. Only "invoice" for now. - `sub_type` 'invoice' | 'creditnote' | 'correctioninvoice' — The subtype of document. - `source` 'peppol' | 'script' | 'supplier' | 'email' — The source the invoice was received from. - `tax_system` string — The tax system of the invoice. Either tax_line_percentages or tax_line_amounts. The first tax system means the invoice lines contain only the tax percentages and the tax amounts are included only in the tax subtotals at the invoice level and so are only calculated at the invoice level. The tax system tax_line_amounts means that in addition to the percentage, each invoice line also contains the tax amount. The tax subtotals at the invoice level are calculated as the sum of the tax of the invoice lines. The distinction between the two tax systems has has implications for rounding. - `invoice_number` string — The invoicenumber. - `issue_date` string — The date the invoice was issued. Format "YYYY-MM-DD". - `tax_point_date` string — The date the invoice was issued for tax purposes. In most countries MUST match the issue_date. Format "YYYY-MM-DD". - `tax_point_date_code` '3' | '35' | '432' — The code describing which date is used as the tax point date. Supported values: 3 (invoice issue date), 35 (actual delivery date), 432 (paid to date). - `due_date` string — The date the invoice must be payed by. Format "YYYY-MM-DD". - `document_currency_code` string — The ISO 4217 currency for the invoice. - `period_start` string — The start date of the period this invoice relates to. Format "YYYY-MM-DD". - `period_end` string — The end date of the period this invoice relates to. Format "YYYY-MM-DD". - `note` string — The invoice level note. - `buyer_reference` string — Reference provided by the buyer. Used for routing. - `billing_reference` string — Reference to the previous invoice this invoice relates to. - `contract_document_reference` string — Reference to the contract. - `order_reference` string — Reference to the order. Used for matching the invoice to an order. - `project_reference` string — Reference to the project. - `accounting_cost` string — The accounting cost code. - `attachments` PurchaseInvoiceAttachment[] - `document` string — The Base64 encoded document attachment. - `content_type` string — The attachment content type (mime type). - `sender` PurchaseInvoiceSender - `peppol_identifiers` PeppolIdentifier - `identifier` string — The identifier. - `scheme` string — The scheme of the identifier. See <<_receiver_identifiers_list>> for a list. - `superscheme` string — The superscheme of the identifier. Should always be "iso6523-actorid-upis". - `corppass` CorpPass - `enabled` boolean — Whether or not the CorpPass flow is enabled. - `flow_type` 'corppass_flow_redirect' | 'corppass_flow_email' | 'corppass_flow_pdf' — The CorpPass flow type. - `signer_name` string — The name of the person who is going to perform the CorpPass process. - `signer_email` string — The email of the person who is going to perform the CorpPass process. - `client_redirect_success_url` string — The URL the CorpPass system will redirect to in case of successful identity verfication. - `client_redirect_fail_url` string — The URL the CorpPass system will redirect to in case of a failure to perform identity verfication. - `corppass_url` string — The CorpPass redirect URL. - `status` 'corppass_no_status' | 'corppass_initiated' | 'corppass_cancelled' | 'corppass_failed' | 'corppass_succeeded' — The status of the CorpPass process. - `simulate_corppass` boolean — Whether or not CorpPass is being simulated. - `annuaire_lines` AnnuaireLineRead[] — Read-only DGFiP directory lines provisioned for this identifier. Present only for identifiers advertised on the "dgfip" network. - `identifier` string - `siren` string - `siret` string - `suffix` string - `routing` string - `platform` string - `start_date` string, date - `end_date` string, date - `effective_end_date` string, date — Actual end date set by the PPF (DateFinEffective). Read-only. - `in_effect` boolean — True when the line is in its validity window today (and not hidden). - `ppf_id_instance` string — Null while pending first sync to the PPF. - `needs_update` boolean — True when a PATCH to the PPF is pending. - `hidden` boolean - `annuaire_routing_codes` AnnuaireRoutingCodeRead[] — Read-only DGFiP routing codes provisioned for this identifier. Present only for identifiers advertised on the "dgfip" network with a routing code. - `siret` string - `routing_id` string - `name` string — PPF libelleCodeRoutage. - `status` 'A' | 'I' | 'F' - `ppf_id_instance` string — Null while pending first sync to the PPF. - `needs_update` boolean - `address_line1` string - `address_line2` string - `address_line3` string - `locality` string - `postal_code` string - `country_code` string - `party_name` string — The party who sent the invoice. - `legal_name` string — The legal name of the party who sent the invoice. - `department` string — The department who sent the invoice. - `line1` string — The address - `line2` string — The address, line 2 - `zip` string — The zip code. - `city` string — The city. - `building_number` string — The building number. Used in SA. - `secondary_number` string — The secondary number. Used in SA. - `neighborhood` string — The neighborhood. Used in SA. - `county` string — The county. - `country` string — The country. - `billing_contact` PurchaseInvoiceSenderBillingContact - `first_name` string — The first name of the billing contact. - `last_name` string — The last name of the billing contact. - `email` string — The email of the billing contact. - `identifiers` PeppolIdentifier[] — The array of identifiers for this sender. - `identifier` string — The identifier. - `scheme` string — The scheme of the identifier. See <<_receiver_identifiers_list>> for a list. - `superscheme` string — The superscheme of the identifier. Should always be "iso6523-actorid-upis". - `corppass` CorpPass - `enabled` boolean — Whether or not the CorpPass flow is enabled. - `flow_type` 'corppass_flow_redirect' | 'corppass_flow_email' | 'corppass_flow_pdf' — The CorpPass flow type. - `signer_name` string — The name of the person who is going to perform the CorpPass process. - `signer_email` string — The email of the person who is going to perform the CorpPass process. - `client_redirect_success_url` string — The URL the CorpPass system will redirect to in case of successful identity verfication. - `client_redirect_fail_url` string — The URL the CorpPass system will redirect to in case of a failure to perform identity verfication. - `corppass_url` string — The CorpPass redirect URL. - `status` 'corppass_no_status' | 'corppass_initiated' | 'corppass_cancelled' | 'corppass_failed' | 'corppass_succeeded' — The status of the CorpPass process. - `simulate_corppass` boolean — Whether or not CorpPass is being simulated. - `annuaire_lines` AnnuaireLineRead[] — Read-only DGFiP directory lines provisioned for this identifier. Present only for identifiers advertised on the "dgfip" network. - `identifier` string - `siren` string - `siret` string - `suffix` string - `routing` string - `platform` string - `start_date` string, date - `end_date` string, date - `effective_end_date` string, date — Actual end date set by the PPF (DateFinEffective). Read-only. - `in_effect` boolean — True when the line is in its validity window today (and not hidden). - `ppf_id_instance` string — Null while pending first sync to the PPF. - `needs_update` boolean — True when a PATCH to the PPF is pending. - `hidden` boolean - `annuaire_routing_codes` AnnuaireRoutingCodeRead[] — Read-only DGFiP routing codes provisioned for this identifier. Present only for identifiers advertised on the "dgfip" network with a routing code. - `siret` string - `routing_id` string - `name` string — PPF libelleCodeRoutage. - `status` 'A' | 'I' | 'F' - `ppf_id_instance` string — Null while pending first sync to the PPF. - `needs_update` boolean - `address_line1` string - `address_line2` string - `address_line3` string - `locality` string - `postal_code` string - `country_code` string - `payment_terms_note` string — A textual description of the payment terms. - `payment_means_array` PurchaseInvoicePaymentMeans[] — The different payment means that can be used to pay the invoice. - `type` 'BankPaymentMean' | 'DirectDebitPaymentMean' | 'CardPaymentMean' | 'NppPaymentMean' | 'SeBankGiroPaymentMean' | 'SePlusgiroPaymentMean' | 'SgCardPaymentMean' | 'SgGiroPaymentMean' | 'SgPaynowPaymentMean' | 'CreditTransferPaymentMean' | 'CreditCardPaymentMean' | 'SeBankgiroPaymentMean' | 'AunzNppPayidPaymentMean' | 'OnlinePaymentServicePaymentMean' | 'StandingAgreementPaymentMean' | 'AunzNppPaytoPaymentMean' | 'AunzBpayPaymentMean' | 'AunzPostbillpayPaymentMean' | 'AunzUriPaymentMean' — The type of payment means. Which type are returned is determined by the &pmv= query parameter. For details see documentation for that field. - `account` string — The account number to which to transfer. - `holder` string — The account holder name to which to transfer. - `branch_code` string — The code identifying the bank branch. May contain a BIC/SWIFT or something appropriate for the payment method, such as "NPP" for type NppPaymentMean. - `mandate` string — The mandate, used only for type DirectDebitPaymentMean. - `network` string — The payment network. Used only for type CardPaymentType. - `payment_id` string — The payment id to use when making the payment. The invoice sender will use this to match the received funds to the invoice. - `delivery` object — The details of the delivery associated with this invoice. - `actual_date` string — The actual delivery date. - `party` object — The party the goods/services were delivered to. - `name` string — The name of the deliveyr party. - `location` object — The location the goods/services were delivered to. - `id` string — The id of the location. - `scheme_id` string — The scheme id for the id of the location. - `department` string — Department name. - `line1` string — Address line 1. - `line2` string — Address line 2. - `zip` string — Address zip code - `city` string — Address city. - `building_number` string — The building number. Used in SA. - `secondary_number` string — The secondary number. Used in SA. - `neighborhood` string — The neighborhood. Used in SA. - `county` string — Address county. - `country` string — Address country. - `invoice_lines` PurchaseInvoiceInvoiceLine[] - `name` string — A short name for the invoice line. - `allowance_charge` number — DEPRECATED - use allowance_charges. - `amount_excluding_vat` number — DEPRECATED - use amount_excluding_tax. The amount excluding VAT. - `vat` object — DEPRECATED - use tax. The VAT details for the invoice line. - `amount` number — The amount of VAT for the invoice line. - `percentage` number — The percentage of VAT for the invoice line. - `country` string — The ISO 3166 country of the VAT for the invoice line. - `description` string — The description for the invoice line. - `period_start` string — The start date of the period this invoice line relates to. Format "YYYY-MM-DD". - `period_end` string — The end date of the period this invoice line relates to. Format "YYYY-MM-DD". - `allowance_charge_array` PurchaseInvoiceInvoiceLineAllowanceCharge[] - `amount` number — The amount of the allowance or charge. - `reason` string — The reason for the allowance or charge. - `allowance_charges` number[] — Deprecated. - `price` PurchaseInvoiceInvoiceLinePrice - `price_amount` number — The price for one item, excluding VAT. Can have up to digits. - `base_quantity` number — The number of items the price is for. Can have up to digits. - `units` PurchaseInvoiceInvoiceLineItem - `quantity` number — The quantity of the item. Can have up to digits. - `unit_code` string — The unit code of the quantity. - `amount_excluding_tax` number — The amount excluding Tax. This is equal to quantity x price_amount + ∑ allowance_charges. - `tax` PurchaseInvoiceTax - `tax` object — The tax element. - `category_code` string — Deprecated. The tax category code. - `amount` number — The tax amount. - `percentage` number — The tax percentage. - `country` string — The tax country. - `category` 'standard' | 'zero_rated' | 'reverse_charge' | 'intra_community' | 'exempt' | 'export' | 'outside_scope' | 'regulation33_exempt' | 'nonregulation33_exempt' | 'deemed_supply' | 'srca_s' | 'srca_c' | 'not_registered' | 'igst' | 'cgst' | 'sgst' | 'cess' | 'state_cess' | 'srovr' | 'srovr_rs' | 'srovr_lvg' | 'srlvg' | 'sales' | 'service' | 'tourism' | 'high_value_goods' | 'low_value_goods' | 'not_applicable' — The tax category. - `type` 'VAT' | 'GST' — The tax type. - `accounting` PurchaseInvoiceAccountingDetails - `code` string — The the code of the general ledger account. - `name` string — A textual description of the code. - `list` string — The name of the list for the code, e.g. "RGS". - `list_version` string — The version of the list for the code, e.g. "1.1". - `allowance_charges` PurchaseInvoiceAllowanceCharge[] - `amount_excluding_vat` string — DEPRECATED - use amount_excluding_tax. - `vat` PurchaseInvoiceVat — DEPRECATED - Use tax. - `amount` string — The VAT country. - `percentage` string — The VAT percentage. - `amount_excluding_tax` number — The amount excluding tax. - `tax` PurchaseInvoiceTax - `tax` object — The tax element. - `category_code` string — Deprecated. The tax category code. - `amount` number — The tax amount. - `percentage` number — The tax percentage. - `country` string — The tax country. - `category` 'standard' | 'zero_rated' | 'reverse_charge' | 'intra_community' | 'exempt' | 'export' | 'outside_scope' | 'regulation33_exempt' | 'nonregulation33_exempt' | 'deemed_supply' | 'srca_s' | 'srca_c' | 'not_registered' | 'igst' | 'cgst' | 'sgst' | 'cess' | 'state_cess' | 'srovr' | 'srovr_rs' | 'srovr_lvg' | 'srlvg' | 'sales' | 'service' | 'tourism' | 'high_value_goods' | 'low_value_goods' | 'not_applicable' — The tax category. - `type` 'VAT' | 'GST' — The tax type. - `reason` string — The reason for the allowance or charge. - `document_totals` PurchaseInvoiceDocumentTotals - `total` number — The total invoice amount, including tax. This is equal to the sum of the invoice_lines (amount_excluding_tax + tax.amount) and the allowances and charges. - `rounding` number — The difference between the payable amount and the total invoice amount including tax. - `prepaid` number — The amount already paid. - `payable` number — The total invoice amount payable including tax. - `tax_subtotals` PurchaseInvoiceTaxSubtotal[] - `amount_excluding_vat` string — DEPRECATED - use amount_excluding_tax. - `vat` PurchaseInvoiceVat — DEPRECATED - Use tax. - `amount` string — The VAT country. - `percentage` string — The VAT percentage. - `amount_excluding_tax` number — The amount excluding tax. - `tax` PurchaseInvoiceTax - `tax` object — The tax element. - `category_code` string — Deprecated. The tax category code. - `amount` number — The tax amount. - `percentage` number — The tax percentage. - `country` string — The tax country. - `category` 'standard' | 'zero_rated' | 'reverse_charge' | 'intra_community' | 'exempt' | 'export' | 'outside_scope' | 'regulation33_exempt' | 'nonregulation33_exempt' | 'deemed_supply' | 'srca_s' | 'srca_c' | 'not_registered' | 'igst' | 'cgst' | 'sgst' | 'cess' | 'state_cess' | 'srovr' | 'srovr_rs' | 'srovr_lvg' | 'srlvg' | 'sales' | 'service' | 'tourism' | 'high_value_goods' | 'low_value_goods' | 'not_applicable' — The tax category. - `type` 'VAT' | 'GST' — The tax type. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found --- [API](https://skmtc.net/storecove/apis/storecove-api.md) · [All operations](https://skmtc.net/storecove/apis/storecove-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/storecove/storecove-api/revisions/7f72642d80e6/schema)