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_descriptionstring or null
Description of the purchase order.
po_line_descriptionstring or null
Description of the PO line.
po_header_amountdouble or null
Total amount at the header level of the PO in transaction currency.
po_ownerstring or null
Name of the PO owner.
service_end_datedate or null
End date of the PO line.
service_start_datedate or null
Start date of the PO line.
invoiced_amountdouble or null
Amount invoiced in transaction currency of the PO line.
po_balancedouble or null
Balance remaining in transaction currency of the PO line.
emailstring or null
Email of the PO owner.
subsidiarystring or null

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

subsidiary_idstring or null

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

subsidiary_currencystring or null

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_idstring or null

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

glaccount_debitstring or null

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

glaccount_debit_idstring or null

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

glaccount_creditstring or null

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

glaccount_credit_idstring or null

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

department_debitstring or null

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

department_debit_idstring or null

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

department_creditstring or null

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

department_credit_idstring or null

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

location_debitstring or null

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

location_debit_idstring or null

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

location_creditstring or null

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

location_credit_idstring or null

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

class_debitstring or null

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

class_debit_idstring or null

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

class_creditstring or null

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

class_credit_idstring or null

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

product_debitstring or null

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

product_debit_idstring or null

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

product_creditstring or null

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

product_credit_idstring or null

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

project_debitstring or null

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

project_debit_idstring or null

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

project_creditstring or null

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

project_credit_idstring or null

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

region_debitstring or null

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

region_debit_idstring or null

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

region_creditstring or null

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

region_credit_idstring or null

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

company_debitstring or null

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

company_debit_idstring or null

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

company_creditstring or null

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

company_credit_idstring or null

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

intercompany_debitstring or null

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

intercompany_debit_idstring or null

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

intercompany_creditstring or null

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

intercompany_credit_idstring or null

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

channel_debitstring or null

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

channel_debit_idstring or null

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

channel_creditstring or null

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

channel_credit_idstring or null

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

po_line_amount_cancelleddouble or null
Any po line amount that has been canceled.
cc_emailstring or null

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

po_datedate or null
PO creation date
po_line_amount_usddouble or null
po_balance_usddouble or null

Errors