NAV

getInvoice

This endpoint allows the developer to access the SimplePin’s API in order to obtain invoice information. It is used to identify if an invoice exists in SimplePin’s database by the specific invoice uuid or invoice code. It allows you to retrieve detailed information on the invoice’s structure and payment status.

Parameters
Name
Description
invoice_number string (optional)

Internal invoice number created by SimplePin platform.

uuid string (optional)

Unique invoice code created by SimplePin.

invoice_id string (optional)

Unique invoice number previously created using addInvoice end-point. Normally the same invoice number created by your system.

Response Messages
Code
Description
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "additional_description": "string",
    "admin_fees_models": [
        {
            "customer_fee_percent": 1.01,
            "payment_method": "CREDIT_CARD"
        }
    ],
    "amount": 1.01,
    "company_address": {
        "id": 0,
        "zip": "string",
        "city": "string",
        "country": 0,
        "province": 0,
        "address": "string",
        "selected": true
    },
    "configured_payment_type": "FULL",
    "contracts": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "currency_code": "AED",
    "customer_address": {
        "id": 0,
        "zip": "string",
        "city": "string",
        "country": 0,
        "province": 0,
        "address": "string",
        "selected": true
    },
    "customer_fee_percent": 1.01,
    "customer_id": "string",
    "enable_preauthorize": true,
    "fee": 1.01,
    "id": 0,
    "invoice_date": "string",
    "invoice_due_date": "string",
    "invoice_number": "string",
    "invoice_owner_account_id": 0,
    "invoice_reminder_schema": "DEFAULT",
    "last_tx_type": "DB",
    "line_item_models": [
        {
            "id": 0,
            "description": "string",
            "quantity": 1.01,
            "unit_price": 1.01,
            "taxable": true
        }
    ],
    "locale": "string",
    "opened_from_email_times": 0,
    "opened_times": 0,
    "paid": "PAID",
    "payment_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "payment_form_model": {
        "url": "string"
    },
    "payment_method": "CREDIT_CARD",
    "payment_plan_template_models": [
        {
            "admin_fees_models": [
                {
                    "customer_fee_percent": 1.01,
                    "payment_method": "CREDIT_CARD"
                }
            ],
            "id": 0,
            "payment_plan_models": [
                {
                    "amount": 1.01,
                    "collect_taxes": true,
                    "id": 0,
                    "interest_amount": 1.01,
                    "scheduled_payment_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
                    "state": "PAID",
                    "tax_payment_plan_models": [
                        {
                            "taxation_id": 0,
                            "label": "string",
                            "amount": 1.01
                        }
                    ]
                }
            ],
            "payment_plan_template_settings_model": {
                "annual_interest_percent": 1.01,
                "early_payment_allowed": true,
                "discount_on_early_payment": true,
                "recurrent_type": "MONTHLY"
            }
        }
    ],
    "payment_type": "FULL",
    "period_end_date": "string",
    "period_start_date": "string",
    "pin": "string",
    "profit_margin": 1.01,
    "qr_code": "string",
    "qr_code_id": "string",
    "scheduled_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "selected_payment_plan_template_id": 0,
    "sent_times": 0,
    "state": "DRAFT",
    "tax_models": [
        {
            "id": 0,
            "label": "string",
            "registration_number": "string",
            "percent": 1.01,
            "amount": 1.01
        }
    ],
    "taxation_type": "PRECALCULATED",
    "timezone_formatted": "string",
    "timezone_id": "string",
    "total_amount": 1.01,
    "transaction_fee": 1.01,
    "url": "string",
    "uuid": "string",
    "version": 0
}
             
          
{ } InvoiceResponseV2Model
additional_description optional string
admin_fees_models optional array|AdminFeesV2Model
amount optional number
company_address optional AddressApiV2Model
configured_payment_type optional string
contracts optional array|CcContractV2Model
creation_date optional string
currency_code optional string
customer_address optional AddressApiV2Model
customer_fee_percent optional number
customer_id optional string
enable_preauthorize required boolean
fee optional number
id optional integer
invoice_date optional string
invoice_due_date optional string
invoice_number optional string
invoice_owner_account_id optional integer
invoice_reminder_schema optional string
last_tx_type optional string
line_item_models optional array|LineItemV2Model
locale optional string
opened_from_email_times optional integer
opened_times optional integer
paid required string
payment_date optional string
payment_form_model optional PaymentFormV2Model
payment_method optional string
payment_plan_template_models optional array|PaymentPlanTemplateV2Model
payment_type optional string
period_end_date optional string
period_start_date optional string
pin optional string
profit_margin optional number
qr_code optional string
qr_code_id optional string
scheduled_date optional string
selected_payment_plan_template_id optional integer
sent_times optional integer
state optional string
tax_models optional array|TaxV2Model
taxation_type optional string
timezone_formatted optional string
timezone_id optional string
total_amount optional number
transaction_fee optional number
url optional string
uuid optional string
version optional integer
{ } AdminFeesV2Model
customer_fee_percent optional number
payment_method optional string
{ } AddressApiV2Model
id optional integer
zip optional string
city optional string
country optional integer
province optional integer
address optional string
selected optional boolean
{ } CcContractV2Model
id optional integer
name optional string
{ } LineItemV2Model
id optional integer
description optional string
quantity optional number
unit_price optional number
taxable optional boolean
{ } PaymentFormV2Model
url required string
{ } PaymentPlanTemplateV2Model
admin_fees_models optional array|AdminFeesV2Model
id optional integer
payment_plan_models optional array|PaymentPlanV2Model
payment_plan_template_settings_model optional PaymentPlanTemplateSettingsV2Model
{ } TaxV2Model
id optional integer
label optional string
registration_number optional string
percent optional number
amount optional number
             <invoice_response_model>
  <additional_description>string</additional_description>
  <admin_fees_models>
    <admin_fees_model>
      <customer_fee_percent>1.01</customer_fee_percent>
      <payment_method>CREDIT_CARD</payment_method>
    </admin_fees_model>
    <admin_fees_model>
      <customer_fee_percent>1.01</customer_fee_percent>
      <payment_method>CREDIT_CARD</payment_method>
    </admin_fees_model>
  </admin_fees_models>
  <amount>1.01</amount>
  <company_address/>
  <configured_payment_type>FULL</configured_payment_type>
  <contracts>
    <contract>
      <id>0</id>
      <name>string</name>
    </contract>
    <contract>
      <id>0</id>
      <name>string</name>
    </contract>
  </contracts>
  <creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
  <currency_code>AED</currency_code>
  <customer_address/>
  <customer_fee_percent>1.01</customer_fee_percent>
  <customer_id>string</customer_id>
  <enable_preauthorize>1</enable_preauthorize>
  <fee>1.01</fee>
  <id>0</id>
  <invoice_date>string</invoice_date>
  <invoice_due_date>string</invoice_due_date>
  <invoice_number>string</invoice_number>
  <invoice_owner_account_id>0</invoice_owner_account_id>
  <invoice_reminder_schema>DEFAULT</invoice_reminder_schema>
  <last_tx_type>DB</last_tx_type>
  <line_item_models>
    <line_item_model>
      <id>0</id>
      <description>string</description>
      <quantity>1.01</quantity>
      <unit_price>1.01</unit_price>
      <taxable>1</taxable>
    </line_item_model>
    <line_item_model>
      <id>0</id>
      <description>string</description>
      <quantity>1.01</quantity>
      <unit_price>1.01</unit_price>
      <taxable>1</taxable>
    </line_item_model>
  </line_item_models>
  <locale>string</locale>
  <opened_from_email_times>0</opened_from_email_times>
  <opened_times>0</opened_times>
  <paid>PAID</paid>
  <payment_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</payment_date>
  <payment_form_model/>
  <payment_method>CREDIT_CARD</payment_method>
  <payment_plan_template_models>
    <payment_plan_template_model>
      <admin_fees_models>
        <admin_fees_model>
          <customer_fee_percent>1.01</customer_fee_percent>
          <payment_method>CREDIT_CARD</payment_method>
        </admin_fees_model>
        <admin_fees_model>
          <customer_fee_percent>1.01</customer_fee_percent>
          <payment_method>CREDIT_CARD</payment_method>
        </admin_fees_model>
      </admin_fees_models>
      <id>0</id>
      <payment_plan_models>
        <payment_plan_model>
          <amount>1.01</amount>
          <collect_taxes>1</collect_taxes>
          <id>0</id>
          <interest_amount>1.01</interest_amount>
          <scheduled_payment_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</scheduled_payment_date>
          <state>PAID</state>
          <tax_payment_plan_models>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
          </tax_payment_plan_models>
        </payment_plan_model>
        <payment_plan_model>
          <amount>1.01</amount>
          <collect_taxes>1</collect_taxes>
          <id>0</id>
          <interest_amount>1.01</interest_amount>
          <scheduled_payment_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</scheduled_payment_date>
          <state>PAID</state>
          <tax_payment_plan_models>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
          </tax_payment_plan_models>
        </payment_plan_model>
      </payment_plan_models>
      <payment_plan_template_settings_model/>
    </payment_plan_template_model>
    <payment_plan_template_model>
      <admin_fees_models>
        <admin_fees_model>
          <customer_fee_percent>1.01</customer_fee_percent>
          <payment_method>CREDIT_CARD</payment_method>
        </admin_fees_model>
        <admin_fees_model>
          <customer_fee_percent>1.01</customer_fee_percent>
          <payment_method>CREDIT_CARD</payment_method>
        </admin_fees_model>
      </admin_fees_models>
      <id>0</id>
      <payment_plan_models>
        <payment_plan_model>
          <amount>1.01</amount>
          <collect_taxes>1</collect_taxes>
          <id>0</id>
          <interest_amount>1.01</interest_amount>
          <scheduled_payment_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</scheduled_payment_date>
          <state>PAID</state>
          <tax_payment_plan_models>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
          </tax_payment_plan_models>
        </payment_plan_model>
        <payment_plan_model>
          <amount>1.01</amount>
          <collect_taxes>1</collect_taxes>
          <id>0</id>
          <interest_amount>1.01</interest_amount>
          <scheduled_payment_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</scheduled_payment_date>
          <state>PAID</state>
          <tax_payment_plan_models>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
            <tax_payment_plan_model>
              <taxation_id>0</taxation_id>
              <label>string</label>
              <amount>1.01</amount>
            </tax_payment_plan_model>
          </tax_payment_plan_models>
        </payment_plan_model>
      </payment_plan_models>
      <payment_plan_template_settings_model/>
    </payment_plan_template_model>
  </payment_plan_template_models>
  <payment_type>FULL</payment_type>
  <period_end_date>string</period_end_date>
  <period_start_date>string</period_start_date>
  <pin>string</pin>
  <profit_margin>1.01</profit_margin>
  <qr_code>string</qr_code>
  <qr_code_id>string</qr_code_id>
  <scheduled_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</scheduled_date>
  <selected_payment_plan_template_id>0</selected_payment_plan_template_id>
  <sent_times>0</sent_times>
  <state>DRAFT</state>
  <tax_models>
    <tax_model>
      <id>0</id>
      <label>string</label>
      <registration_number>string</registration_number>
      <percent>1.01</percent>
      <amount>1.01</amount>
    </tax_model>
    <tax_model>
      <id>0</id>
      <label>string</label>
      <registration_number>string</registration_number>
      <percent>1.01</percent>
      <amount>1.01</amount>
    </tax_model>
  </tax_models>
  <taxation_type>PRECALCULATED</taxation_type>
  <timezone_formatted>string</timezone_formatted>
  <timezone_id>string</timezone_id>
  <total_amount>1.01</total_amount>
  <transaction_fee>1.01</transaction_fee>
  <url>string</url>
  <uuid>string</uuid>
  <version>0</version>
