Skip to main content

Sage Component

Manage contacts and others connected to your Sage account.

Component key: sage

Description#

Sage is software for managing your small business's accounting. This component allows you to generate and track invoices, manage accounts, contacts and more.

Authorization Notes#

You will first need to create and configure a Connected App within Sage Accounting. Be sure to enter Prismatic's OAuth callback URL - https://oauth2.prismatic.io/callback - as a Callback URL. Consult Sage Accounting to determine the proper OAuth Scopes to assign. Select Require Secret for Web Server Flow and Require Secret for Refresh Token Flow:

Once the app has been created, you will be provided with a Client Id and Client Secret.

Now, configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

  • For Client ID and Client Secret enter the values that you received previously.
  • For Scopes either enter full_access or readonly.
  • For Authorization URL enter https://www.sageone.com/oauth2/auth/central?filter=apiv3.1
  • For Access Token URL enter https://oauth.accounting.sage.com/token

Actions#

Create Contact#

Create a new contact | key: createContact

InputKeyNotesExample

Account Name

string
accountNameProvide a string value for the name of the bank account.Example Account

Account Number

string
accountNumberProvide a valid bank account number.Example Account No

Address Line 1

string
addressLine1Provide a valid street address4 Privet Drive

Address Line 2

string
addressLine2Provide a string value for the 2nd address line.apt 319

Address Name

string
addressNameProvide a string value for a name.Example Name

Address Type Id

string
addressTypeIdProvide a unique identifier for the address type90211

Bank Account Id

string
bankAccountIdProvide a value for the postal code.example-9489210

BIC

string
bicProvide a valid BIC for the bank account.BOFA

City

string
cityProvide a string value for the city of the address.Beverly Hills

Contact Type Ids

string
/ Required
Value List
contactTypeIdsFor each list item, provide an Id of a contact typeexample-2356795

Country Id

string
countryIdProvide a unique identifier for the contact's country.

Credit Days

string
creditDaysProvide a number value for the credit days of the contact.10

Credit Limit

string
creditLimitProvide a number value for the credit limit of the contact.350.00

Currency Id

string
currencyIdProvide the unique identifier of the currency type.example-24525235

Default Purchase Ledger Id

string
defaultPurchaseLedgerIdProvide the unique identifier of the default purchase ledger for the contact.example-80430964

Default Sales Ledger Id

string
defaultSalesLedgerIdProvide the unique identifier of the default sales ledger.example-80430964

Default Sales Tax Rate Id

string
defaultSalesTaxRateIdProvide the unique identifier of the sales tax rate for the contact.example-80430964

Delivery Address Bank Account Id

string
deliveryBankAccountIdProvide a value for the postal code.example-9489210

Delivery Address City

string
deliveryCityProvide a string value for the city of the address.Beverly Hills

Delivery Address Country Id

string
deliveryCountryIdProvide a unique identifier for the contact's country.

Delivery Address Line 1

string
deliveryLine1Provide a valid street address4 Privet Drive

Delivery Address Line 2

string
deliveryLine2Provide a string value for the 2nd address line.apt 319

Delivery Address Name

string
deliveryNameProvide a string value for a name.Example Name

Delivery Address Postal Code

string
deliveryPostalCodeProvide a value for the postal code.90211

Delivery Address Region

string
deliveryRegionProvide a valid region for the contact.North America

Delivery Address Type Id

string
deliveryTypeIdProvide a unique identifier for the address type90211

IBAN

string
ibanProvide a valid IBAN for the bank account.CY 17 002 00128 00000012005276002

Is Main Address

boolean
isMainAddressThis flag will determine if this is the contacts main address.

Is Main Address

boolean
isMainDeliveryThis flag will determine if this is the contacts main address.

Name

string
/ Required
nameProvide a string value for a name.Example Name

Notes

string
notesProvide a string value for notes.This is an example note.

Postal Code

string
postalCodeProvide a value for the postal code.90211

Reference

string
referenceProvide a string value for the reference of the contact.uniqueValue

Region

string
regionProvide a valid region for the contact.North America

Sort Code

string
sortCodeProvide a sort code for the bank account.12-34-56

Source GUID

string
sourceGuidProvide a valid GUID, used for importing/exporting contacts from 3rd party services.example-80430964

Tax Number

