PApaper

Retrieve a Sales Invoice Details

Changed on

Returns the full detail of a single Sales Invoice: header information, customer, line items, totals, payment and acceptance status, and every file currently attached to it. Use it to confirm that an upload landed, to read the attachment_id values needed by the Delete Attachment endpoint, or to sync the current state of an invoice back into your own system.

get/sales-invoices/{invoice_id}

Request

  • Base URL
    https://open-api.stag-v2.paper.id/api/v1
  • URL
    https://open-api.stag-v2.paper.id/api/v1/sales-invoices/{invoice_id}
  • Auth
    API key in header client_id and API key in header client_secret

Path parameters

invoice_idstring required

Unique identifier of the Sales Invoice to retrieve.

Response

200

totalinteger
signature_text_headerstring
signature_text_footerstring
terms_conditionstring
notesstring
created_atstring
modified_atstring

Example response

{
  "data": {
    "number": "INV/08/08/0008",
    "invoice_date": "2023-08-08",
    "due_date": "2023-08-20",
    "status": {
      "payment_status": "overdue",
      "acceptance_status": "accepted"
    },
    "payment_link": "get.paper.id/jG8q92b",
    "pdf_link": "get.paper.id/JzdYh2J",
    "customer": {
      "id": "0002",
      "company_name": "Budi Tech",
      "company_email": "budi@ptabcd.id",
      "company_phone": "38478273482",
      "href": "/partners/8f2078f7-5c8c-40cf-a6cb-e405dd432762"
    },
    "items": [
      {
        "name": "item 01",
        "description": "color is black",
        "quantity": 2,
        "price": 10000,
        "discount": 50,
        "product_href": "/products/ec93d51a-7ced-42e6-aaca-c58e5e6755c9"
      }
    ]
  },
  "total": 10000,
  "signature_text_header": "August 08, 2023",
  "signature_text_footer": "Your Store",
  "terms_condition": "We receive payment no later than 7 days after the bill is received",
  "notes": "Invoice include service fee",
  "created_at": "2023-08-15 11:38:46",
  "modified_at": "2023-08-15 11:38:59"
}

Changes

  • 2b6aa3c43ca0Revision changes
    • warning

      deleted the query request parameter end_date

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter offset

    • warning

      deleted the query request parameter order_by

    • warning

      deleted the query request parameter start_date

    • info

      added the optional property / to the response with the status