STstorecove
PurchaseInvoices

DEPRECATED. Get Purchase invoice data as JSON with a Base64-encoded UBL string in the specified version

Changed on

DEPRECATED. Get a specific PurchaseInvoice in UBL format

get/purchase_invoices/{guid}/{packaging}/{package_version}

Request

Path parameters

guidstring uuid required

purchase invoice guid

packaging'ubl' required

How to package the purchase invoice.

package_version'si11' | 'si12' | 'si20' | 'aunz' | 'sg' | 'jp' | 'en16931' | 'original' required

The version of the package.

Response

Success

guidstring uuid

The GUID of the invoice

tax_systemstring

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.

legal_entity_idinteger

The id of the LegalEntity the invoice was received for.

external_user_idstring

Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created.

external_keystring

Used for accountants. The id you specified for the organization.

system_generated_primary_imageboolean

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.

ublstring

The Base64 encoded UBL invoice.

Changes

  • 0312ae5500d2Revision changes
    • breaking

      the path request parameter package_version became required

    • breaking

      the path request parameter packaging became required

    • info

      api operation id get_invoice_ubl removed and replaced with get_invoice_ubl_versioned