POST api/GofreightApi/webhooks/invoiceUpdatedSync

Request Information

URI Parameters

None.

Body Parameters

InvoiceUpdatedPayload
NameDescriptionTypeAdditional information
event_type

string

None.

timestamp

decimal number

None.

invoice

Invoice

None.

creator

Creator

None.

trade_partner

TradePartner

None.

mbl

Mbl

None.

hbl

Hbl

None.

office

Office

None.

Request Formats

application/json, text/json

Sample:
{
  "event_type": "sample string 1",
  "timestamp": 2.1,
  "invoice": {
    "ref": "sample string 1",
    "invoice_no": {},
    "system_no": "sample string 3",
    "customer_ref_no": {},
    "type": "sample string 5",
    "amount": "sample string 6",
    "paid_amount": "sample string 7",
    "tax_amount": "sample string 8",
    "process_state": "sample string 9",
    "post_date": "sample string 10",
    "invoice_date": "sample string 11",
    "due_date": "sample string 12",
    "is_block": true,
    "block_date": "sample string 14",
    "block_by": {
      "ref": "sample string 1",
      "username": "sample string 2"
    },
    "is_general_expense": true,
    "remark": {},
    "lines": [
      {
        "ref": "sample string 1",
        "name": "sample string 2",
        "type": "sample string 3",
        "freight_term": "sample string 4",
        "unit": "sample string 5",
        "link_type": "sample string 6",
        "currency": {
          "ref": "sample string 1",
          "name": "sample string 2"
        },
        "currency_amount": "sample string 7",
        "volume": "sample string 8",
        "rate": "sample string 9",
        "amount": "sample string 10",
        "billing_code": {
          "ref": "sample string 1",
          "code": "sample string 2",
          "name": "sample string 3",
          "general_ledger_code": {
            "ref": "sample string 1",
            "code": "sample string 2",
            "type": "sample string 3"
          }
        },
        "tax": {
          "name": "sample string 1",
          "type": "sample string 2",
          "rate": "sample string 3"
        }
      },
      {
        "ref": "sample string 1",
        "name": "sample string 2",
        "type": "sample string 3",
        "freight_term": "sample string 4",
        "unit": "sample string 5",
        "link_type": "sample string 6",
        "currency": {
          "ref": "sample string 1",
          "name": "sample string 2"
        },
        "currency_amount": "sample string 7",
        "volume": "sample string 8",
        "rate": "sample string 9",
        "amount": "sample string 10",
        "billing_code": {
          "ref": "sample string 1",
          "code": "sample string 2",
          "name": "sample string 3",
          "general_ledger_code": {
            "ref": "sample string 1",
            "code": "sample string 2",
            "type": "sample string 3"
          }
        },
        "tax": {
          "name": "sample string 1",
          "type": "sample string 2",
          "rate": "sample string 3"
        }
      }
    ]
  },
  "creator": {
    "ref": "sample string 1",
    "username": "sample string 2",
    "email": "sample string 3"
  },
  "trade_partner": {
    "ref": "sample string 1",
    "type": "sample string 2",
    "name": "sample string 3",
    "local_name": "sample string 4",
    "short_name": "sample string 5"
  },
  "mbl": {
    "ref": "sample string 1",
    "transportation_mode": "sample string 2",
    "mbl_no": "sample string 3"
  },
  "hbl": {
    "ref": "sample string 1",
    "transportation_mode": "sample string 2",
    "hbl_no": "sample string 3"
  },
  "office": {
    "ref": "sample string 1",
    "short_name": "sample string 2",
    "full_name": "sample string 3",
    "local_name": "sample string 4"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InvoiceUpdatedPayload'.

 
Response information

Resource Description

GoFreightApiWebhookActionResult
NameDescriptionTypeAdditional information
referenceNo

string

None.

Success

Request Success

boolean

None.

Message

Return Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "referenceNo": "sample string 1",
  "Success": true,
  "Message": "sample string 3"
}