Get a list of Invoices

GET

/invoices

GET

/v1/invoices

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

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_id": "currency_id",
48     "start_date": "2023-01-15",
49     "end_date": "2023-01-15",
50     "invoice_quantity": 1.1,
51     "invoice_amount": 1.1,
52     "exchange_rate": 1.1,
53     "channel_debit": "channel_debit",
54     "channel_debit_id": "channel_debit_id",
55     "channel_credit": "channel_credit",
56     "channel_credit_id": "channel_credit_id",
57     "region_debit": "region_debit",
58     "region_debit_id": "region_debit_id",
59     "region_credit": "region_credit",
60     "region_credit_id": "region_credit_id",
61     "company_debit": "company_debit",
62     "company_debit_id": "company_debit_id",
63     "company_credit": "company_credit",
64     "company_credit_id": "company_credit_id",
65     "intercompany_debit": "intercompany_debit",
66     "intercompany_debit_id": "intercompany_debit_id",
67     "intercompany_credit": "intercompany_credit",
68     "intercompany_credit_id": "intercompany_credit_id",
69     "po_number": "po_number",
70     "po_line_id": "po_line_id",
71     "invoice_date_created": "2024-01-15T09:30:00Z",
72     "custom_text_1": "custom_text_1",
73     "custom_text_2": "custom_text_2",
74     "custom_text_3": "custom_text_3",
75     "custom_text_4": "custom_text_4",
76     "custom_text_5": "custom_text_5",
77     "custom_date_1": "2023-01-15",
78     "custom_date_2": "2023-01-15",
79     "custom_date_3": "2023-01-15",
80     "custom_date_4": "2023-01-15",
81     "custom_date_5": "2023-01-15",
82     "custom_numeric_1": 1.1,
83     "custom_numeric_2": 1.1,
84     "custom_numeric_3": 1.1,
85     "custom_numeric_4": 1.1,
86     "custom_numeric_5": 1.1,
87     "invoice_id": "invoice_id",
88     "currency": "currency"
89   },
90   {
91     "source_system_id": "source_system_id",
92     "vendor_id": "vendor_id",
93     "name": "name",
94     "invoice_type": "invoice_type",
95     "invoice_number": "invoice_number",
96     "invoice_line_id": "invoice_line_id",
97     "po_id": "po_id",
98     "memo": "memo",
99     "created_at": "2024-01-15T09:30:00Z",
100     "created_by": "created_by",
101     "updated_at": "2024-01-15T09:30:00Z",
102     "last_modified_by": "last_modified_by",
103     "invoice_date": "2023-01-15",
104     "period": "period",
105     "subsidiary_debit": "subsidiary_debit",
106     "subsidiary_debit_id": "subsidiary_debit_id",
107     "item": "item",
108     "item_id": "item_id",
109     "glaccount_debit": "glaccount_debit",
110     "glaccount_debit_id": "glaccount_debit_id",
111     "glaccount_credit": "glaccount_credit",
112     "glaccount_credit_id": "glaccount_credit_id",
113     "department_debit": "department_debit",
114     "department_debit_id": "department_debit_id",
115     "department_credit": "department_credit",
116     "department_credit_id": "department_credit_id",
117     "product_debit": "product_debit",
118     "product_debit_id": "product_debit_id",
119     "product_credit": "product_credit",
120     "product_credit_id": "product_credit_id",
121     "location_debit": "location_debit",
122     "location_debit_id": "location_debit_id",
123     "location_credit": "location_credit",
124     "location_credit_id": "location_credit_id",
125     "class_debit": "class_debit",
126     "class_debit_id": "class_debit_id",
127     "class_credit": "class_credit",
128     "class_credit_id": "class_credit_id",
129     "project_debit": "project_debit",
130     "project_debit_id": "project_debit_id",
131     "project_credit": "project_credit",
132     "project_credit_id": "project_credit_id",
133     "invoice_memo": "invoice_memo",
134     "status": "status",
135     "currency_id": "currency_id",
136     "start_date": "2023-01-15",
137     "end_date": "2023-01-15",
138     "invoice_quantity": 1.1,
139     "invoice_amount": 1.1,
140     "exchange_rate": 1.1,
141     "channel_debit": "channel_debit",
142     "channel_debit_id": "channel_debit_id",
143     "channel_credit": "channel_credit",
144     "channel_credit_id": "channel_credit_id",
145     "region_debit": "region_debit",
146     "region_debit_id": "region_debit_id",
147     "region_credit": "region_credit",
148     "region_credit_id": "region_credit_id",
149     "company_debit": "company_debit",
150     "company_debit_id": "company_debit_id",
151     "company_credit": "company_credit",
152     "company_credit_id": "company_credit_id",
153     "intercompany_debit": "intercompany_debit",
154     "intercompany_debit_id": "intercompany_debit_id",
155     "intercompany_credit": "intercompany_credit",
156     "intercompany_credit_id": "intercompany_credit_id",
157     "po_number": "po_number",
158     "po_line_id": "po_line_id",
159     "invoice_date_created": "2024-01-15T09:30:00Z",
160     "custom_text_1": "custom_text_1",
161     "custom_text_2": "custom_text_2",
162     "custom_text_3": "custom_text_3",
163     "custom_text_4": "custom_text_4",
164     "custom_text_5": "custom_text_5",
165     "custom_date_1": "2023-01-15",
166     "custom_date_2": "2023-01-15",
167     "custom_date_3": "2023-01-15",
168     "custom_date_4": "2023-01-15",
169     "custom_date_5": "2023-01-15",
170     "custom_numeric_1": 1.1,
171     "custom_numeric_2": 1.1,
172     "custom_numeric_3": 1.1,
173     "custom_numeric_4": 1.1,
174     "custom_numeric_5": 1.1,
175     "invoice_id": "invoice_id",
176     "currency": "currency"
177   }
178 ]

Retrieve a list of Invoices based on specified filters.

Authentication

Authorizationstring

API Key authentication via header

Query parameters

po_idstringOptional

Id of the PO linked to the invoice.

memostringOptional

Invoice header memo.

created_atdatetimeOptional

statusstringOptional

Status of the invoice or invoice line.

invoice_date_createddatetimeOptional

This is the date and time when the invoice is created in the source system.

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.
Format: yyyy-mm-01 (e.g., 2026-03-01).’

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.

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.

invoice_date_createddatetime

This is the date and time when the invoice is created in the source system.

custom_text_1string

User-defined custom text field

custom_text_2string

User-defined custom text field

custom_text_3string

User-defined custom text field

custom_text_4string

User-defined custom text field

custom_text_5string

User-defined custom text field

custom_date_1date

User-defined custom date field

custom_date_2date

User-defined custom date field

custom_date_3date

User-defined custom date field

custom_date_4date

User-defined custom date field

custom_date_5date

User-defined custom date field

custom_numeric_1double