Complete Update Receivable Overpayment Allocations by Id
PUT
/api/v2/receivable_overpayment_allocations/dd62055f-1d97-4495-ad51-f6d52fd7fa67
Use this method to update receivable overpayment allocations. See our HTTP GET documentation for complete queries method.
The following elements are returned in the update receivable overpayment allocations methods response :
Body Request
Element | Description |
---|---|
reason | The reason why changes were made. String 170 characters . |
status | Status transaction, the status must be one of the following types: draft , deleted , submitted , approved , voided , finished . |
date | Transaction date. Date format YYYY-MM-DD . |
time | Transaction time. Time format hh:mm:ss . |
number | Reference number of sales deliveries. String maximum 35 characters . |
description | Description of sales deliveries. String maximum 75 characters . |
customer* | Element for customer. |
customer.id | Unique code for identifier customer. String 36 characters . |
customer.code | Customer code String maximum 255 characters . |
customer.name | Customer name String maximum 255 characters . |
customer.classification* | Element for customer classification. |
customer.classification.id | Unique code for identifier classification. String 36 characters . |
customer.classification.name | Classification name String maximum 255 characters . |
employees* | Element for employees. |
employees.id | Unique code for identifier employees. String 36 characters . |
employees.type* | employees.type |
employees.type.id | Unique code for identifier employees type. String 36 characters . |
employees.type.name | employees type name. String 36 characters . |
employees.contact* | Element for Contact. |
employees.contact.id | Unique code for identifier contact. String 36 characters . |
employees.contact.code | Contact code String maximum 255 characters . |
employees.contact.name | Contact name String maximum 255 characters . |
employees.contact.classification* | contact classification. |
employees.contact.classification.id | Unique code for identifier classification. String 36 characters . |
employees.contact.classification.name | Contact classification name String maximum 255 characters . |
department* | Department of sales invoices. |
Department.id | Unique code for identifier customer. String 36 characters . |
Department.code | Customer code String maximum 255 characters . |
Department.name | Customer name String maximum 255 characters . |
project* | Project of sales invoices. |
project.id | Unique code for identifier project. String 36 characters . |
project.code | Project code String maximum 255 characters . |
project.name | Project name String maximum 255 characters . |
document* | Document of sales invoices. |
document.date | Document date. Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . Automaticaly. |
document.number | Document number String. |
overpayment* | Element of overpayment. |
overpayment.invoice.id | overpayment invoice id. String 36 characters Required. |
overpayment.invoice.date | overpayment invoice date. Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . |
overpayment.invoice.number | overpayment invoice number. String 255 characters . |
overpayment.invoice.description | overpayment invoice description. String 255 characters . |
overpayment.invoice.account.id | overpayment invoice account id. String 36 characters Required. |
overpayment.invoice.account.code | overpayment invoice account code. String 255 characters . |
overpayment.invoice.account.name | overpayment invoice account name. String 255 characters . |
overpayment.invoice.account.alias_name | overpayment invoice account alias_name. String 255 characters . |
overpayment.currency.id | Unique code for identifier currency. String 36 characters . |
overpayment.currency.code | Currency code String maximum 3 characters . |
overpayment.currency.name | Currency name String maximum 255 characters . |
overpayment.currency.symbol | Currency symbol String maximum 255 characters . |
exchange_rate | Exchange rate number. |
amount_origin | amount_origin number. |
amount | amount number. |
line_items* | Element of line_items of sales invoices |
line_items.id | Unique code for identifier line_items. String 36 characters . |
line_items.description | line_items description Number |
line_items.note | line_items note Number |
line_items.departement.id | Unique code for identifier department. String 36 characters . |
line_items.departement.code | Departement code String maximum 255 characters . |
line_items.departement.name | Departement name String maximum 255 characters . |
line_items.project.id | Unique code for identifier project. String 36 characters . |
line_items.project.code | Project code String maximum 255 characters . |
line_items.project.name | Project name String maximum 255 characters . |
line_items.invoice.id | Unique code for identifier invoice id. String 36 characters . |
line_items.invoice.date | Invoice date Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . |
line_items.invoice.description | Invoice description String maximum 255 characters . |
line_items.invoice.account.id | Account id String maximum 255 characters . |
line_items.invoice.account.code | Account code String maximum 255 characters . |
line_items.invoice.account.name | Account name String maximum 255 characters . |
line_items.invoice.account.alias_name | Account alias_name String maximum 255 characters . |
line_items.discount.rate | Discount rate. number. |
line_items.discount.amount_origin | Discount amount origin number. |
line_items.discount.amount | Discount amount number. |
line_items.currency.id | Unique code for identifier currency String 36 characters . |
line_items.currency.code | currency code String 255 characters . |
line_items.currency.name | currency name String 255 characters . |
line_items.currency.symbol | currency symbol String 255 characters . |
line_items.exchange_rate | currency code String 255 characters . |
line_items.amount_origin | currency code String 255 characters . |
line_items.amount | currency code String 255 characters . |
others* | Element for others. |
others.id | Unique code for identifier others.id. String 36 characters . |
others.description | others description String maximum 255 characters . |
others.account.id | Unique code for identifier account. String 36 characters . |
others.account.code | Account code String maximum 255 characters . |
others.account.name | Account name String maximum 255 characters . |
others.currency.id | Unique code for identifier currency String 36 characters . |
others.currency.code | currency code String 255 characters . |
others.currency.name | currency name String 255 characters . |
others.currency.symbol | currency symbol String 255 characters . |
others.exchange_rate | Exchange_rate Number. |
cash* | Element for cash. |
cash.account.id | Unique code for identifier account. String 36 characters . |
cash.account.code | Account code String maximum 255 characters . |
cash.account.name | Account name String maximum 255 characters . |
cash.account.alias_name | Account alias name String maximum 255 characters . |
cash.currency.id | Unique code for identifier currency String 36 characters . |
cash.currency.code | currency code String 255 characters . |
cash.currency.name | currency name String 255 characters . |
cash.currency.symbol | currency symbol String 255 characters . |
cash.exchange_rate | Exchange_rate Number. |
cash.amount_origin | amount_origin Number. |
other_fields | other_fields |
other_fields.id | Unique code for identifier other_fields. String 36 characters . |
other_fields.key | key words of other_fields. String 36 characters . |
other_fields.type | other_fields type. String 36 characters . |
other_fields.value | other_fields value. String 36 characters . |
attachments* | attachments. |
attachments.id | Unique code for identifier attachments. String 36 characters . |
attachments.name | Attachments name String. |
attachments.extension | Attachments extension JPG, PNG, PDF String. |
attachments.url | Attachments url String. |
created* | Created. |
created.user* | Created User. |
created.user.id | User id String Automaticaly. |
created.user.name | User name String. |
created.user.email | User email String. |
created.time | Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . Automaticaly. |
update* | Update. |
update.user* | Update user. |
update.user.id | User id String Automaticaly. |
update.user.name | User name String. |
update.user.email | User email String. |
update.time | Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . Automaticaly. |
Body Response
Element | Description |
---|---|
id | Unique code for identifier receivable overpayment allocations. String 36 characters . |
status | Status transaction, the status must be one of the following types: draft , deleted , submitted , approved , voided , finished . |
date | Transaction date. Date format YYYY-MM-DD . |
time | Transaction time. Time format hh:mm:ss . |
number | Reference number of sales deliveries. String maximum 35 characters . |
description | Description of sales deliveries. String maximum 75 characters . |
customer* | Element for customer. |
customer.id | Unique code for identifier customer. String 36 characters . |
customer.code | Customer code String maximum 255 characters . |
customer.name | Customer name String maximum 255 characters . |
customer.classification* | Element for customer classification. |
customer.classification.id | Unique code for identifier classification. String 36 characters . |
customer.classification.name | Classification name String maximum 255 characters . |
employees* | Element for employees. |
employees.id | Unique code for identifier employees. String 36 characters . |
employees.type* | employees.type |
employees.type.id | Unique code for identifier employees type. String 36 characters . |
employees.type.name | employees type name. String 36 characters . |
employees.contact* | Element for Contact. |
employees.contact.id | Unique code for identifier contact. String 36 characters . |
employees.contact.code | Contact code String maximum 255 characters . |
employees.contact.name | Contact name String maximum 255 characters . |
employees.contact.classification* | contact classification. |
employees.contact.classification.id | Unique code for identifier classification. String 36 characters . |
employees.contact.classification.name | Contact classification name String maximum 255 characters . |
department* | Department of sales invoices. |
Department.id | Unique code for identifier customer. String 36 characters . |
Department.code | Customer code String maximum 255 characters . |
Department.name | Customer name String maximum 255 characters . |
project* | Project of sales invoices. |
project.id | Unique code for identifier project. String 36 characters . |
project.code | Project code String maximum 255 characters . |
project.name | Project name String maximum 255 characters . |
document* | Document of sales invoices. |
document.date | Document date. Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . Automaticaly. |
document.number | Document number String. |
overpayment* | Element of overpayment. |
overpayment.invoice.id | overpayment invoice id. String 36 characters Required. |
overpayment.invoice.date | overpayment invoice date. Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . |
overpayment.invoice.number | overpayment invoice number. String 255 characters . |
overpayment.invoice.description | overpayment invoice description. String 255 characters . |
overpayment.invoice.account.id | overpayment invoice account id. String 36 characters Required. |
overpayment.invoice.account.code | overpayment invoice account code. String 255 characters . |
overpayment.invoice.account.name | overpayment invoice account name. String 255 characters . |
overpayment.invoice.account.alias_name | overpayment invoice account alias_name. String 255 characters . |
overpayment.currency.id | Unique code for identifier currency. String 36 characters . |
overpayment.currency.code | Currency code String maximum 3 characters . |
overpayment.currency.name | Currency name String maximum 255 characters . |
overpayment.currency.symbol | Currency symbol String maximum 255 characters . |
exchange_rate | Exchange rate number. |
amount_origin | amount_origin number. |
amount | amount number. |
line_items* | Element of line_items of sales invoices |
line_items.id | Unique code for identifier line_items. String 36 characters . |
line_items.description | line_items description Number |
line_items.note | line_items note Number |
line_items.departement.id | Unique code for identifier department. String 36 characters . |
line_items.departement.code | Departement code String maximum 255 characters . |
line_items.departement.name | Departement name String maximum 255 characters . |
line_items.project.id | Unique code for identifier project. String 36 characters . |
line_items.project.code | Project code String maximum 255 characters . |
line_items.project.name | Project name String maximum 255 characters . |
line_items.invoice.id | Unique code for identifier invoice id. String 36 characters . |
line_items.invoice.date | Invoice date Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . |
line_items.invoice.description | Invoice description String maximum 255 characters . |
line_items.invoice.account.id | Account id String maximum 255 characters . |
line_items.invoice.account.code | Account code String maximum 255 characters . |
line_items.invoice.account.name | Account name String maximum 255 characters . |
line_items.invoice.account.alias_name | Account alias_name String maximum 255 characters . |
line_items.discount.rate | Discount rate. number. |
line_items.discount.amount_origin | Discount amount origin number. |
line_items.discount.amount | Discount amount number. |
line_items.currency.id | Unique code for identifier currency String 36 characters . |
line_items.currency.code | currency code String 255 characters . |
line_items.currency.name | currency name String 255 characters . |
line_items.currency.symbol | currency symbol String 255 characters . |
line_items.exchange_rate | currency code String 255 characters . |
line_items.amount_origin | currency code String 255 characters . |
line_items.amount | currency code String 255 characters . |
others* | Element for others. |
others.id | Unique code for identifier others.id. String 36 characters . |
others.description | others description String maximum 255 characters . |
others.account.id | Unique code for identifier account. String 36 characters . |
others.account.code | Account code String maximum 255 characters . |
others.account.name | Account name String maximum 255 characters . |
others.currency.id | Unique code for identifier currency String 36 characters . |
others.currency.code | currency code String 255 characters . |
others.currency.name | currency name String 255 characters . |
others.currency.symbol | currency symbol String 255 characters . |
others.exchange_rate | Exchange_rate Number. |
cash* | Element for cash. |
cash.account.id | Unique code for identifier account. String 36 characters . |
cash.account.code | Account code String maximum 255 characters . |
cash.account.name | Account name String maximum 255 characters . |
cash.account.alias_name | Account alias name String maximum 255 characters . |
cash.currency.id | Unique code for identifier currency String 36 characters . |
cash.currency.code | currency code String 255 characters . |
cash.currency.name | currency name String 255 characters . |
cash.currency.symbol | currency symbol String 255 characters . |
cash.exchange_rate | Exchange_rate Number. |
cash.amount_origin | amount_origin Number. |
other_fields | other_fields |
other_fields.id | Unique code for identifier other_fields. String 36 characters . |
other_fields.key | key words of other_fields. String 36 characters . |
other_fields.type | other_fields type. String 36 characters . |
other_fields.value | other_fields value. String 36 characters . |
attachments* | attachments. |
attachments.id | Unique code for identifier attachments. String 36 characters . |
attachments.name | Attachments name String. |
attachments.extension | Attachments extension JPG, PNG, PDF String. |
attachments.url | Attachments url String. |
created* | Created. |
created.user* | Created User. |
created.user.id | User id String Automaticaly. |
created.user.name | User name String. |
created.user.email | User email String. |
created.time | Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . Automaticaly. |
update* | Update. |
update.user* | Update user. |
update.user.id | User id String Automaticaly. |
update.user.name | User name String. |
update.user.email | User email String. |
update.time | Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format) . Automaticaly. |