Update self-billed e-invoice
https://api.light.inc/v1/einvoicing/self-billed-einvoices/{id}
Updates a draft or failed self-billed e-invoice. Fields left out keep their value.
Authorization
Send one of these on every request. See Authentication for how to get credentials.
- API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
- Bearer token
Path parameters
-
idstring · uuidrequired
Request body
application/json;charset=UTF-8
-
issueDatestring · dateThe date on the self-billed e-invoice
-
documentNumberstringThe number on the supplier's document
-
documentDatestring · dateThe date of the supplier's document
-
supplierNamestringThe supplier's name
-
supplierVatNumberstringThe supplier's VAT number
-
supplierBusinessRegistrationNumberstringThe supplier's business registration number
-
supplierAddressobject-
countrystring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZW -
citystringNote
City.
-
statestringNote
State or region, where the country uses one.
-
zipcodestringNote
Postal code.
-
streetstringNote
First address line.
-
street2stringNote
Second address line.
-
-
sdiTdCodestringThe SDI document type code
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
TD16TD17TD18TD19TD20TD21TD22TD23TD28
Response
-
idstring · uuid -
companyEntityIdstring · uuid -
accountingDocumentIdstring · uuidThe accounting document the e-invoice was created for. Null once the accounting document is deleted
-
accountingDocumentTypestring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
APARBPCCCNCTDEFXJEYC -
linkedSelfBilledEInvoiceIdstring · uuid -
typestring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
SELF_BILLED_CREDIT_NOTESELF_BILLED_INVOICE -
networkstring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
FINVOICEFR_PAMYDATANEMHANDELPEPPOLPORTUGUESE_TAX_REPORTINGSDIVERIFACTU -
selfBilledEInvoiceNumberstring -
issueDatestring · dateThe date on the self-billed e-invoice
-
deadlinestring · dateThe last day to send the e-invoice to the network
-
documentNumberstringThe number on the supplier's document
-
documentDatestring · dateThe date of the supplier's document
-
currencystring -
amountinteger · int64Total amount in cents, expressed in the invoice currency.
-
netAmountobject-
amountinteger · int64Note
Unsigned integer in minor units. The direction is in
dcSign; a negative value is rejected. -
dcSignstring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
DC
-
-
taxAmountobject-
amountinteger · int64Note
Unsigned integer in minor units. The direction is in
dcSign; a negative value is rejected. -
dcSignstring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
DC
-
-
buyerNamestring -
buyerVatNumberstring -
buyerBusinessRegistrationNumberstring -
supplierNamestring -
supplierVatNumberstring -
supplierBusinessRegistrationNumberstring -
areLinesWithTaxbooleanHow the accounting document's amounts were entered: true means with tax. Line amounts in this response are always net
-
buyerAddressobject-
countrystring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZW -
citystringNote
City.
-
statestringNote
State or region, where the country uses one.
-
zipcodestringNote
Postal code.
-
streetstringNote
First address line.
-
street2stringNote
Second address line.
-
-
supplierAddressobject-
countrystring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZW -
citystringNote
City.
-
statestringNote
State or region, where the country uses one.
-
zipcodestringNote
Postal code.
-
streetstringNote
First address line.
-
street2stringNote
Second address line.
-
-
linesarray of object-
descriptionstring -
ledgerTaxIdstring · uuidThe tax code's ID as stored on the line
-
taxNamestringThe tax code's name as stored on the line
-
edifactCodestringThe tax code's UNCL5305 code as stored on the line
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
AEEGKLMOSZ -
taxCategorystringWhether the tax code is for goods or for services, as stored on the line
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
GOODSSERVICES -
quantitynumber -
ratenumberThe tax rate as a fraction, so 0.22 is 22%
-
netTransactionAmountobject-
amountinteger · int64Note
Unsigned integer in minor units. The direction is in
dcSign; a negative value is rejected. -
dcSignstring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
DC
-
-
taxTransactionAmountobject-
amountinteger · int64Note
Unsigned integer in minor units. The direction is in
dcSign; a negative value is rejected. -
dcSignstring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
DC
-
-
countryPropertiesobjectThe tax code's country property values, by group internal name, as stored on the line
-
-
statusstring⚠️ This enum is not exhaustive; new values may be added in the future.
One of
ACCEPTEDARCHIVEDDRAFTFAILEDSUBMITTED -
failureContextobjectFailure context when vendor onboarding fails.
-
namestringThe error name
-
typestringThe error type
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
BAD_REQUESTUNAUTHORIZEDFORBIDDENNOT_FOUNDCONFLICTUNPROCESSABLE_CONTENT -
errorsarray of objectList of errors providing details about what went wrong
-
typestringA string code identifying the error type
-
messagestringA human-readable message providing more details about the error
-
patharray of stringOptional path of the error when the error is for a specific field. Used mostly on BAD_REQUEST errors, that path will match the field name on the request object
-
contextobjectOptional context providing additional information about the error. This can include any relevant data that might help in understanding or resolving the error
-
-
-
einvoiceIdstring -
submittedAtstring · date-time -
editedFieldsarray of stringThe fields a user changed. Updates from the accounting document keep their values
One of
DOCUMENT_DATEDOCUMENT_NUMBERISSUE_DATESDI_TD_CODESUPPLIER_ADDRESSSUPPLIER_BUSINESS_REGISTRATION_NUMBERSUPPLIER_NAMESUPPLIER_VAT_NUMBER -
createdAtstring · date-time -
sdiTdCodestringThe SDI document type code. Only set on the SDI network
⚠️ This enum is not exhaustive; new values may be added in the future.
One of
TD16TD17TD18TD19TD20TD21TD22TD23TD28