Skip to main content

 

 

Coupa Success Portal

Charge API (/charges)

Overview

The URL to access charges is: https://{your_instance_name}/api/charges or you can see the OpenAPI docs here: https://{your_instance_name}/api_docs/14

Actions

Verb Path Action Description
GET /api/charges index Query Charges
GET /api/charges/:id show Show Charges

Elements

Keys: id

Element Description Req'd Unique Allowable Value In Out Data Type
account-type-id Chart of Accounts ID associated with the charge         yes integer(11)
card-provider-account Card Provider Account       yes yes string(255)
charge-allocations Account Allocations for charge         yes Charge Allocation
charge-date Date of the charge yes     yes yes datetime
coupa-pay-id Unique Coupa Pay ID       yes yes integer(11)
coupa-pay-statement-id Unique Coupa Pay Statement ID       yes yes integer(11)
created-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
created-by User who created         yes User
currency Base currency of the card yes       yes Currency
exported Indicates if transaction has been exported         yes boolean
external-ref-id Unique 3rd party system ID       yes yes string(255)
id Unique Coupa ID         yes integer(11)
last-exported-at Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
mcc Merchant Category Code       yes yes string(255)
merchant-currency Currency the card was charged in yes       yes Currency
merchant-reference Card provided merchant information       yes yes string(255)
merchant-total Total the merchant charged in merchant currency       yes yes decimal(30,6)
order-header-currency Currency from the charged card's Purchase Order         yes string(6)
order-header-id Purchase Order ID associated with the charged card         yes integer(11)
order-header-number Purchase Order Number associated with the charged card         yes string(20)
order-header-total Total amount on the charged card's Purchase Order         yes string(255)
statement Statement       yes   CoupaPay::Statement 
statement-id Unique Coupa ID         yes integer(11)
statement-name Name of the Statement that this Charge belongs to         yes string(255)
supplier supplier yes     yes   Supplier
supplier-id Unique Coupa Supplier ID         yes integer(11)
statement-name Name of the Statement that this Charge belongs to         yes string(100)
total Total of the charge in the card base currency       yes yes decimal(30,6)
updated-at Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ         yes datetime
updated-by User who updated         yes User
virtual-card Virtual card yes     yes   CoupaPay::VirtualCard 
virtual-card-id Coupa ID for associated Virtual Card         yes integer(11)
  • Was this article helpful?