Get a list of Invoices

GET

/invoices

GET

/v1/invoices

1 curl https://api.gappify.com/v1/invoices \
2      -H "Authorization: <Bearer>"

Try it

200Retrieved

1 [
2   {
3     "source_system_id": "source_system_id",
4     "vendor_id": "vendor_id",
5     "name": "name",
6     "invoice_type": "invoice_type",
7     "invoice_number": "invoice_number",
8     "invoice_line_id": "invoice_line_id",
9     "po_id": "po_id",
10     "memo": "memo",
11     "created_at": "2024-01-15T09:30:00Z",
12     "created_by": "created_by",
13     "updated_at": "2024-01-15T09:30:00Z",
14     "last_modified_by": "last_modified_by",
15     "invoice_date": "2023-01-15",
16     "period": "period",
17     "subsidiary_debit": "subsidiary_debit",
18     "subsidiary_debit_id": "subsidiary_debit_id",
19     "item": "item",
20     "item_id": "item_id",
21     "glaccount_debit": "glaccount_debit",
22     "glaccount_debit_id": "glaccount_debit_id",
23     "glaccount_credit": "glaccount_credit",
24     "glaccount_credit_id": "glaccount_credit_id",
25     "department_debit": "department_debit",
26     "department_debit_id": "department_debit_id",
27     "department_credit": "department_credit",
28     "department_credit_id": "department_credit_id",
29     "product_debit": "product_debit",
30     "product_debit_id": "product_debit_id",
31     "product_credit": "product_credit",
32     "product_credit_id": "product_credit_id",
33     "location_debit": "location_debit",
34     "location_debit_id": "location_debit_id",
35     "location_credit": "location_credit",
36     "location_credit_id": "location_credit_id",
37     "class_debit": "class_debit",
38     "class_debit_id": "class_debit_id",
39     "class_credit": "class_credit",
40     "class_credit_id": "class_credit_id",
41     "project_debit": "project_debit",
42     "project_debit_id": "project_debit_id",
43     "project_credit": "project_credit",
44     "project_credit_id": "project_credit_id",
45     "invoice_memo": "invoice_memo",
46     "status": "status",
47     "currency": "currency",
48     "currency_id": "currency_id",
49     "start_date": "2023-01-15",
50     "end_date": "2023-01-15",
51     "invoice_quantity": 1.1,
52     "invoice_amount": 1.1,
53     "exchange_rate": 1.1,
54     "channel_debit": "channel_debit",
55     "channel_debit_id": "channel_debit_id",
56     "channel_credit": "channel_credit",
57     "channel_credit_id": "channel_credit_id",
58     "region_debit": "region_debit",
59     "region_debit_id": "region_debit_id",
60     "region_credit": "region_credit",
61     "region_credit_id": "region_credit_id",
62     "company_debit": "company_debit",
63     "company_debit_id": "company_debit_id",
64     "company_credit": "company_credit",
65     "company_credit_id": "company_credit_id",
66     "intercompany_debit": "intercompany_debit",
67     "intercompany_debit_id": "intercompany_debit_id",
68     "intercompany_credit": "intercompany_credit",
69     "intercompany_credit_id": "intercompany_credit_id",
70     "po_number": "po_number",
71     "po_line_id": "po_line_id"
72   },
73   {
74     "source_system_id": "source_system_id",
75     "vendor_id": "vendor_id",
76     "name": "name",
77     "invoice_type": "invoice_type",
78     "invoice_number": "invoice_number",
79     "invoice_line_id": "invoice_line_id",
80     "po_id": "po_id",
81     "memo": "memo",
82     "created_at": "2024-01-15T09:30:00Z",
83     "created_by": "created_by",
84     "updated_at": "2024-01-15T09:30:00Z",
85     "last_modified_by": "last_modified_by",
86     "invoice_date": "2023-01-15",
87     "period": "period",
88     "subsidiary_debit": "subsidiary_debit",
89     "subsidiary_debit_id": "subsidiary_debit_id",
90     "item": "item",
91     "item_id": "item_id",
92     "glaccount_debit": "glaccount_debit",
93     "glaccount_debit_id": "glaccount_debit_id",
94     "glaccount_credit": "glaccount_credit",
95     "glaccount_credit_id": "glaccount_credit_id",
96     "department_debit": "department_debit",
97     "department_debit_id": "department_debit_id",
98     "department_credit": "department_credit",
99     "department_credit_id": "department_credit_id",
100     "product_debit": "product_debit",
101     "product_debit_id": "product_debit_id",
102     "product_credit": "product_credit",
103     "product_credit_id": "product_credit_id",
104     "location_debit": "location_debit",
105     "location_debit_id": "location_debit_id",
106     "location_credit": "location_credit",
107     "location_credit_id": "location_credit_id",
108     "class_debit": "class_debit",
109     "class_debit_id": "class_debit_id",
110     "class_credit": "class_credit",
111     "class_credit_id": "class_credit_id",
112     "project_debit": "project_debit",
113     "project_debit_id": "project_debit_id",
114     "project_credit": "project_credit",
115     "project_credit_id": "project_credit_id",
116     "invoice_memo": "invoice_memo",
117     "status": "status",
118     "currency": "currency",
119     "currency_id": "currency_id",
120     "start_date": "2023-01-15",
121     "end_date": "2023-01-15",
122     "invoice_quantity": 1.1,
123     "invoice_amount": 1.1,
124     "exchange_rate": 1.1,
125     "channel_debit": "channel_debit",
126     "channel_debit_id": "channel_debit_id",
127     "channel_credit": "channel_credit",
128     "channel_credit_id": "channel_credit_id",
129     "region_debit": "region_debit",
130     "region_debit_id": "region_debit_id",
131     "region_credit": "region_credit",
132     "region_credit_id": "region_credit_id",
133     "company_debit": "company_debit",
134     "company_debit_id": "company_debit_id",
135     "company_credit": "company_credit",
136     "company_credit_id": "company_credit_id",
137     "intercompany_debit": "intercompany_debit",
138     "intercompany_debit_id": "intercompany_debit_id",
139     "intercompany_credit": "intercompany_credit",
140     "intercompany_credit_id": "intercompany_credit_id",
141     "po_number": "po_number",
142     "po_line_id": "po_line_id"
143   }
144 ]

