Paper Open API

https://open-api-paper-id.readme.io/reference/
Admin
Paper Open API allows developers to integrate applications with Paper.id's financial platform for...
Tokens:99,314
Snippets:222
Trust Score:9.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Invoice Request Example (JSON)

Source: https://open-api-paper-id.readme.io/reference/create-sales-invoice

An example of a JSON request payload for creating an invoice. It includes customer details, line items with pricing and discounts, and sending preferences for notifications.

```json
{
  "invoice_date": "23-11-2025",
  "due_date": "30-11-2025",
  "number": "INV/2025/11/0001",
  "customer": {
    "id": "TESTMITRA001",
    "name": "Mitra Testing",
    "email": "{{PARTNER_EMAIL_TEST}}",
    "phone": "{{PARTNER_EMAIL_PHONE}}"
  },
  "items": [
    {
      "name": "black tie",
      "description": "color is black",
      "quantity": 2,
      "price": 10000,
      "discount": 50,
      "tax_id": "",
      "additional_info": {}
    }
  ],
  "signature_text_header": "November 23, 2025",
  "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",
  "send": {
    "email": true,
    "whatsapp": true,
    "sms": true
  },
  "additional_info": {}
}
```

--------------------------------

### Payment Callback Payload Examples (JSON)

Source: https://open-api-paper-id.readme.io/reference/callback

These JSON examples illustrate the structure of payment callback payloads for different payment methods. They include transaction details, status, and invoice information. These payloads are crucial for confirming payment success and updating system status.

```json
{
  "additional_info": {
		"invoices": [
      {
     		"uuid": "580efeb6-5887-4973-ab13-099e22598adf",
      	"number": "INV/2025/11/0001"
    	}
    ]
	},
  "message": "transaction succeed",
  "payment_date": "2025-06-18",
  "payment_info": {
    "bank_transfer": {
      "amount": 12557,
      "created": "2025-06-18T04:38:54.415786634+07:00",
      "paid_amount": 12557,
      "paid_at": "2025-06-18T04:39:43.594065797+07:00",
      "status": "PAID",
      "updated": "2025-06-18T04:39:43.594065797+07:00"
    },
    "channel": "bca_manual",
    "method": "bank_transfer",
    "source": "open-api",
    "status": "PAID"
  },
  "ref_id": "PAY-REF/2025/06/IN/123"
}
```

```json
{
  "additional_info": {
		"invoices": [
      {
     		"uuid": "580efeb6-5887-4973-ab13-099e22598adf",
      	"number": "INV/2025/11/0001"
    	}
    ]
	},
  "message": "transaction succeed",
  "payment_date": "2025-06-18",
  "payment_info": {
    "channel": "qris",
    "event": "qr.payment",
    "method": "qris",
    "qris": {
      "amount": 10000,
      "created": "2025-06-18T05:16:51.708008011+07:00",
      "paid_amount": 10000,
      "paid_at": "2025-06-18T05:16:59.511610249+07:00",
      "status": "PAID",
      "updated": "2025-06-18T05:16:59.511610249+07:00"
    },
    "source": "open-api",
    "status": "PAID"
  },
  "ref_id": "PAY-REF/2025/06/IN/124"
}
```

```json
{
  "additional_info": {
		"invoices": [
      {
     		"uuid": "580efeb6-5887-4973-ab13-099e22598adf",
      	"number": "INV/2025/11/0001"
    	}
    ]
	},
  "message": "transaction succeed",
  "payment_date": "2025-06-18",
  "payment_info": {
    "channel": "Visa",
    "credit_card": {
      "amount": 10000,
      "created": "2025-06-18T05:18:49.797030079+07:00",
      "paid_amount": 10000,
      "paid_at": "2025-06-18T05:19:01.192687186+07:00",
      "status": "PAID",
      "updated": "2025-06-18T05:19:01.192687186+07:00"
    },
    "method": "credit_card",
    "source": "open-api",
    "status": "PAID"
  },
  "ref_id": "PAY-REF/2025/06/IN/125"
}
```

