API ReferenceInbound to Gappify3. Invoices

Retrieve Invoices by ID

GA
Retrieve Invoices by ID

Path parameters

source-system-idstringRequired

Headers

AuthorizationstringRequired

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_typestring or null
Type of invoice.
invoice_line_idstring or null
Id of the invoice line.
po_idstring or null
Id of the PO linked to the invoice.
memostring or null
Invoice header memo.
created_bystring or null
last_modified_bystring or null
periodstring or null
Period representation of the invoice.
subsidiary_debitstring or null

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

subsidiary_debit_idstring or null

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

itemstring or null
item_idstring or null
glaccount_debitstring or null

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

glaccount_debit_idstring or null

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

glaccount_creditstring or null

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

glaccount_credit_idstring or null

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

department_debitstring or null

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

department_debit_idstring or null

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

department_creditstring or null

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

department_credit_idstring or null

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

product_debitstring or null

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

product_debit_idstring or null

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

product_creditstring or null

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

product_credit_idstring or null

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

location_debitstring or null

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

location_debit_idstring or null

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

location_creditstring or null

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

location_credit_idstring or null

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

class_debitstring or null

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

class_debit_idstring or null

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

class_creditstring or null

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

class_credit_idstring or null

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

project_debitstring or null

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

project_debit_idstring or null

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

project_creditstring or null

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

project_credit_idstring or null

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

invoice_memostring or null
Description of the invoice or invoice line where applicable.
statusstring or null
Status of the invoice or invoice line.
start_datedate or null
Start date of the invoice or invoice line if applicable.
end_datedate or null
End date of the invoice or invoice line if applicable.
invoice_quantitydouble or null
Quantity based value of the invoice or invoice line if applicable.
exchange_ratedouble or null
channel_debitstring or null

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

channel_debit_idstring or null

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

channel_creditstring or null

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

channel_credit_idstring or null

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

region_debitstring or null

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

region_debit_idstring or null

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

region_creditstring or null

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

region_credit_idstring or null

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

company_debitstring or null

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

company_debit_idstring or null

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

company_creditstring or null

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

company_credit_idstring or null

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

intercompany_debitstring or null

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

intercompany_debit_idstring or null

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

intercompany_creditstring or null

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

intercompany_credit_idstring or null

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

po_numberstring or null
PO number linked to the invoice.
po_line_idstring or null
Line Id of the PO linked to the invoice.
invoice_date_createddatetime or null
This is the date and time when the invoice is created in the source system.

Errors