Retrieve a list of Invoices based on specified filters.

Query parameters

po_idstringOptional

Id of the PO linked to the invoice.

memostringOptional

Invoice header memo.

created_atdatetimeOptional

per_pageintegerOptional

pageintegerOptional

Response

This endpoint returns a list of objects.

source_system_idstring

Unique identifier of the invoice in the ERP system. This value will be used to match source data and perform upserts.

vendor_idstring

Id of the Vendor/Supplier. This value should match the source_vendors->g_source_system_id which will be used to send back as part of JE to ERP.

namestring

Vendor/Supplier name.

invoice_typestring

Type of invoice.

invoice_numberstring

Invoice number.

invoice_line_idstring

Id of the invoice line.

po_idstring

Id of the PO linked to the invoice.

memostring

Invoice header memo.

created_atdatetime

created_bystring

updated_atdatetime

last_modified_bystring

invoice_datedate

FX rate applicable period. Format should be yyyy-mm-dd.

periodstring

Period representation of the invoice.

subsidiary_debitstring

Subsidiary name linked to the invoice. This value should match the name in source_coas.

subsidiary_debit_idstring

Subsidiary id linked to the invoice. This value should match the g_source_system_id in source_coas.

itemstring

item_idstring

glaccount_debitstring

GLAccount debit name linked to the invoice. This value should match the name in source_coas.

glaccount_debit_idstring

GLAccount debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

glaccount_creditstring

GLAccount credit name linked to the invoice. This value should match the name in source_coas.

glaccount_credit_idstring

GLAccount credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

department_debitstring

Department/Cost Center debit name linked to the invoice. This value should match the name in source_coas.

department_debit_idstring

Department/Cost Center debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

department_creditstring

Department/Cost Center credit name linked to the invoice. This value should match the name in source_coas.

department_credit_idstring

Department/Cost Center credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

product_debitstring

Product debit name linked to the invoice. This value should match the name in source_coas.

product_debit_idstring

Product debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

product_creditstring

Product credit name linked to the invoice. This value should match the name in source_coas.

product_credit_idstring

Product credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

location_debitstring

Location debit name linked to the invoice. This value should match the name in source_coas.

location_debit_idstring

Location debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

location_creditstring

Location credit name linked to the invoice. This value should match the name in source_coas.

location_credit_idstring

Location credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

class_debitstring

Class debit name linked to the invoice. This value should match the name in source_coas.

class_debit_idstring

Class debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

class_creditstring

Class credit name linked to the invoice. This value should match the name in source_coas.

class_credit_idstring

Class credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

project_debitstring

Project debit name linked to the invoice. This value should match the name in source_coas.

project_debit_idstring

Project debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

project_creditstring

Project credit name linked to the invoice. This value should match the name in source_coas.

project_credit_idstring

Project credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

invoice_memostring

Description of the invoice or invoice line where applicable.

statusstring

Status of the invoice or invoice line.

currencystring

Transactional currency name of the invoice. Use the ISO code of the currency.

currency_idstring

Transactional currency id of the invoice. This value should match the g_source_system_id in source_coas.

start_datedate

Start date of the invoice or invoice line if applicable.

end_datedate

End date of the invoice or invoice line if applicable.

invoice_quantitydouble

Quantity based value of the invoice or invoice line if applicable.

invoice_amountdouble

Invoice or Invoice line amount.

exchange_ratedouble

channel_debitstring

Channel debit name linked to the invoice. This value should match the name in source_coas.

channel_debit_idstring

Channel debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

channel_creditstring

Channel credit name linked to the invoice. This value should match the name in source_coas.

channel_credit_idstring

Channel credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

region_debitstring

Region debit name linked to the invoice. This value should match the name in source_coas.

region_debit_idstring

Region debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

region_creditstring

Region credit name linked to the invoice. This value should match the name in source_coas.

region_credit_idstring

Region credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

company_debitstring

Company debit name linked to the invoice. This value should match the name in source_coas.

company_debit_idstring

Company debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

company_creditstring

Company credit name linked to the invoice. This value should match the name in source_coas.

company_credit_idstring

Company credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

intercompany_debitstring

Intercompay debit name linked to the invoice. This value should match the name in source_coas.

intercompany_debit_idstring

Intercompay debit id linked to the invoice. This value should match the g_source_system_id in source_coas.

intercompany_creditstring

Intercompay credit name linked to the invoice. This value should match the name in source_coas.

intercompany_credit_idstring

Intercompay credit id linked to the invoice. This value should match the g_source_system_id in source_coas.

po_numberstring

PO number linked to the invoice.

po_line_idstring

Line Id of the PO linked to the invoice.

Get a list of Invoices

Headers

Query parameters

Response

Errors