```json
{
  "additional_info": {
		"invoices": [
      {
     		"uuid": "580efeb6-5887-4973-ab13-099e22598adf",
      	"number": "INV/2025/11/0001"
    	}
    ]
	},
  "message": "transaction succeed",
  "payment_date": "2025-06-18",
  "payment_info": {
    "channel": "OVO",
    "ewallet": {
      "amount": 10000,
      "created": "2025-06-18T05:21:14.36293672+07:00",
      "paid_amount": 10000,
      "paid_at": "2025-06-18T05:21:21.741879097+07:00",
      "status": "PAID",
      "updated": "2025-06-18T05:21:21.741879097+07:00"
    },
    "method": "ewallet",
    "source": "open-api",
    "status": "PAID"
  },
  "ref_id": "PAY-REF/2025/06/IN/127"
}
```

--------------------------------

### GET /payments/method

Source: https://open-api-paper-id.readme.io/reference/payment-method-list

Retrieves a list of all available payment methods, including their status, channels, and fee settings.

```APIDOC
## GET /payments/method

### Description
Retrieves a list of all available payment methods, including their status, channels, and fee settings.

### Method
GET

### Endpoint
https://open-api.stag-v2.paper.id/api/v1/payments/method

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status_code** (integer) - The status code of the request.
- **message** (string) - A message indicating the success of the request.
- **data** (object) - An object containing the payment methods.
  - **payment_methods** (array) - A list of payment methods.
    - **method** (string) - The name of the payment method.
    - **status** (string) - The status of the payment method.
    - **channel** (array) - A list of channels available for the payment method.
      - **code** (string) - The code of the channel.
      - **name** (string) - The name of the channel.
      - **fee_setting** (object) - The fee settings for the channel.
        - **type** (string) - The type of fee (percentage or fixed).
        - **value** (number) - The value of the fee.
        - **assign_fee** (string) - Who the fee is assigned to (buyer or seller).

#### Response Example
```json
{
  "status_code": 200,
  "message": "Request Success",
  "data": {
    "payment_methods": [
      {
        "method": "Credit Card",
        "status": "active",
        "channel": [
          {
            "code": "visa",
            "name": "Visa",
            "fee_setting": {
              "type": "percentage",
              "value": 0.02,
              "assign_fee": "buyer"
            }
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### GET /invoices

Source: https://open-api-paper-id.readme.io/reference/list-of-all-purchase-invoice

Retrieves a list of invoices with their details. This endpoint allows fetching comprehensive invoice information, including associated partner data.

```APIDOC
## GET /invoices

### Description
Retrieves a list of invoices with their details. This endpoint allows fetching comprehensive invoice information, including associated partner data.

### Method
GET

### Endpoint
/invoices

### Parameters
#### Query Parameters
- **company_id** (string) - Required - The ID of the company for which to retrieve invoices.
- **partner_id** (string) - Optional - The ID of the partner associated with the invoices.
- **document_type_id** (string) - Optional - The type of document for the invoice.

### Request Example
```json
{
  "example": "GET /invoices?company_id=2cbbd916-14d3-4fc3-9cbe-0c1d759b53e3&partner_id=4bc79ce7-d64f-4c45-8c90-6622ec22f2cf"
}
```

### Response
#### Success Response (200)
- **code** (string) - The status code of the response. Example: "PI-GLT-200"
- **message** (string) - A message indicating the success of the operation. Example: "OK"
- **data** (array) - An array of invoice objects.
  - **uuid** (string) - The unique identifier of the invoice.
  - **invoice_number** (string) - The invoice number.
  - **company_id** (string) - The ID of the company.
  - **partner_id** (string) - The ID of the partner.
  - **document_type_id** (string) - The document type ID.
  - **invoice_date** (string) - The date the invoice was issued.
  - **due_date** (string) - The due date for the invoice.
  - **status** (string) - The payment status of the invoice.
  - **version** (integer) - The version of the invoice.
  - **signature_text_header** (string) - Text for the invoice header signature.
  - **signature_text_footer** (string) - Text for the invoice footer signature.
  - **created_at** (string) - Timestamp when the invoice was created.
  - **updated_at** (string) - Timestamp when the invoice was last updated.
  - **terms_and_conditions** (string) - Terms and conditions for the invoice.
  - **notes** (string) - Additional notes for the invoice.
  - **grand_total** (number) - The grand total amount of the invoice.
  - **subtotal** (number) - The subtotal amount of the invoice.
  - **total_discount** (number) - The total discount applied to the invoice.
  - **tax_inclusive** (number) - Indicates if tax is inclusive.
  - **tax_exclusive** (number) - Indicates if tax is exclusive.
  - **custom_total_per_item** (number) - Custom total per item.
  - **items** (array) - An array of items included in the invoice.
    - **product_name** (string) - Name of the product.
    - **description** (string) - Description of the product.
    - **sku** (string) - Stock Keeping Unit of the product.
    - **uom** (string) - Unit of Measurement.
    - **quantity** (number) - Quantity of the product.
    - **price** (number) - Price per unit of the product.
    - **discount** (number) - Discount applied to the item.
    - **index** (integer) - Index of the item.
    - **tax_type** (string) - Tax type applied to the item.
    - **discount_amount** (number) - Discount amount for the item.
    - **discount_percentage** (number) - Discount percentage for the item.
    - **discount_string** (string) - String representation of the discount.
    - **total** (number) - Total amount for the item.
  - **partner** (object) - Details of the partner associated with the invoice.
    - **uuid** (string) - The unique identifier of the partner.
    - **name** (string) - The name of the partner.
    - **email** (string) - The email address of the partner.
    - **phone** (string) - The phone number of the partner.

#### Response Example
```json
{
  "code": "PI-GLT-200",
  "message": "OK",
  "data": [
    {
      "uuid": "1d70876a-01c3-46fb-a7ae-4345943f2ad4",
      "invoice_number": "EXP/2019/0001",
      "company_id": "2cbbd916-14d3-4fc3-9cbe-0c1d759b53e3",
      "partner_id": "4bc79ce7-d64f-4c45-8c90-6622ec22f2cf",
      "document_type_id": "inv-02",
      "invoice_date": "2021-12-05",
      "due_date": "2019-12-05",
      "status": "PAID",
      "version": 0,
      "signature_text_header": "5 Dec, 2019",
      "signature_text_footer": "Finance",
      "created_at": "2019-12-05 23:52:38",
      "updated_at": "2020-06-20 02:16:53",
      "terms_and_conditions": "",
      "notes": "",
      "grand_total": 0,
      "subtotal": 0,
      "total_discount": 0,
      "tax_inclusive": 0,
      "tax_exclusive": 0,
      "custom_total_per_item": 0,
      "items": [
        {
          "product_name": "tes",
          "description": "tes",
          "sku": "",
          "uom": null,
          "quantity": 10,
          "price": 100000,
          "discount": 0,
          "index": 0,
          "tax_type": "",
          "discount_amount": 0,
          "discount_percentage": 0,
          "discount_string": "",
          "total": 0
        }
      ],
      "partner": {
        "uuid": "4bc79ce7-d64f-4c45-8c90-6622ec22f2cf",
        "name": "Karin 610",
        "email": "karin.putri610@gmail.com",
        "phone": "123456"
      }
    }
  ]
}
```
```

--------------------------------

### Get Sales Invoices (curl)

Source: https://open-api-paper-id.readme.io/reference/retrieve-single-sales-invoice-details

Example using curl to retrieve sales invoices from the Paper ID API. This snippet demonstrates how to make a GET request to the sales invoices endpoint.

```curl
curl --location 'https://open-api.stag-v2.paper.id/api/v1/sales-invoices/db158036-e985-4e62-a34c-536a388893ef' \
--data ''
```

--------------------------------

### Retrieve Payment Transaction (OpenAPI Definition)

Source: https://open-api-paper-id.readme.io/reference/retrieve-a-payment-transaction

The OpenAPI 3.1.0 definition for retrieving a payment transaction. It outlines the server URL, security schemes (client_id, client_secret), and the GET endpoint for /payment/request/:id. Includes example responses for success (200) and error (400) scenarios.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "version-1",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://open-api.stag-v2.paper.id/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "client_id"
      },
      "sec1": {
        "type": "apiKey",
        "in": "header",
        "name": "client_secret"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/payment/request/:id": {
      "get": {
        "summary": "Retrieve a Payment Transaction",
        "description": "",
        "operationId": "retrieve-a-payment-transaction",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"status_code\": 200,\n\t\"data\": {\n\t\t\"payment_id\": \"1664903227N3D3W\",\n\t\t\"transaction_status\": \"pending\",\n\t\t\"ref_id\": \"00000009\"\n\t\t\"created_at\": \"2022-09-31T23:59:59+07:00\",\n\t\t\"modified_at\": \"2022-09-31T23:59:59+07:00\"\n\t},\n}\n"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

--------------------------------

### OpenAPI Definition for Retrieve Digital Payment Balance

Source: https://open-api-paper-id.readme.io/reference/retrieve-digital-payment-balance

This snippet provides the OpenAPI 3.1.0 definition for the 'Retrieve Digital Payment Balance' endpoint. It details the request method (GET), required headers, and the structure of the successful (200) and error (400) responses, including example data formats.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "version-1",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://open-api.stag-v2.paper.id/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "client_id"
      },
      "sec1": {
        "type": "apiKey",
        "in": "header",
        "name": "client_secret"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/payment/balance": {
      "get": {
        "summary": "Retrieve Digital Payment Balance",
        "description": "",
        "operationId": "retrieve-digital-payment-balance",
        "parameters": [
          {
            "name": "client_id",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "client_secret",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": {\n        \"currency\": \"IDR\",\n        \"on_hold_amount\": 0,\n        \"balance\": 56005\n    },\n    \"meta\": {\n        \"created_at\": \"2024-03-13 15:20:31.928975612 +0700 WIB\",\n        \"modified_at\": \"2024-03-13 15:20:31.928975612 +0700 WIB\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "currency": {
                          "type": "string",
                          "example": "IDR"
                        },
                        "on_hold_amount": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "balance": {
                          "type": "integer",
                          "example": 56005,
                          "default": 0
                        }
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "created_at": {
                          "type": "string",
                          "example": "2024-03-13 15:20:31.928975612 +0700 WIB"
                        },
                        "modified_at": {
                          "type": "string",
                          "example": "2024-03-13 15:20:31.928975612 +0700 WIB"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

--------------------------------

### POST /api/v1/payment/request

Source: https://open-api-paper-id.readme.io/reference/create-payment-request

Initiates a payment request with detailed invoice and item information. Allows specifying payment methods and notification preferences.

```APIDOC
## POST /api/v1/payment/request

### Description
Initiates a payment request with detailed invoice and item information. Allows specifying payment methods and notification preferences.

### Method
POST

### Endpoint
/api/v1/payment/request

### Parameters
#### Request Body
- **invoice_number** (string) - Required - Invoice number.
- **invoice_date** (string) - Required - Invoice date.
- **invoice_due_date** (string) - Required - Invoice due date.
- **items** (array) - Optional - List of items included in the invoice.
  - **sku** (string) - Required - Item SKU.
  - **name** (string) - Required - Item name.
  - **quantity** (integer) - Required - Item Quantity.
  - **price** (integer) - Required - Item price.
  - **discount** (integer) - Optional - Discount applied to the item.
  - **tax** (integer) - Optional - Tax amount for the item.
  - **additional_info** (object) - Optional - Additional information about the item.
- **discount** (integer) - Optional - Additional discount for the invoice, in amount.
- **delivery_fee** (integer) - Optional - Total delivery fee for the invoice.
- **payment_method** (object) - Optional - Payment method details.
  - **method** (string) - Required - Payment method (e.g., 'credit_card', 'bank_transfer').
  - **channel** (string) - Required - Payment channel (e.g., 'visa', 'mastercard').
- **redirect_url** (string) - Optional - URL to redirect the user after payment.
- **send** (object) - Optional - Notification preferences.
  - **email** (boolean) - Optional - Send email notifications (default: true).
  - **whatsapp** (boolean) - Optional - Send WhatsApp notifications (default: true).
  - **sms** (boolean) - Optional - Send SMS notifications (default: true).
- **additional_info** (string) - Optional - Any additional information for the payment.
- **instant_payment** (boolean) - Optional - Flag to indicate if instant payment is required.

### Request Example
```json
{
  "invoice_number": "INV-001",
  "invoice_date": "2024-01-18",
  "invoice_due_date": "2024-02-18",
  "items": [
    {
      "sku": "ITEM001",
      "name": "Example Product",
      "quantity": 2,
      "price": 5000,
      "discount": 100,
      "tax": 200,
      "additional_info": {
        "color": "blue"
      }
    }
  ],
  "discount": 500,
  "delivery_fee": 1000,
  "payment_method": {
    "method": "credit_card",
    "channel": "visa"
  },
  "redirect_url": "https://example.com/payment/success",
  "send": {
    "email": true,
    "whatsapp": false,
    "sms": true
  },
  "additional_info": "Please include gift wrap",
  "instant_payment": false
}
```

### Response
#### Success Response (200)
- **status_code** (integer) - The status code of the response.
- **data** (object) - Contains details of the payment request.
  - **amount** (integer) - Total amount of the payment.
  - **buyer_fee** (integer) - Fee charged to the buyer.
  - **external_id** (string) - Unique external identifier for the payment.
  - **merchant_fee** (integer) - Fee charged to the merchant.
  - **payment_channel** (string) - The channel used for payment.
  - **payment_id** (string) - Unique identifier for the payment.
  - **payment_method** (string) - The method used for payment.
  - **ref_id** (string) - Reference ID for the payment.
- **links** (array) - HATEOAS links for related actions or resources.
  - **rel** (string) - Relationship of the link.
  - **href** (string) - URL for the link.
  - **type** (string) - HTTP method for the link.
  - **kind** (string) - Type of link (e.g., 'item', 'action', 'collections').

#### Response Example
```json
{
    "status_code": 201,
    "data": {
        "amount": 10000,
        "buyer_fee": 0,
        "external_id": "17321762704SAS9",
        "merchant_fee": 150,
        "payment_channel": "visa",
        "payment_id": "7664861d-6289-4a53-a177-be51eb403135",
        "payment_method": "credit_card",
        "ref_id": "PAY-REF/2024/01/18/XXzz2"
    },
    "links": [
        {
            "rel": "self",
            "href": "/api/v1/payment/request/7664861d-6289-4a53-a177-be51eb403135",
            "type": "GET",
            "kind": "item"
        },
        {
            "rel": "self",
            "href": "/api/v1/payment/request/7664861d-6289-4a53-a177-be51eb403135/cancel",
            "type": "POST",
            "kind": "action"
        },
        {
            "rel": "self",
            "href": "/api/v1/payment/history",
            "type": "GET",
            "kind": "collections"
        }
    ]
}
```
```

--------------------------------

### Document Creation API

Source: https://open-api-paper-id.readme.io/reference/retrive-single-purchase-invoice-1

Allows the creation of new documents with specified details, including itemized information and financial summaries.

```APIDOC
## POST /documents

### Description
Creates a new document with provided details, including financial information, terms, and itemized entries.

### Method
POST

### Endpoint
/documents

### Parameters
#### Request Body
- **paper_id** (string) - Example: "241035596pp" - The unique identifier for the paper.
- **company_id** (string) - Example: "d9c19fb9-96ae-4f37-919d-bffdfae35bf8" - The ID of the associated company.
- **partner_id** (string) - Example: "de1d95c3-b090-4a2a-8e4e-37af8de87d25" - The ID of the associated partner.
- **document_type_id** (string) - Example: "inv-02" - The identifier for the document type.
- **invoice_date** (string) - Example: "2024-07-31" - The date the invoice was issued.
- **due_date** (string) - Example: "2024-10-11" - The date the invoice is due.
- **status** (string) - Example: "DRAFT" - The current status of the document.
- **version** (integer) - Optional - Example: 0 - The version number of the document.
- **signature_text_header** (string) - Optional - Example: "" - Text to appear in the header of the signature section.
- **signature_text_footer** (string) - Optional - Example: "" - Text to appear in the footer of the signature section.
- **terms_and_conditions** (string) - Optional - Example: "" - The terms and conditions applicable to the document.
- **notes** (string) - Optional - Example: "Nomor Po: POCI00036076 <br> Nomor Surat Jalan: 1400007762 <br> Satuan: BAG" - Additional notes for the document.
- **grand_total** (integer) - Optional - Example: 0 - The final total amount of the document.
- **subtotal** (integer) - Optional - Example: 16141312 - The subtotal amount before discounts and taxes.
- **total_discount** (integer) - Optional - Example: 0 - The total discount applied.
- **tax_inclusive** (integer) - Optional - Example: 0 - Indicates if tax is inclusive.
- **tax_exclusive** (integer) - Optional - Example: 0 - Indicates if tax is exclusive.
- **custom_total_per_item** (integer) - Optional - Example: 0 - Custom total calculated per item.
- **items** (array) - The list of items included in the document.
  - **product_name** (string) - Example: "ThinBed Adhesive for AAC/" - The name of the product.
  - **description** (string) - Example: "ALC" - A description of the product.
  - **sku** (string) - Optional - Example: "" - The Stock Keeping Unit for the product.
  - **uom** (object) - Unit of measure for the item.
  - **quantity** (integer) - Example: 200 - The quantity of the item.
  - **price** (number) - Example: 80706.56 - The price per unit of the item.
  - **discount** (integer) - Optional - Example: 0 - The discount applied to the item.
  - **index** (integer) - The index of the item in the list.

### Request Example
```json
{
  "paper_id": "241035596pp",
  "company_id": "d9c19fb9-96ae-4f37-919d-bffdfae35bf8",
  "partner_id": "de1d95c3-b090-4a2a-8e4e-37af8de87d25",
  "document_type_id": "inv-02",
  "invoice_date": "2024-07-31",
  "due_date": "2024-10-11",
  "status": "DRAFT",
  "items": [
    {
      "product_name": "ThinBed Adhesive for AAC/",
      "description": "ALC",
      "quantity": 200,
      "price": 80706.56,
      "index": 0
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of document creation.
- **document_id** (string) - The ID of the newly created document.

#### Response Example
```json
{
  "message": "Document created successfully",
  "document_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```
```

--------------------------------

### GET /sales-invoices

Source: https://open-api-paper-id.readme.io/reference/retrieve-list-of-all-sales-invoices

Retrieves a list of sales invoices with pagination support.

```APIDOC
## GET /sales-invoices

### Description
Retrieves a list of sales invoices. Supports pagination with `limit` and `offset` query parameters.

### Method
GET

### Endpoint
/sales-invoices

### Query Parameters
- **limit** (integer) - Optional - The maximum number of records to return.
- **offset** (integer) - Optional - The number of records to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **invoices** (array) - A list of sales invoice objects.
  - **uuid** (string) - The unique identifier of the invoice.
  - **number** (string) - The invoice number.
  - **invoice_date** (string) - The date the invoice was issued (YYYY-MM-DD).
  - **status** (integer) - The status of the invoice.
  - **links** (array) - A list of related links for the invoice.
    - **rel** (string) - The relationship of the link (e.g., "self", "action", "file").
    - **href** (string) - The URL for the related resource.
    - **type** (string) - The HTTP method for the link (e.g., "GET", "POST").
    - **kind** (string) - The type of the link (e.g., "item", "action", "file").
- **limit** (integer) - The limit applied to the returned records.
- **offset** (integer) - The offset applied to the returned records.
- **total_records** (integer) - The total number of records available.

#### Response Example
```json
{
    "invoices": [
        {
            "uuid": "db158036-e985-4e62-a34c-536a388893ef",
            "number": "EXP/2023/0001",
            "invoice_date": "2023-05-09",
            "status": 3,
            "links": [
                {
                    "rel": "self",
                    "href": "/sales-invoices/db158036-e985-4e62-a34c-536a388893ef",
                    "type": "GET",
                    "kind": "item"
                },
                {
                    "rel": "self",
                    "href": "/sales-invoices/send/db158036-e985-4e62-a34c-536a388893ef",
                    "type": "POST",
                    "kind": "action"
                },
                {
                    "rel": "self",
                    "href": "/sales-invoices/pdf/db158036-e985-4e62-a34c-536a388893ef",
                    "type": "GET",
                    "kind": "file"
                }
            ]
        }
    ],
    "limit": 8,
    "offset": 0,
    "total_records": 7
}
```
```

--------------------------------

### Invoice Details

Source: https://open-api-paper-id.readme.io/reference/retrive-single-purchase-invoice-1

This section describes the structure of invoice details, including pricing, partner information, and tax invoice specifics.

```APIDOC
## Invoice Details Structure

### Description
Provides a comprehensive breakdown of invoice information, including pricing components, partner details, and tax invoice data.

### Properties

- **price** (object) - Details about the pricing of the invoice.
  - **subtotal** (integer) - The subtotal amount before discounts and taxes.
  - **tax_type** (string) - The type of tax applied.
  - **discount_amount** (integer) - The amount discounted from the subtotal.
  - **discount_percentage** (integer) - The percentage of discount applied.
  - **discount_string** (string) - A string representation of the discount.
  - **total** (integer) - The final total amount after discounts and taxes.

- **partner** (object) - Information about the partner associated with the invoice.
  - **uuid** (string) - The unique identifier for the partner.
  - **name** (string) - The name of the partner.
  - **email** (string) - The email address of the partner.
  - **phone** (string) - The phone number of the partner.

- **tax_invoice** (object) - Details related to the tax invoice.
  - **kd_jenis_transaksi** (string) - Transaction type code.
  - **fg_pengganti** (string) - Flag for replacement invoice.
  - **nomor_faktur** (string) - Tax invoice number.
  - **tanggal_faktur** (string) - Date of the tax invoice (format: MM/DD/YYYY).
  - **npwp_penjual** (string) - Seller's NPWP (Tax Identification Number).
  - **nama_penjual** (string) - Seller's name.
  - **alamat_penjual** (string) - Seller's address.
  - **npwp_lawan_transaksi** (string) - Buyer's NPWP (Tax Identification Number).
  - **nama_lawan_transaksi** (string) - Buyer's name.
  - **alamat_lawan_transaksi** (string) - Buyer's address.
  - **jumlah_dpp** (string) - Amount of Value Added Tax base (DPP).
  - **jumlah_ppn** (string) - Amount of Value Added Tax (PPN).
  - **jumlah_ppnbm** (string) - Amount of Luxury Goods Sales Tax (PPnBM).
  - **status_approval** (string) - Approval status of the tax invoice.
```

--------------------------------

### POST /api/v1/payment/request

Source: https://open-api-paper-id.readme.io/reference/changelog

Allows users to make a payment request. Introduces an 'instant_payment' parameter for immediate processing without requiring an invoice first, useful for scenarios like online shops.

```APIDOC
## POST /api/v1/payment/request

### Description
This endpoint facilitates payment requests. A new `instant_payment` parameter has been added, enabling direct payments without the need to create an invoice beforehand. This is particularly beneficial for AR (Accounts Receivable) transaction scenarios, such as integrating with custom online shops.

### Method
POST

### Endpoint
/api/v1/payment/request

### Parameters
#### Query Parameters
- **instant_payment** (boolean) - Optional - When set to true, the payment is processed instantly without waiting for invoice creation.

### Request Example
```json
{
  "amount": 100.00,
  "currency": "USD",
  "customer_id": "cust_123",
  "instant_payment": true
}
```

### Response
#### Success Response (200)
- **payment_id** (string) - The unique identifier for the processed payment.
- **status** (string) - The status of the payment (e.g., "success", "pending").

#### Response Example
```json
{
  "payment_id": "pay_abc789",
  "status": "success"
}
```
```

--------------------------------

### GET /sales-invoices/{uuid}

Source: https://open-api-paper-id.readme.io/reference/retrieve-list-of-all-sales-invoices

Retrieves details of a specific sales invoice by its UUID.

```APIDOC
## GET /sales-invoices/{uuid}

### Description
Retrieves the detailed information for a specific sales invoice using its unique identifier (UUID).

### Method
GET

### Endpoint
/sales-invoices/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the sales invoice.

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier of the invoice.
- **number** (string) - The invoice number.
- **invoice_date** (string) - The date the invoice was issued (YYYY-MM-DD).
- **status** (integer) - The status of the invoice.
- **links** (array) - A list of related links for the invoice.
  - **rel** (string) - The relationship of the link (e.g., "self", "action", "file").
  - **href** (string) - The URL for the related resource.
  - **type** (string) - The HTTP method for the link (e.g., "GET", "POST").
  - **kind** (string) - The type of the link (e.g., "item", "action", "file").

#### Response Example
```json
{
    "uuid": "a5b69547-4afd-49f4-8aa4-db7b61e6ef9d",
    "number": "EXP/2023/0001",
    "invoice_date": "2023-05-09",
    "status": 3,
    "links": [
        {
            "rel": "self",
            "href": "/sales-invoices/a5b69547-4afd-49f4-8aa4-db7b61e6ef9d",
            "type": "GET",
            "kind": "item"
        },
        {
            "rel": "self",
            "href": "/sales-invoices/send/a5b69547-4afd-49f4-8aa4-db7b61e6ef9d",
            "type": "POST",
            "kind": "action"
        },
        {
            "rel": "self",
            "href": "/sales-invoices/pdf/a5b69547-4afd-49f4-8aa4-db7b61e6ef9d",
            "type": "GET",
            "kind": "file"
        }
    ]
}
```
```

--------------------------------

### GET /sales-invoices/pdf/{uuid}

Source: https://open-api-paper-id.readme.io/reference/retrieve-list-of-all-sales-invoices

Retrieves the PDF version of a sales invoice identified by its UUID.

```APIDOC
## GET /sales-invoices/pdf/{uuid}

### Description
Retrieves the PDF document for a specific sales invoice, identified by its UUID.

### Method
GET

### Endpoint
/sales-invoices/pdf/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the sales invoice for which to retrieve the PDF.

### Response
#### Success Response (200)
Returns the PDF content of the sales invoice.

#### Response Example
(The response will be the binary content of a PDF file. This example shows a placeholder for the content.)
```
%PDF-1.4
... (binary PDF content) ...
```
```

--------------------------------

### POST /store-invoice

Source: https://open-api-paper-id.readme.io/reference/create-sales-invoice

Endpoint to create a new sales invoice with details about the customer, items, and dates.

```APIDOC
## POST /store-invoice

### Description
Creates a new sales invoice with provided customer and item details.

### Method
POST

### Endpoint
https://open-api.stag-v2.paper.id/api/v1/store-invoice

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **invoice_date** (string) - Required - Invoice Date, using DD-MM-YYYY format
- **due_date** (string) - Required - Due Date of Invoice, using DD-MM-YYYY format
- **number** (string) - Required - Invoice Number
- **customer** (object) - Required - Customer Detail Information
  - **id** (string) - Customer ID
  - **name** (string) - Customer Name
  - **email** (string) - Customer Email
  - **phone** (string) - Customer Phone Number
- **items** (array) - Required - Item Details
  - **name** (string) - Item Name
  - **description** (string) - Item Description
  - **quantity** (integer) - Item Quantity
  - **price** (integer) - item price
  - **discount** (integer) - Discount
  - **tax** (integer) - Tax Amount
  - **additional_info** (object) - Additional information for the item
- **send** (boolean) - Required - Whether to send the invoice
- **signature_text_header** (string) - Optional - Signature text for the header
- **signature_text_footer** (string) - Optional - Signature text for the footer
- **terms_condition** (string) - Optional - Terms and conditions for the invoice

### Request Example
```json
{
  "invoice_date": "15-08-2024",
  "due_date": "15-09-2024",
  "number": "INV-001",
  "customer": {
    "id": "CUST-123",
    "name": "Acme Corporation",
    "email": "contact@acme.com",
    "phone": "+1234567890"
  },
  "items": [
    {
      "name": "Product A",
      "description": "High-quality product A",
      "quantity": 2,
      "price": 10000,
      "discount": 500,
      "tax": 1000,
      "additional_info": {}
    }
  ],
  "send": true,
  "signature_text_header": "Thank you for your business!",
  "signature_text_footer": "Payment due within 30 days.",
  "terms_condition": "All sales are final."
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the invoice was created.
- **invoice_id** (string) - The unique identifier for the created invoice.

#### Response Example
```json
{
  "message": "Sales invoice created successfully.",
  "invoice_id": "INV-ABC-789"
}
```
```
Tokens:
Raw