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 of the invoice’s structure and payment status.
Parameters
Name
Description
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_desr": "string",
"billing_address": "string",
"billing_address_id": 0,
"city": "string",
"company_address": "string",
"company_city": "string",
"company_country": 0,
"company_fees_settings_models": [
{
"company_fee_percent": 1.01,
"cross_border_fee_percent": 1.01,
"customer_fee_percent": 1.01,
"payment_method": "CREDIT_CARD",
"profit_margin": 1.01,
"transaction_fee": 1.01
}
],
"company_province": 0,
"company_zip": "string",
"country": 0,
"creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"currency_code": "AED",
"customer_fee_percent": 1.01,
"fee": 1.01,
"id": 0,
"invoice_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"invoice_due_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"invoice_number": "string",
"invoice_type": {
"id": 0,
"state": "DISABLED",
"name": "string",
"order": 0,
"company_id": 0,
"creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
},
"line_items_list": [
{
"amount_price": 1.01,
"creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"description": "string",
"id": 0,
"invoice_id": 0,
"invoice_version": 0,
"order": 0,
"quantity": 1.01,
"taxable": true,
"unit_price": 1.01
}
],
"locale": "string",
"opened": 0,
"opened_from_email": 0,
"paid": "PAID",
"payment_id": "string",
"payment_method": "string",
"period_end_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"period_start_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"policy_id": "string",
"profit_margin": 1.01,
"province": 0,
"sent_times": 0,
"state": "DRAFT",
"subtotal": 1.01,
"target_ccprofile_id": 0,
"taxation_models": [
{
"amount": 1.01,
"id": 0,
"percent": 1.01,
"registration_number": "string",
"version": 0,
"company_id": 0,
"label": "string",
"percentage": 1.01,
"value": 1.01,
"order": 0,
"reg_number": "string",
"enabled": true
}
],
"total": 1.01,
"transaction_fee": 1.01,
"update_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"uuid": "string",
"version": 0,
"zip": "string"
}
{ } InvoiceModel
additional_desr
optional
string
billing_address
optional
string
billing_address_id
optional
integer
city
required
string
company_address
required
string
company_city
required
string
company_country
optional
integer
company_province
optional
integer
company_zip
required
string
country
optional
integer
creation_date
required
string
currency_code
required
string
customer_fee_percent
optional
number
fee
optional
number
id
optional
integer
invoice_date
required
string
invoice_due_date
required
string
invoice_number
required
string
locale
required
string
opened
optional
integer
opened_from_email
optional
integer
paid
required
string
payment_id
optional
string
payment_method
optional
string
period_end_date
optional
string
period_start_date
optional
string
policy_id
required
string
profit_margin
optional
number
province
optional
integer
sent_times
optional
integer
state
optional
string
subtotal
required
number
target_ccprofile_id
required
integer
total
required
number
transaction_fee
optional
number
update_date
required
string
uuid
required
string
version
optional
integer
zip
required
string
{ } CompanyFeeSettingsModel
company_fee_percent
optional
number
cross_border_fee_percent
optional
number
customer_fee_percent
optional
number
payment_method
optional
string
profit_margin
optional
number
transaction_fee
optional
number
{ } InvoiceTypeModel
id
optional
integer
state
optional
string
name
optional
string
order
optional
integer
company_id
optional
integer
creation_date
optional
string
{ } LineItemModel
amount_price
required
number
creation_date
optional
string
description
required
string
id
required
integer
invoice_id
required
integer
invoice_version
required
integer
order
optional
integer
quantity
required
number
taxable
required
boolean
unit_price
required
number
{ } TaxationModel
amount
optional
number
id
optional
integer
percent
optional
number
registration_number
optional
string
version
optional
integer
company_id
optional
integer
label
optional
string
percentage
optional
number
value
optional
number
order
optional
integer
reg_number
optional
string
enabled
optional
boolean
<invoice_model>
<additional_desr>string</additional_desr>
<billing_address>string</billing_address>
<billing_address_id>0</billing_address_id>
<city>string</city>
<company_address>string</company_address>
<company_city>string</company_city>
<company_country>0</company_country>
<company_fees_settings_model>
<company_fee_percent>1.01</company_fee_percent>
<cross_border_fee_percent>1.01</cross_border_fee_percent>
<customer_fee_percent>1.01</customer_fee_percent>
<payment_method>CREDIT_CARD</payment_method>
<profit_margin>1.01</profit_margin>
<transaction_fee>1.01</transaction_fee>
</company_fees_settings_model>
<company_fees_settings_model>
<company_fee_percent>1.01</company_fee_percent>
<cross_border_fee_percent>1.01</cross_border_fee_percent>
<customer_fee_percent>1.01</customer_fee_percent>
<payment_method>CREDIT_CARD</payment_method>
<profit_margin>1.01</profit_margin>
<transaction_fee>1.01</transaction_fee>
</company_fees_settings_model>
<company_province>0</company_province>
<company_zip>string</company_zip>
<country>0</country>
<creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
<currency_code>AED</currency_code>
<customer_fee_percent>1.01</customer_fee_percent>
<fee>1.01</fee>
<id>0</id>
<invoice_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_date>
<invoice_due_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_due_date>
<invoice_number>string</invoice_number>
<invoice_type/>
<line_items_list>
<amount_price>1.01</amount_price>
<creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
<description>string</description>
<id>0</id>
<invoice_id>0</invoice_id>
<invoice_version>0</invoice_version>
<order>0</order>
<quantity>1.01</quantity>
<taxable>1</taxable>
<unit_price>1.01</unit_price>
</line_items_list>
<line_items_list>
<amount_price>1.01</amount_price>
<creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
<description>string</description>
<id>0</id>
<invoice_id>0</invoice_id>
<invoice_version>0</invoice_version>
<order>0</order>
<quantity>1.01</quantity>
<taxable>1</taxable>
<unit_price>1.01</unit_price>
</line_items_list>
<locale>string</locale>
<opened>0</opened>
<opened_from_email>0</opened_from_email>
<paid>PAID</paid>
<payment_id>string</payment_id>
<payment_method>string</payment_method>
<period_end_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</period_end_date>
<period_start_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</period_start_date>
<policy_id>string</policy_id>
<profit_margin>1.01</profit_margin>
<province>0</province>
<sent_times>0</sent_times>
<state>DRAFT</state>
<subtotal>1.01</subtotal>
<target_ccprofile_id>0</target_ccprofile_id>
<taxation_model>
<amount>1.01</amount>
<id>0</id>
<percent>1.01</percent>
<registration_number>string</registration_number>
<version>0</version>
<company_id>0</company_id>
<label>string</label>
<percentage>1.01</percentage>
<value>1.01</value>
<order>0</order>
<reg_number>string</reg_number>
<enabled>1</enabled>
</taxation_model>
<taxation_model>
<amount>1.01</amount>
<id>0</id>
<percent>1.01</percent>
<registration_number>string</registration_number>
<version>0</version>
<company_id>0</company_id>
<label>string</label>
<percentage>1.01</percentage>
<value>1.01</value>
<order>0</order>
<reg_number>string</reg_number>
<enabled>1</enabled>
</taxation_model>
<total>1.01</total>
<transaction_fee>1.01</transaction_fee>
<update_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</update_date>
<uuid>string</uuid>
<version>0</version>
<zip>string</zip>
</invoice_model>
{ } InvoiceModel
additional_desr
optional
string
billing_address
optional
string
billing_address_id
optional
integer
city
required
string
company_address
required
string
company_city
required
string
company_country
optional
integer
company_province
optional
integer
company_zip
required
string
country
optional
integer
creation_date
required
string
currency_code
required
string
customer_fee_percent
optional
number
fee
optional
number
id
optional
integer
invoice_date
required
string
invoice_due_date
required
string
invoice_number
required
string
locale
required
string
opened
optional
integer
opened_from_email
optional
integer
paid
required
string
payment_id
optional
string
payment_method
optional
string
period_end_date
optional
string
period_start_date
optional
string
policy_id
required
string
profit_margin
optional
number
province
optional
integer
sent_times
optional
integer
state
optional
string
subtotal
required
number
target_ccprofile_id
required
integer
total
required
number
transaction_fee
optional
number
update_date
required
string
uuid
required
string
version
optional
integer
zip
required
string
{ } CompanyFeeSettingsModel
company_fee_percent
optional
number
cross_border_fee_percent
optional
number
customer_fee_percent
optional
number
payment_method
optional
string
profit_margin
optional
number
transaction_fee
optional
number
{ } InvoiceTypeModel
id
optional
integer
state
optional
string
name
optional
string
order
optional
integer
company_id
optional
integer
creation_date
optional
string
{ } LineItemModel
amount_price
required
number
creation_date
optional
string
description
required
string
id
required
integer
invoice_id
required
integer
invoice_version
required
integer
order
optional
integer
quantity
required
number
taxable
required
boolean
unit_price
required
number
{ } TaxationModel
amount
optional
number
id
optional
integer
percent
optional
number
registration_number
optional
string
version
optional
integer
company_id
optional
integer
label
optional
string
percentage
optional
number
value
optional
number
order
optional
integer
reg_number
optional
string
enabled
optional
boolean