POST api/zatca-invoices/updateInvoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceNumber	string	None.
TransactionId	string	None.
InvoiceType	string	None.
OriginInvoiceId	string	None.
TotalAmountExclVat	decimal number	None.
TotalQuantity	decimal number	None.
VatAmount	decimal number	None.
TotalAmountInclVat	decimal number	None.
InvoiceDate	date	None.
IdentityValue	string	None.
IdentityType	string	None.
CustomerArabicName	string	None.
CustomerEnglishName	string	None.
CustomerBuilding	string	None.
ExchangeRate	decimal number	None.
CustomerBilledAmount	decimal number	None.
CustomerCurrency	string	None.
CustomerBilledTax	decimal number	None.
CustomerStreet	string	None.
CustomerCity	string	None.
CustomerPostalCode	string	None.
CustomerCountryCode	string	None.
CustomerDistrict	string	None.
CustomerEmail	string	None.
QrCodeBase64	string	None.
Currency	string	None.
ZatcaStatus	string	None.
ArInvoiceLinkId	string	None.
CompanyName	string	None.
CompanyNameArabic	string	None.
AmountInWords	string	None.
Remarks	string	None.
CompleteBillingAddress	string	None.
CompleteBillingAddressArabic	string	None.
ConsignorName	string	None.
ConsignorAddress	string	None.
SourceSystem	string	None.
CutOffDate	date	None.
ResponseAt	date	None.
SentAt	date	None.
CustomerTotalInvoicedAmount	decimal number	None.
ZatcaPushed	boolean	None.
InvoiceDueDate	date	None.
PaymentTermsDescription	string	None.
BankAccountName	string	None.
BankName	string	None.
BankAccountNumber	string	None.
BankIBAN	string	None.
BankCurrency	string	None.
BankSwiftCode	string	None.
ShipmentNumber	string	None.
VesselName	string	None.
Voyage	string	None.
PlaceOfReceipt	string	None.
PortOfLoading	string	None.
PlaceOfDischarge	string	None.
PlaceOfDelivery	string	None.
MblNumber	string	None.
HblNumber	string	None.
CustomerReferenceNumber	string	None.
ModeOfShipment	string	None.
IncoTerm	string	None.
Etd	date	None.
Eta	date	None.
DescriptionOfGoods	string	None.
Weight	string	None.
Volume	string	None.
Chargeable	string	None.
Carrier	string	None.
Packs	string	None.
Error	string	None.
Items	Collection of InvoiceItemDto	None.

Request Formats

application/json, text/json

Sample:

{
  "InvoiceNumber": "sample string 1",
  "TransactionId": "sample string 2",
  "InvoiceType": "sample string 3",
  "OriginInvoiceId": "sample string 4",
  "TotalAmountExclVat": 1.0,
  "TotalQuantity": 1.0,
  "VatAmount": 1.0,
  "TotalAmountInclVat": 1.0,
  "InvoiceDate": "2026-06-17T13:37:07.4101248+03:00",
  "IdentityValue": "sample string 5",
  "IdentityType": "sample string 6",
  "CustomerArabicName": "sample string 7",
  "CustomerEnglishName": "sample string 8",
  "CustomerBuilding": "sample string 9",
  "ExchangeRate": 1.0,
  "CustomerBilledAmount": 1.0,
  "CustomerCurrency": "sample string 10",
  "CustomerBilledTax": 1.0,
  "CustomerStreet": "sample string 11",
  "CustomerCity": "sample string 12",
  "CustomerPostalCode": "sample string 13",
  "CustomerCountryCode": "sample string 14",
  "CustomerDistrict": "sample string 15",
  "CustomerEmail": "sample string 16",
  "QrCodeBase64": "sample string 17",
  "Currency": "sample string 18",
  "ZatcaStatus": "sample string 19",
  "ArInvoiceLinkId": "sample string 20",
  "CompanyName": "sample string 21",
  "CompanyNameArabic": "sample string 22",
  "AmountInWords": "sample string 23",
  "Remarks": "sample string 24",
  "CompleteBillingAddress": "sample string 25",
  "CompleteBillingAddressArabic": "sample string 26",
  "ConsignorName": "sample string 27",
  "ConsignorAddress": "sample string 28",
  "SourceSystem": "sample string 29",
  "CutOffDate": "2026-06-17T13:37:07.4101248+03:00",
  "ResponseAt": "2026-06-17T13:37:07.4101248+03:00",
  "SentAt": "2026-06-17T13:37:07.4101248+03:00",
  "CustomerTotalInvoicedAmount": 1.0,
  "ZatcaPushed": true,
  "InvoiceDueDate": "2026-06-17T13:37:07.4101248+03:00",
  "PaymentTermsDescription": "sample string 31",
  "BankAccountName": "sample string 32",
  "BankName": "sample string 33",
  "BankAccountNumber": "sample string 34",
  "BankIBAN": "sample string 35",
  "BankCurrency": "sample string 36",
  "BankSwiftCode": "sample string 37",
  "ShipmentNumber": "sample string 38",
  "VesselName": "sample string 39",
  "Voyage": "sample string 40",
  "PlaceOfReceipt": "sample string 41",
  "PortOfLoading": "sample string 42",
  "PlaceOfDischarge": "sample string 43",
  "PlaceOfDelivery": "sample string 44",
  "MblNumber": "sample string 45",
  "HblNumber": "sample string 46",
  "CustomerReferenceNumber": "sample string 47",
  "ModeOfShipment": "sample string 48",
  "IncoTerm": "sample string 49",
  "Etd": "2026-06-17T13:37:07.4101248+03:00",
  "Eta": "2026-06-17T13:37:07.4101248+03:00",
  "DescriptionOfGoods": "sample string 50",
  "Weight": "sample string 51",
  "Volume": "sample string 52",
  "Chargeable": "sample string 53",
  "Carrier": "sample string 54",
  "Packs": "sample string 55",
  "Error": "sample string 56",
  "Items": [
    {
      "Id": 1,
      "ItemDescription": "sample string 2",
      "Quantity": 1.0,
      "UnitRate": 1.0,
      "ItemTotalBeforeTax": 1.0,
      "VatRate": 1.0,
      "VatAmount": 1.0,
      "ContainerNbr": "sample string 3",
      "EventName": "sample string 4",
      "ArInvoiceLinkId": "sample string 5",
      "UnitCurrency": "sample string 6",
      "ItemDescriptionArabic": "sample string 7",
      "ItemDetails": "sample string 8",
      "ExchangeRate": 1.0
    },
    {
      "Id": 1,
      "ItemDescription": "sample string 2",
      "Quantity": 1.0,
      "UnitRate": 1.0,
      "ItemTotalBeforeTax": 1.0,
      "VatRate": 1.0,
      "VatAmount": 1.0,
      "ContainerNbr": "sample string 3",
      "EventName": "sample string 4",
      "ArInvoiceLinkId": "sample string 5",
      "UnitCurrency": "sample string 6",
      "ItemDescriptionArabic": "sample string 7",
      "ItemDetails": "sample string 8",
      "ExchangeRate": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZatcaInvoiceIntegration.API.Domain.Entities">
  <AmountInWords>sample string 23</AmountInWords>
  <ArInvoiceLinkId>sample string 20</ArInvoiceLinkId>
  <BankAccountName>sample string 32</BankAccountName>
  <BankAccountNumber>sample string 34</BankAccountNumber>
  <BankCurrency>sample string 36</BankCurrency>
  <BankIBAN>sample string 35</BankIBAN>
  <BankName>sample string 33</BankName>
  <BankSwiftCode>sample string 37</BankSwiftCode>
  <Carrier>sample string 54</Carrier>
  <Chargeable>sample string 53</Chargeable>
  <CompanyName>sample string 21</CompanyName>
  <CompanyNameArabic>sample string 22</CompanyNameArabic>
  <CompleteBillingAddress>sample string 25</CompleteBillingAddress>
  <CompleteBillingAddressArabic>sample string 26</CompleteBillingAddressArabic>
  <ConsignorAddress>sample string 28</ConsignorAddress>
  <ConsignorName>sample string 27</ConsignorName>
  <Currency>sample string 18</Currency>
  <CustomerArabicName>sample string 7</CustomerArabicName>
  <CustomerBilledAmount>1</CustomerBilledAmount>
  <CustomerBilledTax>1</CustomerBilledTax>
  <CustomerBuilding>sample string 9</CustomerBuilding>
  <CustomerCity>sample string 12</CustomerCity>
  <CustomerCountryCode>sample string 14</CustomerCountryCode>
  <CustomerCurrency>sample string 10</CustomerCurrency>
  <CustomerDistrict>sample string 15</CustomerDistrict>
  <CustomerEmail>sample string 16</CustomerEmail>
  <CustomerEnglishName>sample string 8</CustomerEnglishName>
  <CustomerPostalCode>sample string 13</CustomerPostalCode>
  <CustomerReferenceNumber>sample string 47</CustomerReferenceNumber>
  <CustomerStreet>sample string 11</CustomerStreet>
  <CustomerTotalInvoicedAmount>1</CustomerTotalInvoicedAmount>
  <CutOffDate>2026-06-17T13:37:07.4101248+03:00</CutOffDate>
  <DescriptionOfGoods>sample string 50</DescriptionOfGoods>
  <Error>sample string 56</Error>
  <Eta>2026-06-17T13:37:07.4101248+03:00</Eta>
  <Etd>2026-06-17T13:37:07.4101248+03:00</Etd>
  <ExchangeRate>1</ExchangeRate>
  <HblNumber>sample string 46</HblNumber>
  <IdentityType>sample string 6</IdentityType>
  <IdentityValue>sample string 5</IdentityValue>
  <IncoTerm>sample string 49</IncoTerm>
  <InvoiceDate>2026-06-17T13:37:07.4101248+03:00</InvoiceDate>
  <InvoiceDueDate>2026-06-17T13:37:07.4101248+03:00</InvoiceDueDate>
  <InvoiceNumber>sample string 1</InvoiceNumber>
  <InvoiceType>sample string 3</InvoiceType>
  <Items>
    <InvoiceItemDto>
      <ArInvoiceLinkId>sample string 5</ArInvoiceLinkId>
      <ContainerNbr>sample string 3</ContainerNbr>
      <EventName>sample string 4</EventName>
      <ExchangeRate>1</ExchangeRate>
      <Id>1</Id>
      <ItemDescription>sample string 2</ItemDescription>
      <ItemDescriptionArabic>sample string 7</ItemDescriptionArabic>
      <ItemDetails>sample string 8</ItemDetails>
      <ItemTotalBeforeTax>1</ItemTotalBeforeTax>
      <Quantity>1</Quantity>
      <UnitCurrency>sample string 6</UnitCurrency>
      <UnitRate>1</UnitRate>
      <VatAmount>1</VatAmount>
      <VatRate>1</VatRate>
    </InvoiceItemDto>
    <InvoiceItemDto>
      <ArInvoiceLinkId>sample string 5</ArInvoiceLinkId>
      <ContainerNbr>sample string 3</ContainerNbr>
      <EventName>sample string 4</EventName>
      <ExchangeRate>1</ExchangeRate>
      <Id>1</Id>
      <ItemDescription>sample string 2</ItemDescription>
      <ItemDescriptionArabic>sample string 7</ItemDescriptionArabic>
      <ItemDetails>sample string 8</ItemDetails>
      <ItemTotalBeforeTax>1</ItemTotalBeforeTax>
      <Quantity>1</Quantity>
      <UnitCurrency>sample string 6</UnitCurrency>
      <UnitRate>1</UnitRate>
      <VatAmount>1</VatAmount>
      <VatRate>1</VatRate>
    </InvoiceItemDto>
  </Items>
  <MblNumber>sample string 45</MblNumber>
  <ModeOfShipment>sample string 48</ModeOfShipment>
  <OriginInvoiceId>sample string 4</OriginInvoiceId>
  <Packs>sample string 55</Packs>
  <PaymentTermsDescription>sample string 31</PaymentTermsDescription>
  <PlaceOfDelivery>sample string 44</PlaceOfDelivery>
  <PlaceOfDischarge>sample string 43</PlaceOfDischarge>
  <PlaceOfReceipt>sample string 41</PlaceOfReceipt>
  <PortOfLoading>sample string 42</PortOfLoading>
  <QrCodeBase64>sample string 17</QrCodeBase64>
  <Remarks>sample string 24</Remarks>
  <ResponseAt>2026-06-17T13:37:07.4101248+03:00</ResponseAt>
  <SentAt>2026-06-17T13:37:07.4101248+03:00</SentAt>
  <ShipmentNumber>sample string 38</ShipmentNumber>
  <SourceSystem>sample string 29</SourceSystem>
  <TotalAmountExclVat>1</TotalAmountExclVat>
  <TotalAmountInclVat>1</TotalAmountInclVat>
  <TotalQuantity>1</TotalQuantity>
  <TransactionId>sample string 2</TransactionId>
  <VatAmount>1</VatAmount>
  <VesselName>sample string 39</VesselName>
  <Volume>sample string 52</Volume>
  <Voyage>sample string 40</Voyage>
  <Weight>sample string 51</Weight>
  <ZatcaPushed>true</ZatcaPushed>
  <ZatcaStatus>sample string 19</ZatcaStatus>
</InvoiceDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.