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

Method
Description

GET

get-transactions

https://api.pepperi.com/v1.0/transactions

Retrieves a list of transactions including details about each transaction and its nested objects.

GET

get-transaction-by-id

https://api.pepperi.com/v1.0/transactions/{id}

Retrieves a single transaction by internal id.

GET

get-transaction-by-externalid

https://api.pepperi.com/v1.0/transactions/externalid/{id}

Retrieves a single transaction by external id.

GET

get-transactions-totals

https://api.pepperi.com/v1.0/totals/transactions

Retrieves aggregated data for the transactions resource.

GET

get-transactions-metadata

https://api.pepperi.com/v1.0/metadata/transactions

{Beta} Retrieves the transactions metadata(schema).

POST

post-transactions

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.

POST

post-transactions-bulk-json

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.

POST

post-transactions-bulk-csv-zip

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.

POST

post-transactions-metadata-udf

https://api.pepperi.com/v1.0/metadata/transactions

{Beta} Adds a new User Defined Field to the transactions schema.

DELETE

delete-transaction-by-id

https://api.pepperi.com/v1.0/transactions/{id}

Deletes a single transaction by internal id.

DELETE

delete-transaction-by-externalid

https://api.pepperi.com/v1.0/transactions/externalid/{id}

Deletes a single transaction by external id.

Transaction Lines

Method
Description

GET

get-transaction-lines

https://api.pepperi.com/v1.0/transaction_lines

Retrieves a list of transaction lines including details about each transaction line and its nested objects.

GET

get-transaction-line-by-id

https://api.pepperi.com/v1.0/transaction_lines/{id}

Retrieves a single transaction line by internal id.

GET

get-transaction-line-by-externalid

https://api.pepperi.com/v1.0/transaction_lines/externalid/{id}

Retrieves a single transaction line by external id.

GET

get-transaction_lines-totals

https://api.pepperi.com/v1.0/totals/transaction_lines

Retrieves aggregated data for the transaction_lines resource.

GET

get-transaction-lines-metadata

https://api.pepperi.com/v1.0/metadata/transaction_lines

{Beta} Retrieves the transaction lines metadata(schema).

POST

post-transaction-lines

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.

POST

post-transaction-lines-bulk-json

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.

POST

post-transaction-lines-bulk-csv-zip

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.

POST

post-transaction-lines-metadata-udf

https://api.pepperi.com/v1.0/metadata/transaction_lines

{Beta} Adds a new User Defined Field to the transaction_lines schema.

DELETE

delete-transaction-line-by-id

https://api.pepperi.com/v1.0/transaction_lines/{id}

Deletes a single transaction line by internal id.

DELETE

delete-transaction-line-by-externalid

https://api.pepperi.com/v1.0/transaction_lines/externalid/{id}

Deletes a single transaction line by external id.