</invoice_response_model>

             
          
{ } InvoiceResponseV2Model
additional_description optional string
admin_fees_models optional array|AdminFeesV2Model
amount optional number
company_address optional AddressApiV2Model
configured_payment_type optional string
contracts optional array|CcContractV2Model
creation_date optional string
currency_code optional string
customer_address optional AddressApiV2Model
customer_fee_percent optional number
customer_id optional string
enable_preauthorize required boolean
fee optional number
id optional integer
invoice_date optional string
invoice_due_date optional string
invoice_number optional string
invoice_owner_account_id optional integer
invoice_reminder_schema optional string
last_tx_type optional string
line_item_models optional array|LineItemV2Model
locale optional string
opened_from_email_times optional integer
opened_times optional integer
paid required string
payment_date optional string
payment_form_model optional PaymentFormV2Model
payment_method optional string
payment_plan_template_models optional array|PaymentPlanTemplateV2Model
payment_type optional string
period_end_date optional string
period_start_date optional string
pin optional string
profit_margin optional number
qr_code optional string
qr_code_id optional string
scheduled_date optional string
selected_payment_plan_template_id optional integer
sent_times optional integer
state optional string
tax_models optional array|TaxV2Model
taxation_type optional string
timezone_formatted optional string
timezone_id optional string
total_amount optional number
transaction_fee optional number
url optional string
uuid optional string
version optional integer
{ } AdminFeesV2Model
customer_fee_percent optional number
payment_method optional string
{ } AddressApiV2Model
id optional integer
zip optional string
city optional string
country optional integer
province optional integer
address optional string
selected optional boolean
{ } CcContractV2Model
id optional integer
name optional string
{ } LineItemV2Model
id optional integer
description optional string
quantity optional number
unit_price optional number
taxable optional boolean
{ } PaymentFormV2Model
url required string
{ } PaymentPlanTemplateV2Model
admin_fees_models optional array|AdminFeesV2Model
id optional integer
payment_plan_models optional array|PaymentPlanV2Model
payment_plan_template_settings_model optional PaymentPlanTemplateSettingsV2Model
{ } TaxV2Model
id optional integer
label optional string
registration_number optional string
percent optional number
amount optional number