YQueue DocsDevelopers

Schema

MyInvois Address

Address (registered, business, residential, etc.) of business or individual who will be the supplier in a commercial transaction

  • MyInvois

Overview

object · 7 properties · 4 required

Properties

line_1

string Required

This is the main address line in an address structure that can be used to give the main address line information.

Min length 1
Max length 150

line_2

string | null

An additional address line in an address that can be used to give further details supplementing the main line.

Min length 1
Max length 150
Nullable Yes

line_3

string | null

An additional address line in an address that can be used to give further details supplementing the main line.

Min length 1
Max length 150
Nullable Yes

post_code

string | null

The identifier for an addressable group of properties according to the relevant postal service.

Min length 1
Max length 50
Nullable Yes

city

string Required

The common name of the city, town or village, where the Supplier, Buyer and Shipping Recipient address is located.

Min length 1
Max length 50

state

string Required

- If the country is Malaysia, the State code must be used. - For countries other than Malaysia, the actual State name may be stated. - For consolidated submission, State code 17 should be used to indicate “Not Applicable”.

Min length 1
Max length 50

country_code

string Required

A code that identifies the country. Country codes are used to supply precise country information when providing address information as part of the document submission. Country codes used in documents are following ISO-3166 alpha-3 approach.

Min length 3
Max length 3

Used by

Raw YAML
Download source
title: MyInvois Address
type: object
description: 'Address (registered, business, residential, etc.) of business or individual who will be the supplier in a commercial transaction'
x-tags:
  - MyInvois
required:
  - line_1
  - city
  - state
  - country_code
properties:
  line_1:
    type: string
    description: This is the main address line in an address structure that can be used to give the main address line information.
    minLength: 1
    maxLength: 150
  line_2:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 150
    description: An additional address line in an address that can be used to give further details supplementing the main line.
  line_3:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 150
    description: An additional address line in an address that can be used to give further details supplementing the main line.
  post_code:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 50
    description: The identifier for an addressable group of properties according to the relevant postal service.
  city:
    type: string
    minLength: 1
    maxLength: 50
    description: 'The common name of the city, town or village, where the Supplier, Buyer and Shipping Recipient address is located.'
  state:
    type: string
    minLength: 1
    maxLength: 50
    description: |-
      - If the country is Malaysia, the State code must be used.
      - For countries other than Malaysia, the actual State name may be stated.
      - For consolidated submission, State code 17 should be used to indicate “Not Applicable”.
  country_code:
    type: string
    description: A code that identifies the country. Country codes are used to supply precise country information when providing address information as part of the document submission. Country codes used in documents are following ISO-3166 alpha-3 approach.
    maxLength: 3
    minLength: 3

Search documentation

Search across this documentation site.