Invoices
Create Invoice
create an invoice and syncronize it with zatca platform
POST
https://fatoora.idara.sa/api/v1/invoice
Authorization
| Name | Type | Description |
|---|---|---|
| Bearer Token | String | Your API login key you can find it in your main dashboard |
Parameters
| Name | Type | Description |
|---|---|---|
| invoice_type | Integer | 0 for standard invoices and 1 for simplified invoices |
| invoice_type_category | Integer | 4 for credit note, 3 for debit node, 2 for return, 1 for others |
| issue_date | Date | invoice issue date in Y-m-d format |
| issue_time | Time | invoice issue time in H:i:s format |
| customer_name | String | Buyer name
required if invoice_type = 0 which is
standard
prefered if invoice_type = 1 which is simplified |
| customer_vat_reference | String | Buyer Vat number required if invoice_type = 0 which is standard |
| customer_commercial_reference | String | Buyer Commercial number required if invoice_type = 0 which is standard |
| customer_street_name | String | Buyer address Street name required if invoice_type = 0 which is standard |
| customer_building_number | String | Buyer address Building number required if invoice_type = 0 which is standard |
| customer_plot_identification | String | Buyer address plot identification required if invoice_type = 0 which is standard |
| customer_city_sub_division_name | String | Buyer address city sub division name required if invoice_type = 0 which is standard |
| customer_city_name | String | Buyer address City name required if invoice_type = 0 which is standard |
| customer_postal_zone | String | Buyer address Postal zone required if invoice_type = 0 which is standard |
| customer_country_sub_entity | String | Buyer address country sub entitiy required if invoice_type = 0 which is standard |
| customer_identification_code | String | Buyer address country identification code
required if invoice_type = 0 which is
standard
SA for saudi arabia clients |
| vat_percentage | Double | Invoice vat percentage |
| total_vat | Double | Invoice vat amount |
| total_value_with_vat | Double | Invoice total value includes vat |
| details | Array | Invoice items |
| product_name | String | Invoice item name |
| quantity | Double | Invoice item quantity |
| vat_percentage | Double | Invoice item vat percentage |
| vat_amount | Double | Invoice item vat amount |
| price_with_vat | Double | Invoice item price includes vat |
Response
Successfull response
| Name | Type | Description |
|---|---|---|
| Code | Integer | 200 |
| Status | String |
CLEARED or REPORTED
CLEARED: if standard invoice. REPORTED: if simplified invoice. |
| errors | Array | Empty |
| warnings | Array |
Warnings forwarded from zatca response
Prefered to be solved in next invoices |
| info | Array | Info forwarded from zatca response |
Failed response
| Name | Type | Description |
|---|---|---|
| Code | Integer | 400 |
| Status | String |
NOT CLEARED or NOT REPORTED
NOT CLEARED: if standard invoice. NOT REPORTED: if simplified invoice. |
| errors | Array | Errors forwarded from zatca response |
| warnings | Array |
Warnings forwarded from zatca response
Prefered to be solved |
| info | Array | Info forwarded from zatca response |
Limit Excedded response
| Name | Type | Description |
|---|---|---|
| Code | Integer | 402 |
| message | String | Invoices Limitation Exceeded |
Unauthorized response
| Name | Type | Description |
|---|---|---|
| Code | Integer | 401 |
| message | String | un authorized |
Show Invoice
retrive invoice which syncronized successfullt with zatca platform
GET
https://fatoora.idara.sa/api/v1/invoice/id
Authorization
| Name | Type | Description |
|---|---|---|
| Bearer Token | String | Your API login key you can find it in your main dashboard |
Parameters
| Name | Type | Description |
|---|---|---|
| invoice_type | Integer | 0 for standard invoices and 1 for simplified invoices |
Response
Successfull response
| Name | Type | Description |
|---|---|---|
| Code | Integer | 200 |
| status | Boolean | true |
| msg | String | Invoice Retrived successfully |
| data | Object | contains invoice information and its details |
Failed response
| Name | Type | Description |
|---|---|---|
| Code | Integer | 400 |
| status | Boolean | false |
| msg | String | Invoice not exists |
| data | Object | empty |
Unauthorized response
| Name | Type | Description |
|---|---|---|
| Code | Integer | 401 |
| message | String | un authorized |