string
taxNumberProvide a string value for the VAT registration number for the contact.80430964

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "results": {      "id": "example-80745034",      "displayed_as": "Example Contact",      "$path": "/contacts/exmaple",      "created_at": "2022-01-03T18:00:57Z",      "updated_at": "2022-01-03T18:00:57Z",      "links": [        {          "href": "https://accounting.na.sageone.com/contacts/customers/example",          "rel": "alternative",          "type": "text/html"        }      ],      "contact_types": [        {          "id": "CUSTOMER",          "displayd_as": "Customer"        }      ],      "name": "exampleName",      "reference": null,      "default_sales_ledger_account": {        "id": "example",        "displayed_as": "Professional Fees"      }    }  }}

Create Ledger Account#

Create a new Ledger account | key: createLedgerAccount

InputKeyNotesExample

Display Name

string
/ Required
displayNameProvide a string value for the display name.Example Name

Include In Chart

boolean
/ Required
includedInChartThis flag determines if the account will be included in the chart of accounts.true

Ledger Account Type Id

string
/ Required
ledgerAccountTypeIdProvide the unique identifier of a ledger account type.example-2356795

Name

string
/ Required
nameProvide a string value for a name.Example Name

Nominal Code

string
/ Required
nominalCodeProvide an unique integer value for the nominal code of the ledger account.1

Tax Rate Id

string
taxRateIdProvide the unique identifier of a tax rate id.example-238953e2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Purchase Invoice#

Create a new purchase invoice | key: createPurchaseInvoice

InputKeyDefaultNotesExample

Contact Id

string
/ Required
contactIdProvide the unique identifier of a contact.example-533242

Date

string
/ Required
dateProvide a valid date value.2022-01-03

Due Date

string
/ Required
dueDateProvide a valid date value for the due date of the invoice.2022-01-03

Invoice Lines

code
/ Required
invoiceLines
[    {      "description": "string",      "ledger_account_id": "string",      "unit_price": 0,      "product_id": "string",      "service_id": "string",      "quantity": 0,    }  ]
Provide a list of javascript objects, each containing information of an an invoice line item.

Total Amount

string
totalAmountProvide a total amount for the invoice.150.00

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Sales Invoice#

Create a new sales invoice | key: createSalesInvoice

InputKeyDefaultNotesExample

Contact Id

string
/ Required
contactIdProvide the unique identifier of a contact.example-533242

Date

string
/ Required
dateProvide a valid date value.2022-01-03

Invoice Lines

code
/ Required
invoiceLines
[    {      "description": "string",      "ledger_account_id": "string",      "unit_price": 0,      "product_id": "string",      "service_id": "string",      "quantity": 0,    }  ]
Provide a list of javascript objects, each containing information of an an invoice line item.

Total Amount

string
totalAmountProvide a total amount for the invoice.150.00

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Contact#

Delete an existing contact by Id | key: deleteContact

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide the unique identifier of a contact.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Contact Person#

Delete an existing contact person by Id | key: deleteContactPerson

InputKeyNotesExample

Contact Person Id

string
/ Required
contactPersonIdProvide the unique identifier of a contact person.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Purchase Invoice#

Delete the information and metadata of a purchase invoice by Id | key: deletePurchaseInvoice

InputKeyNotesExample

Purchase Invoice Id

string
/ Required
purchaseInvoiceIdProvide the unique identifier of a purchase invoice id.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Sales Invoice#

Delete the information and metadata of a sales invoice by Id | key: deleteSalesInvoice

InputKeyNotesExample

Sales Invoice Id

string
/ Required
salesInvoiceIdProvide the unique identifier of a sales invoice id.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Contact#

Get the information and metadata of a contact by Id | key: getContact

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide the unique identifier of a contact.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Contact Person#

Get the information and metadata of a contact person by Id | key: getContactPerson

InputKeyNotesExample

Contact Person Id

string
/ Required
contactPersonIdProvide the unique identifier of a contact person.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Ledger Account#

Get the information and metadata of a Ledger account | key: getLedgerAccount

InputKeyNotesExample

Ledger Account Id

string
/ Required
ledgerAccountIdProvide the unique identifier of a ledger account.example-2356795

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Purchase Invoice#

Get the information and metadata of a purchase invoice by Id | key: getPurchaseInvoice

InputKeyNotesExample

Purchase Invoice Id

string
/ Required
purchaseInvoiceIdProvide the unique identifier of a purchase invoice id.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Sales Invoice#

