Transaction Resources
Transaction related resources. (a Transaction is defined by the Type Field and usually represents a Sales Order/Sales Quote/Invoice/Credit Note/Purchase Order)
Transactions
https://api.pepperi.com/v1.0/transactions
Retrieves a list of transactions including details about each transaction and its nested objects.
https://api.pepperi.com/v1.0/transactions/{id}
Retrieves a single transaction by internal id.
https://api.pepperi.com/v1.0/transactions/externalid/{id}
Retrieves a single transaction by external id.
https://api.pepperi.com/v1.0/totals/transactions
Retrieves aggregated data for the transactions resource.
https://api.pepperi.com/v1.0/metadata/transactions
{Beta} Retrieves the transactions metadata(schema).
https://api.pepperi.com/v1.0/transactions
Upserts (updates/inserts) a single transaction data. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.
https://api.pepperi.com/v1.0/bulk/transactions/{subTypeId}/json
Starts a new async bulk upload job that upserts (updates/inserts) multiple transactions data as a list of headers and lines. subTypeId should be taken from customization resources get-types-metadata. This async request returns a Job ID and URI to query the job’s status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.
https://api.pepperi.com/v1.0/bulk/transactions/{subTypeId}/csv_zip
Starts a new async bulk upload job that upserts (updates/inserts) multiple transactions data as a zip file that contains a single csv file. subTypeId should be taken from customization resources get-types-metadata. This async request returns a Job ID and URI to query the job’s status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.
https://api.pepperi.com/v1.0/metadata/transactions
{Beta} Adds a new User Defined Field to the transactions schema.
https://api.pepperi.com/v1.0/transactions/{id}
Deletes a single transaction by internal id.
https://api.pepperi.com/v1.0/transactions/externalid/{id}
Deletes a single transaction by external id.
Transaction Lines
method
description
https://api.pepperi.com/v1.0/transaction_lines
Retrieves a list of transaction lines including details about each transaction line and its nested objects.
https://api.pepperi.com/v1.0/transaction_lines/{id}
Retrieves a single transaction line by internal id.
https://api.pepperi.com/v1.0/totals/transaction_lines
Retrieves aggregated data for the transaction_lines resource.
https://api.pepperi.com/v1.0/metadata/transaction_lines
{Beta} Retrieves the transaction lines metadata(schema).
https://api.pepperi.com/v1.0/transaction_lines
Upserts (updates/inserts) a single transaction line data. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.
https://api.pepperi.com/v1.0/bulk/transaction_lines/{subTypeId}/json
Starts a new async bulk upload job that upserts (updates/inserts) multiple transaction lines data as a list of headers and lines. subTypeId should be taken from customization resources get-types-metadata. This async request returns a Job ID and URI to query the job’s status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.
https://api.pepperi.com/v1.0/bulk/transaction_lines/{subTypeId}/csv_zip
Starts a new async bulk upload job that upserts (updates/inserts) multiple transaction lines data as a zip file that contains a single csv file. subTypeId should be taken from customization resources get-types-metadata. This async request returns a Job ID and URI to query the job’s status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.
https://api.pepperi.com/v1.0/metadata/transaction_lines
{Beta} Adds a new User Defined Field to the transaction_lines schema.
https://api.pepperi.com/v1.0/transaction_lines/{id}
Deletes a single transaction line by internal id.