Retrieve Invoices by ID

Path parameters

source-system-idstringRequired

Response

This endpoint returns an object.

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_numberstring

Invoice number.

invoice_datedate

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

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.

invoice_amountdouble

Invoice or Invoice line amount.

invoice_typestringOptional

Type of invoice.

invoice_line_idstringOptional

Id of the invoice line.

po_idstringOptional

Id of the PO linked to the invoice.

memostringOptional

Invoice header memo.

created_bystringOptional

last_modified_bystringOptional

periodstringOptional

Period representation of the invoice.

subsidiary_debitstringOptional

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

subsidiary_debit_idstringOptional

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

itemstringOptional

item_idstringOptional

glaccount_debitstringOptional

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

glaccount_debit_idstringOptional

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

glaccount_creditstringOptional

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

glaccount_credit_idstringOptional

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

department_debitstringOptional

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

department_debit_idstringOptional

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

department_creditstringOptional

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

department_credit_idstringOptional

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

product_debitstringOptional

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

product_debit_idstringOptional

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

product_creditstringOptional

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

product_credit_idstringOptional

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

location_debitstringOptional

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

location_debit_idstringOptional

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

location_creditstringOptional

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

location_credit_idstringOptional

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

class_debitstringOptional

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

class_debit_idstringOptional

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

class_creditstringOptional

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

class_credit_idstringOptional

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

project_debitstringOptional

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

project_debit_idstringOptional

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

project_creditstringOptional

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

project_credit_idstringOptional

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

invoice_memostringOptional

Description of the invoice or invoice line where applicable.

statusstringOptional

Status of the invoice or invoice line.

start_datedateOptional

Start date of the invoice or invoice line if applicable.

end_datedateOptional

End date of the invoice or invoice line if applicable.

invoice_quantitydoubleOptional

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

exchange_ratedoubleOptional

channel_debitstringOptional

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

channel_debit_idstringOptional

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

channel_creditstringOptional

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

channel_credit_idstringOptional

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

region_debitstringOptional

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

region_debit_idstringOptional

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

region_creditstringOptional

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

region_credit_idstringOptional

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

company_debitstringOptional

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

company_debit_idstringOptional

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

company_creditstringOptional

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

company_credit_idstringOptional

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

intercompany_debitstringOptional

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

intercompany_debit_idstringOptional

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

intercompany_creditstringOptional

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

intercompany_credit_idstringOptional

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

po_numberstringOptional

PO number linked to the invoice.

po_line_idstringOptional

Line Id of the PO linked to the invoice.

1	{
2	"source_system_id": "source_system_id",
3	"vendor_id": "vendor_id",
4	"name": "name",
5	"invoice_number": "invoice_number",
6	"invoice_date": "2023-01-15",
7	"currency": "currency",
8	"currency_id": "currency_id",
9	"invoice_amount": 1.1,
10	"invoice_type": "invoice_type",
11	"invoice_line_id": "invoice_line_id",
12	"po_id": "po_id",
13	"memo": "memo",
14	"created_by": "created_by",
15	"last_modified_by": "last_modified_by",
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	"start_date": "2023-01-15",
48	"end_date": "2023-01-15",
49	"invoice_quantity": 1.1,
50	"exchange_rate": 1.1,
51	"channel_debit": "channel_debit",
52	"channel_debit_id": "channel_debit_id",
53	"channel_credit": "channel_credit",
54	"channel_credit_id": "channel_credit_id",
55	"region_debit": "region_debit",
56	"region_debit_id": "region_debit_id",
57	"region_credit": "region_credit",
58	"region_credit_id": "region_credit_id",
59	"company_debit": "company_debit",
60	"company_debit_id": "company_debit_id",
61	"company_credit": "company_credit",
62	"company_credit_id": "company_credit_id",
63	"intercompany_debit": "intercompany_debit",
64	"intercompany_debit_id": "intercompany_debit_id",
65	"intercompany_credit": "intercompany_credit",
66	"intercompany_credit_id": "intercompany_credit_id",
67	"po_number": "po_number",
68	"po_line_id": "po_line_id"
69	}

Retrieve Invoices by ID

Path parameters

Headers

Response

Errors

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