Get the information and metadata of a sales invoice by Id | key: getSalesInvoice

InputKeyNotesExample

Sales Invoice Id

string
/ Required
salesInvoiceIdProvide the unique identifier of a sales invoice id.example-533242

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Address Types#

List all address types | key: listAddressTypes

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Contact People#

List all contact people | key: listContactPeople

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Contact Types#

List all contact types | key: listContactTypes

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Contacts#

List all contacts | key: listContacts

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Countries#

List all countries | key: listCountries

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Currencies#

List all currencies | key: listCurrencies

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Ledger Account Types#

List all Ledger account types | key: listLedgerAccountTypes

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Ledger Accounts#

List all Ledger accounts | key: listLedgerAccounts

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Purchase Invoices#

List all purchase invoices | key: listPurchaseInvoice

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Sales Invoices#

List all sales invoices | key: listSalesInvoices

InputKeyNotesExample

Items Per Page

string
itemsPerPageProvide a value for the amount of items to be returned in the response.100

Page

string
pageProvide a value for the page of results you would like to be returned.1

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Contact#

Update the information and metadata of an existing contact by Id | key: updateContact

InputKeyNotesExample

Account Name

string
accountNameProvide a string value for the name of the bank account.Example Account

Account Number

string
accountNumberProvide a valid bank account number.Example Account No

Address Line 1

string
addressLine1Provide a valid street address4 Privet Drive

Address Line 2

string
addressLine2Provide a string value for the 2nd address line.apt 319

Address Name

string
addressNameProvide a string value for a name.Example Name

Address Type Id

string
addressTypeIdProvide a unique identifier for the address type90211

Bank Account Id

string
bankAccountIdProvide a value for the postal code.example-9489210

BIC

string
bicProvide a valid BIC for the bank account.BOFA

City

string
cityProvide a string value for the city of the address.Beverly Hills

Contact Type Ids

string
Value List
contactTypeIdsFor each list item, provide an Id of a contact typeexample-2356795

Country Id

string
countryIdProvide a unique identifier for the contact's country.

Credit Days

string
creditDaysProvide a number value for the credit days of the contact.10

Credit Limit

string
creditLimitProvide a number value for the credit limit of the contact.350.00

Currency Id

string
currencyIdProvide the unique identifier of the currency type.example-24525235

Default Purchase Ledger Id

string
defaultPurchaseLedgerIdProvide the unique identifier of the default purchase ledger for the contact.example-80430964

Default Sales Ledger Id

string
defaultSalesLedgerIdProvide the unique identifier of the default sales ledger.example-80430964

Default Sales Tax Rate Id

string
defaultSalesTaxRateIdProvide the unique identifier of the sales tax rate for the contact.example-80430964

Delivery Address Bank Account Id

string
deliveryBankAccountIdProvide a value for the postal code.example-9489210

Delivery Address City

string
deliveryCityProvide a string value for the city of the address.Beverly Hills

Delivery Address Country Id

string
deliveryCountryIdProvide a unique identifier for the contact's country.

Delivery Address Line 1

string
deliveryLine1Provide a valid street address4 Privet Drive

Delivery Address Line 2

string
deliveryLine2Provide a string value for the 2nd address line.apt 319

Delivery Address Name

string
deliveryNameProvide a string value for a name.Example Name

Delivery Address Postal Code

string
deliveryPostalCodeProvide a value for the postal code.90211

Delivery Address Region

string
deliveryRegionProvide a valid region for the contact.North America

Delivery Address Type Id

string
deliveryTypeIdProvide a unique identifier for the address type90211

IBAN

string
ibanProvide a valid IBAN for the bank account.CY 17 002 00128 00000012005276002

Is Main Address

boolean
isMainAddressThis flag will determine if this is the contacts main address.

Is Main Address

boolean
isMainDeliveryThis flag will determine if this is the contacts main address.

Name

string
nameProvide a string value for a name.Example Name

Notes

string
notesProvide a string value for notes.This is an example note.

Postal Code

string
postalCodeProvide a value for the postal code.90211

Reference

string
referenceProvide a string value for the reference of the contact.uniqueValue

Region

string
regionProvide a valid region for the contact.North America

Sort Code

string
sortCodeProvide a sort code for the bank account.12-34-56

Source GUID

string
sourceGuidProvide a valid GUID, used for importing/exporting contacts from 3rd party services.example-80430964

