Use the budget line API to create and update budget lines that you have associated with your accounts.
The URL to access budget lines is:
See Integration Best Practices for more info.
The Budget Lines API allows you to:
|PUT||/api/budget_lines/:id/adjust||adjust||Create budget line adjustment for budget line|
|POST||/api/budget_lines||create||Create budget line|
|GET||/api/budget_lines||index||Query budget lines|
|GET||/api/budget_lines/:id||show||Show budget line|
|PATCH||/api/budget_lines/:id||update||Update budget line|
|PUT||/api/budget_lines/:id||update||Update budget line|
The following elements are available for the Budget Lines API:
|Element||Description||Required Field?||Unique?||Allowable Value||Api_In Field?||Api_Out Field?||Data Type|
|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||Currency of transaction||yes||yes||Currency|
|error-on-overrun||Prevent submission of requisitions that would exceed the budget||yes||yes||boolean|
|id||Coupa unique identifier||yes||integer|
|owner-is-approver||Owner is approver?||yes||yes||integer|
|period||This is the nickname for the budget line. Users can view and search against this field through the user interface.||yes||yes||yes|
|segment-1||Optionally provide each segment individually.This is required if any of segments contains the dash "-" character, which prevents the Budgeting Segment code from being split automatically||yes||yes||string|
|segment-10||Optionally provide each segment individually.This is required if any of segments contains the dash "-" character, which prevents the Budgeting Segment code from being split automatically||yes||yes||string|
|segment-11||Optionally provide each segment individually.This is required if any of segments contains the dash "-" character, which prevents the Budgeting Segment code from being split automatically||yes||yes||string|
|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|
- For large data set and performance optimization, always limit your result with some GET criteria.
- You can use POST to create new budget lines for existing budget periods and existing account segments (that is, segment-1, segment-2, and so on). This means that you cannot create new budget periods using the API.
- Once the budget line is created and associated with an account type (that is, a chart of accounts) and specific account, you cannot change this information.