API ReferenceInbound to Gappify4. Purchase Orders

Retrieve Purchase Orders by ID

GA

Retrieve Purchase Orders by ID

Path parameters

source-system-idstringRequired

Headers

AuthorizationstringRequired

Response

This endpoint returns an object.
source_system_idstring

Unique identifier of the purchase order line 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.

po_idstring

System Id of the purchase order record.

po_numberstring

PO number value.

po_line_idstring

System Id of the purchase order line.

po_line_amountdouble

Total amount in transaction currency of the PO line.

po_line_statusstring

Status of the PO line. Status will be leveraged to filter lines that are not active anymore.

transaction_currencystring

Currency in which the transaction was posted in the gl. Should match the name in the currency list of source_coas.



Use the ISO code of the currency.

transaction_currency_idstring

Currency id in which the transaction was posted in the gl. Should match the g_source_system_id in the currency list of source_coas.

po_header_descriptionstringOptional

Description of the purchase order.

po_line_descriptionstringOptional

Description of the PO line.

po_header_amountdoubleOptional

Total amount at the header level of the PO in transaction currency.

po_ownerstringOptional

Name of the PO owner.

service_end_datedateOptional

End date of the PO line.

service_start_datedateOptional

Start date of the PO line.

invoiced_amountdoubleOptional

Amount invoiced in transaction currency of the PO line.

po_balancedoubleOptional

Balance remaining in transaction currency of the PO line.

emailstringOptional

Email of the PO owner.

subsidiarystringOptional

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

subsidiary_idstringOptional

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

subsidiary_currencystringOptional

Subsidiary currency of the posted transaction line in the gl. Should match the name in the currency list of source_coas.



Use the ISO code of the currency.

subsidiary_currency_idstringOptional

Subsidiary currency id of the posted transaction line in the gl. Should match the name in the currency list of source_coas.

glaccount_debitstringOptional

Expense glaccount name linked to the po line. This value should match the name in source_coas.

glaccount_debit_idstringOptional

Expense glaccount id linked to the po line. This value should match the g_source_system_id in source_coas.

glaccount_creditstringOptional

Liability glaccount name linked to the po line. This value should match the name in source_coas.

glaccount_credit_idstringOptional

Liability glaccount id linked to the po line. This value should match the g_source_system_id in source_coas.

department_debitstringOptional

Expense department/cost center name linked to the po line. This value should match the name in source_coas.

department_debit_idstringOptional

Expense department/cost center id linked to the po line. This value should match the g_source_system_id in source_coas

department_creditstringOptional

Liability department/cost center name linked to the po line. This value should match the name in source_coas.

department_credit_idstringOptional

Liability department/cost center id linked to the po line. This value should match the g_source_system_id in source_coas.

location_debitstringOptional

Expense location name linked to the po line. This value should match the name in source_coas.

location_debit_idstringOptional

Expense location id linked to the po line. This value should match the g_source_system_id in source_coas.

location_creditstringOptional

Liability location name linked to the po line. This value should match the name in source_coas.

location_credit_idstringOptional

Liability location id linked to the po line. This value should match the g_source_system_id in source_coas.

class_debitstringOptional

Expense class name linked to the po line. This value should match the name in source_coas.

class_debit_idstringOptional

Expense class id linked to the po line. This value should match the g_source_system_id in source_coas.

class_creditstringOptional

Liability class name linked to the po line. This value should match the name in source_coas.

class_credit_idstringOptional

Liability class id linked to the po line. This value should match the g_source_system_id in source_coas.

product_debitstringOptional

Expense product name linked to the po line. This value should match the name in source_coas.

product_debit_idstringOptional

Expense product id linked to the po line. This value should match the g_source_system_id in source_coas.

product_creditstringOptional

Liability product name linked to the po line. This value should match the name in source_coas.

product_credit_idstringOptional

Liability product id linked to the po line. This value should match the g_source_system_id in source_coas.

project_debitstringOptional

Expense project name linked to the po line. This value should match the name in source_coas.

project_debit_idstringOptional

Expense project id linked to the po line. This value should match the g_source_system_id in source_coas.

project_creditstringOptional

Liability project name linked to the po line. This value should match the name in source_coas.

project_credit_idstringOptional

Liability project id linked to the po line. This value should match the g_source_system_id in source_coas.

region_debitstringOptional

Expense region name linked to the po line. This value should match the name in source_coas.

region_debit_idstringOptional

Expense region id linked to the po line. This value should match the g_source_system_id in source_coas.

region_creditstringOptional

Liability region name linked to the po line. This value should match the name in source_coas.

region_credit_idstringOptional

Liability region id linked to the po line. This value should match the g_source_system_id in source_coas.

company_debitstringOptional

Expense company name linked to the po line. This value should match the name in source_coas.

company_debit_idstringOptional

Expense company id linked to the po line. This value should match the g_source_system_id in source_coas.

company_creditstringOptional

Liability company name linked to the po line. This value should match the name in source_coas.

company_credit_idstringOptional

Liability company id linked to the po line. This value should match the g_source_system_id in source_coas.

intercompany_debitstringOptional

Expense intercompany name linked to the po line. This value should match the name in source_coas.

intercompany_debit_idstringOptional

Expense intercompany id linked to the po line. This value should match the g_source_system_id in source_coas.

intercompany_creditstringOptional

Liability intercompany name linked to the po line. This value should match the name in source_coas.

intercompany_credit_idstringOptional

Liability intercompany id linked to the po line. This value should match the g_source_system_id in source_coas.

channel_debitstringOptional

Expense channel name linked to the po line. This value should match the name in source_coas.

channel_debit_idstringOptional

Expense channel id linked to the po line. This value should match the g_source_system_id in source_coas.

channel_creditstringOptional

Liability channel name linked to the po line. This value should match the name in source_coas.

channel_credit_idstringOptional

Liability channel id linked to the po line. This value should match the g_source_system_id in source_coas.

po_line_amount_cancelleddoubleOptional

Any po line amount that has been canceled.

cc_emailstringOptional

CC emails to be used as part of outreach. Emails should be “;” separated.

po_datedateOptional

PO creation date

po_line_amount_usddoubleOptional
po_balance_usddoubleOptional

Errors