Tax Number

string
taxNumberProvide a string value for the VAT registration number for the contact.80430964

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "results": {      "id": "example-80745034",      "displayed_as": "Example Contact",      "$path": "/contacts/exmaple",      "created_at": "2022-01-03T18:00:57Z",      "updated_at": "2022-01-03T18:00:57Z",      "links": [        {          "href": "https://accounting.na.sageone.com/contacts/customers/example",          "rel": "alternative",          "type": "text/html"        }      ],      "contact_types": [        {          "id": "CUSTOMER",          "displayd_as": "Customer"        }      ],      "name": "exampleName",      "reference": null,      "default_sales_ledger_account": {        "id": "example",        "displayed_as": "Professional Fees"      }    }  }}

Update Ledger Account#

Update the information and metadata of a Ledger account by Id | key: updateLedgerAccount

InputKeyNotesExample

Account Id

string
/ Required
accountIdProvide the unique identifier of the account Id.example-2356795

Display Name

string
/ Required
displayNameProvide a string value for the display name.Example Name

Gifi Code

string
gifiCodeProvide a value for The General Index of Financial Information.NA

Include In Chart

boolean
/ Required
includedInChartThis flag determines if the account will be included in the chart of accounts.true

Ledger Account Type Id

string
/ Required
ledgerAccountTypeIdProvide the unique identifier of a ledger account type.example-2356795

Name

string
/ Required
nameProvide a string value for a name.Example Name

Nominal Code

string
/ Required
nominalCodeProvide an unique integer value for the nominal code of the ledger account.1

Tax Rate Id

string
taxRateIdProvide the unique identifier of a tax rate id.example-238953e2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Purchase Invoice#

Update the information and metadata of a purchase invoice by Id | key: updatePurchaseInvoice

InputKeyDefaultNotesExample

Contact Id

string
contactIdProvide the unique identifier of a contact.example-533242

Contact Name

string
contactNameProvide the name of a contact.John Doe

Currency Id

string
currencyIdProvide the unique identifier of the currency type.example-24525235

Date

string
dateProvide a valid date value.2022-01-03

Due Date

string
/ Required
dueDateProvide a valid date value for the due date of the invoice.2022-01-03

Invoice Lines

code
/ Required
invoiceLines
[    {      "description": "string",      "ledger_account_id": "string",      "unit_price": 0,      "product_id": "string",      "service_id": "string",      "quantity": 0,    }  ]
Provide a list of javascript objects, each containing information of an an invoice line item.

Net Amount

string
netAmountProvide the net amount of the invoice.150.00

Notes

string
notesProvide a string value for notes.This is an example note.

Purchase Invoice Id

string
/ Required
purchaseInvoiceIdProvide the unique identifier of a purchase invoice id.example-533242

Tax Amount

string
taxAmountProvide a tax amount for the invoice.150.00

Total Amount

string
totalAmountProvide a total amount for the invoice.150.00

Total Quantity

string
totalQuantityProvide a total quantity of the invoice.3

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Sales Invoice#

Update the information and metadata of a sales invoice by Id | key: updateSalesInvoice

InputKeyDefaultNotesExample

Contact Id

string
contactIdProvide the unique identifier of a contact.example-533242

Contact Name

string
contactNameProvide the name of a contact.John Doe

Currency Id

string
currencyIdProvide the unique identifier of the currency type.example-24525235

Date

string
dateProvide a valid date value.2022-01-03

Due Date

string
/ Required
dueDateProvide a valid date value for the due date of the invoice.2022-01-03

Invoice Lines

code
/ Required
invoiceLines
[    {      "description": "string",      "ledger_account_id": "string",      "unit_price": 0,      "product_id": "string",      "service_id": "string",      "quantity": 0,    }  ]
Provide a list of javascript objects, each containing information of an an invoice line item.

Net Amount

string
netAmountProvide the net amount of the invoice.150.00

Notes

string
notesProvide a string value for notes.This is an example note.

Sales Invoice Id

string
/ Required
salesInvoiceIdProvide the unique identifier of a sales invoice id.example-533242

Tax Amount

string
taxAmountProvide a tax amount for the invoice.150.00

Total Amount

string
totalAmountProvide a total amount for the invoice.150.00

Total Quantity

string
totalQuantityProvide a total quantity of the invoice.3

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri