{"title":"List cost contracts","category":"default","creationDate":1776961629,"content":"

Request parameters<\/h2>\n

To retrieve a list of cost contracts for a specific account key, make a POST \/listCostContracts<\/code> request specifying:<\/p>\n
Name<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
\n

accountKey<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>

Unique reference to identify an account.\n\n- Company account key format: `Company.COMPANY_CODE`\n- Merchant account key format:\u00a0`Merchant.MERCHANT_CODE`
\n<\/p><\/td><\/tr><\/tbody><\/table>\n

Response parameters<\/h2>\n

The response contains a cost contract\u00a0list for the specified account key.<\/p>\n

\n

There needs to be at least one cost contract associated with the specified\u00a0 accountKey<\/code> for the response to return a populated\u00a0 costContractDataSO<\/code> object. <\/p>\n<\/div><\/div>\n
Name<\/th>Type<\/th>Returned\u00a0by\u00a0default<\/th>Description<\/th><\/tr><\/thead>
\n

costContractDataSO<\/code><\/p>\n<\/td>

\n

class<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

A container for cost contract data.This field takes the following children:

  • billable<\/code><\/li>
  • minimumAmount<\/code><\/li>
  • minimumTxs<\/code><\/li>
  • name<\/code><\/li>
  • remark<\/code><\/li>
  • startDate<\/code><\/li>
  • stopDate<\/code>\u00a0<\/li><\/ul><\/p>\n<\/td><\/tr>
\n

billable<\/code><\/p>\n<\/td>

\n

Boolean<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n
  • \n

    true<\/code>: the cost contract is billable.<\/p>\n<\/li>

  • \n

    false<\/code>: the cost contract is not billable.<\/p>\n<\/li><\/ul>\n<\/td><\/tr>

\n

minimumAmount<\/code><\/p>\n<\/td>

int
\n(Long)<\/td>		\n
\"-x-\"<\/center>\n<\/td>
\n

The minimum chargeable amount per invoice.
\nThe value is represented using the euro currency and minor units (i.e. 1000<\/em> = EUR\u00a010).<\/p>\n<\/td><\/tr>

\n

minimumTxs<\/code><\/p>\n<\/td>

\n

int<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The minimum number of transactions per month. <\/p>\n<\/td><\/tr>

\n

name<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The name identifying the cost contract.<\/p>\n<\/td><\/tr>

remark<\/code>
\n<\/p><\/td>

\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
\n

Free text comment or remark about the cost contract.<\/p>\n<\/td><\/tr>

\n

startDate<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

The start date when the cost contract becomes effective.<\/p>\n<\/td><\/tr>

\n

stopDate<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n
\"-x-\"<\/center>\n<\/td>
The end date after which the cost contract is not effective any longer.
\nIf not end date is returned, it means the contract is effective until one of the parties takes action to terminate it.<\/td><\/tr>
\n

pspReference<\/code><\/p>\n<\/td>

\n

String<\/p>\n<\/td>

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\n

Adyen's 16-character unique reference associated with the transaction\/the request.\u00a0This value is globally unique; quote it when communicating with us about this request.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Examples<\/h2>\n

Request<\/h3>\n
\n <\/code-sample>\n<\/div>\n

Response<\/h3>\n
\n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-cost-contracts\/listcostcontracts","articleFields":{"id":"25134953","type":"page","description":"Retrieve data for all cost contracts, either for a company or the specified merchant accounts.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-cost-contracts\/listcostcontracts","title":"List cost contracts","content":"Request parameters\nTo retrieve a list of cost contracts for a specific account key, make a POST \/listCostContracts request specifying:\nNameTypeRequiredDescription\naccountKey\n\nString\n\n\nUnique reference to identify an account.\n\n- Company account key format: `Company.COMPANY_CODE`\n- Merchant account key format:\u00a0`Merchant.MERCHANT_CODE`\n\nResponse parameters\nThe response contains a cost contract\u00a0list for the specified account key.\n \nThere needs to be at least one cost contract associated with the specified\u00a0 accountKey for the response to return a populated\u00a0 costContractDataSO object. \n\nNameTypeReturned\u00a0by\u00a0defaultDescription\ncostContractDataSO\n\nclass\n\n\n\nA container for cost contract data.This field takes the following children:billableminimumAmountminimumTxsnameremarkstartDatestopDate\u00a0\n\nbillable\n\nBoolean\n\n\n\n\ntrue: the cost contract is billable.\n\nfalse: the cost contract is not billable.\n\n\nminimumAmount\nint\n(Long)\n\n\nThe minimum chargeable amount per invoice.\nThe value is represented using the euro currency and minor units (i.e. 1000 = EUR\u00a010).\n\nminimumTxs\n\nint\n\n\n\nThe minimum number of transactions per month. \n\nname\n\nString\n\n\n\nThe name identifying the cost contract.\nremark\n\nString\n\n\n\nFree text comment or remark about the cost contract.\n\nstartDate\n\nString\n\n\n\nThe start date when the cost contract becomes effective.\n\nstopDate\n\nString\n\n\nThe end date after which the cost contract is not effective any longer.\nIf not end date is returned, it means the contract is effective until one of the parties takes action to terminate it.\npspReference\n\nString\n\n\n\nAdyen's 16-character unique reference associated with the transaction\/the request.\u00a0This value is globally unique; quote it when communicating with us about this request.\n\nExamples\nRequest\n\n \n\nResponse\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage cost contracts","lvl3":"List cost contracts"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/account-management-api","lvl2":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-cost-contracts","lvl3":"\/pt\/account-management-api\/manage-cost-contracts\/listcostcontracts"},"levels":4,"category":"","category_color":"","tags":["contracts"]},"articleFiles":{"419082230.json":"

419082230.json<\/p>","548009467.json":"

548009467.json<\/p>"}}