Use Cases
Customize Autonumbering Schemes
3 min
users can use the update field metadata docid\ wskf9au7 yfzc01hwpsl3 api to create custom auto numbering schemes to replace the default schemes for the name field of the following object types invoice invoiceitem invoiceitemdetail creditmemo creditmemoitem creditmemoitemdetail debitmemo debitmemoitem paymentapplication paymentapplicationitem note about startvalue it is important to note that startvalue can only be set or updated using the api if there are no existing invoices or records attempting to set or update the startvalue when records already exist will result in an error important startvalue can only be set or updated using the api if there are no existing invoices or records attempting to set or update the startvalue when records already exist will result in an error auto number components please refer to the following table about different types of autonumbering scheme components component format description example object type prefix the object type prefix invoice inv order o credit memo cm payment application pa year {yyyy} or {yy} the year the record was created often formatted as yyyy yyyy 2024 yy 24 month {mm} the month the record was created mm 06 (june) day {dd} the day of the month the record was created dd 08 hour {hh} the hour the record was created often formatted as hh 14(2pm) minute {mm} the minute the record was created often formatted as mm 30 second {ss} the second the record was created often formatted as ss 45 sequential number {0000} a unique sequential number that increases with each new record the number of 0 indicates the minimum number of digits in the sequential number an optional start value (startvalue) may be provided {0000} with a start value 222 api example you can use update field metadata docid\ wskf9au7 yfzc01hwpsl3 to update the auto numbering scheme of a specific field here is an api example that sets up a custom scheme for the auto numbering of invoice numbers in the invoice's name field curl location request patch 'https //api perftest nue io/metadata/objects/invoice/fields/name' \\ \ header 'content type application/json' \\ \ header 'nue api key;' \\ \ data '{ "name" "name", "autonumbersetting" { "displayformat" "inv {yyyy} {mm} {dd} {0000}", "startvalue" 2000 } }' once this custom scheme is established, the invoice numbers in the subsequent billing job will follow this format inv 2024 07 11 2001
🤔
Have a question?
Get answers fast with Nue’s intelligent AI, expert support team, and a growing community of users - all here to help you succeed.
To ask a question or participate in discussions, you'll need to authenticate first.