{"title":"Add cost contract","category":"default","creationDate":1776961629,"content":"

Request parameters<\/h2>\n

To add a new cost contract entry associated with an account key, make a POST \/addCostContract<\/code> request specifying: <\/p>\n
Name<\/th>Type<\/th>Required<\/th>Description<\/th>Notes<\/th><\/tr><\/thead>
\n

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

\n

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

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

Unique reference to identify an account.<\/p>\n

    \n
  • Company account key format: Company.COMPANY_CODE<\/code><\/li>\n
  • Merchant account key format:\u00a0Merchant.MERCHANT_CODE<\/code><\/li>\n<\/ul>\n<\/td>
\n

\u00a0<\/p>\n<\/td><\/tr>

\n

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

\n

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

\n
\"-x-\"<\/center>\n<\/td>
\n
    \n
  • true<\/code>: the cost contract is billable.<\/li>\n
  • false<\/code>: the cost contract is not billable.<\/li>\n<\/ul>\n<\/td>
\n

If the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.<\/p>\n<\/td><\/tr>

\n

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

\n

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

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

The name identifying the cost contract.
\nThe specified name needs to be a valid one, i.e. it needs to be on the cost contract list assigned to the company or merchant.<\/p><\/td>

\n

\u00a0<\/p>\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>

\n

If the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.<\/p>\n<\/td><\/tr>

\n

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

\n

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

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

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

\n

If the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.<\/p>\n<\/td><\/tr>

\n

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

\n

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

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

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

\n

If the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.<\/p>\n<\/td><\/tr>

\n

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

\n

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

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

The starting year when the cost contract becomes effective.<\/p>\n<\/td>

\n

Start date = startMonth + startYear
\n<\/em>The starting date needs to be set not earlier than a month, and not later than two years in the future.<\/p>\n<\/td><\/tr>

\n

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

\n

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

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

The starting month when the cost contract becomes effective.<\/p>\n<\/td>

\n

Start date = startMonth + startYear
\n<\/em>The starting date needs to be set not earlier than a month, and not later than two years in the future.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Response parameters<\/h2>\n

If there are no errors in the request, the call returns\u00a0a\u00a0pspReference.<\/code>If any issues occur during the process, the call returns one or more warning or error messages.<\/p>\n
Name<\/th>Type<\/th>Returned by default<\/th>Description<\/th><\/tr><\/thead>
\n

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

\n

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

\n
\"-white_check_mark-\"<\/center>\n<\/td>
A reference to uniquely identify the request.
\nReturned when the response is successful and a new contract is created.<\/td><\/tr>
\n

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

\n

Array<\/p>\n<\/td>

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

List containing one or more warning messages.
\nReturned when the request is not correctly processed.<\/p>\n<\/td><\/tr>

\n

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

\n

Array<\/p>\n<\/td>

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

List containing one or more error messages.
\nReturned when the request fails.<\/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>\n

Response in case of an error<\/h3>\n
\n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-cost-contracts\/addcostcontract","articleFields":{"id":"25134957","type":"page","description":"Create a new cost contract for an account key.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-cost-contracts\/addcostcontract","title":"Add cost contract","content":"Request parameters\nTo add a new cost contract entry associated with an account key, make a POST \/addCostContract request specifying: \nNameTypeRequiredDescriptionNotes\naccountKey\n\nString\n\n\n\nUnique reference to identify an account.\n\nCompany account key format: Company.COMPANY_CODE\nMerchant account key format:\u00a0Merchant.MERCHANT_CODE\n\n\n\u00a0\n\nbillable\n\nBoolean\n\n\n\n\ntrue: the cost contract is billable.\nfalse: the cost contract is not billable.\n\n\nIf the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.\n\ncostContractName\n\nString\n\n\nThe name identifying the cost contract.\nThe specified name needs to be a valid one, i.e. it needs to be on the cost contract list assigned to the company or merchant.\n\u00a0\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\nIf the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.\n\nminimumTxs\n\nint\n\n\n\nThe minimum number of transactions per month. \n\nIf the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.\n\nremark\n\nString\n\n\n\nFree text comment or remark about the cost contract.\n\nIf the specified account key refers to a merchant account, leave this field empty\/do not assign a value to this field.\n\nstartYear\n\nint\n\n\n\nThe starting year when the cost contract becomes effective.\n\nStart date = startMonth + startYear\nThe starting date needs to be set not earlier than a month, and not later than two years in the future.\n\nstartMonth\n\nint\n\n\n\nThe starting month when the cost contract becomes effective.\n\nStart date = startMonth + startYear\nThe starting date needs to be set not earlier than a month, and not later than two years in the future.\n\nResponse parameters\nIf there are no errors in the request, the call returns\u00a0a\u00a0pspReference.If any issues occur during the process, the call returns one or more warning or error messages.\nNameTypeReturned by defaultDescription\npspReference\n\nString\n\n\nA reference to uniquely identify the request.\nReturned when the response is successful and a new contract is created.\nwarnings\n\nArray\n\n\n\nList containing one or more warning messages.\nReturned when the request is not correctly processed.\n\nerrors\n\nArray\n\n\n\nList containing one or more error messages.\nReturned when the request fails.\n\nExamples\nRequest\n\n \n\nResponse\n\n \n\nResponse in case of an error\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage cost contracts","lvl3":"Add cost contract"},"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\/addcostcontract"},"levels":4,"category":"","category_color":"","tags":["contract"]},"articleFiles":{"214761486.json":"

214761486.json<\/p>","1818680747.json":"

1818680747.json<\/p>","1989102402.json":"

1989102402.json<\/p>"}}