API ReferenceInbound to Gappify3. Invoices

Create a new or update existing Invoices entries.

GA
Create a new or update existing Invoices entries with the provided data.

Headers

AuthorizationstringRequired

Request

This endpoint expects a list of objects.
source_system_idstringRequired
Unique identifier of the invoice in the ERP system. This value will be used to match source data and perform upserts.
vendor_idstringRequired

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.

namestringRequired

Vendor/Supplier name.

invoice_numberstringRequired
Invoice number.
invoice_datedateRequired

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

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

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

invoice_amountdoubleRequired
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.
invoice_date_createddatetimeOptional
This is the date and time when the invoice is created in the source system.

Response

This endpoint returns an object.
request_idUUID
Unique identifier for the request
status"IN_PROGRESS"
Status of the request

Errors